| GET | /validid/template |
|---|
"use strict";
export class Authentication {
/** @param {{apiUserId?:string,apiUserKey?: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 */
apiUserId;
/**
* @type {string}
* @description The API User Key provided by us when you signed up to use our API */
apiUserKey;
}
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;
}
export class ArrayOfLists 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 ValidIdBasicRequest {
/** @param {{name1?:string,name2?:string,name3?:string,dateOfBirth?:string,gender?:string,address1?:string,address2?:string,address3?:string,address4?:string,address5?:string,postCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
name1;
/** @type {string} */
name2;
/** @type {string} */
name3;
/** @type {?string} */
dateOfBirth;
/** @type {string} */
gender;
/** @type {string} */
address1;
/** @type {string} */
address2;
/** @type {string} */
address3;
/** @type {string} */
address4;
/** @type {string} */
address5;
/** @type {string} */
postCode;
}
export class ValidIdPassportRequest {
/** @param {{passport1?:string,passport2?:string,passport3?:string,passport4?:string,passport5?:string,passport6?:string,passport7?:string,passport8?:string,passportMrzLineOne1?:string,passportMrzLineOne2?:string,passportMrzLineOne3?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
passport1;
/** @type {string} */
passport2;
/** @type {string} */
passport3;
/** @type {string} */
passport4;
/** @type {string} */
passport5;
/** @type {string} */
passport6;
/** @type {string} */
passport7;
/** @type {string} */
passport8;
/** @type {string} */
passportMrzLineOne1;
/** @type {string} */
passportMrzLineOne2;
/** @type {string} */
passportMrzLineOne3;
}
export class ValidIdDrivingRequest {
/** @param {{driving1?:string,driving2?:string,driving3?:string,drivingPostcode?:string,drivingMailSort?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
driving1;
/** @type {string} */
driving2;
/** @type {string} */
driving3;
/** @type {string} */
drivingPostcode;
/** @type {string} */
drivingMailSort;
}
export class ValidIdBirthRequest {
/** @param {{birthForeName?:string,birthMiddleName?:string,birthSurname?:string,birthMaidenName?:string,birthDistrict?:string,birthCertIssueNum?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
birthForeName;
/** @type {string} */
birthMiddleName;
/** @type {string} */
birthSurname;
/** @type {string} */
birthMaidenName;
/** @type {string} */
birthDistrict;
/** @type {string} */
birthCertIssueNum;
}
export class ValidIdNIRequest {
/** @param {{niNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
niNumber;
}
export class ValidIdNHSRequest {
/** @param {{nhsNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
nhsNumber;
}
export class ValidIdElectricityRequest {
/** @param {{mpanNumber1?:string,mpanNumber2?:string,mpanNumber3?:string,mpanNumber4?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
mpanNumber1;
/** @type {string} */
mpanNumber2;
/** @type {string} */
mpanNumber3;
/** @type {string} */
mpanNumber4;
}
export class ValidIdBankRequest {
/** @param {{bankSortCode?:string,bankAccountNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
bankSortCode;
/** @type {string} */
bankAccountNumber;
}
export class ValidIdCardNumberRequest {
/** @param {{cardNumber?:string,cardType?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
cardNumber;
/** @type {string} */
cardType;
}
export class ValidIdTravelVisaRequest {
/** @param {{travelVisa1?:string,travelVisa2?:string,travelVisa3?:string,travelVisa4?:string,travelVisa5?:string,travelVisa6?:string,travelVisa7?:string,travelVisa8?:string,travelVisa9?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
travelVisa1;
/** @type {string} */
travelVisa2;
/** @type {string} */
travelVisa3;
/** @type {string} */
travelVisa4;
/** @type {string} */
travelVisa5;
/** @type {string} */
travelVisa6;
/** @type {string} */
travelVisa7;
/** @type {string} */
travelVisa8;
/** @type {string} */
travelVisa9;
}
export class ValidIdIdCardRequest {
/** @param {{idCard1?:string,idCard2?:string,idCard3?:string,idCard4?:string,idCard5?:string,idCard6?:string,idCard7?:string,idCard8?:string,idCard9?:string,idCard10?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
idCard1;
/** @type {string} */
idCard2;
/** @type {string} */
idCard3;
/** @type {string} */
idCard4;
/** @type {string} */
idCard5;
/** @type {string} */
idCard6;
/** @type {string} */
idCard7;
/** @type {string} */
idCard8;
/** @type {string} */
idCard9;
/** @type {string} */
idCard10;
}
export class ValidIdPollNumberRequest {
/** @param {{pollNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
pollNumber;
}
export class ValidIdMarriageRequest {
/** @param {{forename?:string,surname?:string,partnerForename?:string,partnerSurname?:string,date?:string,district?:string,certIssueNum?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
forename;
/** @type {string} */
surname;
/** @type {string} */
partnerForename;
/** @type {string} */
partnerSurname;
/** @type {string} */
date;
/** @type {string} */
district;
/** @type {string} */
certIssueNum;
}
export class AddValidIdRequest {
/** @param {{subUserName?:string,type?:string,addPepSearch?:boolean,pepSearchType?:string,addSanctionsSearch?:boolean,selectedLists?:ArrayOfLists,reference?:string,linkedTo?:ArrayOfLinkedTo,basicRequest?:ValidIdBasicRequest,passportRequest?:ValidIdPassportRequest,drivingRequest?:ValidIdDrivingRequest,birthRequest?:ValidIdBirthRequest,niRequest?:ValidIdNIRequest,nhsRequest?:ValidIdNHSRequest,electricityRequest?:ValidIdElectricityRequest,bankRequest?:ValidIdBankRequest,cardNumberRequest?:ValidIdCardNumberRequest,travelVisaRequest?:ValidIdTravelVisaRequest,idCardRequest?:ValidIdIdCardRequest,pollNumberRequest?:ValidIdPollNumberRequest,marriageRequest?:ValidIdMarriageRequest,passportEnabled?:boolean,passportChipEnabled?:boolean,drivingEnabled?:boolean,smartlinkEnabled?:boolean,niEnabled?:boolean,nhsEnabled?:boolean,electricityEnabled?:boolean,bankEnabled?:boolean,creditActiveEnabled?:boolean,idCardEnabled?:boolean,bankLiveEnabled?:boolean,companyDirectorEnabled?:boolean,searchActivityEnabled?:boolean,prsEnabled?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description If the search should be saved against a single Sub User account, specify their username here */
subUserName;
/** @type {string} */
type;
/** @type {boolean} */
addPepSearch;
/** @type {string} */
pepSearchType;
/** @type {boolean} */
addSanctionsSearch;
/** @type {ArrayOfLists} */
selectedLists;
/** @type {string} */
reference;
/**
* @type {ArrayOfLinkedTo}
* @description If the search should be linked to other searches, specify the them here */
linkedTo;
/** @type {ValidIdBasicRequest} */
basicRequest;
/** @type {ValidIdPassportRequest} */
passportRequest;
/** @type {ValidIdDrivingRequest} */
drivingRequest;
/** @type {ValidIdBirthRequest} */
birthRequest;
/** @type {ValidIdNIRequest} */
niRequest;
/** @type {ValidIdNHSRequest} */
nhsRequest;
/** @type {ValidIdElectricityRequest} */
electricityRequest;
/** @type {ValidIdBankRequest} */
bankRequest;
/** @type {ValidIdCardNumberRequest} */
cardNumberRequest;
/** @type {ValidIdTravelVisaRequest} */
travelVisaRequest;
/** @type {ValidIdIdCardRequest} */
idCardRequest;
/** @type {ValidIdPollNumberRequest} */
pollNumberRequest;
/** @type {ValidIdMarriageRequest} */
marriageRequest;
/** @type {boolean} */
passportEnabled;
/** @type {boolean} */
passportChipEnabled;
/** @type {boolean} */
drivingEnabled;
/** @type {boolean} */
smartlinkEnabled;
/** @type {boolean} */
niEnabled;
/** @type {boolean} */
nhsEnabled;
/** @type {boolean} */
electricityEnabled;
/** @type {boolean} */
bankEnabled;
/** @type {boolean} */
creditActiveEnabled;
/** @type {boolean} */
idCardEnabled;
/** @type {boolean} */
bankLiveEnabled;
/** @type {boolean} */
companyDirectorEnabled;
/** @type {boolean} */
searchActivityEnabled;
/** @type {boolean} */
prsEnabled;
}
export class AddValidIdTemplateData extends BaseResponse {
/** @param {{request?:AddValidIdRequest,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {AddValidIdRequest} */
request;
}
export class AddValidIdTemplateResponse {
/** @param {{data?:AddValidIdTemplateData}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {AddValidIdTemplateData} */
data;
}
export class AddValidIdTemplate extends BaseRequest {
/** @param {{clientId?:number,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
clientId;
}
JavaScript AddValidIdTemplate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /validid/template HTTP/1.1 Host: api.sanctionssearch.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AddValidIdTemplateResponse 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>
<AddPepSearch>false</AddPepSearch>
<AddSanctionsSearch>false</AddSanctionsSearch>
<BankEnabled>false</BankEnabled>
<BankLiveEnabled>false</BankLiveEnabled>
<BankRequest>
<BankAccountNumber>String</BankAccountNumber>
<BankSortCode>String</BankSortCode>
</BankRequest>
<BasicRequest>
<Address1>String</Address1>
<Address2>String</Address2>
<Address3>String</Address3>
<Address4>String</Address4>
<Address5>String</Address5>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<Gender>String</Gender>
<Name1>String</Name1>
<Name2>String</Name2>
<Name3>String</Name3>
<PostCode>String</PostCode>
</BasicRequest>
<BirthRequest>
<BirthCertIssueNum>String</BirthCertIssueNum>
<BirthDistrict>String</BirthDistrict>
<BirthForeName>String</BirthForeName>
<BirthMaidenName>String</BirthMaidenName>
<BirthMiddleName>String</BirthMiddleName>
<BirthSurname>String</BirthSurname>
</BirthRequest>
<CardNumberRequest>
<CardNumber>String</CardNumber>
<CardType>String</CardType>
</CardNumberRequest>
<CompanyDirectorEnabled>false</CompanyDirectorEnabled>
<CreditActiveEnabled>false</CreditActiveEnabled>
<DrivingEnabled>false</DrivingEnabled>
<DrivingRequest>
<Driving1>String</Driving1>
<Driving2>String</Driving2>
<Driving3>String</Driving3>
<DrivingMailSort>String</DrivingMailSort>
<DrivingPostcode>String</DrivingPostcode>
</DrivingRequest>
<ElectricityEnabled>false</ElectricityEnabled>
<ElectricityRequest>
<MPANNumber1>String</MPANNumber1>
<MPANNumber2>String</MPANNumber2>
<MPANNumber3>String</MPANNumber3>
<MPANNumber4>String</MPANNumber4>
</ElectricityRequest>
<IdCardEnabled>false</IdCardEnabled>
<IdCardRequest>
<IdCard1>String</IdCard1>
<IdCard10>String</IdCard10>
<IdCard2>String</IdCard2>
<IdCard3>String</IdCard3>
<IdCard4>String</IdCard4>
<IdCard5>String</IdCard5>
<IdCard6>String</IdCard6>
<IdCard7>String</IdCard7>
<IdCard8>String</IdCard8>
<IdCard9>String</IdCard9>
</IdCardRequest>
<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>
<MarriageRequest>
<CertIssueNum>String</CertIssueNum>
<Date>String</Date>
<District>String</District>
<Forename>String</Forename>
<PartnerForename>String</PartnerForename>
<PartnerSurname>String</PartnerSurname>
<Surname>String</Surname>
</MarriageRequest>
<NHSEnabled>false</NHSEnabled>
<NHSRequest>
<NHSNumber>String</NHSNumber>
</NHSRequest>
<NIEnabled>false</NIEnabled>
<NIRequest>
<NINumber>String</NINumber>
</NIRequest>
<PRSEnabled>false</PRSEnabled>
<PassportChipEnabled>false</PassportChipEnabled>
<PassportEnabled>false</PassportEnabled>
<PassportRequest>
<Passport1>String</Passport1>
<Passport2>String</Passport2>
<Passport3>String</Passport3>
<Passport4>String</Passport4>
<Passport5>String</Passport5>
<Passport6>String</Passport6>
<Passport7>String</Passport7>
<Passport8>String</Passport8>
<PassportMrzLineOne1>String</PassportMrzLineOne1>
<PassportMrzLineOne2>String</PassportMrzLineOne2>
<PassportMrzLineOne3>String</PassportMrzLineOne3>
</PassportRequest>
<PepSearchType>String</PepSearchType>
<PollNumberRequest>
<PollNumber>String</PollNumber>
</PollNumberRequest>
<Reference>String</Reference>
<SearchActivityEnabled>false</SearchActivityEnabled>
<SelectedLists>
<ListId>String</ListId>
</SelectedLists>
<SmartlinkEnabled>false</SmartlinkEnabled>
<SubUserName>String</SubUserName>
<TravelVisaRequest>
<TravelVisa1>String</TravelVisa1>
<TravelVisa2>String</TravelVisa2>
<TravelVisa3>String</TravelVisa3>
<TravelVisa4>String</TravelVisa4>
<TravelVisa5>String</TravelVisa5>
<TravelVisa6>String</TravelVisa6>
<TravelVisa7>String</TravelVisa7>
<TravelVisa8>String</TravelVisa8>
<TravelVisa9>String</TravelVisa9>
</TravelVisaRequest>
<Type>String</Type>
</Request>
</Data>
</AddValidIdTemplateResponse>