// @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="CreateMobileClientType", Namespace="http://schemas.servicestack.net/types")
export enum CreateMobileClientType
{
Undefined = 'Undefined',
ValidateMe = 'ValidateMe',
PassportChipVerification = 'PassportChipVerification',
}
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 LinkedTo
{
public clientId?: number;
public id?: number;
public type?: string;
public subtype?: string;
public status?: string;
public description?: string;
public isArchived?: boolean;
public name?: string;
public date?: string;
public constructor(init?: Partial<LinkedTo>) { (Object as any).assign(this, init); }
}
export class ArrayOfLinkedTo extends Array<LinkedTo>
{
public constructor(init?: Partial<ArrayOfLinkedTo>) { super(); (Object as any).assign(this, init); }
}
export class AddClientRequest
{
/** @description The full name of the client */
// @ApiMember(Description="The full name of the client", IsRequired=true)
public name: string;
/** @description The email address of the client */
// @ApiMember(Description="The email address of the client", IsRequired=true)
public email: string;
/** @description The client's mobile phone number in international format (e.g. '+447123456789') */
// @ApiMember(Description="The client's mobile phone number in international format (e.g. '+447123456789')", IsRequired=true)
public mobileInternational: string;
/** @description The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine */
// @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)
public postCode: string;
/** @description Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name */
// @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)
public proofOfPreset: CreateMobileClientType;
/** @description The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe' */
// @ApiMember(Description="The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'")
public proofOfDocumentCategories: ArrayOfProofOfDocumentCategories;
/** @description If the client should be linked to other searches, specify the them here */
// @ApiMember(Description="If the client should be linked to other searches, specify the them here")
public linkedTo: ArrayOfLinkedTo;
public constructor(init?: Partial<AddClientRequest>) { (Object as any).assign(this, init); }
}
export class AddClientTemplateData extends BaseResponse
{
public request: AddClientRequest;
public constructor(init?: Partial<AddClientTemplateData>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class AddClientTemplateResponse
{
// @DataMember
public data: AddClientTemplateData;
public constructor(init?: Partial<AddClientTemplateResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class AddClientTemplate extends BaseRequest
{
public constructor(init?: Partial<AddClientTemplate>) { super(init); (Object as any).assign(this, init); }
}
TypeScript 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>
</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>
</Request>
</Data>
</AddClientTemplateResponse>
</soap12:Body>
</soap12:Envelope>