Sanctions Search API: v2

GetProofOfDocumentCategories

Clients

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

**GetProofOfDocumentCategories** Parameters:
Name	Parameter	Data Type	Required	Description
OnlyDefaults	query	bool	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

**GetProofOfDocumentCategoriesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	GetProofOfDocumentCategoriesData	No

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

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

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

HTTP + XML

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

GET /clients/proofs/defaults HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml

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

<GetProofOfDocumentCategoriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <ProofOfDocumentCategories>
      <CategoryId>
        <Id>0</Id>
        <ProofOf>String</ProofOf>
        <ProofOfDocuments>
          <DocumentId>
            <Id>0</Id>
            <Name>String</Name>
          </DocumentId>
        </ProofOfDocuments>
      </CategoryId>
    </ProofOfDocumentCategories>
  </Data>
</GetProofOfDocumentCategoriesResponse>