GET | /validid/template |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientId | query | int | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Authentication | header, body | Authentication | Yes | The authentication credentials |
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Data | form | AddValidIdTemplateData | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Request | form | AddValidIdRequest | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | The status of the response |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorCode | form | string | No | |
Message | form | string | No | |
StackTrace | form | string | No | |
Errors | form | ArrayOfResponseError | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ErrorCode | form | string | No | |
FieldName | form | string | No | |
Message | form | string | No | |
Meta | form | Dictionary<string, string> | No |
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Driving1 | form | string | No | |
Driving2 | form | string | No | |
Driving3 | form | string | No | |
DrivingPostcode | form | string | No | |
DrivingMailSort | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BirthForeName | form | string | No | |
BirthMiddleName | form | string | No | |
BirthSurname | form | string | No | |
BirthMaidenName | form | string | No | |
BirthDistrict | form | string | No | |
BirthCertIssueNum | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NINumber | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
NHSNumber | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MPANNumber1 | form | string | No | |
MPANNumber2 | form | string | No | |
MPANNumber3 | form | string | No | |
MPANNumber4 | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
BankSortCode | form | string | No | |
BankAccountNumber | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CardNumber | form | string | No | |
CardType | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PollNumber | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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"}}}}