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 .xml suffix or ?format=xml

HTTP + 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>