Identifiers and attributes
Optional fields on a subject for POST /v1/screen and POST /v1/screen/batch. Identifiers are exact values. Attributes are type-specific details that sharpen a match. See Request for the rest of the body.
Identifiers
identifiers is optional on a subject. On a batch, the same field lives on each subjects[] entry. Validation pointers are /subject/identifiers and /subjects/0/identifiers.
Identifiers are exact values used to identify a subject. Provide one or more identifiers as an array of objects in the format
{ "value": "string" }. Examples include LEI (5493001KJTIIGC8Y1R12), tax ID (EE123456789), passport number (P1234567), DUNS (123456789), and VAT (EE12345678).Attributes
Description: These fields are provided inside the details object and depend on the selected type. type is required when details is present.
Example:
{
"subject": {
"type": "INDIVIDUAL",
"name": "Kim Yong Un",
"details": {
"gender": "MALE",
"date_of_birth": ["1980-01-09"],
"country": "Russia",
"country_code": "RU"
}
}
}
*Values are case-insensitive, but returned in uppercase.
Attributes are descriptive values that provide additional context about a subject, such as date of birth or country code. To use attributes, you must set the type, as attributes are type-specific. See the sections below for supported attributes per type. Including attributes helps improve match precision and reduce false positives.
INDIVIDUAL
| Field | Type | Requirement | Description |
|---|---|---|---|
| gender | string | optional | Allowed values: MALE, FEMALE |
| date_of_birth | array of strings | optional | JSON array of 1–32 strings. Each value must be YYYY, YYYY-MM, or YYYY-MM-DD (examples: "1952", "1952-10", "1952-10-07"). Month 01–12, day 01–31. Matching uses the year. A conflicting year lowers the score unless dob_penalty is false. One year apart is not a conflict. |
| country_code | string | optional | 2-letter ISO code (e.g. US, GB) |
ENTITY
| Field | Type | Requirement | Description |
|---|---|---|---|
| country_code | string | optional | 2-letter ISO code (e.g. US, GB) |
VESSEL
| Field | Type | Requirement | Description |
|---|---|---|---|
| flag | array of strings | optional | Flag or registry name (e.g. Panama, Liberia) |
| call_sign | array of strings | optional | Vessel call sign (e.g. 9HA4112) |
| year_built | string | optional | Year built (format: YYYY) |
AIRCRAFT
| Field | Type | Requirement | Description |
|---|---|---|---|
| tail_number | array of strings | optional | Aircraft tail number (e.g. N12345) |
| manufacturer_serial_number | string | optional | Manufacturer serial number |
| construction_number | string | optional | Construction number |