For the complete documentation index, see llms.txt. This page is also available as Markdown.

SVX Verify

List SVX Verify sessions

get

List SVX Verify sessions with pagination and optional filters. Each session record contains current processing/submission status, metadata (created/updated timestamps), and a summary of any verified claims collected so far.

Authorizations
AuthorizationstringOptional
Bearer authentication header of the form Bearer <token>.
Query parameters
orderstring · enumOptionalPossible values:
order_bystring · enumOptionalPossible values:
per_pageinteger · min: 1 · max: 50Optional
pageinteger · min: 1Optional
submission_statusstring · enumOptionalPossible values:
created_at_fromstring · date-timeOptional
created_at_tostring · date-timeOptional
updated_at_fromstring · date-timeOptional
updated_at_tostring · date-timeOptional
Responses
200

SVX Verify sessions successfully loaded

application/json
get/verify/sessions

Create an SVX Verify session

post

Create an SVX Verify session for a configured presentation template. This server-side call initiates a hosted identity verification flow and returns a session identifier and a redirect URL. Use the returned id to poll session status or to fetch verified claims after the user completes the hosted flow.

Authorizations
AuthorizationstringOptional
Bearer authentication header of the form Bearer <token>.
Body
return_urlstring · uriRequired

URI to return to when the verification flow exits or is aborted.

Example: meeco://verify/return
success_urlstring · uriRequired

URI to return to after a successful verification flow.

Example: meeco://verify/success
presentation_template_idstring · uuidRequired

Whitelisted presentation template identifier to use for this session.

Example: 43345678-1234-4234-a234-123456789012
Responses
201

SVX Verify session created

application/json
idstring · uuidRequired

Created session identifier.

Example: 7dcfa413-bff0-4f62-a51a-ab9959623332
urlstring · uriRequired

Verification URL for the browser-based verification flow.

Example: https://wallet.example.com/verify/verification/7dcfa413-bff0-4f62-a51a-ab9959623332
post/verify/sessions

Get an SVX Verify session

get

Retrieve an SVX Verify session by identifier. The response includes the session status, redirect URLs, lifecycle timestamps, and any verified claims produced by the hosted verification flow. Sessions may expire; use the id returned by the create call to locate results after the user returns from the hosted experience.

Authorizations
AuthorizationstringOptional
Bearer authentication header of the form Bearer <token>.
Path parameters
idstring · uuidRequired
Responses
200

SVX Verify session loaded

application/json
session_idstring · uuidRequired

SVX Verify session identifier.

Example: 7dcfa413-bff0-4f62-a51a-ab9959623332
statusstring · enumRequired

Current verification status for the session.

Possible values:
errorstring · nullableOptional

Error code recorded against the session when verification fails.

error_descriptionstring · nullableOptional

Human-readable description of the recorded session error.

get/verify/sessions/{id}

Get an SVX Verify presentation request JWT

get

Retrieve the raw signed JWT presentation request associated with an SVX Verify session. Clients use this JWT when a raw authorization/request token is required by downstream components or wallets. Depending on configuration (svx_verify.policy.presentation_request_multiple_loads_enabled) the JWT may be single-use and readable only once.

Path parameters
idstring · uuidRequired
Responses
200

Presentation request JWT successfully loaded

application/jwt
stringOptional
get/verify/verification/{id}/request

Get SVX Verify presentation status

get

Retrieve the current processing status for an SVX Verify session and brief verification result metadata. This endpoint is intended to be polled from the browser during the hosted flow and therefore may require the session cookie established by the verification UI.

Path parameters
idstring · uuidRequired
Responses
200

Presentation status successfully loaded

application/json
idstring · uuidRequired

SVX Verify session identifier.

Example: 7dcfa413-bff0-4f62-a51a-ab9959623332
statusstring · enumRequired

Current state of the presentation request processing.

Possible values:
errorstring · nullableRequired

Error code returned while the request is still pending.

error_descriptionstring · nullableRequired

Human-readable description for the current error, when present.

get/verify/verification/{id}/status

Accept SVX Verify terms

post

Mark the verification session's terms and conditions as accepted for the current SVX Verify flow. Intended to be called from the hosted verification UI; this operation typically requires the session cookie established during the browser-based flow.

Path parameters
idstring · uuidRequired
Responses
200

Terms accepted

application/json
objectOptional
post/verify/verification/{id}/accept_terms

Last updated