"use strict";
export class Authentication {
/** @param {{apiUserId?:string,apiUserKey?:string,userId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description 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) */
apiUserId;
/**
* @type {string}
* @description 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) */
apiUserKey;
/**
* @type {string}
* @description 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). */
userId;
}
export class BaseRequest {
/** @param {{authentication?:Authentication}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {Authentication}
* @description The authentication credentials */
authentication;
}
export class ResponseError {
/** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
errorCode;
/** @type {string} */
fieldName;
/** @type {string} */
message;
/** @type {{ [index: string]: string; }} */
meta;
}
export class ArrayOfResponseError extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
/** @param {{errorCode?:string,message?:string,stackTrace?:string,errors?:ArrayOfResponseError,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
errorCode;
/** @type {string} */
message;
/** @type {string} */
stackTrace;
/** @type {ArrayOfResponseError} */
errors;
/** @type {{ [index: string]: string; }} */
meta;
}
export class BaseResponse {
/** @param {{responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {ResponseStatus}
* @description The status of the response */
responseStatus;
}
/** @typedef {'Undefined'|'ValidateMe'|'PassportChipVerification'} */
export var CreateMobileClientType;
(function (CreateMobileClientType) {
CreateMobileClientType["Undefined"] = "Undefined"
CreateMobileClientType["ValidateMe"] = "ValidateMe"
CreateMobileClientType["PassportChipVerification"] = "PassportChipVerification"
})(CreateMobileClientType || (CreateMobileClientType = {}));
export class ProofOfDocument {
/** @param {{id?:number,name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The ID of the ProofOfDocument */
id;
/**
* @type {string}
* @description The name of the ProofOfDocument */
name;
}
export class ArrayOfProofOfDocuments extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class ProofOfDocumentCategory {
/** @param {{id?:number,proofOf?:string,proofOfDocuments?:ArrayOfProofOfDocuments}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The ID of the ProofOfDocumentCategory */
id;
/**
* @type {string}
* @description The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work') */
proofOf;
/**
* @type {ArrayOfProofOfDocuments}
* @description The documents that can be used to provide proof for the specified category. */
proofOfDocuments;
}
export class ArrayOfProofOfDocumentCategories extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class LinkedTo {
/** @param {{clientId?:number,id?:number,type?:string,subtype?:string,status?:string,description?:string,isArchived?:boolean,name?:string,date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
clientId;
/** @type {?number} */
id;
/** @type {?string} */
type;
/** @type {?string} */
subtype;
/** @type {?string} */
status;
/** @type {?string} */
description;
/** @type {?boolean} */
isArchived;
/** @type {?string} */
name;
/** @type {?string} */
date;
}
export class ArrayOfLinkedTo extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class AddClientRequest {
/** @param {{name?:string,email?:string,mobileInternational?:string,postCode?:string,proofOfPreset?:CreateMobileClientType,proofOfDocumentCategories?:ArrayOfProofOfDocumentCategories,linkedTo?:ArrayOfLinkedTo,reference?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The full name of the client */
name;
/**
* @type {string}
* @description The email address of the client */
email;
/**
* @type {string}
* @description The client's mobile phone number in international format (e.g. '+447123456789') */
mobileInternational;
/**
* @type {string}
* @description A reference or postcode that will be sent to the client to help them recognize the communication as genuine */
postCode;
/**
* @type {CreateMobileClientType}
* @description Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name */
proofOfPreset;
/**
* @type {ArrayOfProofOfDocumentCategories}
* @description The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe' */
proofOfDocumentCategories;
/**
* @type {ArrayOfLinkedTo}
* @description If the client should be linked to other searches, specify the them here */
linkedTo;
/**
* @type {string}
* @description Your reference, if any */
reference;
}
export class AddClientTemplateData extends BaseResponse {
/** @param {{request?:AddClientRequest,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {AddClientRequest} */
request;
}
export class AddClientTemplateResponse {
/** @param {{data?:AddClientTemplateData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AddClientTemplateData} */
data;
}
export class AddClientTemplate extends BaseRequest {
/** @param {{authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
JavaScript AddClientTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap12 suffix or ?format=soap12
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap12 HTTP/1.1
Host: api.sanctionssearch.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AddClientTemplate 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>
</AddClientTemplate>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<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>
<Reference>String</Reference>
</Request>
</Data>
</AddClientTemplateResponse>
</soap12:Body>
</soap12:Envelope>