GET
/
v1
/
verifications
/
{id}
Retrieve a verification
curl --request GET \
  --url https://sandbox.authbound.io/v1/verifications/{id} \
  --header 'X-Authbound-Key: <api-key>'
{
  "id": "vrf_abc123",
  "object": "verification",
  "policy_id": "pol_age_over_18_authbound_v1",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "policy_hash": "<string>",
  "provider": "eudi",
  "client_action": {
    "data": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  },
  "verification_url": "<string>",
  "customer_user_ref": "<string>",
  "metadata": {},
  "terminal_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-Authbound-Key
string
header
required

Server-side secret key header. Format: sk_live_* (production) or sk_test_* (testing).

Path Parameters

id
string
required

Verification ID. Runtime IDs may be UUIDs during alpha; external IDs use vrf_*.

Pattern: ^(vrf_[a-zA-Z0-9_-]+|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Verification details

id
string
required

Unique identifier

Example:

"vrf_abc123"

object
enum<string>
required
Available options:
verification
env_mode
enum<string>
required
Available options:
test,
live
status
enum<string>
required
Available options:
created,
awaiting_user,
awaiting_provider,
processing,
verified,
failed,
canceled,
expired
policy_id
string
required
Example:

"pol_age_over_18_authbound_v1"

created_at
string<date-time>
required
expires_at
string<date-time>
required
policy_hash
string

SHA-256 hash of policy at creation time

provider
enum<string>

Selected provider ID

Available options:
eudi
Example:

"eudi"

failure_code
enum<string> | null

Reason for failure (only when status=failed)

Available options:
presentation_invalid,
credential_expired,
credential_revoked,
issuer_untrusted,
policy_not_satisfied,
processing_timeout,
provider_error,
user_declined,
wallet_error,
null
client_action
object

Action data for user to complete verification

verification_url
string<uri>

Link to the hosted verification page, returned on create when the installation has one, while the verification can still be handed to a wallet and its response mode is not dc_api.jwt. Its fragment carries the client token and the publishable key, so it is a bearer link. Redirect the user's browser to it; never show it as a QR code or write it to a log. For the wallet handoff, use client_action.data.

customer_user_ref
string

Your reference for the end user

metadata
object

Custom metadata

terminal_at
string<date-time> | null

When verification reached terminal state