Developer centerv1.0.0
Documentation menu
Data models

EntityRecord

Fields, types and constraints for the EntityRecord public API model.

Normalized person, organization, vessel, aircraft or other primary record.

Fields

FieldTypeConstraintExampleVisibility
entityId

Stable normalized entity id across source records.

string"example"Public contract
type

Entity or identifier type.

EntityType{}Public contract
primaryName

Canonical primary name for the entity.

string"example"Public contract
names

Normalized names including the primary name.

string[][]Public contract
gender

Optional gender value for person records.

stringnullable"example"Public contract
birthDates

Birth date values reported by official sources.

string[][]Personal context
birthPlaces

Birth place values reported by official sources.

string[][]Personal context
nationalities

Nationality values reported by official sources.

string[][]Personal context
countries

Country values associated with the entity.

string[][]Public contract
pep

Whether the record carries a PEP signal; this is not a legal conclusion.

booleanfalsePublic contract

Machine-readable schema

The model is published under the same name in the JSON Schema bundle.

JSON Schema

Decision boundary

An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.