API REFERENCE · SCHEMA

Subject schema

Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

nameRequired
string

Name to compare with publisher records. Leading and trailing whitespace is removed; provide the fullest reliable name available.

Minimum length: 2. Maximum length: 300.

entityTypeOptional
string

Type of subject. Defaults to person when omitted. Every selected source must support this type.

Values: "person", "organization", "vessel", "aircraft", "other". Default: "person".

identifiersOptional
object[]

Typed identifiers used for exact matching, such as passport, national_id, registration, lei, imo or mmsi. Defaults to an empty array. Use the publisher’s identifier scheme; custom scheme names are accepted.

Maximum items: 20. Default: [].

identifiers item fields

Each array item: object.

identifiers[].typeRequired
string

Identifier scheme, such as passport, national_id, registration, lei, imo or mmsi. Matching normalizes supported scheme aliases.

Minimum length: 1. Maximum length: 80.

identifiers[].valueRequired
string

Identifier value. Send the original value; scheme-specific normalization is applied during matching.

Minimum length: 1. Maximum length: 160.

identifiers[].issuerOptional
string

Optional issuing authority or country. Omit when unknown; do not send null.

Minimum length: 1. Maximum length: 100.

Additional fields are not accepted.

birthDateOptional
string

Known date or partial date: YYYY, YYYY-MM or YYYY-MM-DD. Preserve known precision; do not invent a month or day. Year 0000 and invalid dates are rejected.

birthDate fields and rules

Allowed alternatives

  • string

    Pattern: ^(?!0000)\d{4}$.

  • string

    Pattern: ^(?!0000)\d{4}-(0[1-9]|1[0-2])$.

  • string

    Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$.

    Pattern: ^(?!0000).

countryOptional
string

Known country name or code used as supporting identity evidence. It is not a source-selection or geographic coverage filter.

Minimum length: 2. Maximum length: 100.

Additional fields are not accepted.

Use Subject in a workflow

Complete synthetic example. This illustrates the schema; it is not a live screening result.

JSON · synthetic Subject
{
  "name": "Alex Morgan",
  "entityType": "person",
  "birthDate": "1984"
}

Used by

Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.

Implementation guides