{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/guides/sidebars.yaml","api-docs-docs/openapi/verification-v1.yaml":"api-docs-docs/openapi/verification-v1.yaml"},"props":{"metadata":{"markdoc":{"tagList":["openapi-code-sample","json-schema","admonition"]},"type":"markdown"},"seo":{"title":"Verification Flow"},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"verification-flow","__idx":0},"children":["Verification Flow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide explains the full lifecycle of an identity verification session — from creation to result retrieval."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An API credential with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deepcredentials.verify"]}," scope. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/authentication"},"children":["Authentication"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A credential definition configured in your organization."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"session-lifecycle","__idx":2},"children":["Session lifecycle"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"stateDiagram-v2\n [*] --> pending: POST /verification-sessions\n pending --> success: User presents valid credentials\n pending --> failed: Presentation rejected or invalid\n pending --> expired: Session TTL exceeded\n success --> [*]\n failed --> [*]\n expired --> [*]\n","diagramHtml":"

POST /verification-sessions

User presents valid credentials

Presentation rejected or invalid

Session TTL exceeded

pending

success

failed

expired

","diagramHtmlDark":"

POST /verification-sessions

User presents valid credentials

Presentation rejected or invalid

Session TTL exceeded

pending

success

failed

expired

"},"children":["stateDiagram-v2\n [*] --> pending: POST /verification-sessions\n pending --> success: User presents valid credentials\n pending --> failed: Presentation rejected or invalid\n pending --> expired: Session TTL exceeded\n success --> [*]\n failed --> [*]\n expired --> [*]\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"statuses","__idx":3},"children":["Statuses"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status    "]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Session created, waiting for user to scan QR and present credentials."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["success"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credentials verified successfully. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_subject_data"]}," contains the disclosed claims. Check ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_status"]}," too — a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suspended"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revoked"]}," credential still reports ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["success"]}," here."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Verification failed. Check ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error_code"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error_description"]}," for details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Session exceeded its TTL without completion."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-a-session","__idx":4},"children":["Step 1: Create a session"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/verification-v1"},"children":["Open in API reference →"]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-docs/openapi/verification-v1.yaml","operationId":"POST:b2b.Verify","parameters":{},"requestBody":{"credential_definition_id":"YOUR_CREDENTIAL_DEFINITION_ID","claims":["family_name","given_name","date_of_birth"],"reference_id":"order-12345","purpose":"Age verification for purchase"},"environments":{"https://api.dev.deepcredentials.swiss":{"BearerAuth":"YOUR_ACCESS_TOKEN"}},"environment":"https://api.dev.deepcredentials.swiss","codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X POST \\\n https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions \\\n -H 'Content-Type: application/json' \\\n -H 'X-Environment: beta' \\\n -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \\\n -d '{\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"claims\": [\n \"family_name\",\n \"given_name\",\n \"date_of_birth\"\n ],\n \"reference_id\": \"order-12345\",\n \"purpose\": \"Age verification for purchase\"\n }'"},{"lang":"javascript","title":"JavaScript","source":"const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions`,\n {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n },\n body: JSON.stringify({\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n claims: [\n 'family_name',\n 'given_name',\n 'date_of_birth'\n ],\n reference_id: 'order-12345',\n purpose: 'Age verification for purchase'\n })\n }\n);\n\nconst data = await resp.json();\nconsole.log(data);"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions`,\n {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n },\n body: JSON.stringify({\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n claims: [\n 'family_name',\n 'given_name',\n 'date_of_birth'\n ],\n reference_id: 'order-12345',\n purpose: 'Age verification for purchase'\n })\n }\n );\n\n const data = await resp.json();\n console.log(data);\n}\n\nrun();"},{"lang":"python","title":"Python","source":"import requests\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions\"\n\npayload = {\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"claims\": [\n \"family_name\",\n \"given_name\",\n \"date_of_birth\"\n ],\n \"reference_id\": \"order-12345\",\n \"purpose\": \"Age verification for purchase\"\n}\n\nheaders = {\n \"Content-Type\": \"application/json\",\n \"X-Org-Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"X-Environment\": \"beta\"\n}\n\nresponse = requests.post(url, json=payload, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\n\npublic class App {\n public static void main(String[] args) throws Exception {\n var httpClient = HttpClient.newBuilder().build();\n\n var payload = String.join(\"\\n\"\n , \"{\"\n , \" \\\"credential_definition_id\\\": \\\"YOUR_CREDENTIAL_DEFINITION_ID\\\",\"\n , \" \\\"claims\\\": [\"\n , \" \\\"family_name\\\",\"\n , \" \\\"given_name\\\",\"\n , \" \\\"date_of_birth\\\"\"\n , \" ],\"\n , \" \\\"reference_id\\\": \\\"order-12345\\\",\"\n , \" \\\"purpose\\\": \\\"Age verification for purchase\\\"\"\n , \"}\"\n );\n\n var host = \"https://api.dev.deepcredentials.swiss\";\n var pathname = \"/b2b/v1/verification-sessions\";\n var request = HttpRequest.newBuilder()\n .POST(HttpRequest.BodyPublishers.ofString(payload))\n .uri(URI.create(host + pathname ))\n .header(\"Content-Type\", \"application/json\")\n .header(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n .header(\"X-Environment\", \"beta\")\n .build();\n\n var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\nusing System.Text;\nusing System.Text.Json;\n\npublic class Program\n{\n public static async Task Main()\n {\n System.Net.Http.HttpClient client = new()\n {\n DefaultRequestHeaders =\n {\n {\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\n {\"X-Environment\", \"beta\"},\n }\n };\n\n string json = JsonSerializer.Serialize(new\n {\n credential_definition_id = \"YOUR_CREDENTIAL_DEFINITION_ID\",\n claims = new[] {\n \"family_name\",\n \"given_name\",\n \"date_of_birth\"\n },\n reference_id = \"order-12345\",\n purpose = \"Age verification for purchase\"\n });\n\n using StringContent postData = new(json, Encoding.UTF8, \"application/json\");\n using HttpResponseMessage request = await client.PostAsync(\"https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions\", postData);\n string response = await request.Content.ReadAsStringAsync();\n\n Console.WriteLine(response);\n }\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\n$curl = curl_init();\n\n$payload = array(\n \"credential_definition_id\" => \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"claims\" => array(\n \"family_name\",\n \"given_name\",\n \"date_of_birth\"\n ),\n \"reference_id\" => \"order-12345\",\n \"purpose\" => \"Age verification for purchase\"\n);\n\ncurl_setopt_array($curl, [\n CURLOPT_HTTPHEADER => [\n \"Content-Type: application/json\",\n \"X-Environment: beta\",\n \"X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n CURLOPT_POSTFIELDS => json_encode($payload),\n CURLOPT_URL => \"https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n echo \"cURL Error #:\" . $error;\n} else {\n echo $response;\n}"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n \"fmt\"\n \"bytes\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n reqUrl := \"https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions\"\n var data = []byte(`{\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"claims\": [\n \"family_name\",\n \"given_name\",\n \"date_of_birth\"\n ],\n \"reference_id\": \"order-12345\",\n \"purpose\": \"Age verification for purchase\"\n }`)\n req, err := http.NewRequest(\"POST\", reqUrl, bytes.NewBuffer(data))\n if err != nil {\n panic(err)\n }\n req.Header.Add(\"Content-Type\", \"application/json\")\n req.Header.Add(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n req.Header.Add(\"X-Environment\", \"beta\")\n res, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer res.Body.Close()\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(res)\n fmt.Println(string(body))\n}"},{"lang":"ruby","title":"Ruby","source":"require 'json'\nrequire 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI('https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions')\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest['Content-Type'] = 'application/json'\nrequest['X-Org-Id'] = '497f6eca-6276-4993-bfeb-53cbbbba6f08'\nrequest['X-Environment'] = 'beta'\nrequest.body = {\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n claims: [\n 'family_name',\n 'given_name',\n 'date_of_birth'\n ],\n reference_id: 'order-12345',\n purpose: 'Age verification for purchase'\n}.to_json\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"r","title":"R","source":"library(httr)\n\nbody = '{\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"claims\": [\n \"family_name\",\n \"given_name\",\n \"date_of_birth\"\n ],\n \"reference_id\": \"order-12345\",\n \"purpose\": \"Age verification for purchase\"\n}'\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions\"\n\ndata_req <- POST(\n url,\n add_headers(\"Content-Type\" = \"application/json\", \"X-Org-Id\" = \"497f6eca-6276-4993-bfeb-53cbbbba6f08\", \"X-Environment\" = \"beta\"),\n body = body,\n encode = \"json\",\n verbose()\n)\n\ncontent(data_req)"},{"lang":"json","title":"Payload application/json","source":"{\n \"allowed_issuer_dids\": [\n \"string\"\n ],\n \"case_id\": \"c74269e5-1f97-4e20-9164-ffbe3494d8d6\",\n \"claims\": [\n \"string\"\n ],\n \"credential_definition_id\": \"631a1b36-dbe6-4899-b427-3167b0844238\",\n \"purpose\": \"string\",\n \"reference_id\": \"string\"\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":5},"children":["Response"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../openapi/verification-v1.yaml#/paths/~1b2b~1v1~1verification-sessions/post/responses/200/content/application~1json/schema"},"options":{"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/schema"},"verification.SessionStatus":{"type":"string","enum":["pending","success","failed","expired"],"description":"Lifecycle state of a verification session."},"schema":{"properties":{"deeplink":{"description":"Wallet app link, e.g. openid4vp://?client_id=...&request_uri=...","type":"string"},"expires_at":{"format":"date-time","description":"Session TTL deadline (RFC3339).","type":"string"},"qr_content_base64":{"description":"Base64-encoded PNG; QR payload is the same URI as deeplink.","type":"string"},"session_id":{"type":"string","format":"uuid","description":"UUID v4 identifier.","example":"550e8400-e29b-41d4-a716-446655440000"},"status":{"$ref":"#/components/schemas/verification.SessionStatus"}},"required":["session_id","qr_content_base64","deeplink","status","expires_at"],"type":"object"}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-present-the-qr-code","__idx":6},"children":["Step 2: Present the QR code"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You have two options to present the verification request to the user:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"qr-code-desktop--in-person","__idx":7},"children":["QR code (desktop / in-person)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["qr_content_base64"]}," field is a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["standard Base64-encoded PNG image"]},". Display it directly:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"\"Scan\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Or decode it to a file:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"import base64\n\npng_bytes = base64.b64decode(qr_content_base64)\nwith open(\"qr.png\", \"wb\") as f:\n f.write(png_bytes)\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"deeplink-mobile","__idx":8},"children":["Deeplink (mobile)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deeplink"]}," field contains a URI that opens the wallet app directly:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"swiyu-verify://?client_id=...&request_uri=...\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this when the user is on a mobile device — redirect them to the deeplink instead of showing a QR code."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-retrieve-the-result","__idx":9},"children":["Step 3: Retrieve the result"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"option-a-polling","__idx":10},"children":["Option A: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/verification-v1"},"children":["Polling"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Poll ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /b2b/v1/verification-sessions/{sessionId}"]}," until the status is no longer ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},":"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/verification-v1"},"children":["Open in API reference →"]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-docs/openapi/verification-v1.yaml","operationId":"GET:b2b.GetVerificationSession","parameters":{"path":{"sessionId":"770e8400-e29b-41d4-a716-446655440000"}},"environments":{"https://api.dev.deepcredentials.swiss":{"BearerAuth":"YOUR_ACCESS_TOKEN"}},"environment":"https://api.dev.deepcredentials.swiss","codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X GET \\\n https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions/770e8400-e29b-41d4-a716-446655440000 \\\n -H 'X-Environment: beta' \\\n -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'"},{"lang":"javascript","title":"JavaScript","source":"const sessionId = '770e8400-e29b-41d4-a716-446655440000';\nconst resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions/${sessionId}`,\n {\n method: 'GET',\n headers: {\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n }\n }\n);\n\nconst data = await resp.text();\nconsole.log(data);"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n const sessionId = '770e8400-e29b-41d4-a716-446655440000';\n const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions/${sessionId}`,\n {\n method: 'GET',\n headers: {\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n }\n }\n );\n\n const data = await resp.text();\n console.log(data);\n}\n\nrun();"},{"lang":"python","title":"Python","source":"import requests\n\nsession_id = \"770e8400-e29b-41d4-a716-446655440000\"\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions/\" + session_id\n\nheaders = {\n \"X-Org-Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"X-Environment\": \"beta\"\n}\n\nresponse = requests.get(url, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\n\npublic class App {\n public static void main(String[] args) throws Exception {\n var httpClient = HttpClient.newBuilder().build();\n\n var host = \"https://api.dev.deepcredentials.swiss\";\n var sessionId = \"770e8400-e29b-41d4-a716-446655440000\";\n var pathname = \"/b2b/v1/verification-sessions/%7BsessionId%7D\";\n var request = HttpRequest.newBuilder()\n .GET()\n .uri(URI.create(host + pathname ))\n .header(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n .header(\"X-Environment\", \"beta\")\n .build();\n\n var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\n\npublic class Program\n{\n public static async Task Main()\n {\n System.Net.Http.HttpClient client = new()\n {\n DefaultRequestHeaders =\n {\n {\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\n {\"X-Environment\", \"beta\"},\n }\n };\n\n var SessionId = \"770e8400-e29b-41d4-a716-446655440000\";\n using HttpResponseMessage request = await client.GetAsync(\"https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions/\" + SessionId);\n string response = await request.Content.ReadAsStringAsync();\n\n Console.WriteLine(response);\n }\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\nconst sessionId = \"770e8400-e29b-41d4-a716-446655440000\";\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_HTTPHEADER => [\n \"X-Environment: beta\",\n \"X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n CURLOPT_URL => \"https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions/\" . sessionId,\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n echo \"cURL Error #:\" . $error;\n} else {\n echo $response;\n}"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n \"fmt\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n sessionId := \"770e8400-e29b-41d4-a716-446655440000\";\n reqUrl := \"https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions/\" + sessionId\n req, err := http.NewRequest(\"GET\", reqUrl, nil)\n if err != nil {\n panic(err)\n }\n req.Header.Add(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n req.Header.Add(\"X-Environment\", \"beta\")\n res, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer res.Body.Close()\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(res)\n fmt.Println(string(body))\n}"},{"lang":"ruby","title":"Ruby","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nsession_id = '770e8400-e29b-41d4-a716-446655440000'\nurl = URI('https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions/' + session_id)\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest['X-Org-Id'] = '497f6eca-6276-4993-bfeb-53cbbbba6f08'\nrequest['X-Environment'] = 'beta'\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"r","title":"R","source":"library(httr)\n\nsession_id = \"770e8400-e29b-41d4-a716-446655440000\"\n\n# create you own operator\n\"%&%\" <- function(x, y)paste0(x,y)\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/verification-sessions/\" %&% session_id\n\ndata_req <- GET(\n url,\n add_headers(\"X-Org-Id\" = \"497f6eca-6276-4993-bfeb-53cbbbba6f08\", \"X-Environment\" = \"beta\"),\n verbose()\n)\n\ncontent(data_req)"}]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-1","__idx":11},"children":["Response"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../openapi/verification-v1.yaml#/components/schemas/b2b.b2bSessionResponse"},"options":{"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/b2b.b2bSessionResponse"},"b2b.credentialDefinitionRef":{"properties":{"has_logo":{"description":"Whether the credential definition currently has an uploaded logo.","type":"boolean"},"id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"Credential definition UUID. UUID v4 identifier."},"name":{"description":"Human-readable credential definition name.","type":"string"},"vct":{"description":"Verifiable credential type (e.g. \"urn:ietf:params:oauth:vct:PersonId\").","type":"string"}},"required":["id","vct","name","has_logo"],"description":"A compact reference to the credential definition.","type":"object"},"verification.SessionStatus":{"type":"string","enum":["pending","success","failed","expired"],"description":"Lifecycle state of a verification session."},"b2b.b2bSessionResponse":{"properties":{"accepted_issuer_dids":{"items":{"type":"string"},"description":"Effective issuer allow-list for this session (may come from credential\ndefinition locks).","type":"array"},"completed_at":{"format":"date-time","description":"Set when the session leaves pending (success, failed, or expired).","type":"string"},"created_at":{"format":"date-time","description":"When the session was created (RFC3339).","type":"string"},"credential_definition":{"allOf":[{"$ref":"#/components/schemas/b2b.credentialDefinitionRef"}],"description":"Credential definition reference."},"credential_status":{"description":"On success: the token-status-list state of the credential the holder presented — \"valid\", \"suspended\" (shown as \"Locked\" in the portal), or \"revoked\". Resolved when the holder presented and never recomputed.\n\nA \"suspended\" or \"revoked\" value still accompanies a successful verification with its disclosed claims: the wallet can present such a credential and the holder can consent to sharing it, so the verifier is given the state and applies its own policy. Branch on this in addition to \\`status\\` if a locked credential should not be accepted.","type":"string"},"credential_subject_data":{"description":"On success: disclosed subject claims (structure depends on credential definition\nand wallet).","type":"object"},"credential_subject_types":{"additionalProperties":{"type":"string"},"description":"For sessions created through the deprecated `credential_definition_id` plus `claims`\nrequest shape, this maps requested claim names to the types configured on the credential\ndefinition. It is currently an empty object for sessions created with `case_id`.\nPartners using case-based verification must not rely on this field to infer disclosed-value types.","type":"object"},"deeplink":{"description":"Only when status is pending: wallet deep link (e.g. openid4vp://...).","type":"string"},"environment":{"description":"Swiyu environment: \"beta\" or \"production\" (matches the credential binding).","type":"string"},"error_code":{"description":"Machine-readable failure reason when status is failed or expired.","type":"string"},"error_description":{"description":"Human-readable error detail when status is failed or expired.","type":"string"},"expires_at":{"format":"date-time","description":"When a pending session expires if not completed (RFC3339).","type":"string"},"matched_vct":{"description":"On success: the vct of the credential the holder actually presented, relevant when the session accepts more than one credential type.","type":"string"},"purpose":{"description":"Purpose string from the create request, if any.","type":"string"},"qr_content_base64":{"description":"Only when status is pending: Base64 PNG QR code for the wallet.","type":"string"},"reference_id":{"description":"Your reference_id from the create request, if any.","type":"string"},"requested_fields":{"items":{"type":"string"},"description":"Claim keys requested in the presentation definition.","type":"array"},"session_id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"Session id (matches the value returned at creation time). UUID v4 identifier."},"status":{"allOf":[{"$ref":"#/components/schemas/verification.SessionStatus"}],"description":"Current lifecycle state of the session."}},"required":["session_id","status","expires_at","environment","credential_definition","requested_fields","credential_subject_types","created_at"],"description":"The current status and outcome of a verification session.","type":"object"}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["While ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},", only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["session_id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["qr_content_base64"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deeplink"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expires_at"]}," are populated. On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["success"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_subject_data"]}," contains the disclosed claims and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["qr_content_base64"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deeplink"]}," are omitted. Sessions created with the deprecated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_definition_id"]}," plus ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims"]}," shape populate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_subject_types"]}," from the definition. Case-based sessions currently return an empty object instead, so do not use that field to infer types in the preferred flow."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["success"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_status"]}," reports the token-status-list state of the credential the holder actually presented. Values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valid"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suspended"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revoked"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"A locked or revoked credential still verifies successfully"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suspended"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revoked"]}," arrive with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status: \"success\""]}," and the full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_subject_data"]},". This is not a bug: a wallet can present a locked or revoked credential and the holder can consent to sharing it, so the presentation genuinely verified — the issuer has simply since withdrawn the credential's validity."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Checking ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status == \"success\""]}," alone will accept a withdrawn credential."]}," If your integration must not accept one, branch on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_status"]}," in addition to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},"."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When status is no longer ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["qr_content_base64"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deeplink"]}," are omitted from the response — the wallet flow is complete."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Polling recommendations:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Poll every 2–3 seconds."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Stop when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["success"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Respect the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expires_at"]}," timestamp — stop polling after expiration."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"option-b-webhooks","__idx":12},"children":["Option B: Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For production integrations, opt in to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/webhook-events-v1"},"children":["Verification Completed"]}," webhook event. Its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," field is a slim terminal hint containing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["session_id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},", and, on successful status resolution, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_status"]},". Follow it with authenticated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /b2b/v1/verification-sessions/{sessionId}"]}," to reconcile the authoritative session and read disclosed fields. The callback is not a copy of the GET response."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/webhooks"},"children":["Webhooks guide"]}," for setup, signature verification, and secret rotation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-handling","__idx":13},"children":["Error handling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["On failure:"]}," the same response object is returned with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status: failed"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error_code"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error_description"]}," populated. See the full schema above."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["On a status-check failure:"]}," if the credential's token-status-list entry can't be fetched or its signature can't be verified, the session fails with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error_code: status_check_failed"]}," rather than being reported with an unknown or stale state. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_status"]}," is absent on such a session."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Status-check failures can originate from issuer infrastructure"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status_check_failed"]}," rejection may result from problems with the issuer's status-list infrastructure, not from a cryptographically invalid credential. For example, the issuer rotates its signing key and republishes the status list under the new key — credentials issued before the rotation reference the old key and can no longer have their list verified — or the issuer issues credentials with no status reference at all. In both cases, a valid credential is rejected and your session returns no claims. This is especially relevant when verifying credentials from issuers you do not operate."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["On expiration:"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sessions that remain ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}," past their ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expires_at"]}," transition to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]}," automatically."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/error-handling"},"children":["Error Handling"]}," for a complete list of error codes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":14},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/webhooks"},"children":["Webhooks"]}," — Receive verification results in real time."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/error-handling"},"children":["Error Handling"]}," — Handle all possible error scenarios."]}]}]},"headings":[{"value":"Verification Flow","id":"verification-flow","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Session lifecycle","id":"session-lifecycle","depth":2},{"value":"Statuses","id":"statuses","depth":3},{"value":"Step 1: Create a session","id":"step-1-create-a-session","depth":2},{"value":"Response","id":"response","depth":3},{"value":"Step 2: Present the QR code","id":"step-2-present-the-qr-code","depth":2},{"value":"QR code (desktop / in-person)","id":"qr-code-desktop--in-person","depth":3},{"value":"Deeplink (mobile)","id":"deeplink-mobile","depth":3},{"value":"Step 3: Retrieve the result","id":"step-3-retrieve-the-result","depth":2},{"value":"Option A: Polling","id":"option-a-polling","depth":3},{"value":"Response","id":"response-1","depth":3},{"value":"Option B: Webhooks","id":"option-b-webhooks","depth":3},{"value":"Error handling","id":"error-handling","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Verification Flow"}},"lastModified":"2026-08-19T08:56:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/guides/verification-flow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}