Developer Guides
Screening API Reference
Public REST API contracts for name screening, batch jobs, account credits, coverage and Crypto Address Check. Authentication, status handling and OpenAPI.
Updated
The public API base URL is https://screenveritai.com/api/v1. Screening requests use X-API-Key with the required scope. Account-authenticated key management uses a bearer token. Download the public OpenAPI contract for request models and documented response shapes, or use the interactive documentation to inspect an endpoint. Some response and error details, especially Crypto Address Check, are described in the product guide rather than fully typed in the schema. The public schema covers customer-facing v1 routes; internal application and MCP endpoints are separate.
What this workflow covers
- POST /search starts asynchronous name screening. Supported products are sanctions_check (€0.39), adverse_media (€0.99), full_search (€5.90) and deep_research_report (€14.90). Execution and allowance rules depend on the product.
- GET /search/{search_id} retrieves a result owned by the calling account. Inspect status, then source findings. GET /search lists saved results; DELETE /search/{search_id} removes a saved result.
- POST /batch accepts CSV or XLSX files up to 2 MB and 100 rows, with one supported search type for the file. Poll the returned batch identifier. Deep Research Report is not a batch product.
- GET /account/credits reports allowances and prepaid balance. Usage units are distinct from euro-denominated prepaid charges. Read the returned billing fields rather than multiplying credits_charged by a guessed price.
- Coverage endpoints expose the published screening source inventory. A source name is not evidence that a subject matched it; use the findings attached to the completed search.
- POST /crypto-address/checks returns a synchronous Crypto Address Check. Supply X-API-Key, a required Idempotency-Key and max_prepaid_cents: 39. GET /crypto-address/checks/{id} retrieves the saved result. This product has no PDF endpoint or batch mode.
- Authentication and permissions: a missing or invalid key is rejected; grant only the required scopes. Key-management endpoints use the account bearer token rather than a screening API key.
- Retries and limits: honor Retry-After on HTTP 429. Reuse the same idempotency key and payload when retrying supported POST operations. Do not assume all POST endpoints support idempotency.
- Use the OpenAPI schema for request field names and the contracts it declares. Validate generated clients against the product guides and actual responses: the Crypto Address Check success payload is not fully typed in this schema.
Code samples
curl https://screenveritai.com/openapi.json -o screenveritai-openapi.jsonAuthoritative references
Questions
Frequently asked questions
Where is the machine-readable API contract?
The public static OpenAPI schema is at /openapi.json. The live v1 schema and interactive documentation are at /api/v1/openapi.json and /api/v1/docs.
Is Crypto Address Check the same as sanctions name screening?
No. It is a separate API-only check of an exact wallet identifier against OFAC identifiers, with optional native-USDC issuer-block status on Ethereum. It does not trace transactions, score exposure or monitor wallets.
Start screening in minutes.
Choose a plan and start screening today.