Developer Guides

    Your First Screening API Request

    Create a scoped API key, submit a name for sanctions and PEP/RCA screening, and poll the saved result. A runnable REST quickstart with retry guidance.

    Updated

    Start with a Quick Check for sanctions, PEP/RCA and criminal watchlists. Create an account, fund the selected product or use an eligible subscription allowance, then create a scoped API key in the dashboard. Keep the key on your server. A name-screening request returns HTTP 202 and a search_id; save that identifier and retrieve the result until processing completes. The €0.39 Quick Check price is per check, with a €5 minimum prepaid top-up.

    What this workflow covers

    • 1. Create a key with search:write and search:read permissions in the API keys dashboard. Send it through X-API-Key; never place it in browser code.
    • 2. Submit entity_name and search_type: sanctions_check to POST /api/v1/search. entity_type can be person, company or any. Keep optional identity information for your reviewer; it does not turn Quick Check into an identity-verification service.
    • 3. Save search_id from the HTTP 202 response. Poll GET /api/v1/search/{search_id} with bounded backoff. HTTP 200 can still carry a processing status: wait for status: completed and inspect the returned findings.
    • 4. Route failed, timed-out or unresolved checks into review rather than treating them as clearance. Retain the submitted identity, result identifier and source findings in your own case record.
    • 5. Reuse the same Idempotency-Key and payload for transport retries. For request_in_progress_or_uncertain, poll the supplied search_id instead of creating another key. Batch uploads do not support this header.
    • 6. Crypto Address Check is a separate synchronous, prepaid endpoint. Use the dedicated crypto reference for its required Idempotency-Key and budget cap.

    Code samples

    Submit a Quick Checkbash
    curl -X POST https://screenveritai.com/api/v1/search \
      -H 'X-API-Key: YOUR_API_KEY' \
      -H 'Content-Type: application/json' \
      -H 'Idempotency-Key: onboarding-example-001' \
      -d '{"entity_name":"Test Person","entity_type":"person","search_type":"sanctions_check"}'
    
    # HTTP 202: save the returned search_id.
    Retrieve the resultbash
    curl https://screenveritai.com/api/v1/search/SEARCH_ID \
      -H 'X-API-Key: YOUR_API_KEY'
    
    # Continue polling while status is processing.
    # Review sanctions, pep and criminal_watchlists when status is completed.

    Authoritative references

    Questions

    Frequently asked questions

    Do I need a browser session to call the screening API?

    No. Screening calls use a scoped X-API-Key. Creating or managing keys uses the account dashboard or authenticated key-management endpoints.

    Does HTTP 200 mean the subject passed screening?

    No. It means the result request succeeded. Check processing status and review the findings. A possible match is evidence for review, not an automatic decision.

    Start screening in minutes.

    Choose a plan and start screening today.