API REFERENCE · Screening and evidence

Download retained JSON evidence

Complete request parameters, body fields, response formats, examples, and errors for GET /results/{id}/evidence.

Base URL: https://www.sanctionskit.com/api/v1. Documentation examples are saved and require no API key to read.

GET/results/{id}/evidenceDownload retained JSON evidence

Authentication: Authorization: Bearer YOUR_API_KEY (required). Use a server-side key for the intended environment and scopes.

Required API key scope: results:read.

Request parameters

Path parameters: id
Query parameters: None.
Headers: Authorization (required)
JSON body fields: None.

This operation has no request body.

Headers, path and query parameters

idpathRequired

string

Opaque resource identifier owned by the authenticated organization.

Format: uuid.

Request body

This operation has no request body.

Responses

200Successful response. The response is the documented raw JSON or file content, without a data envelope. Check Content-Type before decoding.

Response headers

X-Request-Id

string

Server-generated request correlation identifier.

Format: uuid.

application/jsonView ScreeningEvidence schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

formatRequired

"sanctionskit-evidence@1"

Must equal "sanctionskit-evidence@1".

resultRequired

object

Result returned by POST /screenings and plain GET /results items. Its required fields are always present. A successful result is either potential_match or no_match; failures use the Error envelope instead.

View ScreeningResult schema

result fields and rules

result.idRequired

string

Screening UUID; use it to retrieve retained result/evidence and locate linked review cases.

Format: uuid.

result.environmentRequired

enum

Environment owned by the API key. Sandbox evidence is synthetic.

Values: "sandbox", "production".

result.statusRequired

enum

potential_match requires review of candidates; no_match means no returned candidates within the selected coverage and matching rules. Neither is a business approval or legal clearance.

Values: "potential_match", "no_match".

result.createdAtRequired

string

Screening creation timestamp in ISO 8601 UTC.

Format: date-time.

result.matchesRequired

object[]

Candidate records with field evidence and conflicts. Always an array; empty for no_match. No silent truncation is performed.

result.matches item fields

Each array item: object.

result.matches[].recordRequired

objectView SourceRecord schema

result.matches[].record fields and rules

See all SourceRecord fields for the complete structure, required properties and constraints.

result.matches[].scoreRequired

number

Similarity measure, not probability of wrongdoing.

Minimum: 0. Maximum: 100.

result.matches[].evidenceRequired

object[]

result.matches[].evidence item fields

Each array item: object.

result.matches[].evidence[].fieldRequired: string
result.matches[].evidence[].queryValueRequired: string
result.matches[].evidence[].sourceValueRequired: string
result.matches[].evidence[].methodRequired: string
result.matches[].evidence[].contributionRequired: number
result.matches[].evidence[].explanationRequired: string

result.matches[].conflictsRequired

string[]

result.matches[].conflicts item fields

Each array item: string.

result.coverageRequired

Coverage[]

Exact source versions used, including freshness and retained publisher notices. Always present, including no_match.

result.coverage item fields

Each array item: Coverage.

See all Coverage fields for the complete structure, required properties and constraints.

result.versionsRequired

object

Dataset, matching engine and policy versions used for this result. package is included only for package-based coverage.

result.versions fields and rules

result.versions.datasetRequired: string
result.versions.matchingEngineRequired: string
result.versions.policyRequired: string
result.versions.packageOptional: string

result.disclaimerRequired

string

Interpretation limits supplied with this result; preserve them when presenting or exporting evidence.

result.policySnapshotOptional

object

Immutable organization policy applied at screening time, when one was selected. Omitted when no organization policy applied.

View ScreeningPolicySnapshot schema

result.policySnapshot fields and rules

result.policySnapshot.nameRequired

string

Minimum length: 2. Maximum length: 120.

result.policySnapshot.purposeRequired

string

Minimum length: 3. Maximum length: 1000.

result.policySnapshot.jurisdictionsRequired

string[]

Minimum items: 1. Maximum items: 30.

result.policySnapshot.jurisdictions item fields

Each array item: string.

Minimum length: 2. Maximum length: 100.

result.policySnapshot.requiredSourcesRequired

object

Allowed keys: "person", "organization", "vessel", "aircraft", "other". Default: {}.

result.policySnapshot.requiredSources fields and rules

Each additional key uses the following value structure.

Maximum items: 512.

Each array item: string.

Minimum length: 1. Maximum length: 80.

result.policySnapshot.optionalSourcesRequired

object

Allowed keys: "person", "organization", "vessel", "aircraft", "other". Default: {}.

result.policySnapshot.optionalSources fields and rules

Each additional key uses the following value structure.

Maximum items: 512.

Each array item: string.

Minimum length: 1. Maximum length: 80.

result.policySnapshot.exclusionsRequired

string[]

Maximum items: 30. Default: [].

result.policySnapshot.exclusions item fields

Each array item: string.

Minimum length: 3. Maximum length: 500.

result.policySnapshot.externalChecksRequired

string[]

Maximum items: 20. Default: [].

result.policySnapshot.externalChecks item fields

Each array item: string.

Minimum length: 3. Maximum length: 200.

result.policySnapshot.externalCheckGuidanceOptional

object[]

Maximum items: 20.

result.policySnapshot.externalCheckGuidance item fields

Each array item: object.

result.policySnapshot.externalCheckGuidance[].labelRequired: string
Minimum length: 3. Maximum length: 200.
result.policySnapshot.externalCheckGuidance[].instructionsRequired: string
Minimum length: 3. Maximum length: 2000.
result.policySnapshot.externalCheckGuidance[].evidenceExampleOptional: string
Minimum length: 3. Maximum length: 1000.

Additional fields are not accepted.

result.policySnapshot.reviewRequired

object

Default: {}.

result.policySnapshot.review fields and rules

result.policySnapshot.review.requireSecondReviewOptional: boolean
Default: false.
result.policySnapshot.review.secondReviewForOptional: string[]
Maximum items: 4. Default: [].; result.policySnapshot.review.secondReviewFor item fields
Each array item: string.
Values: "same_identity", "allow", "restrict", "escalate".
result.policySnapshot.review.approverRolesOptional: string[]
Minimum items: 1. Maximum items: 3. Default: ["owner","admin","analyst"].; result.policySnapshot.review.approverRoles item fields
Each array item: string.
Values: "owner", "admin", "analyst".

Additional fields are not accepted.

result.policySnapshot.monitoringIntervalHoursRequired

6 or 24 or 168

Default: 24.

result.policySnapshot.monitoringIntervalHours fields and rules

Allowed alternatives

6
Must equal 6.
24
Must equal 24.
168
Must equal 168.

result.policySnapshot.retentionTriggerRequired

string

Values: "review_completed", "relationship_ended", "business_event". Default: "review_completed".

result.policySnapshot.idRequired

string

Format: uuid.

result.policySnapshot.versionRequired

integer

Minimum: 0.

result.policySnapshot.environmentRequired

string

Values: "sandbox", "production".

result.policySnapshot.createdAtRequired

string

Format: date-time.

Additional fields are not accepted.

retentionRequired

string

Values: "standard", "minimal".

expires_atRequired

string or null

Null while evidence is protected by an open review, unrecorded retention trigger or indefinite hold; inspect case governance.

May be null.

expires_at fields and rules

Allowed alternatives

string
Format: date-time.
null
May be null.

subjectRequired

Subject or null

Retained subject; null for minimal retention or when no subject was retained.

May be null.

subject fields and rules

Allowed alternatives

Subject
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.
null
May be null.

referenceRequired

string or null

Retained caller reference; null for minimal retention or if absent.

May be null.

reference fields and rules

Allowed alternatives

string
null
May be null.

requestRequired

ScreeningRequest or null

Retained complete request; null for minimal retention or when inputs were not retained.

May be null.

request fields and rules

Allowed alternatives

ScreeningRequest
Single subject input. Exactly one of sources or package is required. Only subject is unconditionally required; coverage and approved policy also have conditional requirements described below.
request.subjectRequired
object
Identity to screen. name is required; entityType defaults to person and identifiers defaults to an empty array.
request.subject fields and rules
request.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.
request.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".
request.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: [].
request.subject.identifiers item fields
Each array item: object.
request.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.
request.subject.identifiers[].valueRequired
string
Identifier value. Send the original value; scheme-specific normalization is applied during matching.
Minimum length: 1. Maximum length: 160.
request.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.
request.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.
request.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).
request.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.
request.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)$.
request.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.
request.policy fields and rules
request.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)$.
request.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.
request.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.
request.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.
request.sources item fields
Each array item: string.
Minimum length: 1. Maximum length: 80.
request.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.
request.retentionOptional
string
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.
Values: "standard", "minimal". Default: "standard".
Choose exactly one option
- Provide request.sources. Do not provide request.package.
- Provide request.package. Do not provide request.sources.
Additional fields are not accepted.
null
May be null.

retainedInputsRequired

boolean

Whether both subject and request inputs were retained. A false value means full historical input replay is unavailable.

replayLimitRequired

string or null

Explanation of replay limitations for minimal retention; otherwise null.

May be null.

replayLimit fields and rules

Allowed alternatives

string
null
May be null.

Example response

Recorded from the real application handler against an isolated synthetic database. IDs, times and nonfunctional temporary secrets are normalized. No customer data or live provider request.

{
  "format": "sanctionskit-evidence@1",
  "result": {
    "id": "00000000-0000-4000-8000-000000000001",
    "status": "potential_match",
    "matches": [
      {
        "score": 96,
        "record": {
          "id": "sandbox:person-001",
          "list": "Synthetic demonstration records",
          "names": [
            {
              "kind": "primary",
              "value": "Alex Morgan"
            },
            {
              "kind": "alias",
              "value": "Алекс Морган"
            }
          ],
          "sourceId": "sandbox-synthetic",
          "addresses": [],
          "authority": "SanctionsKit synthetic examples",
          "sourceUrl": "https://sanctionskit.com/demo",
          "birthDates": [
            {
              "value": "1984",
              "original": "1984",
              "precision": "year"
            }
          ],
          "entityType": "person",
          "extensions": {
            "synthetic": true
          },
          "identifiers": [
            {
              "type": "passport",
              "value": "DEMO-001",
              "issuer": "Fictional authority"
            }
          ],
          "designations": [
            {
              "wording": "Invented example, not a government designation.",
              "category": "other",
              "programs": [
                "Synthetic demonstration only"
              ],
              "legalReferences": []
            }
          ],
          "nationalities": []
        },
        "evidence": [
          {
            "field": "name",
            "method": "normalized_name_exact",
            "queryValue": "Alex Morgan",
            "explanation": "Name similarity is a review signal, not a probability or finding of wrongdoing.",
            "sourceValue": "Alex Morgan",
            "contribution": 96
          }
        ],
        "conflicts": []
      }
    ],
    "coverage": [
      {
        "fresh": true,
        "version": "1",
        "sourceId": "sandbox-synthetic",
        "retrievedAt": "2026-09-17T12:00:00.000Z"
      }
    ],
    "versions": {
      "policy": "review-1.1.0",
      "dataset": "sandbox-synthetic-v1",
      "package": "sandbox@1",
      "matchingEngine": "deterministic-1.1.1"
    },
    "createdAt": "2026-09-17T12:00:00.000Z",
    "disclaimer": "Potential matches support analyst review. No match means no match in the selected sources and dataset, not legal clearance. Scores are similarity measures, not probabilities of wrongdoing.",
    "environment": "sandbox",
    "policySnapshot": {
      "id": "00000000-0000-4000-8000-000000000002",
      "name": "Synthetic onboarding policy",
      "review": {
        "approverRoles": [
          "owner",
          "admin",
          "analyst"
        ],
        "secondReviewFor": [],
        "requireSecondReview": false
      },
      "purpose": "Document vendor onboarding checks",
      "version": 1,
      "createdAt": "2026-09-17T12:00:00.000Z",
      "exclusions": [],
      "environment": "sandbox",
      "jurisdictions": [
        "Example jurisdiction"
      ],
      "externalChecks": [
        "Ownership review"
      ],
      "optionalSources": {},
      "requiredSources": {},
      "retentionTrigger": "business_event",
      "monitoringIntervalHours": 24
    }
  },
  "retention": "standard",
  "expires_at": null,
  "subject": {
    "name": "Alex Morgan",
    "entityType": "person",
    "identifiers": []
  },
  "reference": null,
  "request": {
    "policy": {
      "id": "00000000-0000-4000-8000-000000000002",
      "version": 1
    },
    "package": "sandbox@1",
    "subject": {
      "name": "Alex Morgan",
      "entityType": "person",
      "identifiers": []
    },
    "retention": "standard",
    "counterpartyId": "00000000-0000-4000-8000-000000000003"
  },
  "retainedInputs": true,
  "replayLimit": null
}

400invalid_request — Correct the request fields, resource identifiers, JSON body or query parameters before retrying.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

Optional JSON details for client and validation failures. Validation failures return an array of { path, message } issues; other 4xx codes may return a code-specific object. Server failures omit details. Never assume this key is present.

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Correct the request fields, resource identifiers, JSON body or query parameters before retrying.

{
  "error": {
    "code": "invalid_request",
    "message": "The request is invalid.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

401authentication_required — Send Authorization: Bearer with a valid API key. An omitted header can produce authentication_required; invalid supplied credentials produce invalid_api_key. invalid_api_key — Use an active key for the intended environment.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

WWW-Authenticate

string

Bearer authentication challenge.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Send Authorization: Bearer with a valid API key. An omitted header can produce authentication_required; invalid supplied credentials produce invalid_api_key.

{
  "error": {
    "code": "authentication_required",
    "message": "Sign in to continue.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

invalid api key

Synthetic error example. Use an active key for the intended environment.

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is invalid, expired, or revoked.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

403permission_denied — Ask an organization owner to grant the required role or API-key scope. insufficient_scope — Use a key with the scope stated in this operation.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Ask an organization owner to grant the required role or API-key scope.

{
  "error": {
    "code": "permission_denied",
    "message": "Your role does not allow this action.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

insufficient scope

Synthetic error example. Use a key with the scope stated in this operation.

{
  "error": {
    "code": "insufficient_scope",
    "message": "The API key does not grant this action.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

404not_found — Check the identifier and selected environment. The resource must belong to your organization and remain available.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Check the identifier and selected environment. The resource must belong to your organization and remain available.

{
  "error": {
    "code": "not_found",
    "message": "Screening not found.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

405method_not_allowed — Use a method in the Allow response header. OPTIONS lists supported methods; HEAD follows GET authorization and returns no body.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

Allow

string

Comma-separated supported HTTP methods.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Use a method in the Allow response header. OPTIONS lists supported methods; HEAD follows GET authorization and returns no body.

{
  "error": {
    "code": "method_not_allowed",
    "message": "This method is not supported for this endpoint.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

410result_expired — Run a new screening and review its retained evidence. Expired evidence is not reconstructed.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Run a new screening and review its retained evidence. Expired evidence is not reconstructed.

{
  "error": {
    "code": "result_expired",
    "message": "The evidence has expired. Run a new screening before reviewing it.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

413response_too_large — Reduce the requested page size or use the documented segmented case archive. No evidence is silently truncated.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Reduce the requested page size or use the documented segmented case archive. No evidence is silently truncated.

{
  "error": {
    "code": "response_too_large",
    "message": "This response exceeds the size limit. Request a smaller page or a segmented export.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

422result_too_large — Use more precise screening input. Large results are rejected rather than silently truncated.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Use more precise screening input. Large results are rejected rather than silently truncated.

{
  "error": {
    "code": "result_too_large",
    "message": "A retained result exceeds the response size limit. No matches were truncated or skipped.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

429rate_limited — Wait for the request window to reset and retry with backoff.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

Retry-After

string

When present, a delay in seconds or an HTTP-date before which the client should not retry. Service-unavailable responses default to a one-second delay unless another safe value is supplied. A usage allowance error may require quota recovery instead of retrying.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Wait for the request window to reset and retry with backoff.

{
  "error": {
    "code": "rate_limited",
    "message": "The per-minute request limit has been reached.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

500internal_error — Retry with backoff. For writes reuse the same idempotency key and identical input; include requestId when contacting support.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Retry with backoff. For writes reuse the same idempotency key and identical input; include requestId when contacting support.

{
  "error": {
    "code": "internal_error",
    "message": "The request could not be completed.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

503temporarily_unavailable — Honor Retry-After when present and retry with bounded backoff. Follow this endpoint’s retry contract; preserve the same key and input for idempotent writes. Contact support with requestId if the failure persists.

Response headers

X-Request-Id

string

Server-generated correlation identifier, also returned in error.requestId.

Format: uuid.

Retry-After

string

application/jsonView Error schema

Response fields

Required means present in the containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.

Failure envelope for every documented non-2xx API response. No data property is returned. Switch on error.code; messages may change.

errorRequired

object

error fields and rules

error.codeRequired

string

Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.

error.messageRequired

string

Human-readable explanation. Do not parse this text to control application behavior.

error.requestIdRequired

string

Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.

Format: uuid.

error.detailsOptional

object[] or object or string or number or boolean or null

error.details fields and rules

Allowed alternatives

object[]
Maximum items: 50.
Each array item: object.
error.details[].pathRequired
string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
error.details[].messageRequired
string
Validation problem for this field.
Maximum length: 300.
object
Additional keys are allowed; their values are not a fixed contract.
string or number or boolean or null
May be null.

error.detailsTruncatedOptional

boolean

True when only the first 50 validation issues are returned. Validation paths and messages are bounded.

Example response

Synthetic error example. Honor Retry-After when present and retry with bounded backoff. Follow this endpoint’s retry contract; preserve the same key and input for idempotent writes. Contact support with requestId if the failure persists.

{
  "error": {
    "code": "temporarily_unavailable",
    "message": "The service is temporarily unavailable. Retry shortly.",
    "requestId": "01234567-89ab-4cde-8f01-23456789abcd"
  }
}

Back to request parameters