API REFERENCE · SCHEMA

Counterparty 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.

All endpoints and schemas
idRequired
string

Format: uuid.

environmentRequired
string

Values: "sandbox", "production".

labelRequired
string
externalIdRequired
string or null

May be null.

externalId fields and rules

Allowed alternatives

  • string
  • null

    May be null.

relationshipRequired
string

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

subjectRequired
objectView Subject schema
subject fields and rules
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.

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

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

subject.identifiers item fields

Each array item: object.

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.

subject.identifiers[].valueRequired
string

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

Minimum length: 1. Maximum length: 160.

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.

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.

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

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.

tagsRequired
string[]
tags item fields

Each array item: string.

statusRequired
string

Values: "active", "archived".

revisionRequired
integer

Minimum: 0.

createdAtRequired
string

Format: date-time.

updatedAtRequired
string

Format: date-time.