Sanctions Search API: v2

<back to all web services

AddClient

Clients
The following routes are available for this service:
POST/clientsAdd a client
namespace SanctionsSearch.Api2.ServiceModel.Operations.Base

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseError() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val FieldName:String = null with get,set

        [<DataMember(Order=3)>]
        member val Message:String = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type ArrayOfResponseError() = 
        inherit ResizeArray<ResponseError>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseStatus() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val Message:String = null with get,set

        [<DataMember(Order=3)>]
        member val StackTrace:String = null with get,set

        [<DataMember(Order=4)>]
        member val Errors:ArrayOfResponseError = null with get,set

        [<DataMember(Order=5)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///The status of the response
        ///</summary>
        [<ApiMember(Description="The status of the response")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type LinkedTo() = 
        member val ClientId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val Type:String = null with get,set
        member val Subtype:String = null with get,set
        member val Status:String = null with get,set
        member val Description:String = null with get,set
        member val IsArchived:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Name:String = null with get,set
        member val Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type ArrayOfLinkedTo() = 
        inherit ResizeArray<LinkedTo>()

    [<DataContract(Name="ClientState", Namespace="http://schemas.servicestack.net/types")>]
    type ClientState =
        | Undefined = 0
        | PendingCompletion = 1
        | PendingOcr = 2
        | PendingVerification = 3
        | Verified = 4

    [<AllowNullLiteral>]
    type Face() = 
        member val Age:Nullable<Double> = new Nullable<Double>() with get,set
        member val Gender:String = null with get,set
        member val Emotion:String = null with get,set
        member val Smile:Nullable<Double> = new Nullable<Double>() with get,set
        member val HairColour:String = null with get,set
        member val FacialHair:String = null with get,set
        member val Makeup:String = null with get,set
        member val Glasses:String = null with get,set
        member val Accessories:String = null with get,set

    [<AllowNullLiteral>]
    type VideoTimestamp() = 
        member val TagName:String = null with get,set
        member val Milli:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ImageUrl:String = null with get,set

    [<AllowNullLiteral>]
    type Video() = 
        member val Id:Int32 = new Int32() with get,set
        member val VideoUrl:String = null with get,set
        member val ImageUrl:String = null with get,set
        member val VideoTimestamps:ResizeArray<VideoTimestamp> = new ResizeArray<VideoTimestamp>() with get,set

    [<AllowNullLiteral>]
    type Location() = 
        member val Latitude:Double = new Double() with get,set
        member val Longitude:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type Image() = 
        member val Id:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val OcrId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Url:String = null with get,set

    [<AllowNullLiteral>]
    type ArrayOfImages() = 
        inherit ResizeArray<Image>()

    [<AllowNullLiteral>]
    type PassportChipData() = 
        member val IsIssuerVerified:Boolean = new Boolean() with get,set
        member val IssuerCommonName:String = null with get,set
        member val IssuerOrganisationName:String = null with get,set
        member val IssuerCountry:String = null with get,set
        member val MRZLine1:String = null with get,set
        member val MRZLine2:String = null with get,set
        member val IsMrzLine1Verified:Boolean = new Boolean() with get,set
        member val IsMrzLine2Verified:Boolean = new Boolean() with get,set
        member val DataGroupsVerified:Int32[] = [||] with get,set
        member val DataGroupsFailed:Int32[] = [||] with get,set
        member val IsFaceMatch:Boolean = new Boolean() with get,set
        member val FaceMatchConfidence:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type Passport() = 
        member val ClientFileId:Int32 = new Int32() with get,set
        member val FirstName:String = null with get,set
        member val MiddleName:String = null with get,set
        member val LastName:String = null with get,set
        member val DateOfBirth:String = null with get,set
        member val Gender:String = null with get,set
        member val MrzLineOne:String = null with get,set
        member val MrzLineTwo1:String = null with get,set
        member val MrzLineTwo2:String = null with get,set
        member val MrzLineTwo3:String = null with get,set
        member val MrzLineTwo4:String = null with get,set
        member val MrzLineTwo5:String = null with get,set
        member val MrzLineTwo6:String = null with get,set
        member val MrzLineTwo7:String = null with get,set
        member val MrzLineTwo8:String = null with get,set
        member val Images:ArrayOfImages = null with get,set
        member val IsVerified:Boolean = new Boolean() with get,set
        member val IsFaceMatch:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val FaceMatchConfidence:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val HasPcvSearch:Boolean = new Boolean() with get,set
        member val HasDfaSearch:Boolean = new Boolean() with get,set
        member val IsPassportChipVerified:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val PassportChipData:PassportChipData = null with get,set
        member val IsEligibleForPcv:Boolean = new Boolean() with get,set
        member val IsEligibleForDfa:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ArrayOfPassports() = 
        inherit ResizeArray<Passport>()

    [<AllowNullLiteral>]
    type DrivingLicence() = 
        member val ClientFileId:Int32 = new Int32() with get,set
        member val FirstName:String = null with get,set
        member val MiddleName:String = null with get,set
        member val LastName:String = null with get,set
        member val DateOfBirth:String = null with get,set
        member val Address:String = null with get,set
        member val DrivingLicenceNumber:String = null with get,set
        member val Images:ArrayOfImages = null with get,set
        member val IsVerified:Boolean = new Boolean() with get,set
        member val IsFaceMatch:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val FaceMatchConfidence:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val HasDfaSearch:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ArrayOfDrivingLicences() = 
        inherit ResizeArray<DrivingLicence>()

    [<AllowNullLiteral>]
    type OtherDocument() = 
        member val ClientFileId:Int32 = new Int32() with get,set
        member val Type:String = null with get,set
        member val TypeOther:String = null with get,set
        member val Description:String = null with get,set
        member val OriginalImageUrl:String = null with get,set
        member val CroppedImageUrl:String = null with get,set
        member val IsVerified:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ArrayOfOtherDocuments() = 
        inherit ResizeArray<OtherDocument>()

    [<AllowNullLiteral>]
    type ProofOfDocument() = 
        ///<summary>
        ///The ID of the ProofOfDocument
        ///</summary>
        [<ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true)>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The name of the ProofOfDocument
        ///</summary>
        [<ApiMember(Description="The name of the ProofOfDocument", IsRequired=true)>]
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type ArrayOfProofOfDocuments() = 
        inherit ResizeArray<ProofOfDocument>()

    [<AllowNullLiteral>]
    type ProofOfDocumentCategory() = 
        ///<summary>
        ///The ID of the ProofOfDocumentCategory
        ///</summary>
        [<ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true)>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')
        ///</summary>
        [<ApiMember(Description="The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')", IsRequired=true)>]
        member val ProofOf:String = null with get,set

        ///<summary>
        ///The documents that can be used to provide proof for the specified category.
        ///</summary>
        [<ApiMember(Description="The documents that can be used to provide proof for the specified category.", IsRequired=true)>]
        member val ProofOfDocuments:ArrayOfProofOfDocuments = null with get,set

    [<AllowNullLiteral>]
    type ArrayOfProofOfDocumentCategories() = 
        inherit ResizeArray<ProofOfDocumentCategory>()

    [<AllowNullLiteral>]
    type Client() = 
        member val Id:Int32 = new Int32() with get,set
        member val DateCreated:DateTime = new DateTime() with get,set
        member val Name:String = null with get,set
        member val Email:String = null with get,set
        member val Reference:String = null with get,set
        member val State:ClientState = new ClientState() with get,set
        member val MobileInternational:String = null with get,set
        member val PostCode:String = null with get,set
        member val IsValidateMe:Boolean = new Boolean() with get,set
        member val Face:Face = null with get,set
        member val Video:Video = null with get,set
        member val Location:Location = null with get,set
        member val NumOfDocuments:Int32 = new Int32() with get,set
        member val Passports:ArrayOfPassports = null with get,set
        member val DrivingLicences:ArrayOfDrivingLicences = null with get,set
        member val OtherDocuments:ArrayOfOtherDocuments = null with get,set
        member val ProofOfDocumentCategories:ArrayOfProofOfDocumentCategories = null with get,set

    [<AllowNullLiteral>]
    type AddClientData() = 
        inherit BaseResponse()
        member val LinkedTo:ArrayOfLinkedTo = null with get,set
        member val Client:Client = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AddClientResponse() = 
        [<DataMember>]
        member val Data:AddClientData = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Authentication() = 
        ///<summary>
        ///The API User ID provided by us when you signed up to use our API
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")>]
        member val ApiUserId:String = null with get,set

        ///<summary>
        ///The API User Key provided by us when you signed up to use our API
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")>]
        member val ApiUserKey:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")>]
        member val Authentication:Authentication = null with get,set

    [<DataContract(Name="CreateMobileClientType", Namespace="http://schemas.servicestack.net/types")>]
    type CreateMobileClientType =
        | Undefined = 0
        | ValidateMe = 1
        | PassportChipVerification = 2

    [<AllowNullLiteral>]
    type AddClientRequest() = 
        ///<summary>
        ///The full name of the client
        ///</summary>
        [<ApiMember(Description="The full name of the client", IsRequired=true)>]
        member val Name:String = null with get,set

        ///<summary>
        ///The email address of the client
        ///</summary>
        [<ApiMember(Description="The email address of the client", IsRequired=true)>]
        member val Email:String = null with get,set

        ///<summary>
        ///The client's mobile phone number in international format (e.g. '+447123456789')
        ///</summary>
        [<ApiMember(Description="The client's mobile phone number in international format (e.g. '+447123456789')", IsRequired=true)>]
        member val MobileInternational:String = null with get,set

        ///<summary>
        ///The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine
        ///</summary>
        [<ApiMember(Description="The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine", IsRequired=true)>]
        member val PostCode:String = null with get,set

        ///<summary>
        ///Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name
        ///</summary>
        [<ApiMember(Description="Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name", IsRequired=true)>]
        member val ProofOfPreset:CreateMobileClientType = new CreateMobileClientType() with get,set

        ///<summary>
        ///The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'
        ///</summary>
        [<ApiMember(Description="The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'")>]
        member val ProofOfDocumentCategories:ArrayOfProofOfDocumentCategories = null with get,set

        ///<summary>
        ///If the client should be linked to other searches, specify the them here
        ///</summary>
        [<ApiMember(Description="If the client should be linked to other searches, specify the them here")>]
        member val LinkedTo:ArrayOfLinkedTo = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AddClient() = 
        inherit BaseRequest()
        [<DataMember>]
        member val Request:AddClientRequest = null with get,set

F# AddClient DTOs

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