Sanctions Search API: v2

UpdateDefaultProofOfDocumentCategories

Clients

The following routes are available for this service:
PUT	/clients/proofs/defaults	Update the configured default categories of proof and their documents

**UpdateDefaultProofOfDocumentCategories** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	UpdateDefaultProofOfDocumentCategoriesRequest	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. 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).

**UpdateDefaultProofOfDocumentCategoriesRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ProofOfDocumentCategories	form	ArrayOfProofOfDocumentCategories	Yes

**ProofOfDocumentCategory** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	Yes	The ID of the ProofOfDocumentCategory
ProofOf	form	string	Yes	The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')
ProofOfDocuments	form	ArrayOfProofOfDocuments	Yes	The documents that can be used to provide proof for the specified category.

**ProofOfDocument** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	Yes	The ID of the ProofOfDocument
Name	form	string	Yes	The name of the ProofOfDocument

**UpdateDefaultProofOfDocumentCategoriesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	UpdateDefaultProofOfDocumentCategoriesData	No

**UpdateDefaultProofOfDocumentCategoriesData** Parameters:
Name	Parameter	Data Type	Required	Description
ProofOfDocumentCategories	form	ArrayOfProofOfDocumentCategories	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.

PUT /clients/proofs/defaults HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}]},"authentication":{"apiUserId":"String","apiUserKey":"String","userId":"String"}}

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

{"data":{"proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}