API REFERENCE · SCHEMA
Error 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.
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
errorRequired.code - string
Machine-readable failure code. See this operation’s status-specific examples for codes and recovery.
errorRequired.message - string
Human-readable explanation. Do not parse this text to control application behavior.
errorRequired.requestId - string
Server correlation ID, also returned in X-Request-Id. Include this ID in support requests.
Format: uuid.
errorOptional.details - 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.
errorRequired.details[] .path - string
Dot-separated invalid field path, including array indexes.
Maximum length: 160.
errorRequired.details[] .message - 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.
- object[]
errorOptional.detailsTruncated - boolean
True when only the first 50 validation issues are returned. Validation paths and messages are bounded.
Use Error in a workflow
Used by
Open an operation for its complete request or response example, including any outer JSON object that wraps these fields.
- GET /sourcesResponse · Discover source capabilities, qualification and availability
- GET /policiesResponse · Read current approved screening policy versions
- GET /policies/{id}Response · Read the current version of an approved policy
- POST /screeningsResponse · Screen one subject against explicitly selected coverage
- GET /resultsResponse · List retained results
- GET /results/{id}Response · Retrieve one retained screening
- GET /results/{id}/evidenceResponse · Download retained JSON evidence
- GET /batchesResponse · List batches with progress
- POST /batchesResponse · Accept up to 100 inline requests or an authorized private upload
- GET /batches/{id}Response · Read batch and row outcomes
- DELETE /batches/{id}Response · Cancel pending batch rows
- POST /uploads/intentResponse · Authorize a direct private Blob upload
- POST /uploadsResponse · Create a client token for an authorized private batch upload
- GET /files/{id}Response · Download a private file after tenant authorization
- GET /monitorsResponse · List retained monitoring subjects
- POST /monitorsResponse · Create a monitor with retained subject data
- GET /monitors/{id}Response · Read one active or paused monitor
- PATCH /monitors/{id}Response · Update a monitored subject and queue a fresh screen
- DELETE /monitors/{id}Response · Stop monitoring and remove retained monitor input
- GET /monitoringResponse · Read monitor health, controls and estimated period capacity
- PATCH /monitoring/{id}Response · Pause, resume, change cadence or queue a check now using the current revision
- GET /monitoring/inboxResponse · List meaningful changes, failures and reviews that must be renewed
- GET /monitoring/inbox/{id}Response · Read bounded before-and-after previews from retained evidence
- GET /webhooksResponse · Read endpoints and recent delivery history
- POST /webhooksResponse · Register a public HTTPS endpoint and obtain its signing secret once
- DELETE /webhooks/{id}Response · Disable a webhook endpoint
- POST /webhooks/{id}/retryResponse · Retry a failed webhook delivery
- GET /counterpartiesResponse · List persistent customer and vendor records
- GET /counterparties/{id}Response · Read a counterparty and linked screening, case and monitor history
- GET /counterparties/{id}/historyResponse · Page through linked history including truthful expired evidence metadata
- GET /casesResponse · List analyst review cases
- POST /casesResponse · Open a review case for an existing retained screening
- GET /cases/{id}Response · Read a case and append-only decisions
- GET /investigations/{id}Response · Read match decisions, assignments, retained notes and attachment metadata
- GET /investigations/{id}/attachments/{attachmentId}Response · Download a retained text attachment
- GET /reportsResponse · Read current backlog and period screening and reviewer activity
- GET /reports/screeningsResponse · Download a bounded screening CSV with explicit expired outcomes
- GET /reports/cases/{id}Response · Download a bounded case audit packet in JSON or PDF
- GET /reports/cases/{id}/archiveResponse · Export every retained case archive segment
- GET /reports/cases/{id}/governanceResponse · Read retention triggers, holds and approved external document references
- GET /usageResponse · Read period allowance, used subjects and pending reservations
- GET /auditResponse · List retained human review decisions
Implementation guides
- Sanctions screening API requests and responses
- Batch sanctions screening API: submit and track a list
- Sanctions monitoring API: create and manage repeat checks
- Choose sanctions API sources and check coverage
- Set a sanctions screening policy for your team
- Import counterparties and link customer screening records
- Connect sanctions screening to case review
- Retrieve sanctions screening results and evidence
- Sanctions screening webhooks: verify and process events
- Sanctions screening API usage and allowance limits