Sanctions Search API: v2

AddValidIdTemplate

ValidID

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

**AddValidIdTemplate** Parameters:
Name	Parameter	Data Type	Required	Description
ClientId	query	int	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	header, body	Authentication	Yes	The authentication credentials

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	header, body	string	Yes	The API User ID provided by us when you signed up to use our API
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API

**AddValidIdTemplateResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	AddValidIdTemplateData	No

**AddValidIdTemplateData** Parameters:
Name	Parameter	Data Type	Required	Description
Request	form	AddValidIdRequest	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	The status of the response

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No
Meta	form	Dictionary<string, string>	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	string	No
Meta	form	Dictionary<string, string>	No

**AddValidIdRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SubUserName	form	string	No	If the search should be saved against a single Sub User account, specify their username here
Type	form	string	No
AddPepSearch	form	bool	No
PepSearchType	form	string	No
AddSanctionsSearch	form	bool	No
SelectedLists	form	ArrayOfLists	No
Reference	form	string	No
LinkedTo	form	ArrayOfLinkedTo	No	If the search should be linked to other searches, specify the them here
BasicRequest	form	ValidIdBasicRequest	No
PassportRequest	form	ValidIdPassportRequest	No
DrivingRequest	form	ValidIdDrivingRequest	No
BirthRequest	form	ValidIdBirthRequest	No
NIRequest	form	ValidIdNIRequest	No
NHSRequest	form	ValidIdNHSRequest	No
ElectricityRequest	form	ValidIdElectricityRequest	No
BankRequest	form	ValidIdBankRequest	No
CardNumberRequest	form	ValidIdCardNumberRequest	No
TravelVisaRequest	form	ValidIdTravelVisaRequest	No
IdCardRequest	form	ValidIdIdCardRequest	No
PollNumberRequest	form	ValidIdPollNumberRequest	No
MarriageRequest	form	ValidIdMarriageRequest	No
PassportEnabled	form	bool	No
PassportChipEnabled	form	bool	No
DrivingEnabled	form	bool	No
SmartlinkEnabled	form	bool	No
NIEnabled	form	bool	No
NHSEnabled	form	bool	No
ElectricityEnabled	form	bool	No
BankEnabled	form	bool	No
CreditActiveEnabled	form	bool	No
IdCardEnabled	form	bool	No
BankLiveEnabled	form	bool	No
CompanyDirectorEnabled	form	bool	No
SearchActivityEnabled	form	bool	No
PRSEnabled	form	bool	No

**LinkedTo** Parameters:
Name	Parameter	Data Type	Required
ClientId	form	int?	No
Id	form	long?	No
Type	form	string	No
Subtype	form	string	No
Status	form	string	No
Description	form	string	No
IsArchived	form	bool?	No
Name	form	string	No
Date	form	DateTime?	No

**ValidIdBasicRequest** Parameters:
Name	Parameter	Data Type	Required
Name1	form	string	No
Name2	form	string	No
Name3	form	string	No
DateOfBirth	form	DateTime?	No
Gender	form	string	No
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
Address4	form	string	No
Address5	form	string	No
PostCode	form	string	No

**ValidIdPassportRequest** Parameters:
Name	Parameter	Data Type	Required
Passport1	form	string	No
Passport2	form	string	No
Passport3	form	string	No
Passport4	form	string	No
Passport5	form	string	No
Passport6	form	string	No
Passport7	form	string	No
Passport8	form	string	No
PassportMrzLineOne1	form	string	No
PassportMrzLineOne2	form	string	No
PassportMrzLineOne3	form	string	No

**ValidIdDrivingRequest** Parameters:
Name	Parameter	Data Type	Required
Driving1	form	string	No
Driving2	form	string	No
Driving3	form	string	No
DrivingPostcode	form	string	No
DrivingMailSort	form	string	No

**ValidIdBirthRequest** Parameters:
Name	Parameter	Data Type	Required
BirthForeName	form	string	No
BirthMiddleName	form	string	No
BirthSurname	form	string	No
BirthMaidenName	form	string	No
BirthDistrict	form	string	No
BirthCertIssueNum	form	string	No

**ValidIdNIRequest** Parameters:
Name	Parameter	Data Type	Required	Description
NINumber	form	string	No

**ValidIdNHSRequest** Parameters:
Name	Parameter	Data Type	Required	Description
NHSNumber	form	string	No

**ValidIdElectricityRequest** Parameters:
Name	Parameter	Data Type	Required
MPANNumber1	form	string	No
MPANNumber2	form	string	No
MPANNumber3	form	string	No
MPANNumber4	form	string	No

**ValidIdBankRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BankSortCode	form	string	No
BankAccountNumber	form	string	No

**ValidIdCardNumberRequest** Parameters:
Name	Parameter	Data Type	Required	Description
CardNumber	form	string	No
CardType	form	string	No

**ValidIdTravelVisaRequest** Parameters:
Name	Parameter	Data Type	Required
TravelVisa1	form	string	No
TravelVisa2	form	string	No
TravelVisa3	form	string	No
TravelVisa4	form	string	No
TravelVisa5	form	string	No
TravelVisa6	form	string	No
TravelVisa7	form	string	No
TravelVisa8	form	string	No
TravelVisa9	form	string	No

**ValidIdIdCardRequest** Parameters:
Name	Parameter	Data Type	Required
IdCard1	form	string	No
IdCard2	form	string	No
IdCard3	form	string	No
IdCard4	form	string	No
IdCard5	form	string	No
IdCard6	form	string	No
IdCard7	form	string	No
IdCard8	form	string	No
IdCard9	form	string	No
IdCard10	form	string	No

**ValidIdPollNumberRequest** Parameters:
Name	Parameter	Data Type	Required	Description
PollNumber	form	string	No

**ValidIdMarriageRequest** Parameters:
Name	Parameter	Data Type	Required
Forename	form	string	No
Surname	form	string	No
PartnerForename	form	string	No
PartnerSurname	form	string	No
Date	form	string	No
District	form	string	No
CertIssueNum	form	string	No

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>