Hit records

Available on request. Contact IDCanopy for access; details may change.

Pending verification. Every field below follows the data provider's model plus our design and is to be defined with the contract. The names and spellings are indicative, not a contract.

A screening check returns a person profile with the attributes that explain the match. All sub-objects are optional and may be absent or empty.

Profile attributes (`data.attributes`)

Field	Type	Description
`firstName`	string	Given name.
`middleName`	string	Middle name or names, if any.
`lastName`	string	Family name.
`gender`	string	`Male`, `Female` or `Unknown`.
`datesOfBirthIso`	string array	Known dates of birth, ISO `YYYY-MM-DD`.
`datesOfDeathIso`	string array	Known dates of death, ISO format.
`nationalitiesIsoCodes`	string array	Nationality country codes, ISO 3166-1 alpha-2.
`isDeceased`	boolean	Whether the person is known to be deceased.
`isDeleted`	boolean	Whether the profile has been logically deleted in the back systems.
`monitoringId`	string	Identifier used for ongoing monitoring of this profile.
`version`	integer	Internal version of the profile in the monitoring system.
`datasets`	string array	Datasets that apply to the profile, for example `["PEP-LINKED","POI","SAN-CURRENT"]`. See Screening an individual.
`addresses`	object array	Known addresses. See below.
`aliases`	object array	Name variations and alternative spellings. See below.
`contactEntries`	object array	Phone, fax and email entries. See below.
`notes`	object array	Free-form notes on the profile.
`evidences`	object array	Sources behind the profile: articles, websites, official documents. See below.
`profileImages`	string array	URLs of profile images.
`pepEntries`	object or array	Structured PEP status, or `{}` when not applicable.
`pepByAssociationEntries`	object array	PEP-by-association links to other profiles via shared evidence.
`poiEntries`	object array	Profiles of interest, with public roles and positions. See below.
`sanEntries`	object	Sanctions information, grouped by status. See below.
`relEntries`	object array	Regulatory enforcement entries. See below.
`rreEntries`	object array	Reputational risk exposure entries. See below.
`ddEntries`	object array	Disqualified director entries.
`griEntries`	object array	Gambling risk intelligence entries. See below.
`identifiers`	object array	System identifiers and external reference IDs.
`individualLinks`	object array	Individuals linked directly to the subject. See below.
`businessLinks`	object array	Businesses linked to the subject, with their key people. See below.

Address object (`addresses[]`)

Field	Type	Description
`addressType`	string	`Place of birth`, `Business`, `Residential`, and so on.
`line1`	string	First line of the address.
`line2`	string	Second line, if any.
`city`	string	City or town.
`postcode`	string	Postal code, if available.
`county`	string	County or region.
`countyAbbreviation`	string	Abbreviation or code for the county or region.
`countryIsoCode`	string	Two-letter ISO country code.

Alias object (`aliases[]`)

Field	Type	Description
`firstName`	string	Given name used in the alias.
`middleName`	string	Middle name or names, if any.
`lastName`	string	Family name used in the alias.
`type`	string	Alias type, for example `Name Spelling Variation` or `Former name`.

Contact entry object (`contactEntries[]`)

Field	Type	Description
`category`	string	`Telephone`, `Fax`, `Email`, and so on.
`value`	string	The contact value.

Evidence object (`evidences[]`)

Field	Type	Description
`evidenceId`	string	Identifier of the evidence.
`datasets`	string array	Datasets this evidence supports.
`originalUrl`	string	URL of the original source.
`assetUrl`	string	URL of a stored copy or document, if any.
`publicationDateIso`	string	Publication date, ISO format.
`captureDateIso`	string	Date the evidence was captured or indexed.
`summary`	string	Short description of what the source says.
`title`	string	Title of the article or document.
`credibility`	string	Source credibility, for example `High` or `Medium`, where available.
`language`	string	Language code of the source, for example `eng`.
`isCopyrighted`	boolean	Whether the source is copyrighted.

POI entry object (`poiEntries[]`)

Field	Type	Description
`category`	string	Category of the profile of interest, for example `Other Public Figures` or `Senior Government Officials`.
`evidenceIds`	string array	Evidence that supports the classification.
`positions`	object array	Positions held, see below.

Position object (`positions[]`)

Field	Type	Description
`countryIsoCode`	string	ISO 3166-1 alpha-2 code of the country of the position.
`dateFromIso`	string	Start date, ISO format, sometimes year only.
`dateToIso`	string	End date, ISO format, if applicable.
`position`	string	Title of the role.
`segment`	string	Segment or classification of the position.

Sanctions object (`sanEntries`)

sanEntries groups sanctions by status: current for active sanctions and former for historical ones, when the source provides them.

Field	Type	Description
`events`	object array	Chronological events on the sanction.
`measures`	string array	Measures imposed, for example `Travel Ban` or asset freezes.
`regime`	object	Issuing body and regime name.
`sanctionId`	string	Identifier of the sanction, if present.

Sanction event object (`events[]`)

Field	Type	Description
`dateIso`	string	Event date, ISO format.
`evidenceIds`	string array	Evidence supporting the event.
`type`	string	Event type, for example `Added`.

Pending verification: the source is inconsistent here; the contract will define it. The sanctions events use dateIso and evidenceIds, while the REL and RRE event tables below use dateISO and evidenceIDs.

Sanction regime object (`regime`)

Field	Type	Description
`body`	string	Issuing body or authority.
`name`	string	Name of the regime.
`origin`	string	Country or organisation of origin.

REL entry object (`relEntries[]`)

Field	Type	Description
`category`	string	Category of the entry, for example `Law Enforcement`.
`subcategory`	string	Name of the list.
`events`	string array	Events on the entry.

Pending verification: the source is inconsistent here; the contract will define it. This table gives events as a string array, while the event object below describes events as an object array.

REL event object (`events[]`)

Field	Type	Description
`type`	string	Event type, for example `Arrest`.
`currencyCode`	string	Currency of a financial penalty, where the event has one.
`amount`	integer	Amount of the financial penalty, if applicable.
`period`	string array	Length of a penalty, as days, months and years.
`dateISO`	string	Event date, ISO format.
`evidenceIDs`	string array	Evidence supporting the event.

RRE entry object (`rreEntries[]`)

Field	Type	Description
`category`	string	Category of the entry.
`subcategory`	string	Name of the list.
`events`	string array	Events on the entry.

Pending verification: the source is inconsistent here; the contract will define it. As in the REL entry above, events is a string array in this table but an object array in the event object below.

RRE event object (`events[]`)

Field	Type	Description
`type`	string	Event type, for example `Court Proceedings in Progress: Remand`.
`dateISO`	string	Event date, ISO format.
`evidenceIDs`	string array	Evidence supporting the event.

GRI entry object (`griEntries[]`)

Field	Type	Description
`title`	string	Title of the report.
`evidenceId`	string	Identifier of the supporting evidence.
`summary`	string	Description of the report.
`keywords`	string	Keywords associated with the report.

Linked individual object (`individualLinks[]` and `businessLinks[].individualLinks[]`)

Field	Type	Description
`firstName`	string	Given name of the linked individual.
`middleName`	string	Middle name or names, if any.
`lastName`	string	Family name of the linked individual.
`datasets`	string array	Datasets that apply to the linked individual.
`monitoringId`	string	Monitoring identifier of the linked individual.
`ownershipPercentage`	number	Ownership percentage when the link is an ownership link.
`relationship`	string	How the person is related to the subject.
`id`	string	Identifier of the linked individual.

Linked business object (`businessLinks[]`)

Field	Type	Description
`name`	string	Name of the linked business.
`datasets`	string array	Datasets that apply to the business.
`monitoringId`	string	Monitoring identifier of the business profile.
`ownershipPercentage`	number	Ownership percentage where applicable.
`relationship`	string	How the business is related to the subject.
`id`	string	Identifier of the business profile.
`individualLinks`	object array	Key people of the business, as linked individual objects above.

Hit records

On this page