Sanctions Search API: v2

<back to all web services

AddValidIdTemplate

ValidID
The following routes are available for this service:
GET/validid/template
AddValidIdTemplate Parameters:
NameParameterData TypeRequiredDescription
ClientIdqueryintYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
Authenticationheader, bodyAuthenticationYesThe authentication credentials
Authentication Parameters:
NameParameterData TypeRequiredDescription
ApiUserIdheader, bodystringYesThe API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
ApiUserKeyheader, bodystringYesThe API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
UserIdheader, bodystringNoThe User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).
AddValidIdTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
DataformAddValidIdTemplateDataNo
AddValidIdTemplateData Parameters:
NameParameterData TypeRequiredDescription
RequestformAddValidIdRequestNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNoThe status of the response
ResponseStatus Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StackTraceformstringNo
ErrorsformArrayOfResponseErrorNo
MetaformDictionary<string, string>No
ResponseError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
FieldNameformstringNo
MessageformstringNo
MetaformDictionary<string, string>No
AddValidIdRequest Parameters:
NameParameterData TypeRequiredDescription
SubUserNameformstringNoIf the search should be saved against a single Sub User account, specify their username here
TypeformstringNo
AddPepSearchformboolNo
PepSearchTypeformstringNo
AddSanctionsSearchformboolNo
SelectedListsformArrayOfListsNo
ReferenceformstringNo
LinkedToformArrayOfLinkedToNoIf the search should be linked to other searches, specify the them here
BasicRequestformValidIdBasicRequestNo
PassportRequestformValidIdPassportRequestNo
DrivingRequestformValidIdDrivingRequestNo
BirthRequestformValidIdBirthRequestNo
NIRequestformValidIdNIRequestNo
NHSRequestformValidIdNHSRequestNo
ElectricityRequestformValidIdElectricityRequestNo
BankRequestformValidIdBankRequestNo
CardNumberRequestformValidIdCardNumberRequestNo
TravelVisaRequestformValidIdTravelVisaRequestNo
IdCardRequestformValidIdIdCardRequestNo
PollNumberRequestformValidIdPollNumberRequestNo
MarriageRequestformValidIdMarriageRequestNo
PassportEnabledformboolNo
PassportChipEnabledformboolNo
DrivingEnabledformboolNo
SmartlinkEnabledformboolNo
NIEnabledformboolNo
NHSEnabledformboolNo
ElectricityEnabledformboolNo
BankEnabledformboolNo
CreditActiveEnabledformboolNo
IdCardEnabledformboolNo
BankLiveEnabledformboolNo
CompanyDirectorEnabledformboolNo
SearchActivityEnabledformboolNo
PRSEnabledformboolNo
LinkedTo Parameters:
NameParameterData TypeRequiredDescription
ClientIdformint?No
Idformlong?No
TypeformstringNo
SubtypeformstringNo
StatusformstringNo
DescriptionformstringNo
IsArchivedformbool?No
NameformstringNo
DateformDateTime?No
ValidIdBasicRequest Parameters:
NameParameterData TypeRequiredDescription
Name1formstringNo
Name2formstringNo
Name3formstringNo
DateOfBirthformDateTime?No
GenderformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
Address4formstringNo
Address5formstringNo
PostCodeformstringNo
ValidIdPassportRequest Parameters:
NameParameterData TypeRequiredDescription
Passport1formstringNo
Passport2formstringNo
Passport3formstringNo
Passport4formstringNo
Passport5formstringNo
Passport6formstringNo
Passport7formstringNo
Passport8formstringNo
PassportMrzLineOne1formstringNo
PassportMrzLineOne2formstringNo
PassportMrzLineOne3formstringNo
ValidIdDrivingRequest Parameters:
NameParameterData TypeRequiredDescription
Driving1formstringNo
Driving2formstringNo
Driving3formstringNo
DrivingPostcodeformstringNo
DrivingMailSortformstringNo
DrivingExpiryDateformDateTime?No
ValidIdBirthRequest Parameters:
NameParameterData TypeRequiredDescription
BirthForeNameformstringNo
BirthMiddleNameformstringNo
BirthSurnameformstringNo
BirthMaidenNameformstringNo
BirthDistrictformstringNo
BirthCertIssueNumformstringNo
ValidIdNIRequest Parameters:
NameParameterData TypeRequiredDescription
NINumberformstringNo
ValidIdNHSRequest Parameters:
NameParameterData TypeRequiredDescription
NHSNumberformstringNo
ValidIdElectricityRequest Parameters:
NameParameterData TypeRequiredDescription
MPANNumber1formstringNo
MPANNumber2formstringNo
MPANNumber3formstringNo
MPANNumber4formstringNo
ValidIdBankRequest Parameters:
NameParameterData TypeRequiredDescription
BankSortCodeformstringNo
BankAccountNumberformstringNo
ValidIdCardNumberRequest Parameters:
NameParameterData TypeRequiredDescription
CardNumberformstringNo
CardTypeformstringNo
ValidIdTravelVisaRequest Parameters:
NameParameterData TypeRequiredDescription
TravelVisa1formstringNo
TravelVisa2formstringNo
TravelVisa3formstringNo
TravelVisa4formstringNo
TravelVisa5formstringNo
TravelVisa6formstringNo
TravelVisa7formstringNo
TravelVisa8formstringNo
TravelVisa9formstringNo
ValidIdIdCardRequest Parameters:
NameParameterData TypeRequiredDescription
IdCard1formstringNo
IdCard2formstringNo
IdCard3formstringNo
IdCard4formstringNo
IdCard5formstringNo
IdCard6formstringNo
IdCard7formstringNo
IdCard8formstringNo
IdCard9formstringNo
IdCard10formstringNo
ValidIdPollNumberRequest Parameters:
NameParameterData TypeRequiredDescription
PollNumberformstringNo
ValidIdMarriageRequest Parameters:
NameParameterData TypeRequiredDescription
ForenameformstringNo
SurnameformstringNo
PartnerForenameformstringNo
PartnerSurnameformstringNo
DateformstringNo
DistrictformstringNo
CertIssueNumformstringNo

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","drivingExpiryDate":"\/Date(-62135596800000-0000)\/"},"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"}}}}