Skip to main content
Starts a QID verification session and returns the provider verification link.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

vc-verify

Verify journey access

Body

The QID verification initiation request.

Request used to initiate a QID identity verification session.

metadata
string | null

Optional metadata that will be passed through the QID verification process.

Example:

"customer-12345"

livenessCheckEnabled
boolean

Enables liveness detection during identity verification.

Example:

true

modeId
string | null

Verification mode identifier.

Example:

"LIGHT"

locationEnabled
boolean

Enables collection of device location during verification.

Example:

true

tmpCallbackUrl
string | null

Temporary callback URL used for development environments.

Example:

"https://example.ngrok.io/journey/qid-callback"

Response

Error

Response returned when a verification or QID journey link is generated.

url
string | null

The URL that the subject should open to start or continue the verification journey.

Example:

"https://verify.securecitizen.cloud/Ab12Xy"

pin
string | null

The unique pin associated with the generated verification flow.

Example:

"Ab12Xy"

message
string | null

Status message describing the result of the request.

Example:

"Success"

isSuccessful
boolean
read-only

Indicates whether the request completed successfully.