Documentation menu
EntityRecord
Fields, types and constraints for the EntityRecord public API model.
Normalized person, organization, vessel, aircraft or other primary record.
Fields
| Field | Type | Constraint | Example | Visibility |
|---|---|---|---|---|
entityIdStable normalized entity id across source records. | string | — | "example" | Public contract |
typeEntity or identifier type. | EntityType | — | {} | Public contract |
primaryNameCanonical primary name for the entity. | string | — | "example" | Public contract |
namesNormalized names including the primary name. | string[] | — | [] | Public contract |
genderOptional gender value for person records. | string | nullable | "example" | Public contract |
birthDatesBirth date values reported by official sources. | string[] | — | [] | Personal context |
birthPlacesBirth place values reported by official sources. | string[] | — | [] | Personal context |
nationalitiesNationality values reported by official sources. | string[] | — | [] | Personal context |
countriesCountry values associated with the entity. | string[] | — | [] | Public contract |
pepWhether the record carries a PEP signal; this is not a legal conclusion. | boolean | — | false | Public contract |
Machine-readable schema
The model is published under the same name in the JSON Schema bundle.
JSON SchemaDecision boundary
An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.