All requests must first be Authorized and must use the HTTP GET method over HTTPS.
This call allows you to purchase a copy of a scanned document in PDF or TIFF format (default). New documents since 2021 are only available in PDF format, so we recommend you always request PDF.
https://api.vision-net.ie/cws/2.3/documentapi/document/{{DOC_ID}}?coNum={{COMPANY_NUM}}&format={{FORMAT}}
Parameter | Type | Description |
---|---|---|
DOC_ID | Positive Integer | A unique number representing one scan of a document. The number that contains up to 15 digits. This number is retrieved from a call to Submission Search. This ID is also available in the latest_doc_ids section of the company report for certain common document types. A doc_id is sometimes available in relation to charges and satisfactions too. |
coNum | 83-999999 | Optional The Company number the document belongs to. If you are requesting the document belonging to a Registered Business Name (RBN) then do NOT supply this field. Passing an incorrect number will cause the document to be marked as not available, so only supply this if you know the CRO Company number. |
format | PDF or TIFF | If you want the document in PDF format, or multi-page TIFF format (default). New documents since 2021 are only available in PDF format, so we recommend you always request PDF. |
userRef | String | Optionally record a User Reference for tracking your own usage. |