CounterpartyDetail schema

Saved identity plus up to 100 rows for each related resource collection. Use /counterparties/{id}/history to paginate the complete history.

counterpartyRequired

objectView Counterparty schema

counterparty fields and rules

counterparty.idRequired

string

Format: uuid.

counterparty.environmentRequired

string

Values: "sandbox", "production".

counterparty.labelRequired

string

counterparty.externalIdRequired

string or null

May be null.

counterparty.externalId fields and rules

Allowed alternatives

• string
• null

  May be null.

counterparty.relationshipRequired

string

Values: "customer", "vendor", "employee", "other".

counterparty.subjectRequired

objectView Subject schema

counterparty.subject fields and rules

counterparty.subject.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.

counterparty.subject.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".

counterparty.subject.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: [].

counterparty.subject.identifiers item fields

Each array item: object.

counterparty.subject.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.

counterparty.subject.identifiers[].valueRequired

string

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

Minimum length: 1. Maximum length: 160.

counterparty.subject.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.

counterparty.subject.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.

counterparty.subject.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).

counterparty.subject.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.

counterparty.tagsRequired

string[]

counterparty.tags item fields

Each array item: string.

counterparty.statusRequired

string

Values: "active", "archived".

counterparty.revisionRequired

integer

Minimum: 0.

counterparty.createdAtRequired

string

Format: date-time.

counterparty.updatedAtRequired

string

Format: date-time.

screeningsRequired

object[]

screenings item fields

Each array item: object.

screenings[].idRequired

string

Format: uuid.

screenings[].created_atRequired

string

Format: date-time.

screenings[].statusRequired

string

Values: "potential_match", "no_match", "expired".

screenings[].evidence_stateRequired

string

Values: "available", "expired".

monitorsRequired

object[]

monitors item fields

Each array item: object.

monitors[].idRequired

string

Format: uuid.

monitors[].nameRequired

string

monitors[].statusRequired

string

Values: "active", "paused", "deleted".

monitors[].last_screening_idRequired

string or null

May be null.

monitors[].last_screening_id fields and rules

Allowed alternatives

• string

  Format: uuid.

• null

  May be null.

monitors[].next_run_atRequired

string

Format: date-time.

casesRequired

object[]

cases item fields

Each array item: object.

cases[].idRequired

string

Format: uuid.

cases[].created_atRequired

string

Format: date-time.

cases[].decisionRequired

string

Values: "open", "confirmed", "dismissed".

cases[].business_dispositionRequired

string

Values: "pending", "allow", "restrict", "escalate".

cases[].review_stateRequired

string

cases[].screening_idRequired

string

Format: uuid.

cases[].latest_screening_idRequired

string or null

May be null.

cases[].latest_screening_id fields and rules

Allowed alternatives

• string

  Format: uuid.

• null

  May be null.