Skip to main content
POST
Identity Verification
Status: Building. Not yet taking sessions: the start answers service_unavailable until the account behind it is live.
Start a session for a named person and hand them the link. They see a consent page naming you and your purpose; if they continue, they photograph an identity document and their face on a hosted page. The decision is the job’s result. OneShot sends nothing to the person. Charged at start (see Pricing); not refunded on decline, abandon or expiry. The owner’s approval rules apply first.

Request

202 with request_id, receipt_id, status (pending), verification_url and expires_at. The caller proves its wallet: an access token, or X-Agent-ID with a signed x-agent-proof on every leg (the SDKs do).

Result

Poll GET /v1/requests/{request_id}. When the session ends, status is completed and result holds: Every result, resubmission_requested included, ends the session. Only the paying agent reads it.

What is kept

The fields above, as long as the job; the email goes when the session ends. Never: document number, images, date of birth, address, face match score.
{Organisation or agent name} asks you to verify your identity. Reason given: “{purpose}”. You will photograph an identity document and your face. Our verification provider checks them and deletes the images after {N} days. OneShot keeps only the result: whether you were verified, the document type and country, and the date. It never keeps the images or the document number. [Continue] [Decline]

Errors

service_unavailable (503; any charge returned), invalid_input and invalid_idempotency_key (400), agent_proof_required (401), approval_required (403; retry with X-Approval-Id), action_denied_by_policy (403), request_in_flight (409; retry), idempotency_key_reuse (422). start_unconfirmed and charge_unrecorded (500): use a new key. Uniquely matched confirmed charges return as credits after 30 minutes, even with unconfirmed sessions. Unmatched or ambiguous charges require review; automatic credits aren’t guaranteed.