sessions

Create Verification Session

Create a new verification session.

Validates country code, per-session check overrides, workflow reference, and redirect URL. Generates a capture URL with QR code. Fires a session.created webhook and logs the action.

Returns: SessionResponse with session ID, capture URL, and QR data URL.

post/api/v1/sessions

Request

  • Base URL: https://api.withverifa.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.withverifa.com/api/v1/sessions
  • Auth: none declared

Request body

external_refstring nullable
metadataobject nullable
countrystring nullable
checksstring[] nullable
workflow_idstring nullable
redirect_urlstring nullable
send_emailboolean
applicant_namestring nullable
applicant_emailstring nullable
display_namestring nullable
support_urlstring nullable
expires_ininteger nullable

Response

Successful Response

idstring required
statusstring required
external_refstring nullable required
capture_urlstring required
qr_code_data_urlstring nullable
is_sandboxboolean
created_atstring required
expires_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.