BatchRequest schema

Batch input. Exactly one of subjects or uploadId is required in addition to name. Every row uses standard retention.

nameRequired

string

Human-readable batch label. Leading and trailing whitespace is removed.

Minimum length: 1. Maximum length: 100.

subjectsConditional

object[]

One to 100 complete ScreeningRequest objects. Each row chooses its own coverage and must use standard retention (or omit retention). Supply subjects or uploadId, exactly one.

Minimum items: 1. Maximum items: 100.

subjects item fields

Each array item: object.

subjects[].subjectRequired

object

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

subjects[].subject fields and rules

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

subjects[].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".

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

subjects[].subject.identifiers item fields

Each array item: object.

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

subjects[].subject.identifiers[].valueRequired

string

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

Minimum length: 1. Maximum length: 160.

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

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

subjects[].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).

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

subjects[].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)$.

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

subjects[].policy fields and rules

subjects[].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)$.

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

subjects[].referenceOptional

string

Optional caller reference (up to 160 characters). It is retained with standard evidence and returned by GET /results/{id}; it is null in minimal-retention retrieval.

Maximum length: 160.

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

subjects[].sources item fields

Each array item: string.

Minimum length: 1. Maximum length: 80.

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

subjects[].retentionOptional

"standard"

standard retains inputs and evidence under organization/case policy. minimal is available only for individual API-key screenings, lasts 24 hours, omits submitted inputs, and cannot create a review case. Governance requirements can require standard. Defaults to standard.

Must equal "standard". Default: "standard".

Choose exactly one option

• Provide subjects[].sources. Do not provide subjects[].package.
• Provide subjects[].package. Do not provide subjects[].sources.

Additional fields are not accepted.

uploadIdConditional

string

UUID returned by POST /uploads/intent after its private NDJSON upload has completed and passed validation. The file must be ready, unexpired and unused. Mutually exclusive with subjects; uploaded files support up to 10,000 request rows.

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

Additional fields are not accepted.