ArchiveCorrection schema

Retained record for archive category corrections. Keys retain their stored snake_case spelling. Nullable columns are included with null values. Expired records use ArchiveExpiredRecord instead; holdings can omit expired reason text.

idRequired

string

Format: uuid.

organization_idRequired

string

environmentRequired

string

case_idRequired

string

Format: uuid.

screening_idRequired

string

Format: uuid.

result_screening_idRequired

string

Format: uuid.

result_case_idRequired

string or null

May be null.

result_case_id fields and rules

Allowed alternatives

• string

  Format: uuid.

• null

  May be null.

before_subjectRequired

objectView Subject schema

before_subject fields and rules

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

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

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

before_subject.identifiers item fields

Each array item: object.

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

before_subject.identifiers[].valueRequired

string

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

Minimum length: 1. Maximum length: 160.

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

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

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

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

after_subjectRequired

objectView Subject schema

after_subject fields and rules

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

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

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

after_subject.identifiers item fields

Each array item: object.

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

after_subject.identifiers[].valueRequired

string

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

Minimum length: 1. Maximum length: 160.

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

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

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

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

reasonRequired

string

actor_idRequired

string

created_atRequired

string

Format: date-time.

expires_atRequired

string or null

May be null.

expires_at fields and rules

Allowed alternatives

• string

  Format: date-time.

• null

  May be null.