{"items":[{"type":"link","label":"Verification Cases API","link":"/docs/openapi/verification-cases-v1","routeSlug":"/docs/openapi/verification-cases-v1","content":{"contentType":"overview","meta":{"name":"Verification Cases API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"verification-cases-v1.json","url":"/_bundle/docs/openapi/verification-cases-v1.json?download"},{"kind":"download","label":"verification-cases-v1.yaml","url":"/_bundle/docs/openapi/verification-cases-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Verification Cases API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Author verification cases and launch them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A verification case is a rule: which credentials are accepted, which attributes are asked for, and the constraints their values must meet. It runs wherever its credentials are enabled ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"environments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), has a contract "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that moves on every change of what it asks for, and may carry your own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the object it guards. Launching a case starts a verification session, polled in the Verification API. Reading and launching require the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deepcredentials.verify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope; creating, changing and archiving require "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deepcredentials.verification-cases"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/docs/openapi/verification-cases-v1"}],"sectionId":"/docs/openapi/verification-cases-v1"}]}]}},{"type":"group","label":"Verification Cases","link":"/docs/openapi/verification-cases-v1/verification-cases","routeSlug":"/docs/openapi/verification-cases-v1/verification-cases","items":[{"label":"List verification cases.\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/verification-cases-v1/verification-cases/get:b2b.listverificationcases","routeSlug":"/docs/openapi/verification-cases-v1/verification-cases/get:b2b.listverificationcases","metadata":{"seo":{"title":"List verification cases.\n","description":"Returns the verification cases of the calling service user's organization (X-Org-Id) that run in its environment (X-Environment): those whose every accepted credential is enabled there. With `availability=all`, every case is returned with its `environments`, so an integration sees what it would have to enable. Launch a case with POST /b2b/v1/verification-cases/{caseId}/sessions. To check one credential definition without a case, create the session with `credential_definition_id` instead. Requires the deepcredentials.verify scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:b2b.ListVerificationCases","name":"List verification cases.\n","isWebhook":false,"pointer":"/paths/~1b2b~1v1~1verification-cases/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List verification cases.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the verification cases of the calling service user's organization (X-Org-Id) that run in its environment (X-Environment): those whose every accepted credential is enabled there. With `availability=all`, every case is returned with its `environments`, so an integration sees what it would have to enable. Launch a case with POST /b2b/v1/verification-cases/{caseId}/sessions. To check one credential definition without a case, create the session with `credential_definition_id` instead. Requires the deepcredentials.verify scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"DeepAdmin-issued Keycloak access token obtained via the OAuth 2.0\nResource Owner Password Credentials grant against the DeepCloud SSO\nrealm. See the Service Users guide for the exchange flow."}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"availability","in":"query","schemaId":"schema_0","description":"\"all\" returns every case with its environments; omitted, only the cases that run in X-Environment.\n"},{"name":"reference_id","in":"query","schemaId":"schema_1","description":"Your key for the case: at most one case.\n"},{"name":"archived","in":"query","schemaId":"schema_2","description":"\"exclude\" (default), \"only\" or \"include\": the working list, your archive, or both.\n"}],"pointer":"/paths/~1b2b~1v1~1verification-cases/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Org-Id","in":"header","schemaId":"schema_3","description":"Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.","required":true},{"name":"X-Environment","in":"header","schemaId":"schema_4","description":"Environment the call is scoped to. Resources are isolated per environment.","required":true}],"pointer":"/paths/~1b2b~1v1~1verification-cases/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/b2b/v1/verification-cases","servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"parameters":{"path":[],"query":[{"name":"availability","in":"query","required":false,"schemaId":"schema_0","style":"form","explode":true},{"name":"reference_id","in":"query","required":false,"schemaId":"schema_1","style":"form","explode":true},{"name":"archived","in":"query","required":false,"schemaId":"schema_2","style":"form","explode":true}],"querystring":[],"header":[{"name":"X-Org-Id","in":"header","required":true,"schemaId":"schema_3"},{"name":"X-Environment","in":"header","required":true,"schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/b2b/v1/verification-cases","href":"verification-cases/get:b2b.listverificationcases","openApiOperationId":"GET:b2b.ListVerificationCases","summary":"List verification cases.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_5","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request. Common causes: missing or malformed X-Org-Id / X-Environment headers, or a missing required field in the request body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthenticated. The Bearer token failed validation (signature, issuer, audience, or expiry).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission denied. The token does not carry the scope required by this endpoint. Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim on the token you received from the DeepCloud SSO token endpoint."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1b2b~1v1~1verification-cases/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_5","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-cases/get:b2b.listverificationcases"}],"panels":[]}]},"httpPath":"/b2b/v1/verification-cases"},{"label":"Create a verification case.\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/verification-cases-v1/verification-cases/post:b2b.createverificationcase","routeSlug":"/docs/openapi/verification-cases-v1/verification-cases/post:b2b.createverificationcase","metadata":{"seo":{"title":"Create a verification case.\n","description":"Creates a verification case owned by your organization, at version 1. It runs wherever every credential it accepts is enabled (`environments`). Requires the deepcredentials.verification-cases scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST:b2b.CreateVerificationCase","name":"Create a verification case.\n","isWebhook":false,"pointer":"/paths/~1b2b~1v1~1verification-cases/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a verification case.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a verification case owned by your organization, at version 1. It runs wherever every credential it accepts is enabled (`environments`). Requires the deepcredentials.verification-cases scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"DeepAdmin-issued Keycloak access token obtained via the OAuth 2.0\nResource Owner Password Credentials grant against the DeepCloud SSO\nrealm. See the Service Users guide for the exchange flow."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Org-Id","in":"header","schemaId":"schema_3","description":"Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.","required":true},{"name":"X-Environment","in":"header","schemaId":"schema_4","description":"Environment the call is scoped to. Resources are isolated per environment.","required":true}],"pointer":"/paths/~1b2b~1v1~1verification-cases/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_6","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1b2b~1v1~1verification-cases/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/b2b/v1/verification-cases","servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Org-Id","in":"header","required":true,"schemaId":"schema_3"},{"name":"X-Environment","in":"header","required":true,"schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/b2b/v1/verification-cases","href":"verification-cases/post:b2b.createverificationcase","openApiOperationId":"POST:b2b.CreateVerificationCase","summary":"Create a verification case.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"schemaId":"schema_6","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/b2b.b2bVerificationCase","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/b2b.b2bVerificationCase","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request. Common causes: missing or malformed X-Org-Id / X-Environment headers, or a missing required field in the request body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthenticated. The Bearer token failed validation (signature, issuer, audience, or expiry).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission denied. The token does not carry the scope required by this endpoint. Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim on the token you received from the DeepCloud SSO token endpoint."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/403/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credential definition not found: an entry of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credential_definition_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names no definition (any definition resolves by its id: your own, an official one, or another organization's). The message names the id."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/404/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict: another case of your organization, archived or not, already has this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"already_exists"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", message prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_id_conflict:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.case_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names that case, so an integration that lost its mapping can recover it."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/409/content/application~1json/examples/reference_id_conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/409/content/application~1json/examples/reference_id_conflict"]},{"code":"429","description":"Rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1b2b~1v1~1verification-cases/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/b2b.b2bVerificationCase","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/b2b.b2bVerificationCase","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/409/content/application~1json/examples/reference_id_conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/409/content/application~1json/examples/reference_id_conflict"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-cases/post:b2b.createverificationcase"}],"panels":[]}]},"httpPath":"/b2b/v1/verification-cases"},{"label":"Get a verification case.\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/verification-cases-v1/verification-cases/get:b2b.getverificationcase","routeSlug":"/docs/openapi/verification-cases-v1/verification-cases/get:b2b.getverificationcase","metadata":{"seo":{"title":"Get a verification case.\n","description":"Returns one verification case by id, with its accepted credentials and requested attributes: one of the calling organization's own, or any other organization's, which the caller may launch with POST /b2b/v1/verification-cases/{caseId}/sessions. A case id is not a secret (it is in every QR code the case produces), so holding it is what it takes to read and run the case. Another organization's case reads in the same shape, without its owner's `reference_id` and `description`, and only while it is not archived. Requires the deepcredentials.verify scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:b2b.GetVerificationCase","name":"Get a verification case.\n","isWebhook":false,"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a verification case.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one verification case by id, with its accepted credentials and requested attributes: one of the calling organization's own, or any other organization's, which the caller may launch with POST /b2b/v1/verification-cases/{caseId}/sessions. A case id is not a secret (it is in every QR code the case produces), so holding it is what it takes to read and run the case. Another organization's case reads in the same shape, without its owner's `reference_id` and `description`, and only while it is not archived. Requires the deepcredentials.verify scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"DeepAdmin-issued Keycloak access token obtained via the OAuth 2.0\nResource Owner Password Credentials grant against the DeepCloud SSO\nrealm. See the Service Users guide for the exchange flow."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseId","in":"path","schemaId":"schema_3","required":true}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Org-Id","in":"header","schemaId":"schema_3","description":"Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.","required":true},{"name":"X-Environment","in":"header","schemaId":"schema_4","description":"Environment the call is scoped to. Resources are isolated per environment.","required":true}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/b2b/v1/verification-cases/{caseId}","servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"parameters":{"path":[{"name":"caseId","in":"path","required":true,"schemaId":"schema_3","style":"simple","explode":false}],"query":[],"querystring":[],"header":[{"name":"X-Org-Id","in":"header","required":true,"schemaId":"schema_3"},{"name":"X-Environment","in":"header","required":true,"schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/b2b/v1/verification-cases/{caseId}","href":"verification-cases/get:b2b.getverificationcase","openApiOperationId":"GET:b2b.GetVerificationCase","summary":"Get a verification case.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/b2b.b2bVerificationCase","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/b2b.b2bVerificationCase","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"Invalid request. Common causes: missing or malformed X-Org-Id / X-Environment headers, or a missing required field in the request body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthenticated. The Bearer token failed validation (signature, issuer, audience, or expiry).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission denied. The token does not carry the scope required by this endpoint. Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim on the token you received from the DeepCloud SSO token endpoint."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"Resource not found. Either the resource ID is unknown, or the X-Org-Id you supplied is not an organization the authenticated service user is a member of.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/b2b.b2bVerificationCase","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/b2b.b2bVerificationCase","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-cases/get:b2b.getverificationcase"}],"panels":[]}]},"httpPath":"/b2b/v1/verification-cases/{caseId}"},{"label":"Update a verification case.\n","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/verification-cases-v1/verification-cases/put:b2b.updateverificationcase","routeSlug":"/docs/openapi/verification-cases-v1/verification-cases/put:b2b.updateverificationcase","metadata":{"seo":{"title":"Update a verification case.\n","description":"Replaces the case's contract and texts. The version moves when what the case asks for changed (credentials, attributes, constraints), never on a rename; launches pinned to the old version are then refused with 409. Only your organization's own cases are writable. Requires the deepcredentials.verification-cases scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT:b2b.UpdateVerificationCase","name":"Update a verification case.\n","isWebhook":false,"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a verification case.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Replaces the case's contract and texts. The version moves when what the case asks for changed (credentials, attributes, constraints), never on a rename; launches pinned to the old version are then refused with 409. Only your organization's own cases are writable. Requires the deepcredentials.verification-cases scope.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"DeepAdmin-issued Keycloak access token obtained via the OAuth 2.0\nResource Owner Password Credentials grant against the DeepCloud SSO\nrealm. See the Service Users guide for the exchange flow."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseId","in":"path","schemaId":"schema_3","required":true}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Org-Id","in":"header","schemaId":"schema_3","description":"Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.","required":true},{"name":"X-Environment","in":"header","schemaId":"schema_4","description":"Environment the call is scoped to. Resources are isolated per environment.","required":true}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/requestBody/content/application~1json/example"]}},"schemaId":"schema_7","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/b2b/v1/verification-cases/{caseId}","servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"parameters":{"path":[{"name":"caseId","in":"path","required":true,"schemaId":"schema_3","style":"simple","explode":false}],"query":[],"querystring":[],"header":[{"name":"X-Org-Id","in":"header","required":true,"schemaId":"schema_3"},{"name":"X-Environment","in":"header","required":true,"schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/b2b/v1/verification-cases/{caseId}","href":"verification-cases/put:b2b.updateverificationcase","openApiOperationId":"PUT:b2b.UpdateVerificationCase","summary":"Update a verification case.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"schemaId":"schema_7","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/b2b.b2bVerificationCase"}},"schemaId":"components/schemas/b2b.b2bVerificationCase"},{"code":"400","description":"Invalid request. Common causes: missing or malformed X-Org-Id / X-Environment headers, or a missing required field in the request body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthenticated. The Bearer token failed validation (signature, issuer, audience, or expiry).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission denied. The token does not carry the scope required by this endpoint. Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim on the token you received from the DeepCloud SSO token endpoint."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"Resource not found. Either the resource ID is unknown, or the X-Org-Id you supplied is not an organization the authenticated service user is a member of.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/404/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict. Either another case of your organization already has this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"already_exists"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", message prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference_id_conflict:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details.case_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names it), or the case is no longer at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expected_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aborted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", message prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case_version_mismatch:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): read it again and reapply your change."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/reference_id_conflict","paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/case_version_mismatch"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/reference_id_conflict","paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/case_version_mismatch"]},{"code":"429","description":"Rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/b2b.b2bVerificationCase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/b2b.b2bVerificationCase"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/reference_id_conflict","paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/case_version_mismatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/reference_id_conflict","paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/case_version_mismatch"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-cases/put:b2b.updateverificationcase"}],"panels":[]}]},"httpPath":"/b2b/v1/verification-cases/{caseId}"},{"label":"Archive or restore a verification case.\n","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/verification-cases-v1/verification-cases/patch:b2b.setverificationcasearchived","routeSlug":"/docs/openapi/verification-cases-v1/verification-cases/patch:b2b.setverificationcasearchived","metadata":{"seo":{"title":"Archive or restore a verification case.\n","description":"Archiving takes the case out of the working list: launches answer 404 and updates 400 until it is restored. Sessions already run stay as they were. Requires the deepcredentials.verification-cases scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH:b2b.SetVerificationCaseArchived","name":"Archive or restore a verification case.\n","isWebhook":false,"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive or restore a verification case.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archiving takes the case out of the working list: launches answer 404 and updates 400 until it is restored. Sessions already run stay as they were. Requires the deepcredentials.verification-cases scope.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"DeepAdmin-issued Keycloak access token obtained via the OAuth 2.0\nResource Owner Password Credentials grant against the DeepCloud SSO\nrealm. See the Service Users guide for the exchange flow."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseId","in":"path","schemaId":"schema_3","required":true}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Org-Id","in":"header","schemaId":"schema_3","description":"Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.","required":true},{"name":"X-Environment","in":"header","schemaId":"schema_4","description":"Environment the call is scoped to. Resources are isolated per environment.","required":true}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8"}},"schemaId":"schema_8","pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/b2b/v1/verification-cases/{caseId}/archived","servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"parameters":{"path":[{"name":"caseId","in":"path","required":true,"schemaId":"schema_3","style":"simple","explode":false}],"query":[],"querystring":[],"header":[{"name":"X-Org-Id","in":"header","required":true,"schemaId":"schema_3"},{"name":"X-Environment","in":"header","required":true,"schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_8"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/b2b/v1/verification-cases/{caseId}/archived","href":"verification-cases/patch:b2b.setverificationcasearchived","openApiOperationId":"PATCH:b2b.SetVerificationCaseArchived","summary":"Archive or restore a verification case.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"schemaId":"schema_8","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_8"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/b2b.b2bVerificationCase"}},"schemaId":"components/schemas/b2b.b2bVerificationCase"},{"code":"400","description":"Invalid request. Common causes: missing or malformed X-Org-Id / X-Environment headers, or a missing required field in the request body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthenticated. The Bearer token failed validation (signature, issuer, audience, or expiry).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission denied. The token does not carry the scope required by this endpoint. Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim on the token you received from the DeepCloud SSO token endpoint."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"Resource not found. Either the resource ID is unknown, or the X-Org-Id you supplied is not an organization the authenticated service user is a member of.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/404/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/b2b.b2bVerificationCase","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/b2b.b2bVerificationCase"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-cases/patch:b2b.setverificationcasearchived"}],"panels":[]}]},"httpPath":"/b2b/v1/verification-cases/{caseId}/archived"},{"label":"Launch a verification case.\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/verification-cases-v1/verification-cases/post:b2b.launchverificationcase","routeSlug":"/docs/openapi/verification-cases-v1/verification-cases/post:b2b.launchverificationcase","metadata":{"seo":{"title":"Launch a verification case.\n","description":"Starts a verification session from a verification case: your organization's own, or any other organization's, by its id. The case is the contract: the session asks for every attribute of the case, with its constraints, as authored. The session runs in X-Environment, which must be one of the case's `environments` (otherwise 400 case_not_available). Returns a QR code and deeplink; poll GET /b2b/v1/verification-sessions/{sessionId} or subscribe to the \"verification.completed\" webhook. Requires the deepcredentials.verify scope."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST:b2b.LaunchVerificationCase","name":"Launch a verification case.\n","isWebhook":false,"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Launch a verification case.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts a verification session from a verification case: your organization's own, or any other organization's, by its id. The case is the contract: the session asks for every attribute of the case, with its constraints, as authored. The session runs in X-Environment, which must be one of the case's `environments` (otherwise 400 case_not_available). Returns a QR code and deeplink; poll GET /b2b/v1/verification-sessions/{sessionId} or subscribe to the \"verification.completed\" webhook. Requires the deepcredentials.verify scope."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"DeepAdmin-issued Keycloak access token obtained via the OAuth 2.0\nResource Owner Password Credentials grant against the DeepCloud SSO\nrealm. See the Service Users guide for the exchange flow."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"caseId","in":"path","schemaId":"schema_3","required":true}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Org-Id","in":"header","schemaId":"schema_3","description":"Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.","required":true},{"name":"X-Environment","in":"header","schemaId":"schema_4","description":"Environment the call is scoped to. Resources are isolated per environment.","required":true}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_9","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/b2b/v1/verification-cases/{caseId}/sessions","servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"parameters":{"path":[{"name":"caseId","in":"path","required":true,"schemaId":"schema_3","style":"simple","explode":false}],"query":[],"querystring":[],"header":[{"name":"X-Org-Id","in":"header","required":true,"schemaId":"schema_3"},{"name":"X-Environment","in":"header","required":true,"schemaId":"schema_4"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/b2b/v1/verification-cases/{caseId}/sessions","href":"verification-cases/post:b2b.launchverificationcase","openApiOperationId":"POST:b2b.LaunchVerificationCase","summary":"Launch a verification case.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"schemaId":"schema_9","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}},"schemaId":"schema_10"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Either the body or headers were malformed ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invalid_argument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or the case cannot run as asked ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failed_precondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): it does not run in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Environment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because a credential it accepts is not enabled there (message prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case_not_available:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" naming the environment and the missing definitions by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", whoever's case it is), or the date bounds of one of its attributes have crossed since it was saved (the message names the attribute)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/invalid_argument","paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/case_not_available"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/invalid_argument","paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/case_not_available"]},{"code":"401","description":"Unauthenticated. The Bearer token failed validation (signature, issuer, audience, or expiry).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission denied. The token does not carry the scope required by this endpoint. Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim on the token you received from the DeepCloud SSO token endpoint."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/403/content/application~1json/example"]},{"code":"404","description":"Resource not found. Either the resource ID is unknown, or the X-Org-Id you supplied is not an organization the authenticated service user is a member of.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/404/content/application~1json/example"]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case_version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pins a version that is neither the case's current one nor listed in its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"launchable_versions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aborted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", message prefix "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"case_version_mismatch:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/409/content/application~1json/examples/case_version_mismatch"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/409/content/application~1json/examples/case_version_mismatch"]},{"code":"429","description":"Rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_10","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/invalid_argument","paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/case_not_available"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/invalid_argument","paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/case_not_available"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/409/content/application~1json/examples/case_version_mismatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/409/content/application~1json/examples/case_version_mismatch"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verification-cases/post:b2b.launchverificationcase"}],"panels":[]}]},"httpPath":"/b2b/v1/verification-cases/{caseId}/sessions"}],"content":{"contentType":"group","meta":{"name":"Verification Cases"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verification Cases","showPageActions":true},{"nodeType":"markdoc","content":"Author verification cases and launch sessions from them."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/b2b/v1/verification-cases","summary":"List verification cases.\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verification-cases/get:b2b.listverificationcases","deprecated":false},{"title":"/b2b/v1/verification-cases","summary":"Create a verification case.\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verification-cases/post:b2b.createverificationcase","deprecated":false},{"title":"/b2b/v1/verification-cases/{caseId}","summary":"Get a verification case.\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verification-cases/get:b2b.getverificationcase","deprecated":false},{"title":"/b2b/v1/verification-cases/{caseId}","summary":"Update a verification case.\n","prefix":{"name":"put","color":"put"},"badges":[],"link":"/verification-cases/put:b2b.updateverificationcase","deprecated":false},{"title":"/b2b/v1/verification-cases/{caseId}/archived","summary":"Archive or restore a verification case.\n","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/verification-cases/patch:b2b.setverificationcasearchived","deprecated":false},{"title":"/b2b/v1/verification-cases/{caseId}/sessions","summary":"Launch a verification case.\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/verification-cases/post:b2b.launchverificationcase","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code."},"message":{"type":"string","description":"Human-readable error description."},"details":{"type":"object","description":"Optional structured data with additional context."}}}},"components/schemas/claimtypes.ClaimDisplay":{"id":"components/schemas/claimtypes.ClaimDisplay","kind":"json-schema","title":"claimtypes.ClaimDisplay","data":{"properties":{"locale":{"description":"Language of the text: \"de\", \"fr\", \"it\" or \"en\".","type":"string"},"name":{"description":"The text in this language.","type":"string"}},"required":["name","locale"],"description":"ClaimDisplay is one localized text (a label or a description) for a claim or an enum option.","type":"object"}},"components/schemas/b2b.b2bVerificationCase":{"id":"components/schemas/b2b.b2bVerificationCase","kind":"json-schema","title":"b2b.b2bVerificationCase","data":{"properties":{"archived_at":{"format":"date-time","description":"When the case was archived; absent while it is not. An archived case cannot be launched or changed until restored.","type":"string"},"created_at":{"format":"date-time","description":"When the case was created (RFC3339).","type":"string"},"credential_definition_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The credential definitions the case accepts. With several, the holder presents any one of them."},"environments":{"items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments the case runs in (\"beta\", \"production\"): those where every credential it accepts is enabled. A launch in any other environment is refused with case_not_available."},"children":[]}]}]}],"type":"array"},"id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Case id: launch it at POST /b2b/v1/verification-cases/{caseId}/sessions. UUID v4 identifier."},"children":[]}]}]}]},"launchable_versions":{"items":{"format":"int64","type":"integer"},"description":"Older versions a launch pinning them may still run, while the owner keeps them open (a migration window); ascending. Empty means only the current version launches.","type":"array"},"name":{"description":"Case name, as shown in the portal.","type":"string"},"presentation":{"allOf":[{"$ref":"#/components/schemas/b2b.b2bCasePresentation"}],"description":"What the holder reads: the headline of the verification screen and the reason shown in the wallet. Not part of the contract: changing it never moves the version."},"reference_id":{"description":"Your own key for what the case guards (a door, a zone), when you gave one. Unique within your organization. Absent on another organization's case: the key is the owner's bookkeeping.","type":"string"},"requested_attributes":{"items":{"$ref":"#/components/schemas/b2b.b2bCaseAttribute"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The attributes the case asks for, each bound to a claim in every accepted credential, with what a presented value must satisfy under `constraints`."},"children":[]}]}]}],"type":"array"},"updated_at":{"format":"date-time","description":"When the case was last changed (RFC3339).","type":"string"},"version":{"format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version of the contract (credentials, attributes, constraints); moves on every change of one of them, never on a rename. Pin it with case_version when launching."},"children":[]}]}]}],"type":"integer"}},"required":["id","environments","name","presentation","version","launchable_versions","credential_definition_ids","requested_attributes","created_at","updated_at"],"description":"A verification case: the rule a verification session is launched from.","type":"object"}},"components/schemas/b2b.b2bCaseAttribute":{"id":"components/schemas/b2b.b2bCaseAttribute","kind":"json-schema","title":"b2b.b2bCaseAttribute","data":{"properties":{"bindings":{"additionalProperties":{"type":"string"},"description":"The claim this attribute reads in each accepted credential, keyed by credential definition id. Required on a write: every accepted credential needs one.","type":"object"},"constraints":{"allOf":[{"$ref":"#/components/schemas/b2b.b2bAttributeConstraints"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What a presented value must satisfy. Absent: the attribute is only asked for. A value that fails a constraint closes the session as failed (attribute_value_rejected) and nothing disclosed is kept."},"children":[]}]}]}]},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The attribute's own id: a session answers with it in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", whichever credential the holder presented. Letters, digits, _ and -."},"children":[]}]}]}],"type":"string"},"label":{"description":"Display name of the attribute, for your staff: shown on the kiosk result and the session detail in the portal, not to the holder. Optional; without one the bound claim's label is shown.","type":"string"},"sensitive":{"description":"True when a bound claim is marked sensitive in its credential definition. Read-only.","type":"boolean"},"value_type":{"description":"Value type of the attribute (\"string\", \"integer\", \"number\", \"boolean\", \"date\", \"enum\", \"image/jpeg\"). Optional on writes: taken from the bound claims, which must all have the same type. It decides which constraints the attribute can carry.","type":"string"}},"required":["id"],"description":"One attribute a verification case asks for.","type":"object"}},"components/schemas/verification.SessionStatus":{"id":"components/schemas/verification.SessionStatus","kind":"json-schema","title":"verification.SessionStatus","data":{"type":"string","enum":["pending","success","failed","expired"],"description":"Lifecycle state of a verification session."}},"components/schemas/b2b.b2bCasePresentation":{"id":"components/schemas/b2b.b2bCasePresentation","kind":"json-schema","title":"b2b.b2bCasePresentation","data":{"properties":{"purpose":{"items":{"$ref":"#/components/schemas/claimtypes.ClaimDisplay"},"description":"Why the verification asks, one entry per language, at most 1000 characters each. It travels with the request, and in the swiyu Sandbox is published with it in the swiyu trust registry, where anyone can read it. A launch may give a different reason for one run (not published).","type":"array"},"title":{"items":{"$ref":"#/components/schemas/claimtypes.ClaimDisplay"},"description":"Headline of the verification screen, one entry per language (\"de\", \"fr\", \"it\", \"en\"). Without one, the case name is shown. In the swiyu Sandbox it is also the published name of the verification.","type":"array"}},"required":[],"description":"What the holder reads when a case is launched.","type":"object"}},"components/schemas/b2b.b2bAttributeConstraints":{"id":"components/schemas/b2b.b2bAttributeConstraints","kind":"json-schema","title":"b2b.b2bAttributeConstraints","data":{"properties":{"max":{"oneOf":[{"type":"number"},{"type":"string"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusive upper bound, in the same forms as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"min"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today-18y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a birth date means at least 18 years old."},"children":[]}]}]}]},"min":{"oneOf":[{"type":"number"},{"type":"string"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inclusive lower bound: a number, or for a date an ISO date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2000-01-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a date relative to the day of verification ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today-18y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today+30d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"today-6m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"values":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"boolean"}]},"description":"Allowed values: strings for string and enum attributes, booleans for a boolean attribute."}},"required":[],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What a presented value of an attribute must satisfy. Which fields apply depends on the attribute's value type, and a field the type does not take is refused with 400 invalid_argument:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string: values, the allowed non-empty strings."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enum: values, keys from the bound claims' options; a key that is not an option of every bound claim is refused."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean: values, [true] or [false]."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer, number: min and/or max, numbers, inclusive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"date: min and/or max, inclusive, each an ISO date (2000-01-01) or a date relative to the day of verification (today, today-18y, today+30d, today-6m); max today-18y on a birth date means at least 18 years old. min above max is refused."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"image/jpeg: none; an image can be asked for, not constrained."},"children":[]}]}]}]}],"type":"object"}},"schema_0":{"kind":"json-schema","data":{"type":"string","enum":["all"]},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","enum":["exclude","only","include"]},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","enum":["beta","production"]},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"properties":{"cases":{"items":{"$ref":"#/components/schemas/b2b.b2bVerificationCase"},"description":"The cases, oldest first.","type":"array"}},"required":["cases"],"type":"object"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"properties":{"credential_definition_ids":{"items":{"format":"uuid","type":"string"},"description":"The credential definitions the case accepts: your own, official ones, or any other organization's, by id. With several, the holder presents any one of them. They must share at least one environment: the case runs wherever all of them are enabled.","type":"array"},"name":{"description":"Case name, as shown in the portal.","type":"string"},"presentation":{"$ref":"#/components/schemas/b2b.b2bCasePresentation"},"reference_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your own key for what the case guards (a door, a zone). Unique within your organization; a key in use is refused with 409 already_exists (reference_id_conflict) and the holder's id in details.case_id."},"children":[]}]}]}],"type":"string"},"requested_attributes":{"items":{"$ref":"#/components/schemas/b2b.b2bCaseAttribute"},"description":"The attributes the case asks for, each bound to a claim in every accepted credential. At least one.","type":"array"}},"required":["name","credential_definition_ids","requested_attributes"],"type":"object"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"properties":{"credential_definition_ids":{"items":{"format":"uuid","type":"string"},"description":"The credential definitions the case accepts.","type":"array"},"expected_version":{"format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version you read before editing. A case that has moved on since is refused with 409 aborted (case_version_mismatch). Omitted applies the update regardless."},"children":[]}]}]}],"type":"integer"},"keep_previous_launchable":{"description":"On an update that creates a new version: keep the version it replaces launchable for integrations that pin it, until the owner closes it in the portal. Ignored otherwise.","type":"boolean"},"name":{"description":"Case name, as shown in the portal.","type":"string"},"presentation":{"$ref":"#/components/schemas/b2b.b2bCasePresentation"},"reference_id":{"description":"Your own key for the case. Omitted keeps the current one.","type":"string"},"requested_attributes":{"items":{"$ref":"#/components/schemas/b2b.b2bCaseAttribute"},"description":"The attributes the case asks for.","type":"array"}},"required":["name","credential_definition_ids","requested_attributes"],"type":"object"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"properties":{"archived":{"description":"true archives the case (no launches, no changes until restored); false restores it.","type":"boolean"}},"required":["archived"],"type":"object"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"properties":{"case_version":{"format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pins the contract version your integration was built against. The current version runs; an older one runs while the owner keeps it in the case's launchable_versions (a migration window). Any other version is refused with 409 case_version_mismatch. Omitted: the current version."},"children":[]}]}]}],"type":"integer"},"purpose":{"description":"Optional text shown in wallet/consent context where supported; replaces the case's purpose for this run.","type":"string"},"redirect_uri":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional same-device return: where the wallet sends the holder after they answer, with a fresh `response_code` query parameter. Absolute https, no fragment, no `response_code` of its own. A session created with it returns its `attributes` only to a read that passes that code. See the Same-Device Flow guide."},"children":[]}]}]}],"type":"string"},"reference_id":{"description":"Optional correlation identifier from your system; echoed on the resource.","type":"string"}},"type":"object"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"properties":{"deeplink":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wallet app link, e.g. openid4vp://?client_id=...&request_uri=..."},"children":[]}]}]}],"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"},"id":"schema_10"}},"exampleStore":{"paths/~1b2b~1v1~1verification-cases/get/responses/200/content/application~1json/example":{"value":{"cases":[{"id":"3f2a1b4c-5d6e-4f70-8a9b-0c1d2e3f4a5b","reference_id":"door-7B","environments":["beta","production"],"name":"Door 7B","presentation":{"title":[{"locale":"en","name":"Server room access"}],"purpose":[{"locale":"de","name":"Zutritt zum Serverraum"},{"locale":"en","name":"Access to the server room"}]},"version":1,"launchable_versions":[],"credential_definition_ids":["5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c"],"requested_attributes":[{"id":"zone","label":"Access zone","value_type":"enum","constraints":{"values":["server-room"]},"bindings":{"5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b":"zone","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c":"area"}},{"id":"born","label":"Date of birth","value_type":"date","constraints":{"max":"today-18y"},"bindings":{"5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b":"birth_date","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c":"date_of_birth"}}],"created_at":"2026-09-29T10:00:00Z","updated_at":"2026-09-29T10:00:00Z"}]},"id":"paths/~1b2b~1v1~1verification-cases/get/responses/200/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/get/responses/400/content/application~1json/example":{"value":{"code":"invalid_argument","message":"X-Org-Id header is required."},"id":"paths/~1b2b~1v1~1verification-cases/get/responses/400/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/get/responses/401/content/application~1json/example":{"value":{"code":"unauthenticated","message":"Missing or invalid Bearer token."},"id":"paths/~1b2b~1v1~1verification-cases/get/responses/401/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/get/responses/403/content/application~1json/example":{"value":{"code":"permission_denied","message":"Token lacks the required scope."},"id":"paths/~1b2b~1v1~1verification-cases/get/responses/403/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/get/responses/429/content/application~1json/example":{"value":{"code":"resource_exhausted","message":"Rate limit exceeded. Retry with backoff."},"id":"paths/~1b2b~1v1~1verification-cases/get/responses/429/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/get/responses/500/content/application~1json/example":{"value":{"code":"internal","message":"An unexpected error occurred."},"id":"paths/~1b2b~1v1~1verification-cases/get/responses/500/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/post/requestBody/content/application~1json/example":{"value":{"reference_id":"door-7B","name":"Door 7B","presentation":{"title":[{"locale":"de","name":"Zutritt Serverraum"},{"locale":"en","name":"Server room access"}],"purpose":[{"locale":"de","name":"Zutritt zum Serverraum"},{"locale":"en","name":"Access to the server room"}]},"credential_definition_ids":["5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c"],"requested_attributes":[{"id":"zone","label":"Access zone","constraints":{"values":["server-room"]},"bindings":{"5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b":"zone","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c":"area"}},{"id":"born","label":"Date of birth","constraints":{"max":"today-18y"},"bindings":{"5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b":"birth_date","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c":"date_of_birth"}}]},"id":"paths/~1b2b~1v1~1verification-cases/post/requestBody/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/post/responses/200/content/application~1json/example":{"value":{"id":"3f2a1b4c-5d6e-4f70-8a9b-0c1d2e3f4a5b","reference_id":"door-7B","environments":["beta","production"],"name":"Door 7B","presentation":{"title":[{"locale":"en","name":"Server room access"}],"purpose":[{"locale":"de","name":"Zutritt zum Serverraum"},{"locale":"en","name":"Access to the server room"}]},"version":1,"launchable_versions":[],"credential_definition_ids":["5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c"],"requested_attributes":[{"id":"zone","label":"Access zone","value_type":"enum","constraints":{"values":["server-room"]},"bindings":{"5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b":"zone","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c":"area"}},{"id":"born","label":"Date of birth","value_type":"date","constraints":{"max":"today-18y"},"bindings":{"5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b":"birth_date","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c":"date_of_birth"}}],"created_at":"2026-09-29T10:00:00Z","updated_at":"2026-09-29T10:00:00Z"},"id":"paths/~1b2b~1v1~1verification-cases/post/responses/200/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/post/responses/400/content/application~1json/example":{"value":{"code":"invalid_argument","message":"X-Org-Id header is required."},"id":"paths/~1b2b~1v1~1verification-cases/post/responses/400/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/post/responses/401/content/application~1json/example":{"value":{"code":"unauthenticated","message":"Missing or invalid Bearer token."},"id":"paths/~1b2b~1v1~1verification-cases/post/responses/401/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/post/responses/403/content/application~1json/example":{"value":{"code":"permission_denied","message":"Token lacks the required scope."},"id":"paths/~1b2b~1v1~1verification-cases/post/responses/403/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/post/responses/404/content/application~1json/example":{"value":{"code":"not_found","message":"credential definition 0f8e1d2c-3b4a-4596-8778-695a4b3c2d1e could not be loaded: definition not found"},"id":"paths/~1b2b~1v1~1verification-cases/post/responses/404/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/post/responses/409/content/application~1json/examples/reference_id_conflict":{"value":{"code":"already_exists","message":"reference_id_conflict: another verification case of this organization already has this reference_id","details":{"reason":"reference_id_conflict","case_id":"3f2b8c1e-7a4d-4e9b-8c2a-1d5e6f7a8b9c"}},"key":"reference_id_conflict","summary":"reference_id taken by another case","id":"paths/~1b2b~1v1~1verification-cases/post/responses/409/content/application~1json/examples/reference_id_conflict"},"paths/~1b2b~1v1~1verification-cases/post/responses/429/content/application~1json/example":{"value":{"code":"resource_exhausted","message":"Rate limit exceeded. Retry with backoff."},"id":"paths/~1b2b~1v1~1verification-cases/post/responses/429/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases/post/responses/500/content/application~1json/example":{"value":{"code":"internal","message":"An unexpected error occurred."},"id":"paths/~1b2b~1v1~1verification-cases/post/responses/500/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/200/content/application~1json/example":{"value":{"id":"3f2a1b4c-5d6e-4f70-8a9b-0c1d2e3f4a5b","reference_id":"door-7B","environments":["beta","production"],"name":"Door 7B","presentation":{"title":[{"locale":"en","name":"Server room access"}],"purpose":[{"locale":"de","name":"Zutritt zum Serverraum"},{"locale":"en","name":"Access to the server room"}]},"version":1,"launchable_versions":[],"credential_definition_ids":["5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c"],"requested_attributes":[{"id":"zone","label":"Access zone","value_type":"enum","constraints":{"values":["server-room"]},"bindings":{"5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b":"zone","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c":"area"}},{"id":"born","label":"Date of birth","value_type":"date","constraints":{"max":"today-18y"},"bindings":{"5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b":"birth_date","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c":"date_of_birth"}}],"created_at":"2026-09-29T10:00:00Z","updated_at":"2026-09-29T10:00:00Z"},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/200/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/400/content/application~1json/example":{"value":{"code":"invalid_argument","message":"X-Org-Id header is required."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/400/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/401/content/application~1json/example":{"value":{"code":"unauthenticated","message":"Missing or invalid Bearer token."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/401/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/403/content/application~1json/example":{"value":{"code":"permission_denied","message":"Token lacks the required scope."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/403/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/404/content/application~1json/example":{"value":{"code":"not_found","message":"Resource not found."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/404/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/429/content/application~1json/example":{"value":{"code":"resource_exhausted","message":"Rate limit exceeded. Retry with backoff."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/429/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/500/content/application~1json/example":{"value":{"code":"internal","message":"An unexpected error occurred."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/get/responses/500/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/requestBody/content/application~1json/example":{"value":{"reference_id":"door-7B","name":"Door 7B","presentation":{"title":[{"locale":"de","name":"Zutritt Serverraum"},{"locale":"en","name":"Server room access"}],"purpose":[{"locale":"de","name":"Zutritt zum Serverraum"},{"locale":"en","name":"Access to the server room"}]},"credential_definition_ids":["5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c"],"requested_attributes":[{"id":"zone","label":"Access zone","constraints":{"values":["server-room"]},"bindings":{"5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b":"zone","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c":"area"}},{"id":"born","label":"Date of birth","constraints":{"max":"today-18y"},"bindings":{"5b0c7e2a-1f3d-4c8e-9a6b-2d4f6e8a0c1b":"birth_date","9e1a3c5d-7b2f-4e6a-8c0d-1f3b5d7e9a2c":"date_of_birth"}}],"expected_version":1},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/requestBody/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/400/content/application~1json/example":{"value":{"code":"invalid_argument","message":"X-Org-Id header is required."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/400/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/401/content/application~1json/example":{"value":{"code":"unauthenticated","message":"Missing or invalid Bearer token."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/401/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/403/content/application~1json/example":{"value":{"code":"permission_denied","message":"Token lacks the required scope."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/403/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/404/content/application~1json/example":{"value":{"code":"not_found","message":"Resource not found."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/404/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/reference_id_conflict":{"value":{"code":"already_exists","message":"reference_id_conflict: another verification case of this organization already has this reference_id","details":{"reason":"reference_id_conflict","case_id":"3f2b8c1e-7a4d-4e9b-8c2a-1d5e6f7a8b9c"}},"key":"reference_id_conflict","summary":"reference_id taken by another case","id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/reference_id_conflict"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/case_version_mismatch":{"value":{"code":"aborted","message":"case_version_mismatch: the case is at version 4, the update expected 3"},"key":"case_version_mismatch","summary":"The case moved on from expected_version","id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/409/content/application~1json/examples/case_version_mismatch"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/429/content/application~1json/example":{"value":{"code":"resource_exhausted","message":"Rate limit exceeded. Retry with backoff."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/429/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/500/content/application~1json/example":{"value":{"code":"internal","message":"An unexpected error occurred."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}/put/responses/500/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/400/content/application~1json/example":{"value":{"code":"invalid_argument","message":"X-Org-Id header is required."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/400/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/401/content/application~1json/example":{"value":{"code":"unauthenticated","message":"Missing or invalid Bearer token."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/401/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/403/content/application~1json/example":{"value":{"code":"permission_denied","message":"Token lacks the required scope."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/403/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/404/content/application~1json/example":{"value":{"code":"not_found","message":"Resource not found."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/404/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/429/content/application~1json/example":{"value":{"code":"resource_exhausted","message":"Rate limit exceeded. Retry with backoff."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/429/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/500/content/application~1json/example":{"value":{"code":"internal","message":"An unexpected error occurred."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1archived/patch/responses/500/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/requestBody/content/application~1json/example":{"value":{"case_version":1,"reference_id":"door-7B-2026-09-29-0815","purpose":"Access to the server room"},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/requestBody/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/invalid_argument":{"value":{"code":"invalid_argument","message":"X-Org-Id header is required."},"key":"invalid_argument","summary":"Malformed request","id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/invalid_argument"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/case_not_available":{"value":{"code":"failed_precondition","message":"case_not_available: this case does not run in production: Badge is not enabled there","details":{"reason":"case_not_available","environment":"production","missing_definitions":[{"id":"5b0c2f7e-9d3a-4c1b-8e6f-2a4d7c9b1e3f","name":"Badge"}]}},"key":"case_not_available","summary":"The case does not run in X-Environment","id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/400/content/application~1json/examples/case_not_available"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/401/content/application~1json/example":{"value":{"code":"unauthenticated","message":"Missing or invalid Bearer token."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/401/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/403/content/application~1json/example":{"value":{"code":"permission_denied","message":"Token lacks the required scope."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/403/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/404/content/application~1json/example":{"value":{"code":"not_found","message":"Resource not found."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/404/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/409/content/application~1json/examples/case_version_mismatch":{"value":{"code":"aborted","message":"case_version_mismatch: the case is at version 4, the request pins 3"},"key":"case_version_mismatch","summary":"case_version is neither current nor launchable","id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/409/content/application~1json/examples/case_version_mismatch"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/429/content/application~1json/example":{"value":{"code":"resource_exhausted","message":"Rate limit exceeded. Retry with backoff."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/429/content/application~1json/example"},"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/500/content/application~1json/example":{"value":{"code":"internal","message":"An unexpected error occurred."},"id":"paths/~1b2b~1v1~1verification-cases~1{caseId}~1sessions/post/responses/500/content/application~1json/example"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"DeepAdmin-issued Keycloak access token obtained via the OAuth 2.0\nResource Owner Password Credentials grant against the DeepCloud SSO\nrealm. See the Service Users guide for the exchange flow."}},"servers":[{"url":"/_mock/docs/openapi/verification-cases-v1","isMockServer":true,"description":"Mock server"},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/docs/openapi/verification-cases-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/openapi/verification-cases-v1.json?download"},{"url":"/_bundle/docs/openapi/verification-cases-v1.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Verification Cases API","description":"Author verification cases and launch them.\n\nA verification case is a rule: which credentials are accepted, which attributes are asked for, and the constraints their values must meet. It runs wherever its credentials are enabled (`environments`), has a contract `version` that moves on every change of what it asks for, and may carry your own `reference_id` for the object it guards. Launching a case starts a verification session, polled in the Verification API. Reading and launching require the `deepcredentials.verify` scope; creating, changing and archiving require `deepcredentials.verification-cases`."}},"baseSlug":"/docs/openapi/verification-cases-v1","routesMapping":{}}