Skip to content
Last updated

Authentication

The DeepCredentials B2B API authenticates every call with a DeepAdmin service-user JWT obtained from the DeepCloud SSO realm. There is no portal-side credential to mint — identity is delegated to DeepCloud's IdP (Keycloak), and the portal verifies tokens at request time.

Every B2B request carries three headers:

HeaderValue
AuthorizationBearer <access_token> from the DeepCloud SSO token endpoint.
X-Org-IdUUID of the organization the call is acting on; the service user must be a member.
X-Environmentbeta or production. Resources are isolated per environment.

Start here:

  • Service Users — the canonical guide: how to get a partner client and a service user from DeepCloud, exchange credentials for an access token, request scopes, call the API, and the full error reference.

Scopes

All B2B endpoints gate access on the JWT's scope claim. Request explicitly via the scope=… form parameter on the token call; only the scopes your integration uses.

ScopeGrants access to
deepcredentials.verifyCreate and read OID4VP verification sessions.
deepcredentials.issueCreate credential offers, list and inspect issued credentials, suspend / revoke / reactivate.
deepcredentials.self-serviceRead and decide on end-user-initiated self-service requests.
Least privilege

Only request the scopes your integration actually needs. If you only verify identities, scope=deepcredentials.verify is sufficient.