Skip to content
Last updated

DeepCredentials Developer API

DeepCredentials is the B2B API for the Swiss eID ecosystem. Integrate once to verify identities, issue verifiable credentials to wallets, and let end users self-initiate their own credential requests.

What you can build

Verify identities

  • Start an OID4VP session, display a QR code or deeplink, and receive the disclosed claims when the holder scans it with their Swiss eID wallet.
  • Automate onboarding and KYC against government-issued credentials — no raw identity documents, no manual review.

Issue credentials

  • Create credential offers and deliver verifiable credentials directly to holders' wallets, either via QR/deeplink or out-of-band email.
  • Track issuance status and manage the full credential lifecycle — suspend, revoke, or reactivate at any time.

Self-service issuance

  • Let end users initiate their own credential requests through a branded web flow.
  • Receive a webhook when a request is submitted, fetch the snapshot, then approve or reject via the API.

Get started

New to the DeepCredentials API? The Quickstart gets you up and running in minutes. Authentication is delegated to DeepCloud's SSO realm — see Authentication — Service Users for the full setup.

APIs

APIDescription
Verification APICreate and poll OID4VP identity verification sessions.
Credential Offers APICreate and manage credential offers.
Issued Credentials APIList, inspect, and manage the status of issued credentials.
Self-Service APIApprove or reject end-user-initiated credential requests.
Credential Definitions APIList the credential definitions available to your organization.
Health APIValidate connectivity and inspect credential metadata.
Webhook EventsEvent payloads delivered to your webhook endpoint.

Environments

EnvironmentPurpose
BetaBeta swiyu environment for development and testing — no real identity data.
Production (planned for December 2026)Live swiyu environment connected to the Swiss eID infrastructure.

Every B2B request carries an explicit X-Environment: beta or X-Environment: production header; resources are isolated per environment.