{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"DeepCredentials Developer API"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"deepcredentials-developer-api","__idx":0},"children":["DeepCredentials Developer API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-you-can-build","__idx":1},"children":["What you can build"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Verify identities"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Automate onboarding and KYC against government-issued credentials — no raw identity documents, no manual review."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Issue credentials"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create credential offers and deliver verifiable credentials directly to holders' wallets, either via QR/deeplink or out-of-band email."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Track issuance status and manage the full credential lifecycle — suspend, revoke, or reactivate at any time."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Self-service issuance"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Let end users initiate their own credential requests through a branded web flow."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Receive a webhook when a request is submitted, fetch the snapshot, then approve or reject via the API."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-started","__idx":2},"children":["Get started"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["New to the DeepCredentials API? The ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/quickstart"},"children":["Quickstart"]}," gets you up and running in minutes. Authentication is delegated to DeepCloud's SSO realm — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/authentication/service-users"},"children":["Authentication — Service Users"]}," for the full setup."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"apis","__idx":3},"children":["APIs"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API"},"children":["API"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/verification-v1"},"children":["Verification API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create and poll OID4VP identity verification sessions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/credential-offers-v1"},"children":["Credential Offers API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create and manage credential offers."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/issued-credentials-v1"},"children":["Issued Credentials API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List, inspect, and manage the status of issued credentials."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/self-service-v1"},"children":["Self-Service API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Approve or reject end-user-initiated credential requests."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/credential-definitions-v1"},"children":["Credential Definitions API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List the credential definitions available to your organization."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/health-v1"},"children":["Health API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Validate connectivity and inspect credential metadata."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/webhook-events-v1"},"children":["Webhook Events"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Event payloads delivered to your webhook endpoint."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"environments","__idx":4},"children":["Environments"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Beta"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Beta swiyu environment for development and testing — no real identity data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Production"]}," (planned for December 2026)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Live swiyu environment connected to the Swiss eID infrastructure."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every B2B request carries an explicit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Environment: beta"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Environment: production"]}," header; resources are isolated per environment."]}]},"headings":[{"value":"DeepCredentials Developer API","id":"deepcredentials-developer-api","depth":1},{"value":"What you can build","id":"what-you-can-build","depth":2},{"value":"Get started","id":"get-started","depth":2},{"value":"APIs","id":"apis","depth":2},{"value":"Environments","id":"environments","depth":2}],"frontmatter":{"seo":{"title":"DeepCredentials Developer API"}},"lastModified":"2026-06-10T12:08:36.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}