Skip to content
APIs
/Verification Cases API/Verification Cases

List verification cases.

Request

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.

Security
BearerAuth
Query
availabilitystring

"all" returns every case with its environments; omitted, only the cases that run in X-Environment.

Value:"all"
reference_idstring

Your key for the case: at most one case.

archivedstring

"exclude" (default), "only" or "include": the working list, your archive, or both.

Enum:"exclude""only""include"
Headers
X-Org-Idstring, (uuid)required

Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.

X-Environmentstringrequired

Environment the call is scoped to. Resources are isolated per environment.

Enum:"beta""production"
curl -i -X GET \
  'https://docs.deepcredentials.swiss/_mock/docs/openapi/verification-cases-v1/b2b/v1/verification-cases?availability=all&reference_id=string&archived=exclude' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Environment: beta' \
  -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Success response

Bodyapplication/json
casesArray of objects(b2b.b2bVerificationCase)required

The cases, oldest first.

Response
{
  "cases": [
    { … }
  ]
}