Starts a QID verification session and returns the provider verification link.
curl --request POST \
--url https://verify.dev.securecitizen.cloud/journey/generate-qid-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": "customer-12345",
"livenessCheckEnabled": true,
"modeId": "LIGHT",
"locationEnabled": true,
"tmpCallbackUrl": "https://example.ngrok.io/journey/qid-callback"
}
'import requests
url = "https://verify.dev.securecitizen.cloud/journey/generate-qid-link"
payload = {
"metadata": "customer-12345",
"livenessCheckEnabled": True,
"modeId": "LIGHT",
"locationEnabled": True,
"tmpCallbackUrl": "https://example.ngrok.io/journey/qid-callback"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: 'customer-12345',
livenessCheckEnabled: true,
modeId: 'LIGHT',
locationEnabled: true,
tmpCallbackUrl: 'https://example.ngrok.io/journey/qid-callback'
})
};
fetch('https://verify.dev.securecitizen.cloud/journey/generate-qid-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://verify.dev.securecitizen.cloud/journey/generate-qid-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'metadata' => 'customer-12345',
'livenessCheckEnabled' => true,
'modeId' => 'LIGHT',
'locationEnabled' => true,
'tmpCallbackUrl' => 'https://example.ngrok.io/journey/qid-callback'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verify.dev.securecitizen.cloud/journey/generate-qid-link"
payload := strings.NewReader("{\n \"metadata\": \"customer-12345\",\n \"livenessCheckEnabled\": true,\n \"modeId\": \"LIGHT\",\n \"locationEnabled\": true,\n \"tmpCallbackUrl\": \"https://example.ngrok.io/journey/qid-callback\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://verify.dev.securecitizen.cloud/journey/generate-qid-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": \"customer-12345\",\n \"livenessCheckEnabled\": true,\n \"modeId\": \"LIGHT\",\n \"locationEnabled\": true,\n \"tmpCallbackUrl\": \"https://example.ngrok.io/journey/qid-callback\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://verify.dev.securecitizen.cloud/journey/generate-qid-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": \"customer-12345\",\n \"livenessCheckEnabled\": true,\n \"modeId\": \"LIGHT\",\n \"locationEnabled\": true,\n \"tmpCallbackUrl\": \"https://example.ngrok.io/journey/qid-callback\"\n}"
response = http.request(request)
puts response.read_body{
"url": "https://verify.securecitizen.cloud/Ab12Xy",
"pin": "Ab12Xy",
"message": "Success",
"isSuccessful": true
}Journey API
Starts a QID verification session and returns the provider verification link.
This endpoint initiates a QID verification request through the configured QID service. A callback URL is generated automatically from the current host and passed to the provider.
For local development only, if the request host is localhost and TmpCallbackUrl is supplied,
that temporary callback URL is used instead of the generated one.
The authenticated caller must contain a client_id claim.
Starts a QID verification session and returns the provider verification link.
curl --request POST \
--url https://verify.dev.securecitizen.cloud/journey/generate-qid-link \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metadata": "customer-12345",
"livenessCheckEnabled": true,
"modeId": "LIGHT",
"locationEnabled": true,
"tmpCallbackUrl": "https://example.ngrok.io/journey/qid-callback"
}
'import requests
url = "https://verify.dev.securecitizen.cloud/journey/generate-qid-link"
payload = {
"metadata": "customer-12345",
"livenessCheckEnabled": True,
"modeId": "LIGHT",
"locationEnabled": True,
"tmpCallbackUrl": "https://example.ngrok.io/journey/qid-callback"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metadata: 'customer-12345',
livenessCheckEnabled: true,
modeId: 'LIGHT',
locationEnabled: true,
tmpCallbackUrl: 'https://example.ngrok.io/journey/qid-callback'
})
};
fetch('https://verify.dev.securecitizen.cloud/journey/generate-qid-link', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://verify.dev.securecitizen.cloud/journey/generate-qid-link",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'metadata' => 'customer-12345',
'livenessCheckEnabled' => true,
'modeId' => 'LIGHT',
'locationEnabled' => true,
'tmpCallbackUrl' => 'https://example.ngrok.io/journey/qid-callback'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verify.dev.securecitizen.cloud/journey/generate-qid-link"
payload := strings.NewReader("{\n \"metadata\": \"customer-12345\",\n \"livenessCheckEnabled\": true,\n \"modeId\": \"LIGHT\",\n \"locationEnabled\": true,\n \"tmpCallbackUrl\": \"https://example.ngrok.io/journey/qid-callback\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://verify.dev.securecitizen.cloud/journey/generate-qid-link")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metadata\": \"customer-12345\",\n \"livenessCheckEnabled\": true,\n \"modeId\": \"LIGHT\",\n \"locationEnabled\": true,\n \"tmpCallbackUrl\": \"https://example.ngrok.io/journey/qid-callback\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://verify.dev.securecitizen.cloud/journey/generate-qid-link")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metadata\": \"customer-12345\",\n \"livenessCheckEnabled\": true,\n \"modeId\": \"LIGHT\",\n \"locationEnabled\": true,\n \"tmpCallbackUrl\": \"https://example.ngrok.io/journey/qid-callback\"\n}"
response = http.request(request)
puts response.read_body{
"url": "https://verify.securecitizen.cloud/Ab12Xy",
"pin": "Ab12Xy",
"message": "Success",
"isSuccessful": true
}Authorizations
Body
application/jsontext/jsonapplication/*+json
The QID verification initiation request.
Request used to initiate a QID identity verification session.
Response
Error
Response returned when a verification or QID journey link is generated.

