Sanctions Search API: v2

GetClientDocument

Clients

The following routes are available for this service:
GET	/clients/documents/{Id}	Gets the document image
GET	/clients/documents/{Id}/original	Get the original document image
GET	/clients/documents/{Id}/cropped	Get the cropped document image

**GetClientDocument** Parameters:
Name	Parameter	Data Type	Required
Id	path	int	Yes
Original	query	bool	No
Mil	query	int?	No
OcrId	query	int?	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	header, body	Authentication	Yes	The authentication credentials

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	header, body	string	Yes	The API User ID provided by us when you signed up to use our API
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API

**GetClientDocumentResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetClientDocumentData	No

**GetClientDocumentData** Parameters:
Name	Parameter	Data Type	Required	Description
Base64Image	form	string	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	The status of the response

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No
Meta	form	Dictionary<string, string>	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	string	No
Meta	form	Dictionary<string, string>	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /clients/documents/{Id} HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"data":{"base64Image":"String","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}