Valid ID > AddValidId

This method allows a ValidID check to be instigated. More information is needed in comparison to a sanctions check and the resulting check will bear a cost as indicated in the users account. A sanctions check is also carried out as part of a ValidID check so it is not necessary to carry out the separate AddSearch method.

There are two levels of ValidID "basic" and "enhanced" these are specified by "Type" parameter described below.

You must specify "enhanced" as the "Type" if you wish to use the additional checking facilities e.g. BankEnabled, BirthEnabled, etc. If you specify "basic" you only need to fill in the "BasicRequest" parameter

Please check the request parameters to ensure full compliance with the format requirements for all ValidID request objects.

Request Parameters

Parameter Type Format Description
BasicRequest Required BasicRequest   Instance of BasicRequest (see here)
Type Required String   Type of ValidID search, valid values are "basic" or "enhanced"
SelectedLists > ListId Required String Max length 5 characters

Array of sanctions lists to be included in the search. At least one is required.

The following values are valid:

ALL Perform your search against all your enabled lists, no further values are required if you select "ALL"

DFAT Australian DFAT Sanctions List
EUR EU Sanctions List
HMTSL HM Treasury Sanctions List
HMTUK HM Treasury Ukraine Securities List
UKSAN UK Sanctions List
OFACC OFAC Consolidated (Non SDN) List
OFACL OFAC Specially Designated Nationals List
CASEM Canadian Consolidated Sanctions List
OSFI Deprecated Canadian OSFI Sanctions List
CAJUS Deprecated Canadian Justice for Victims of Corrupt Foreign Officials
SSECO Swiss SECO Sanctions
SNGPO Singapore TSOFA Sanctions List
BELSL Belgium Sanctions List
FRESL French Sanctions List
UN United Nations Sanctions List
NZL New Zealand Sanctions List
UAE United Arab Emirates Sanctions List


Example specifying the All lists lists:
<SelectedLists>
    <ListId>ALL</ListId>
</SelectedLists>
Example specifying the HM Treasury list:
<SelectedLists>
    <ListId>HMTSL</ListId>
</SelectedLists>
Example specifying the US and HM Treasury list:
<SelectedLists>
    <ListId>OFACL</ListId>
    <ListId>HMTSL</ListId>
</SelectedLists>
Reference String Max length 250 characters A custom reference for the ValidID Search
SubUserName New string Null or max length 50 characters If this is specified, the search will be created for the specified sub user, otherwise it will be created in the main user account.
LinkedTo New LinkedTo   The entities with which this search is linked to. Instance of LinkedTo (see here)
Parameters for "enhanced" checks
BankEnabled Boolean   Flag to enable checking of a bank account
BankRequest BankRequest   Required if BankEnabled is true. Instance of BankRequest (see here)
BankLiveEnabled Boolean   Flag to enable checking of a bank account with live information from the bank. Requires BankEnabled and BankRequest
CompanyDirectorEnabled Boolean   Flag to enable checking of company directorships
CreditActiveEnabled Boolean   Flag to enable checking for active credit accounts
DrivingEnabled Boolean   Flag to enable checking of a driving licence
DrivingRequest DrivingRequest   Required if DrivingEnabled is true. Instance of DrivingRequest (see here)
ElectricityEnabled Boolean   Flag to enable checking of an electricity account (MPAN)
ElectricityRequest ElectricityRequest   Required if ElectricityEnabled is true. Instance of ElectricityRequest (see here)
IdCardEnabled Boolean   Flag to enable checking of a Identity Card
IdCardRequest IdCardRequest   Required if IdCardEnabled is true. Instance of IdCard (see here)
NHSEnabled Boolean   Flag to enable checking of a NHS (National Health Service) number
NHSRequest NHSRequest   Required if NHSEnabled is true. Instance of NHSRequest (see here)
NIEnabled Boolean   Flag to enable checking of a NI (National Insurance) number
NIRequest NIRequest   Required if NIEnabled is true. Instance of NIRequest (see here)
PassportChipEnabled New Boolean   Flag to enable Passport Chip Verification
PassportEnabled Boolean   Flag to enable checking of a passport
PassportRequest PassportRequest   Required if PassportEnabled is true. Instance of PassportRequest (see here)
PRSEnabled Boolean   Flag to enable checking for property ownership from the Land Registry property register
SearchActivityEnabled Boolean   Flag to enable checking of search activity
SmartlinkEnabled Boolean   Flag to enable checking for previous addresses
Deprecated
CardAVSEnabled Removed Boolean   Flag to enable credit/debit card pre-authorisation
CardAVSRequest Removed CardAVSRequest   Required if CardAVSEnabled is true. Instance of CardAVSRequest (see here)
GenderEnabled Removed Boolean   Flag to enable checking of persons gender
MobileEnabled Removed Boolean   Flag to enable checking of a mobile phone number
MobileRequest Removed MobileRequest   Required if MobileEnabled is true. Instance of MobileRequest (see here)
TelephoneEnabled Removed Boolean   Flag to enable checking of a landline phone number
TelephoneRequest Removed TelephoneRequest   Required if TelephoneEnabled is true. Instance of TelephoneRequest (see here)
BirthEnabled Removed Boolean   Flag to enable checking of birth records
BirthRequest Removed BirthRequest   Required if BirthEnabled is true. Instance of BirthRequest (see here)
CardNumberEnabled Removed Boolean   Flag to enable checking a credit/debit card number is valid
CardNumberRequest Removed CardNumberRequest   Required if CardNumberEnabled is true. Instance of CardNumberRequest (see here)
MarriageEnabled Removed Boolean   Flag to enable checking of a marriage certificate
MarriageRequest Removed MarriageRequest   Required if MarriageEnabled is true. Instance of MarriageRequest (see here)
OnlineProfileEnabled Removed Boolean   Flag to enable checking for online profiles (Twitter)
PollNumberEnabled Removed Boolean   Flag to enable checking of a electoral roll registration number
PollNumberRequest Removed PollNumberRequest   Required if PollNumberEnabled is true. Instance of PollNumberRequest (see here)
TravelVisaEnabled Removed Boolean   Flag to enable checking of a Travel Visa
TravelVisaRequest Removed TravelVisaRequest   Required if TravelVisaEnabled is true. Instance of TravelVisa (see here)

Response Parameters

Parameter Type Format Description
ResponseStatus ResponseStatus   Instance of ResponseStatus object (see here)
SearchRecord SearchRecord   Instance of ValidID SearchRecord object (see here)
SanctionsSearchId Int64   Id number of the sanctions search part of the ValidID record
ResolveSanctionsResults Boolean   True if the sanctions search part requires resolving
ValidIdSearchId Int32   Id of the ValidID record