Client > AddClientTemplate

URLs
JSON/XML: GET https://api.sanctionssearch.com/v2/clients/template/
JSON/XML Legacy: POST https://api.sanctionssearch.com/v2/{json/xml}/reply/AddClientTemplate/

This method gives a template for creating clients - the response body of this contains the request body of the AddClient method.

Request Parameters

None

Response Parameters

Parameter Type Format Description
Name String
Email String
MobileInternational String
PostCode String
ProofOfPreset String Specifies the type of ValidateMe preset. This will default to 'ValidateMe'

The following values are valid:

ValidateMe Allows you to set the ProofOfDocuments using the ProofOfDocumentCategories
PassportChipVerification Sets the only ProofOfDocument as 'Passport' under ProofOfDocumentCategory 'Name'
ProofOfDocumentCategories Array The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'.

This will be set to the defaults configured for the UserAccount via the UpdateDefaultProofOfDocumentCategories method. If no defaults have been configured, it will return all the possible ProofOfDocumentCategories and ProofOfDocuments.

Array of ProofOfDocumentCategory objects (see here)
ResponseStatus ResponseStatus   Instance of ResponseStatus object (see here)