Sanctions Search API: v2

AddClientTemplate

Clients

The following routes are available for this service:
GET	/clients/template	Get a template for adding a client

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

**AddClientTemplateResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	AddClientTemplateData	No

**AddClientTemplateData** Parameters:
Name	Parameter	Data Type	Required	Description
Request	form	AddClientRequest	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

**AddClientRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes	The full name of the client
Email	form	string	Yes	The email address of the client
MobileInternational	form	string	Yes	The client's mobile phone number in international format (e.g. '+447123456789')
PostCode	form	string	Yes	The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine
ProofOfPreset	form	CreateMobileClientType	Yes	Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name
ProofOfDocumentCategories	form	ArrayOfProofOfDocumentCategories	No	The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'
LinkedTo	form	ArrayOfLinkedTo	No	If the client should be linked to other searches, specify the them here

**CreateMobileClientType** Enum:
Undefined
ValidateMe
PassportChipVerification

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

**LinkedTo** Parameters:
Name	Parameter	Data Type	Required
ClientId	form	int?	No
Id	form	long?	No
Type	form	string	No
Subtype	form	string	No
Status	form	string	No
Description	form	string	No
IsArchived	form	bool?	No
Name	form	string	No
Date	form	DateTime?	No

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/template HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml

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

<AddClientTemplateResponse 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>
    <Request>
      <Email>String</Email>
      <LinkedTo>
        <LinkedTo>
          <ClientId>0</ClientId>
          <Date>0001-01-01T00:00:00</Date>
          <Description>String</Description>
          <Id>0</Id>
          <IsArchived>false</IsArchived>
          <Name>String</Name>
          <Status>String</Status>
          <Subtype>String</Subtype>
          <Type>String</Type>
        </LinkedTo>
      </LinkedTo>
      <MobileInternational>String</MobileInternational>
      <Name>String</Name>
      <PostCode>String</PostCode>
      <ProofOfDocumentCategories>
        <CategoryId>
          <Id>0</Id>
          <ProofOf>String</ProofOf>
          <ProofOfDocuments>
            <DocumentId>
              <Id>0</Id>
              <Name>String</Name>
            </DocumentId>
          </ProofOfDocuments>
        </CategoryId>
      </ProofOfDocumentCategories>
      <ProofOfPreset>Undefined</ProofOfPreset>
    </Request>
  </Data>
</AddClientTemplateResponse>