Sanctions Search API: v2

GetPdf

Account

The following routes are available for this service:
POST	/pdfs/get	Get a PDF

**GetPdf** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	GetPdfRequest	No	The request data

**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. Can be provided in the request body, or as a header parameter (X-Api-User)
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
UserId	header, body	string	No	The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).

**GetPdfRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SubUserName	form	string	No	If the saved document is kept within a single Sub User account, specify their username here
Id	form	long	No	The ID of the document to retrieve

**GetPdfResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetPdfData	No	The response data

**GetPdfData** Parameters:
Name	Parameter	Data Type	Required	Description
Document	form	PdfDocumentWithData	No	The single document that is being returned, including the file data

**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

**PdfDocumentWithData** Parameters:
Name	Parameter	Data Type	Required	Description
DocumentBytes	form	byte[]	No	The file data in a byte array

**PdfDocument** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	long	No	The ID of the saved document
IsReady	form	bool	No	Is the document ready to download
Name	form	string	No	The name of the saved document
FileName	form	string	No	The file name (including extension) of the saved document
Type	form	string	No	The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)
SanctionsSearchId	form	long?	No	If this document is a Saved Sanctions Search, the ID of the search it relates to
PepSearchId	form	long?	No	If this document is a Saved PEP Search, the ID of the search it relates to
ValidIdSearchId	form	int?	No	If this document is a Saved ValidID Search, the ID of the search it relates to
CompanyLookupSearchId	form	int?	No	If this document is a Saved CompanyLookup Search, the ID of the search it relates to
DateCreated	form	DateTime	No	The date the saved document was created/requested
DateExpires	form	DateTime	No	The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods

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.

POST /pdfs/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","id":0},"authentication":{"apiUserId":"String","apiUserKey":"String","userId":"String"}}

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

{"data":{"document":{"documentBytes":"AA==","id":0,"isReady":false,"name":"String","fileName":"String","type":"String","sanctionsSearchId":0,"pepSearchId":0,"validIdSearchId":0,"companyLookupSearchId":0,"dateCreated":"\/Date(-62135596800000-0000)\/","dateExpires":"\/Date(-62135596800000-0000)\/"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}