JSON/XML: | GET https://api.sanctionssearch.com/v2/clients/documents/{id}/original/ |
JSON/XML: | GET https://api.sanctionssearch.com/v2/clients/documents/{id}/cropped/ |
JSON/XML: | GET https://api.sanctionssearch.com/v2/clients/documents/{id}/ |
This method, armed with a client file ID or link provided from a GetClient response, will return an image of the document.
An Accept header of image/jpg will return the image directly in JPEG format.
Request Parameters
Parameter | Type | Format | Description |
---|---|---|---|
Id Required | Int64 | The ClientFile ID number | |
Original | Boolean | Set true to return the original document image, or false to return the cropped version. Defaults to false. |
Response Parameters
Parameter | Type | Format | Description |
---|---|---|---|
ResponseStatus | ResponseStatus | Instance of ResponseStatus object (see here) | |
Base64Image | string | Base64 representation of the requested image |