Objects > LinkedTo

Request Parameters

These parameters can be provided in any requests where LinkedTo is present.

These parameters will also be included in any responses where LinkedTo is present.

Parameter Type Format Description
ClientId Deprecated Int64

The ID of the Client this search is linked to.

Deprecated: Please use Type "client" and the Id parameter instead.
Id Required Int64 The ID of the search to link to (or is linked to).
Type Required String

The Type of search to link to (or is linked to).

The following values are valid:

Type Description
client A Client search (Simplified.ID App)
sanctions A Sanctions Search
pep A PEP Search
validid A ValidID Search
companylookup A CompanyLookup Search
dbs A DBS Search
Subtype String

Required on requests when linking to a ValidID Search
(Type = "validid").

The Subtype of search to link to (or is linked to).

The following values are valid with the associated Type:

Subtype Type Description
validate-me client A Simplified.ID App Client
doc-upload client A Document Upload Client
entity sanctions An Entity Sanctions Search
individual sanctions An Individual Sanctions Search
entity pep An Entity PEP Search
individual pep An Individual PEP Search
basic validid A Basic ValidID Search
enhanced validid An Enhanced ValidID Search
age validid A ValidID Age Search
driving-licence validid A ValidID Driving Licence Validation Search
passport validid A ValidID Passport Validation Search
pcv validid A ValidID Passport Chip Verification Search
ccj-insolvency validid A ValidID CCJ/Insolvency Search
basic companylookup A Basic CompanyLookup Search
enhanced companylookup An Enhanced CompanyLookup Search
monitor companylookup A CompanyLookup Monitored Search
basic dbs A Basic DBS Search
standard dbs A Standard DBS Search

Response Parameters

These parameters are not valid in any requests.

These parameters will be included in any responses where LinkedTo is present.

Parameter Type Format Description
Status String The status of the linked search.
Description String A short description of the linked search. This can provide additional context.
IsArchived Bool true/false Whether the linked search is archived (true) or not (false)
Name String The name of the entity/individual the linked search was performed on.
Date DateTime ISO 8601 The date the linked search was created.