MonitorUpdate schema

Full replacement identity and coverage, guarded by expectedRevision. Exactly one of sources or package is required.

nameRequired

string

Complete replacement monitor label. PATCH requires the full name, subject and coverage, not only changed fields.

Minimum length: 1. Maximum length: 100.

counterpartyIdOptional

string

Optional existing active counterparty UUID in the same organization and environment. The submitted subject must match its current identity; this does not create a counterparty.

Format: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.

policyConditional

object

Approved organization policy reference. Required when GET /policies returns requirePolicy=true. A supplied policy must be current and compatible with the subject and requested coverage.

Required when GET /policies returns requirePolicy=true for the current API key environment.

policy fields and rules

policy.idRequired

string

Policy UUID from GET /policies.

Format: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.

policy.versionRequired

integer

Exact approved policy version from GET /policies. Reload the policy if that version is no longer available.

Maximum: 9007199254740991. Must be greater than 0.

Additional fields are not accepted.

subjectRequired

object

Identity to screen. name is required; entityType defaults to person and identifiers defaults to an empty array.

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.

sourcesConditional

string[]

Explicit source IDs from GET /sources. Provide sources or package, exactly one. Every selected source must be available, fresh and support the subject type; unavailable coverage fails closed.

Minimum items: 1. Maximum items: 512.

sources item fields

Each array item: string.

Minimum length: 1. Maximum length: 80.

packageConditional

string

One versioned coverage package, mutually exclusive with sources. Sandbox accepts only sandbox@1. Use only a package available to the selected environment; no implicit global coverage is applied.

Minimum length: 1. Maximum length: 80.

expectedRevisionRequired

integer

Current revision from GET /monitors/{id} or GET /monitoring. The update fails with monitor_changed if another edit occurred; reload before applying your change.

Minimum: 1. Maximum: 9007199254740991.

Additional fields are not accepted.