Sanctions Search API: v2

<back to all web services

AddValidIdTemplate

ValidID
The following routes are available for this service:
GET/validid/template

// @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); }
}

export class ArrayOfLists extends Array<string>
{

    public constructor(init?: Partial<ArrayOfLists>) { 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 ValidIdBasicRequest
{
    public name1: string;
    public name2: string;
    public name3: string;
    public dateOfBirth?: string;
    public gender: string;
    public address1: string;
    public address2: string;
    public address3: string;
    public address4: string;
    public address5: string;
    public postCode: string;

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

export class ValidIdPassportRequest
{
    public passport1: string;
    public passport2: string;
    public passport3: string;
    public passport4: string;
    public passport5: string;
    public passport6: string;
    public passport7: string;
    public passport8: string;
    public passportMrzLineOne1: string;
    public passportMrzLineOne2: string;
    public passportMrzLineOne3: string;

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

export class ValidIdDrivingRequest
{
    public driving1: string;
    public driving2: string;
    public driving3: string;
    public drivingPostcode: string;
    public drivingMailSort: string;

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

export class ValidIdBirthRequest
{
    public birthForeName: string;
    public birthMiddleName: string;
    public birthSurname: string;
    public birthMaidenName: string;
    public birthDistrict: string;
    public birthCertIssueNum: string;

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

export class ValidIdNIRequest
{
    public niNumber: string;

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

export class ValidIdNHSRequest
{
    public nhsNumber: string;

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

export class ValidIdElectricityRequest
{
    public mpanNumber1: string;
    public mpanNumber2: string;
    public mpanNumber3: string;
    public mpanNumber4: string;

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

export class ValidIdBankRequest
{
    public bankSortCode: string;
    public bankAccountNumber: string;

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

export class ValidIdCardNumberRequest
{
    public cardNumber: string;
    public cardType: string;

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

export class ValidIdTravelVisaRequest
{
    public travelVisa1: string;
    public travelVisa2: string;
    public travelVisa3: string;
    public travelVisa4: string;
    public travelVisa5: string;
    public travelVisa6: string;
    public travelVisa7: string;
    public travelVisa8: string;
    public travelVisa9: string;

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

export class ValidIdIdCardRequest
{
    public idCard1: string;
    public idCard2: string;
    public idCard3: string;
    public idCard4: string;
    public idCard5: string;
    public idCard6: string;
    public idCard7: string;
    public idCard8: string;
    public idCard9: string;
    public idCard10: string;

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

export class ValidIdPollNumberRequest
{
    public pollNumber: string;

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

export class ValidIdMarriageRequest
{
    public forename: string;
    public surname: string;
    public partnerForename: string;
    public partnerSurname: string;
    public date: string;
    public district: string;
    public certIssueNum: string;

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

export class AddValidIdRequest
{
    /** @description If the search should be saved against a single Sub User account, specify their username here */
    // @ApiMember(Description="If the search should be saved against a single Sub User account, specify their username here")
    public subUserName: string;

    public type: string;
    public addPepSearch: boolean;
    public pepSearchType: string;
    public addSanctionsSearch: boolean;
    public selectedLists: ArrayOfLists;
    public reference: string;
    /** @description If the search should be linked to other searches, specify the them here */
    // @ApiMember(Description="If the search should be linked to other searches, specify the them here")
    public linkedTo: ArrayOfLinkedTo;

    public basicRequest: ValidIdBasicRequest;
    public passportRequest: ValidIdPassportRequest;
    public drivingRequest: ValidIdDrivingRequest;
    public birthRequest: ValidIdBirthRequest;
    public niRequest: ValidIdNIRequest;
    public nhsRequest: ValidIdNHSRequest;
    public electricityRequest: ValidIdElectricityRequest;
    public bankRequest: ValidIdBankRequest;
    public cardNumberRequest: ValidIdCardNumberRequest;
    public travelVisaRequest: ValidIdTravelVisaRequest;
    public idCardRequest: ValidIdIdCardRequest;
    public pollNumberRequest: ValidIdPollNumberRequest;
    public marriageRequest: ValidIdMarriageRequest;
    public passportEnabled: boolean;
    public passportChipEnabled: boolean;
    public drivingEnabled: boolean;
    public smartlinkEnabled: boolean;
    public niEnabled: boolean;
    public nhsEnabled: boolean;
    public electricityEnabled: boolean;
    public bankEnabled: boolean;
    public creditActiveEnabled: boolean;
    public idCardEnabled: boolean;
    public bankLiveEnabled: boolean;
    public companyDirectorEnabled: boolean;
    public searchActivityEnabled: boolean;
    public prsEnabled: boolean;

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

export class AddValidIdTemplateData extends BaseResponse
{
    public request: AddValidIdRequest;

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

// @DataContract
export class AddValidIdTemplateResponse
{
    // @DataMember
    public data: AddValidIdTemplateData;

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

// @DataContract
export class AddValidIdTemplate extends BaseRequest
{
    // @DataMember
    // @ApiMember(IsRequired=true)
    public clientId: number;

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

TypeScript AddValidIdTemplate 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.

GET /validid/template HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json

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

{"data":{"request":{"subUserName":"String","type":"String","addPepSearch":false,"pepSearchType":"String","addSanctionsSearch":false,"selectedLists":["String"],"reference":"String","linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"basicRequest":{"name1":"String","name2":"String","name3":"String","dateOfBirth":"\/Date(-62135596800000-0000)\/","gender":"String","address1":"String","address2":"String","address3":"String","address4":"String","address5":"String","postCode":"String"},"passportRequest":{"passport1":"String","passport2":"String","passport3":"String","passport4":"String","passport5":"String","passport6":"String","passport7":"String","passport8":"String","passportMrzLineOne1":"String","passportMrzLineOne2":"String","passportMrzLineOne3":"String"},"drivingRequest":{"driving1":"String","driving2":"String","driving3":"String","drivingPostcode":"String","drivingMailSort":"String"},"birthRequest":{"birthForeName":"String","birthMiddleName":"String","birthSurname":"String","birthMaidenName":"String","birthDistrict":"String","birthCertIssueNum":"String"},"niRequest":{"niNumber":"String"},"nhsRequest":{"nhsNumber":"String"},"electricityRequest":{"mpanNumber1":"String","mpanNumber2":"String","mpanNumber3":"String","mpanNumber4":"String"},"bankRequest":{"bankSortCode":"String","bankAccountNumber":"String"},"cardNumberRequest":{"cardNumber":"String","cardType":"String"},"travelVisaRequest":{"travelVisa1":"String","travelVisa2":"String","travelVisa3":"String","travelVisa4":"String","travelVisa5":"String","travelVisa6":"String","travelVisa7":"String","travelVisa8":"String","travelVisa9":"String"},"idCardRequest":{"idCard1":"String","idCard2":"String","idCard3":"String","idCard4":"String","idCard5":"String","idCard6":"String","idCard7":"String","idCard8":"String","idCard9":"String","idCard10":"String"},"pollNumberRequest":{"pollNumber":"String"},"marriageRequest":{"forename":"String","surname":"String","partnerForename":"String","partnerSurname":"String","date":"String","district":"String","certIssueNum":"String"},"passportEnabled":false,"passportChipEnabled":false,"drivingEnabled":false,"smartlinkEnabled":false,"niEnabled":false,"nhsEnabled":false,"electricityEnabled":false,"bankEnabled":false,"creditActiveEnabled":false,"idCardEnabled":false,"bankLiveEnabled":false,"companyDirectorEnabled":false,"searchActivityEnabled":false,"prsEnabled":false},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}