Sanctions Search API: v2

AddClient

Clients

The following routes are available for this service:
POST	/clients	Add a client

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

**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	A reference or postcode that will be 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
Reference	form	string	No	Your reference, if any

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

**AddClientResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	AddClientData	No

**AddClientData** Parameters:
Name	Parameter	Data Type	Required	Description
LinkedTo	form	ArrayOfLinkedTo	No
Client	form	Client	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

**Client** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
DateCreated	form	DateTime	No
Name	form	string	No
Email	form	string	No
Reference	form	string	No
State	form	ClientState	No
MobileInternational	form	string	No
PostCode	form	string	No
IsValidateMe	form	bool	No
Face	form	Face	No
Video	form	Video	No
Location	form	Location	No
NumOfDocuments	form	int	No
NumOfVideos	form	int	No
Passports	form	ArrayOfPassports	No
DrivingLicences	form	ArrayOfDrivingLicences	No
OtherDocuments	form	ArrayOfOtherDocuments	No
ProofOfDocumentCategories	form	ArrayOfProofOfDocumentCategories	No

**ClientState** Enum:
Undefined
PendingCompletion
PendingOcr
PendingVerification
Verified

**Face** Parameters:
Name	Parameter	Data Type	Required
Age	form	double?	No
Gender	form	string	No
Emotion	form	string	No
Smile	form	double?	No
HairColour	form	string	No
FacialHair	form	string	No
Makeup	form	string	No
Glasses	form	string	No
Accessories	form	string	No

**Video** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
VideoUrl	form	string	No
ImageUrl	form	string	No
VideoTimestamps	form	List<VideoTimestamp>	No

**VideoTimestamp** Parameters:
Name	Parameter	Data Type	Required
TagName	form	string	No
Milli	form	int?	No
ImageUrl	form	string	No

**Location** Parameters:
Name	Parameter	Data Type	Required	Description
Latitude	form	double	No
Longitude	form	double	No

**Passport** Parameters:
Name	Parameter	Data Type	Required
ClientFileId	form	int	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
DateOfBirth	form	string	No
Gender	form	string	No
MrzLineOne	form	string	No
MrzLineTwo1	form	string	No
MrzLineTwo2	form	string	No
MrzLineTwo3	form	string	No
MrzLineTwo4	form	string	No
MrzLineTwo5	form	string	No
MrzLineTwo6	form	string	No
MrzLineTwo7	form	string	No
MrzLineTwo8	form	string	No
Images	form	ArrayOfImages	No
IsVerified	form	bool	No
IsFaceMatch	form	bool?	No
FaceMatchConfidence	form	decimal?	No
HasPcvSearch	form	bool	No
HasDfaSearch	form	bool	No
IsPassportChipVerified	form	bool?	No
PassportChipData	form	PassportChipData	No
IsEligibleForPcv	form	bool	No
IsEligibleForDfa	form	bool	No

**Image** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
OcrId	form	int?	No
Url	form	string	No

**PassportChipData** Parameters:
Name	Parameter	Data Type	Required
IsIssuerVerified	form	bool	No
IssuerCommonName	form	string	No
IssuerOrganisationName	form	string	No
IssuerCountry	form	string	No
MRZLine1	form	string	No
MRZLine2	form	string	No
IsMrzLine1Verified	form	bool	No
IsMrzLine2Verified	form	bool	No
DataGroupsVerified	form	int[]	No
DataGroupsFailed	form	int[]	No
IsFaceMatch	form	bool	No
FaceMatchConfidence	form	decimal?	No

**DrivingLicence** Parameters:
Name	Parameter	Data Type	Required
ClientFileId	form	int	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
DateOfBirth	form	string	No
Address	form	string	No
DrivingLicenceNumber	form	string	No
ExpiryDate	form	string	No
Images	form	ArrayOfImages	No
IsVerified	form	bool	No
IsFaceMatch	form	bool?	No
FaceMatchConfidence	form	decimal?	No
HasDfaSearch	form	bool	No

**OtherDocument** Parameters:
Name	Parameter	Data Type	Required
ClientFileId	form	int	No
Type	form	string	No
TypeOther	form	string	No
Description	form	string	No
OriginalImageUrl	form	string	No
CroppedImageUrl	form	string	No
IsVerified	form	bool	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.

POST /clients HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddClient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
    <UserId>String</UserId>
  </Authentication>
  <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>
    <Reference>String</Reference>
  </Request>
</AddClient>

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

<AddClientResponse 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>
    <Client>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DrivingLicences>
        <Passport>
          <Address>String</Address>
          <ClientFileId>0</ClientFileId>
          <DateOfBirth>String</DateOfBirth>
          <DrivingLicenceNumber>String</DrivingLicenceNumber>
          <ExpiryDate>String</ExpiryDate>
          <FaceMatchConfidence>0</FaceMatchConfidence>
          <FirstName>String</FirstName>
          <HasDfaSearch>false</HasDfaSearch>
          <Images>
            <CategoryId>
              <Id>0</Id>
              <Name>String</Name>
              <OcrId>0</OcrId>
              <Url>String</Url>
            </CategoryId>
          </Images>
          <IsFaceMatch>false</IsFaceMatch>
          <IsVerified>false</IsVerified>
          <LastName>String</LastName>
          <MiddleName>String</MiddleName>
        </Passport>
      </DrivingLicences>
      <Email>String</Email>
      <Face>
        <Accessories>String</Accessories>
        <Age>0</Age>
        <Emotion>String</Emotion>
        <FacialHair>String</FacialHair>
        <Gender>String</Gender>
        <Glasses>String</Glasses>
        <HairColour>String</HairColour>
        <Makeup>String</Makeup>
        <Smile>0</Smile>
      </Face>
      <Id>0</Id>
      <IsValidateMe>false</IsValidateMe>
      <Location>
        <Latitude>0</Latitude>
        <Longitude>0</Longitude>
      </Location>
      <MobileInternational>String</MobileInternational>
      <Name>String</Name>
      <NumOfDocuments>0</NumOfDocuments>
      <NumOfVideos>0</NumOfVideos>
      <OtherDocuments>
        <OtherDocument>
          <ClientFileId>0</ClientFileId>
          <CroppedImageUrl>String</CroppedImageUrl>
          <Description>String</Description>
          <IsVerified>false</IsVerified>
          <OriginalImageUrl>String</OriginalImageUrl>
          <Type>String</Type>
          <TypeOther>String</TypeOther>
        </OtherDocument>
      </OtherDocuments>
      <Passports>
        <Passport>
          <ClientFileId>0</ClientFileId>
          <DateOfBirth>String</DateOfBirth>
          <FaceMatchConfidence>0</FaceMatchConfidence>
          <FirstName>String</FirstName>
          <Gender>String</Gender>
          <HasDfaSearch>false</HasDfaSearch>
          <HasPcvSearch>false</HasPcvSearch>
          <Images>
            <CategoryId>
              <Id>0</Id>
              <Name>String</Name>
              <OcrId>0</OcrId>
              <Url>String</Url>
            </CategoryId>
          </Images>
          <IsEligibleForDfa>false</IsEligibleForDfa>
          <IsEligibleForPcv>false</IsEligibleForPcv>
          <IsFaceMatch>false</IsFaceMatch>
          <IsPassportChipVerified>false</IsPassportChipVerified>
          <IsVerified>false</IsVerified>
          <LastName>String</LastName>
          <MiddleName>String</MiddleName>
          <MrzLineOne>String</MrzLineOne>
          <MrzLineTwo1>String</MrzLineTwo1>
          <MrzLineTwo2>String</MrzLineTwo2>
          <MrzLineTwo3>String</MrzLineTwo3>
          <MrzLineTwo4>String</MrzLineTwo4>
          <MrzLineTwo5>String</MrzLineTwo5>
          <MrzLineTwo6>String</MrzLineTwo6>
          <MrzLineTwo7>String</MrzLineTwo7>
          <MrzLineTwo8>String</MrzLineTwo8>
          <PassportChipData>
            <DataGroupsFailed xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </DataGroupsFailed>
            <DataGroupsVerified xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>0</d7p1:int>
            </DataGroupsVerified>
            <FaceMatchConfidence>0</FaceMatchConfidence>
            <IsFaceMatch>false</IsFaceMatch>
            <IsIssuerVerified>false</IsIssuerVerified>
            <IsMrzLine1Verified>false</IsMrzLine1Verified>
            <IsMrzLine2Verified>false</IsMrzLine2Verified>
            <IssuerCommonName>String</IssuerCommonName>
            <IssuerCountry>String</IssuerCountry>
            <IssuerOrganisationName>String</IssuerOrganisationName>
            <MRZLine1>String</MRZLine1>
            <MRZLine2>String</MRZLine2>
          </PassportChipData>
        </Passport>
      </Passports>
      <PostCode>String</PostCode>
      <ProofOfDocumentCategories>
        <CategoryId>
          <Id>0</Id>
          <ProofOf>String</ProofOf>
          <ProofOfDocuments>
            <DocumentId>
              <Id>0</Id>
              <Name>String</Name>
            </DocumentId>
          </ProofOfDocuments>
        </CategoryId>
      </ProofOfDocumentCategories>
      <Reference>String</Reference>
      <State>Undefined</State>
      <Video>
        <Id>0</Id>
        <ImageUrl>String</ImageUrl>
        <VideoTimestamps>
          <VideoTimestamp>
            <ImageUrl>String</ImageUrl>
            <Milli>0</Milli>
            <TagName>String</TagName>
          </VideoTimestamp>
        </VideoTimestamps>
        <VideoUrl>String</VideoUrl>
      </Video>
    </Client>
    <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>
  </Data>
</AddClientResponse>