Skip to main content
POST
Set a test outcome

Authorizations

X-API-Key
string
header
required

Your workspace public key (pk_test_… or pk_live_…).

X-HMAC-Signature
string
header
required

HMAC-SHA256 of the request, hex-encoded, keyed with the workspace secret key. See API authentication.

Path Parameters

verification
string<uuid>
required

The verification ID

Body

application/json
status
enum<string>
required

The outcome to set: approved, declined, review or resubmission_requested.

Available options:
approved,
declined,
review,
resubmission_requested
reason
string | null

A note kept with a resubmission_requested outcome in the verification's history. It is not the decision reason code.

Maximum string length: 1000

Response

The verification with its new status.

id
string
required
external_id
string | null
required
external_metadata
object | null
required
redirect_url
string | null
required
status
string
required
reason
string | null
required
duplicate_check
object
required
erasure
object | null
required
created_at
string
required
updated_at
string
required