Sanctions Search API: v2

<back to all web services

UpdateClient

Clients
The following routes are available for this service:
PUT/clients/{Id}Update a client when it is PendingVerification

// @DataContract
export class Authentication
{
    /** @description The API User ID provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserId: string;

    /** @description The API User Key provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserKey: string;

    public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseRequest implements IBaseRequest
{
    /** @description The authentication credentials */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public authentication: Authentication;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseError
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public fieldName: string;

    // @DataMember(Order=3)
    public message: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}

export class ArrayOfResponseError extends Array<ResponseError>
{

    public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public message: string;

    // @DataMember(Order=3)
    public stackTrace: string;

    // @DataMember(Order=4)
    public errors: ArrayOfResponseError;

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
    /** @description The status of the response */
    // @ApiMember(Description="The status of the response")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ClientState", Namespace="http://schemas.servicestack.net/types")
export enum ClientState
{
    Undefined = 'Undefined',
    PendingCompletion = 'PendingCompletion',
    PendingOcr = 'PendingOcr',
    PendingVerification = 'PendingVerification',
    Verified = 'Verified',
}

export class Face
{
    public age?: number;
    public gender: string;
    public emotion: string;
    public smile?: number;
    public hairColour: string;
    public facialHair: string;
    public makeup: string;
    public glasses: string;
    public accessories: string;

    public constructor(init?: Partial<Face>) { (Object as any).assign(this, init); }
}

export class VideoTimestamp
{
    public tagName: string;
    public milli?: number;
    public imageUrl: string;

    public constructor(init?: Partial<VideoTimestamp>) { (Object as any).assign(this, init); }
}

export class Video
{
    public id: number;
    public videoUrl: string;
    public imageUrl: string;
    public videoTimestamps: VideoTimestamp[];

    public constructor(init?: Partial<Video>) { (Object as any).assign(this, init); }
}

export class Location
{
    public latitude: number;
    public longitude: number;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

export class Image
{
    public id: number;
    public name: string;
    public ocrId?: number;
    public url: string;

    public constructor(init?: Partial<Image>) { (Object as any).assign(this, init); }
}

export class ArrayOfImages extends Array<Image>
{

    public constructor(init?: Partial<ArrayOfImages>) { super(); (Object as any).assign(this, init); }
}

export class PassportChipData
{
    public isIssuerVerified: boolean;
    public issuerCommonName: string;
    public issuerOrganisationName: string;
    public issuerCountry: string;
    public mrzLine1: string;
    public mrzLine2: string;
    public isMrzLine1Verified: boolean;
    public isMrzLine2Verified: boolean;
    public dataGroupsVerified: number[];
    public dataGroupsFailed: number[];
    public isFaceMatch: boolean;
    public faceMatchConfidence?: number;

    public constructor(init?: Partial<PassportChipData>) { (Object as any).assign(this, init); }
}

export class Passport
{
    public clientFileId: number;
    public firstName: string;
    public middleName: string;
    public lastName: string;
    public dateOfBirth: string;
    public gender: string;
    public mrzLineOne: string;
    public mrzLineTwo1: string;
    public mrzLineTwo2: string;
    public mrzLineTwo3: string;
    public mrzLineTwo4: string;
    public mrzLineTwo5: string;
    public mrzLineTwo6: string;
    public mrzLineTwo7: string;
    public mrzLineTwo8: string;
    public images: ArrayOfImages;
    public isVerified: boolean;
    public isFaceMatch?: boolean;
    public faceMatchConfidence?: number;
    public hasPcvSearch: boolean;
    public hasDfaSearch: boolean;
    public isPassportChipVerified?: boolean;
    public passportChipData: PassportChipData;
    public isEligibleForPcv: boolean;
    public isEligibleForDfa: boolean;

    public constructor(init?: Partial<Passport>) { (Object as any).assign(this, init); }
}

export class ArrayOfPassports extends Array<Passport>
{

    public constructor(init?: Partial<ArrayOfPassports>) { super(); (Object as any).assign(this, init); }
}

export class DrivingLicence
{
    public clientFileId: number;
    public firstName: string;
    public middleName: string;
    public lastName: string;
    public dateOfBirth: string;
    public address: string;
    public drivingLicenceNumber: string;
    public images: ArrayOfImages;
    public isVerified: boolean;
    public isFaceMatch?: boolean;
    public faceMatchConfidence?: number;
    public hasDfaSearch: boolean;

    public constructor(init?: Partial<DrivingLicence>) { (Object as any).assign(this, init); }
}

export class ArrayOfDrivingLicences extends Array<DrivingLicence>
{

    public constructor(init?: Partial<ArrayOfDrivingLicences>) { super(); (Object as any).assign(this, init); }
}

export class OtherDocument
{
    public clientFileId: number;
    public type: string;
    public typeOther: string;
    public description: string;
    public originalImageUrl: string;
    public croppedImageUrl: string;
    public isVerified: boolean;

    public constructor(init?: Partial<OtherDocument>) { (Object as any).assign(this, init); }
}

export class ArrayOfOtherDocuments extends Array<OtherDocument>
{

    public constructor(init?: Partial<ArrayOfOtherDocuments>) { super(); (Object as any).assign(this, init); }
}

export class ProofOfDocument
{
    /** @description The ID of the ProofOfDocument */
    // @ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true)
    public id: number;

    /** @description The name of the ProofOfDocument */
    // @ApiMember(Description="The name of the ProofOfDocument", IsRequired=true)
    public name: string;

    public constructor(init?: Partial<ProofOfDocument>) { (Object as any).assign(this, init); }
}

export class ArrayOfProofOfDocuments extends Array<ProofOfDocument>
{

    public constructor(init?: Partial<ArrayOfProofOfDocuments>) { super(); (Object as any).assign(this, init); }
}

export class ProofOfDocumentCategory
{
    /** @description The ID of the ProofOfDocumentCategory */
    // @ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true)
    public id: number;

    /** @description The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work') */
    // @ApiMember(Description="The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')", IsRequired=true)
    public proofOf: string;

    /** @description The documents that can be used to provide proof for the specified category. */
    // @ApiMember(Description="The documents that can be used to provide proof for the specified category.", IsRequired=true)
    public proofOfDocuments: ArrayOfProofOfDocuments;

    public constructor(init?: Partial<ProofOfDocumentCategory>) { (Object as any).assign(this, init); }
}

export class ArrayOfProofOfDocumentCategories extends Array<ProofOfDocumentCategory>
{

    public constructor(init?: Partial<ArrayOfProofOfDocumentCategories>) { super(); (Object as any).assign(this, init); }
}

export class Client
{
    public id: number;
    public dateCreated: string;
    public name: string;
    public email: string;
    public reference: string;
    public state: ClientState;
    public mobileInternational: string;
    public postCode: string;
    public isValidateMe: boolean;
    public face: Face;
    public video: Video;
    public location: Location;
    public numOfDocuments: number;
    public passports: ArrayOfPassports;
    public drivingLicences: ArrayOfDrivingLicences;
    public otherDocuments: ArrayOfOtherDocuments;
    public proofOfDocumentCategories: ArrayOfProofOfDocumentCategories;

    public constructor(init?: Partial<Client>) { (Object as any).assign(this, init); }
}

export class UpdateClientData extends BaseResponse
{
    public client: Client;

    public constructor(init?: Partial<UpdateClientData>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class UpdateClientResponse
{
    // @DataMember
    public data: UpdateClientData;

    public constructor(init?: Partial<UpdateClientResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class UpdateClient extends BaseRequest
{
    // @DataMember
    // @ApiMember(IsRequired=true, ParameterType="path")
    public id: number;

    // @DataMember
    public request: Client;

    public constructor(init?: Partial<UpdateClient>) { super(init); (Object as any).assign(this, init); }
}

TypeScript UpdateClient DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /clients/{Id} HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":0,"request":{"id":0,"dateCreated":"\/Date(-62135596800000-0000)\/","name":"String","email":"String","reference":"String","state":"Undefined","mobileInternational":"String","postCode":"String","isValidateMe":false,"face":{"age":0,"gender":"String","emotion":"String","smile":0,"hairColour":"String","facialHair":"String","makeup":"String","glasses":"String","accessories":"String"},"video":{"id":0,"videoUrl":"String","imageUrl":"String","videoTimestamps":[{"tagName":"String","milli":0,"imageUrl":"String"}]},"location":{"latitude":0,"longitude":0},"numOfDocuments":0,"passports":[{"clientFileId":0,"firstName":"String","middleName":"String","lastName":"String","dateOfBirth":"String","gender":"String","mrzLineOne":"String","mrzLineTwo1":"String","mrzLineTwo2":"String","mrzLineTwo3":"String","mrzLineTwo4":"String","mrzLineTwo5":"String","mrzLineTwo6":"String","mrzLineTwo7":"String","mrzLineTwo8":"String","images":[{"id":0,"name":"String","ocrId":0,"url":"String"}],"isVerified":false,"isFaceMatch":false,"faceMatchConfidence":0,"hasPcvSearch":false,"hasDfaSearch":false,"isPassportChipVerified":false,"passportChipData":{"isIssuerVerified":false,"issuerCommonName":"String","issuerOrganisationName":"String","issuerCountry":"String","mrzLine1":"String","mrzLine2":"String","isMrzLine1Verified":false,"isMrzLine2Verified":false,"dataGroupsVerified":[0],"dataGroupsFailed":[0],"isFaceMatch":false,"faceMatchConfidence":0},"isEligibleForPcv":false,"isEligibleForDfa":false}],"drivingLicences":[{"clientFileId":0,"firstName":"String","middleName":"String","lastName":"String","dateOfBirth":"String","address":"String","drivingLicenceNumber":"String","images":[{"id":0,"name":"String","ocrId":0,"url":"String"}],"isVerified":false,"isFaceMatch":false,"faceMatchConfidence":0,"hasDfaSearch":false}],"otherDocuments":[{"clientFileId":0,"type":"String","typeOther":"String","description":"String","originalImageUrl":"String","croppedImageUrl":"String","isVerified":false}],"proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}]},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"client":{"id":0,"dateCreated":"\/Date(-62135596800000-0000)\/","name":"String","email":"String","reference":"String","state":"Undefined","mobileInternational":"String","postCode":"String","isValidateMe":false,"face":{"age":0,"gender":"String","emotion":"String","smile":0,"hairColour":"String","facialHair":"String","makeup":"String","glasses":"String","accessories":"String"},"video":{"id":0,"videoUrl":"String","imageUrl":"String","videoTimestamps":[{"tagName":"String","milli":0,"imageUrl":"String"}]},"location":{"latitude":0,"longitude":0},"numOfDocuments":0,"passports":[{"clientFileId":0,"firstName":"String","middleName":"String","lastName":"String","dateOfBirth":"String","gender":"String","mrzLineOne":"String","mrzLineTwo1":"String","mrzLineTwo2":"String","mrzLineTwo3":"String","mrzLineTwo4":"String","mrzLineTwo5":"String","mrzLineTwo6":"String","mrzLineTwo7":"String","mrzLineTwo8":"String","images":[{"id":0,"name":"String","ocrId":0,"url":"String"}],"isVerified":false,"isFaceMatch":false,"faceMatchConfidence":0,"hasPcvSearch":false,"hasDfaSearch":false,"isPassportChipVerified":false,"passportChipData":{"isIssuerVerified":false,"issuerCommonName":"String","issuerOrganisationName":"String","issuerCountry":"String","mrzLine1":"String","mrzLine2":"String","isMrzLine1Verified":false,"isMrzLine2Verified":false,"dataGroupsVerified":[0],"dataGroupsFailed":[0],"isFaceMatch":false,"faceMatchConfidence":0},"isEligibleForPcv":false,"isEligibleForDfa":false}],"drivingLicences":[{"clientFileId":0,"firstName":"String","middleName":"String","lastName":"String","dateOfBirth":"String","address":"String","drivingLicenceNumber":"String","images":[{"id":0,"name":"String","ocrId":0,"url":"String"}],"isVerified":false,"isFaceMatch":false,"faceMatchConfidence":0,"hasDfaSearch":false}],"otherDocuments":[{"clientFileId":0,"type":"String","typeOther":"String","description":"String","originalImageUrl":"String","croppedImageUrl":"String","isVerified":false}],"proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}