JSON/XML: GET https://api.sanctionssearch.com/v2/validid/template

This method gives a template for creating ValidID Searches - the response body of this contains the request body of the AddValidId method.

As well as the Response Parameters below, the response will return all other properties of a AddValidId request - with default values. See AddValidId for full documentation of this request.

Request Parameters

Parameter	Type	Format	Description
ClientId Required	Int64		Query param. Supplying a ClientId will populate the template with the BasicRequest, Passport and Driving Licence data of the client

Response Parameters

Parameter	Type	Format	Description
BasicRequest	BasicRequest		Populated with the Clients data, where it exists. Instance of BasicRequest (see here)
Type	String		This will be 'basic' if the client has no Passport or Driving Licence, and 'enhanced' if they do
LinkedTo	LinkedTo		The entities with which this search is linked to. Instance of LinkedTo (see here)
DrivingEnabled	Boolean		True if the Client has a Driving Licence, false if not
DrivingRequest	DrivingRequest		Populated with the Clients data, where it exists. Instance of DrivingRequest (see here)
PassportChipEnabled	PassportRequest		True if the Client has done a Passport Chip Scan
PassportEnabled	Boolean		True if the Client has a Driving Licence, false if not
PassportRequest	PassportRequest		Populated with the Clients data, where it exists. Instance of PassportRequest (see here)
ResponseStatus	ResponseStatus		Instance of ResponseStatus object (see here)