Sanctions Search API: v2

AddValidIdTemplate

ValidID

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

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class AddValidIdTemplate : BaseRequest()
{
    @DataMember
    @ApiMember(IsRequired=true)
    var clientId:Int? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    var authentication:Authentication? = null
}

@DataContract
open class Authentication
{
    /**
    * 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")
    var apiUserId:String? = null

    /**
    * 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")
    var apiUserKey:String? = null
}

@DataContract
open class AddValidIdTemplateResponse
{
    @DataMember
    @SerializedName("data") var Data:AddValidIdTemplateData? = null
}

open class AddValidIdTemplateData : BaseResponse()
{
    var request:AddValidIdRequest? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    var responseStatus:ResponseStatus? = null
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class AddValidIdRequest
{
    /**
    * 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")
    var subUserName:String? = null

    @SerializedName("type") var Type:String? = null
    var addPepSearch:Boolean? = null
    var pepSearchType:String? = null
    var addSanctionsSearch:Boolean? = null
    var selectedLists:ArrayOfLists? = null
    var reference:String? = null
    /**
    * 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")
    var linkedTo:ArrayOfLinkedTo? = null

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

open class ArrayOfLists : ArrayList<String>()
{
}

open class ArrayOfLinkedTo : ArrayList<LinkedTo>()
{
}

open class LinkedTo
{
    var clientId:Int? = null
    var id:Long? = null
    @SerializedName("type") var Type:String? = null
    var subtype:String? = null
    var status:String? = null
    var description:String? = null
    var isArchived:Boolean? = null
    var name:String? = null
    var date:Date? = null
}

open class ValidIdBasicRequest
{
    var name1:String? = null
    var name2:String? = null
    var name3:String? = null
    var dateOfBirth:Date? = null
    var gender:String? = null
    var address1:String? = null
    var address2:String? = null
    var address3:String? = null
    var address4:String? = null
    var address5:String? = null
    var postCode:String? = null
}

open class ValidIdPassportRequest
{
    var passport1:String? = null
    var passport2:String? = null
    var passport3:String? = null
    var passport4:String? = null
    var passport5:String? = null
    var passport6:String? = null
    var passport7:String? = null
    var passport8:String? = null
    var passportMrzLineOne1:String? = null
    var passportMrzLineOne2:String? = null
    var passportMrzLineOne3:String? = null
}

open class ValidIdDrivingRequest
{
    var driving1:String? = null
    var driving2:String? = null
    var driving3:String? = null
    var drivingPostcode:String? = null
    var drivingMailSort:String? = null
}

open class ValidIdBirthRequest
{
    var birthForeName:String? = null
    var birthMiddleName:String? = null
    var birthSurname:String? = null
    var birthMaidenName:String? = null
    var birthDistrict:String? = null
    var birthCertIssueNum:String? = null
}

open class ValidIdNIRequest
{
    var niNumber:String? = null
}

open class ValidIdNHSRequest
{
    var nhsNumber:String? = null
}

open class ValidIdElectricityRequest
{
    var mpanNumber1:String? = null
    var mpanNumber2:String? = null
    var mpanNumber3:String? = null
    var mpanNumber4:String? = null
}

open class ValidIdBankRequest
{
    var bankSortCode:String? = null
    var bankAccountNumber:String? = null
}

open class ValidIdCardNumberRequest
{
    var cardNumber:String? = null
    var cardType:String? = null
}

open class ValidIdTravelVisaRequest
{
    var travelVisa1:String? = null
    var travelVisa2:String? = null
    var travelVisa3:String? = null
    var travelVisa4:String? = null
    var travelVisa5:String? = null
    var travelVisa6:String? = null
    var travelVisa7:String? = null
    var travelVisa8:String? = null
    var travelVisa9:String? = null
}

open class ValidIdIdCardRequest
{
    var idCard1:String? = null
    var idCard2:String? = null
    var idCard3:String? = null
    var idCard4:String? = null
    var idCard5:String? = null
    var idCard6:String? = null
    var idCard7:String? = null
    var idCard8:String? = null
    var idCard9:String? = null
    var idCard10:String? = null
}

open class ValidIdPollNumberRequest
{
    var pollNumber:String? = null
}

open class ValidIdMarriageRequest
{
    var forename:String? = null
    var surname:String? = null
    var partnerForename:String? = null
    var partnerSurname:String? = null
    var date:String? = null
    var district:String? = null
    var certIssueNum:String? = null
}

Kotlin 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>