{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/guides/sidebars.yaml","api-docs-docs/openapi/credential-invitations-v1.yaml":"api-docs-docs/openapi/credential-invitations-v1.yaml","api-docs-docs/openapi/credential-offers-v1.yaml":"api-docs-docs/openapi/credential-offers-v1.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","openapi-code-sample","json-schema"]},"type":"markdown"},"seo":{"title":"Credential Issuance Flow"},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"credential-issuance-flow","__idx":0},"children":["Credential Issuance Flow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide explains both B2B issuance branches: an immediate credential offer and a partner-delivered invitation code. Both branches end in the same credential-offer and issued-credential lifecycle."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An API credential with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deepcredentials.issue"]}," scope. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/authentication"},"children":["Authentication"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A credential definition configured for your organization in the portal."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Issuer setup completed (DID + status list) in the portal."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For webhook progress notifications, a destination and event subscriptions configured in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Settings > Webhooks"]}," in the portal."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Portal configuration comes first. At runtime, your partner integration uses the B2B endpoints below; invitation redemption is the one anonymous public step performed for the recipient."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If issuance follows an eID check, wait for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status: success"]}," and evaluate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_status"]}," through the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/verification-flow"},"children":["Verification Flow"]},", then fetch the disclosed values with authenticated GET. Your system decides how to build the new credential claims: it may copy, transform, supplement, or ignore the verified values. Issuance does not accept a verification-session ID and does not require the new claims to match the eID."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"choose-a-delivery-branch","__idx":2},"children":["Choose a delivery branch"]},{"$$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":"Branch"},"children":["Branch"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Create call"},"children":["Create call"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What your system receives"},"children":["What your system receives"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Who delivers it"},"children":["Who delivers it"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Immediate offer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /b2b/v1/credential-offers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["An OID4VCI deeplink and QR image"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your system displays or delivers the offer. The existing optional offer-email delivery is separate from invitations."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invitation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /b2b/v1/credential-invitations"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invitation metadata and a one-time code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your system delivers the code and controls the redemption experience. DeepCredentials sends no B2B invitation email."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the immediate branch when the holder can consume the offer now. Use an invitation when the holder should redeem later or through a separate channel controlled by your system."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"offer-lifecycle","__idx":3},"children":["Offer lifecycle"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"stateDiagram-v2\n [*] --> pending: POST /credential-offers\n pending --> issued: Wallet accepts the credential\n pending --> expired: Offer TTL exceeded\n pending --> failed: Issuance error\n issued --> [*]\n expired --> [*]\n failed --> [*]\n","diagramHtml":"

POST /credential-offers

Wallet accepts the credential

Offer TTL exceeded

Issuance error

pending

issued

expired

failed

","diagramHtmlDark":"

POST /credential-offers

Wallet accepts the credential

Offer TTL exceeded

Issuance error

pending

issued

expired

failed

"},"children":["stateDiagram-v2\n [*] --> pending: POST /credential-offers\n pending --> issued: Wallet accepts the credential\n pending --> expired: Offer TTL exceeded\n pending --> failed: Issuance error\n issued --> [*]\n expired --> [*]\n failed --> [*]\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"offer-statuses","__idx":4},"children":["Offer statuses"]},{"$$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":"Status"},"children":["Status    "]},{"$$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":"code","attributes":{},"children":["pending"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Offer created, waiting for the wallet holder to scan the QR and accept."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issued"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credential successfully issued to the wallet. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issued_credential_id"]}," is set."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Offer exceeded its TTL without being claimed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Issuance failed. Check ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error_code"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error_description"]}," for details."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"credential-statuses","__idx":5},"children":["Credential statuses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once issued, a credential has its own lifecycle:"]},{"$$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":"Status"},"children":["Status    "]},{"$$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":"code","attributes":{},"children":["active"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credential is valid and can be presented by the holder."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suspended"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Temporarily suspended. Can be reactivated."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revoked"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Permanently revoked. Cannot be reactivated."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These three values cover the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["revocation"]}," lifecycle (status-list driven). Expiration is an orthogonal axis — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#credential-validity"},"children":["Credential validity"]}," below."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"credential-validity","__idx":6},"children":["Credential validity"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every credential carries an SD-JWT ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exp"]}," claim (when set) that wallets and verifiers honour independently of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},". The lifetime is resolved at issuance time from this fallback chain:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validity_seconds"]}," on the create request"]}," — explicit override, only for this offer."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["default_validity_seconds"]}," on the credential definition"]}," — tenant-set default for this ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["vct"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exp"]}," claim"]}," — credential never expires (only reached if both above are absent)."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The value is stamped onto the SD-JWT at signing time. The resolved lifetime is echoed back on the offer response as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_validity_seconds"]},"; once the credential is issued it surfaces as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valid_until"]}," (alongside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valid_from"]},", which mirrors ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["iat"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nbf"]},") on the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["issued-credential"]}," response — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /b2b/v1/issued-credentials/{id}"]},". These surfaces are read-only — credentials are immutably signed, so once issued the validity window cannot be changed without re-issuing."]},{"$$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":"Concept"},"children":["Concept"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Spec"},"children":["Spec"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Carrier"},"children":["Carrier"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Offer (QR / pre-auth) TTL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["How long the wallet has to pick up the offer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Offer record"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expires_at"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credential lifetime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the credential itself stops being valid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SD-JWT payload"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exp"]}," → issued-credential ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valid_until"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Status ≠ expiration"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A credential can be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]}," and past its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["valid_until"]}," simultaneously. Wallets show it as expired; verifiers reject it on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["exp"]}," claim; our status list is unchanged. To shorten the lifetime of an existing credential you must revoke it via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /b2b/v1/issued-credentials/{id}/status"]}," and re-issue — the JWT is signed and immutable."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Range: 60 seconds to 10 years (315 360 000 seconds). Self-service flows always carry their own explicit validity chosen on the config; the request-level override here is for direct B2B issuance only."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"partner-delivered-invitation-flow","__idx":7},"children":["Partner-delivered invitation flow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An invitation stores the credential claims and eventual offer settings until the recipient redeems a one-time code. B2B list, get, and revoke responses never expose the code or claims. Only successful create and rotate responses contain the plaintext code."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"invitation-statuses","__idx":8},"children":["Invitation statuses"]},{"$$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":"Status"},"children":["Status"]},{"$$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":"code","attributes":{},"children":["pending"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The current code can be redeemed, subject to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expires_at"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The recipient redeemed the code and DeepCredentials created ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemed_offer_id"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The pending code passed its expiry and can no longer be redeemed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revoked"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your organization revoked the invitation before redemption."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-an-invitation","__idx":9},"children":["Create an invitation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/credential-invitations-v1"},"children":["Open in API reference →"]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-docs/openapi/credential-invitations-v1.yaml","operationId":"POST:b2b.CreateCredentialInvitation","parameters":{},"requestBody":{"credential_definition_id":"YOUR_CREDENTIAL_DEFINITION_ID","email":"alice@example.com","claims":{"given_name":"Alice","employee_number":"E-1042"},"reference_id":"partner-invitation-1042","invitation_ttl_seconds":86400,"offer_validity_seconds":600,"validity_seconds":31536000},"environments":{"https://api.dev.deepcredentials.swiss":{"BearerAuth":"YOUR_ACCESS_TOKEN"}},"environment":"https://api.dev.deepcredentials.swiss","codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X POST \\\n https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations \\\n -H 'Content-Type: application/json' \\\n -H 'X-Environment: beta' \\\n -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \\\n -d '{\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"email\": \"alice@example.com\",\n \"claims\": {\n \"given_name\": \"Alice\",\n \"employee_number\": \"E-1042\"\n },\n \"reference_id\": \"partner-invitation-1042\",\n \"invitation_ttl_seconds\": 86400,\n \"offer_validity_seconds\": 600,\n \"validity_seconds\": 31536000\n }'"},{"lang":"javascript","title":"JavaScript","source":"const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations`,\n {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n },\n body: JSON.stringify({\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n email: 'alice@example.com',\n claims: {\n given_name: 'Alice',\n employee_number: 'E-1042'\n },\n reference_id: 'partner-invitation-1042',\n invitation_ttl_seconds: 86400,\n offer_validity_seconds: 600,\n validity_seconds: 31536000\n })\n }\n);\n\nconst data = await resp.json();\nconsole.log(data);"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations`,\n {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n },\n body: JSON.stringify({\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n email: 'alice@example.com',\n claims: {\n given_name: 'Alice',\n employee_number: 'E-1042'\n },\n reference_id: 'partner-invitation-1042',\n invitation_ttl_seconds: 86400,\n offer_validity_seconds: 600,\n validity_seconds: 31536000\n })\n }\n );\n\n const data = await resp.json();\n console.log(data);\n}\n\nrun();"},{"lang":"python","title":"Python","source":"import requests\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations\"\n\npayload = {\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"email\": \"alice@example.com\",\n \"claims\": {\n \"given_name\": \"Alice\",\n \"employee_number\": \"E-1042\"\n },\n \"reference_id\": \"partner-invitation-1042\",\n \"invitation_ttl_seconds\": 86400,\n \"offer_validity_seconds\": 600,\n \"validity_seconds\": 31536000\n}\n\nheaders = {\n \"Content-Type\": \"application/json\",\n \"X-Org-Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"X-Environment\": \"beta\"\n}\n\nresponse = requests.post(url, json=payload, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\n\npublic class App {\n public static void main(String[] args) throws Exception {\n var httpClient = HttpClient.newBuilder().build();\n\n var payload = String.join(\"\\n\"\n , \"{\"\n , \" \\\"credential_definition_id\\\": \\\"YOUR_CREDENTIAL_DEFINITION_ID\\\",\"\n , \" \\\"email\\\": \\\"alice@example.com\\\",\"\n , \" \\\"claims\\\": {\"\n , \" \\\"given_name\\\": \\\"Alice\\\",\"\n , \" \\\"employee_number\\\": \\\"E-1042\\\"\"\n , \" },\"\n , \" \\\"reference_id\\\": \\\"partner-invitation-1042\\\",\"\n , \" \\\"invitation_ttl_seconds\\\": 86400,\"\n , \" \\\"offer_validity_seconds\\\": 600,\"\n , \" \\\"validity_seconds\\\": 31536000\"\n , \"}\"\n );\n\n var host = \"https://api.dev.deepcredentials.swiss\";\n var pathname = \"/b2b/v1/credential-invitations\";\n var request = HttpRequest.newBuilder()\n .POST(HttpRequest.BodyPublishers.ofString(payload))\n .uri(URI.create(host + pathname ))\n .header(\"Content-Type\", \"application/json\")\n .header(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n .header(\"X-Environment\", \"beta\")\n .build();\n\n var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\nusing System.Text;\nusing System.Text.Json;\n\npublic class Program\n{\n public static async Task Main()\n {\n System.Net.Http.HttpClient client = new()\n {\n DefaultRequestHeaders =\n {\n {\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\n {\"X-Environment\", \"beta\"},\n }\n };\n\n string json = JsonSerializer.Serialize(new\n {\n credential_definition_id = \"YOUR_CREDENTIAL_DEFINITION_ID\",\n email = \"alice@example.com\",\n claims = new {\n given_name = \"Alice\",\n employee_number = \"E-1042\"\n },\n reference_id = \"partner-invitation-1042\",\n invitation_ttl_seconds = \"86400\",\n offer_validity_seconds = \"600\",\n validity_seconds = \"31536000\"\n });\n\n using StringContent postData = new(json, Encoding.UTF8, \"application/json\");\n using HttpResponseMessage request = await client.PostAsync(\"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations\", postData);\n string response = await request.Content.ReadAsStringAsync();\n\n Console.WriteLine(response);\n }\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\n$curl = curl_init();\n\n$payload = array(\n \"credential_definition_id\" => \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"email\" => \"alice@example.com\",\n \"claims\" => array(\n \"given_name\" => \"Alice\",\n \"employee_number\" => \"E-1042\"\n ),\n \"reference_id\" => \"partner-invitation-1042\",\n \"invitation_ttl_seconds\" => 86400,\n \"offer_validity_seconds\" => 600,\n \"validity_seconds\" => 31536000\n);\n\ncurl_setopt_array($curl, [\n CURLOPT_HTTPHEADER => [\n \"Content-Type: application/json\",\n \"X-Environment: beta\",\n \"X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n CURLOPT_POSTFIELDS => json_encode($payload),\n CURLOPT_URL => \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n echo \"cURL Error #:\" . $error;\n} else {\n echo $response;\n}"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n \"fmt\"\n \"bytes\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n reqUrl := \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations\"\n var data = []byte(`{\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"email\": \"alice@example.com\",\n \"claims\": {\n \"given_name\": \"Alice\",\n \"employee_number\": \"E-1042\"\n },\n \"reference_id\": \"partner-invitation-1042\",\n \"invitation_ttl_seconds\": 86400,\n \"offer_validity_seconds\": 600,\n \"validity_seconds\": 31536000\n }`)\n req, err := http.NewRequest(\"POST\", reqUrl, bytes.NewBuffer(data))\n if err != nil {\n panic(err)\n }\n req.Header.Add(\"Content-Type\", \"application/json\")\n req.Header.Add(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n req.Header.Add(\"X-Environment\", \"beta\")\n res, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer res.Body.Close()\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(res)\n fmt.Println(string(body))\n}"},{"lang":"ruby","title":"Ruby","source":"require 'json'\nrequire 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI('https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations')\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest['Content-Type'] = 'application/json'\nrequest['X-Org-Id'] = '497f6eca-6276-4993-bfeb-53cbbbba6f08'\nrequest['X-Environment'] = 'beta'\nrequest.body = {\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n email: 'alice@example.com',\n claims: {\n given_name: 'Alice',\n employee_number: 'E-1042'\n },\n reference_id: 'partner-invitation-1042',\n invitation_ttl_seconds: 86400,\n offer_validity_seconds: 600,\n validity_seconds: 31536000\n}.to_json\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"r","title":"R","source":"library(httr)\n\nbody = '{\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"email\": \"alice@example.com\",\n \"claims\": {\n \"given_name\": \"Alice\",\n \"employee_number\": \"E-1042\"\n },\n \"reference_id\": \"partner-invitation-1042\",\n \"invitation_ttl_seconds\": 86400,\n \"offer_validity_seconds\": 600,\n \"validity_seconds\": 31536000\n}'\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations\"\n\ndata_req <- POST(\n url,\n add_headers(\"Content-Type\" = \"application/json\", \"X-Org-Id\" = \"497f6eca-6276-4993-bfeb-53cbbbba6f08\", \"X-Environment\" = \"beta\"),\n body = body,\n encode = \"json\",\n verbose()\n)\n\ncontent(data_req)"},{"lang":"json","title":"Payload application/json","source":"{\n \"credential_definition_id\": \"db167a9d-8182-430c-bff0-f9baa6d48bb6\",\n \"email\": \"alice@example.com\",\n \"claims\": {\n \"given_name\": \"Alice\",\n \"employee_number\": \"E-1042\"\n },\n \"reference_id\": \"partner-invitation-1042\",\n \"invitation_ttl_seconds\": 86400,\n \"offer_validity_seconds\": 600,\n \"validity_seconds\": 31536000\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference_id"]}," is optional correlation metadata echoed on the invitation. It is not an idempotency key, uniqueness constraint, or cached-response key. Repeating create can create another resource unless the pending-recipient uniqueness rule rejects it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The successful response includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]},", formatted like ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["7KMTD-5X7Q9"]},". Send that secret through your own email, SMS, or other channel. DeepCredentials does not send the email and does not return a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redemption_url"]}," for this B2B operation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keep the submitted ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["claims"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validity_seconds"]}," in your own durable request record. Invitation create, list, and get responses intentionally omit both, so they cannot be reconstructed from the B2B resource later."]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../openapi/credential-invitations-v1.yaml#/components/schemas/CredentialInvitationWithCode"},"options":{"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/CredentialInvitationWithCode"},"CredentialInvitationStatus":{"type":"string","enum":["pending","redeemed","expired","revoked"],"description":"Current invitation lifecycle state."},"CredentialInvitation":{"type":"object","required":["invitation_id","environment","credential_definition_id","credential_definition_name","email","code_last4","status","expires_at","created_at"],"properties":{"invitation_id":{"type":"string","format":"uuid","description":"Credential invitation ID."},"environment":{"type":"string","enum":["beta","production"],"description":"Environment selected by `X-Environment` when the invitation was created."},"credential_definition_id":{"type":"string","format":"uuid","description":"Credential definition used for the eventual offer."},"credential_definition_name":{"type":"string","description":"Credential definition name captured when the invitation was created."},"email":{"type":"string","format":"email","description":"Normalized recipient email required for public redemption."},"code_last4":{"type":"string","minLength":4,"maxLength":4,"pattern":"^[0-9A-HJKMNP-TV-Z]{4}$","description":"Last four normalized code characters for support and delivery confirmation. This is not a redeemable code."},"status":{"$ref":"#/components/schemas/CredentialInvitationStatus"},"reference_id":{"type":"string","description":"Optional correlation identifier from your system; echoed on the resource."},"offer_validity_seconds":{"type":"integer","format":"int64","description":"Configured lifetime of the offer created after redemption, when supplied at creation."},"redeemed_offer_id":{"type":"string","format":"uuid","description":"Offer created by a successful redemption. Present only after redemption."},"expires_at":{"type":"string","format":"date-time","description":"Invitation-code expiry timestamp in RFC 3339 UTC."},"redeemed_at":{"type":"string","format":"date-time","description":"Successful redemption timestamp in RFC 3339 UTC."},"revoked_at":{"type":"string","format":"date-time","description":"Revocation timestamp in RFC 3339 UTC."},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp in RFC 3339 UTC."}}},"CredentialInvitationWithCode":{"allOf":[{"$ref":"#/components/schemas/CredentialInvitation"},{"type":"object","required":["code"],"properties":{"code":{"type":"string","minLength":11,"maxLength":11,"pattern":"^[0-9A-HJKMNP-TV-Z]{5}-[0-9A-HJKMNP-TV-Z]{5}$","description":"One-time plaintext invitation code. Returned only by create and rotate; the caller owns secure delivery."}}}]}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"redeem-the-invitation","__idx":10},"children":["Redeem the invitation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your system decides where and how to present the redemption experience. Once it has the recipient's email address and one-time code, its backend exchanges them through the anonymous public endpoint:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /api/v1/public/credential-invitations/redeem\nContent-Type: application/json\n\n{\n \"email\": \"alice@example.com\",\n \"code\": \"7KMTD-5X7Q9\"\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response contains a fresh OID4VCI ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deeplink"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["qr_content_base64"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offer_id"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expires_at"]},". Your system decides how to deliver or display those values to the recipient. This endpoint requires no service-user token; do not expose a B2B token to the recipient or include one in the redemption call."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful redemption atomically marks the invitation ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemed"]}," and creates a fresh OID4VCI offer. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_invitation.status_changed"]}," webhook contains the resulting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offer_id"]},"; from that point, track the offer through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /b2b/v1/credential-offers/{offerId}"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issuing.status_changed"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"list-and-get-invitations","__idx":11},"children":["List and get invitations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List results are scoped by your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Org-Id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Environment"]},", ordered newest first, and contain no plaintext code or claims. The optional filters are exact matches."]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-docs/openapi/credential-invitations-v1.yaml","operationId":"GET:b2b.ListCredentialInvitations","parameters":{"query":{"status":"pending","credential_definition_id":"YOUR_CREDENTIAL_DEFINITION_ID","email":"alice@example.com","reference_id":"partner-invitation-1042","limit":50,"offset":0}},"environments":{"https://api.dev.deepcredentials.swiss":{"BearerAuth":"YOUR_ACCESS_TOKEN"}},"environment":"https://api.dev.deepcredentials.swiss","codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X GET \\\n 'https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations?limit=50&offset=0&status=pending&credential_definition_id=YOUR_CREDENTIAL_DEFINITION_ID&email=alice%40example.com&reference_id=partner-invitation-1042' \\\n -H 'X-Environment: beta' \\\n -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'"},{"lang":"javascript","title":"JavaScript","source":"const query = new URLSearchParams({\n limit: '50',\n offset: '0',\n status: 'pending',\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n email: 'alice@example.com',\n reference_id: 'partner-invitation-1042'\n}).toString();\n\nconst resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations?${query}`,\n {\n method: 'GET',\n headers: {\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n }\n }\n);\n\nconst data = await resp.text();\nconsole.log(data);"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n const query = new URLSearchParams({\n limit: '50',\n offset: '0',\n status: 'pending',\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n email: 'alice@example.com',\n reference_id: 'partner-invitation-1042'\n }).toString();\n\n const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations?${query}`,\n {\n method: 'GET',\n headers: {\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n }\n }\n );\n\n const data = await resp.text();\n console.log(data);\n}\n\nrun();"},{"lang":"python","title":"Python","source":"import requests\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations\"\n\nquery = {\n \"limit\": \"50\",\n \"offset\": \"0\",\n \"status\": \"pending\",\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"email\": \"alice@example.com\",\n \"reference_id\": \"partner-invitation-1042\"\n}\n\nheaders = {\n \"X-Org-Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"X-Environment\": \"beta\"\n}\n\nresponse = requests.get(url, headers=headers, params=query)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\nimport java.nio.charset.StandardCharsets;\nimport java.util.stream.Collectors;\n\npublic class App {\n public static void main(String[] args) throws Exception {\n var httpClient = HttpClient.newBuilder().build();\n\n HashMap params = new HashMap<>();\n params.put(\"limit\", \"50\");\n params.put(\"offset\", \"0\");\n params.put(\"status\", \"pending\");\n params.put(\"credential_definition_id\", \"YOUR_CREDENTIAL_DEFINITION_ID\");\n params.put(\"email\", \"alice@example.com\");\n params.put(\"reference_id\", \"partner-invitation-1042\");\n\n var query = params.keySet().stream()\n .map(key -> key + \"=\" + URLEncoder.encode(params.get(key), StandardCharsets.UTF_8))\n .collect(Collectors.joining(\"&\"));\n\n var host = \"https://api.dev.deepcredentials.swiss\";\n var pathname = \"/b2b/v1/credential-invitations\";\n var request = HttpRequest.newBuilder()\n .GET()\n .uri(URI.create(host + pathname + '?' + query))\n .header(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n .header(\"X-Environment\", \"beta\")\n .build();\n\n var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\n\npublic class Program\n{\n public static async Task Main()\n {\n System.Net.Http.HttpClient client = new()\n {\n DefaultRequestHeaders =\n {\n {\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\n {\"X-Environment\", \"beta\"},\n }\n };\n\n using HttpResponseMessage request = await client.GetAsync(\"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations?limit=50&offset=0&status=pending&credential_definition_id=YOUR_CREDENTIAL_DEFINITION_ID&email=alice%40example.com&reference_id=partner-invitation-1042\");\n string response = await request.Content.ReadAsStringAsync();\n\n Console.WriteLine(response);\n }\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\n$query = array(\n \"limit\" => \"50\",\n \"offset\" => \"0\",\n \"status\" => \"pending\",\n \"credential_definition_id\" => \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"email\" => \"alice@example.com\",\n \"reference_id\" => \"partner-invitation-1042\"\n);\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_HTTPHEADER => [\n \"X-Environment: beta\",\n \"X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n CURLOPT_URL => \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations?\" . http_build_query($query),\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n echo \"cURL Error #:\" . $error;\n} else {\n echo $response;\n}"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n \"fmt\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n reqUrl := \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations\"\n req, err := http.NewRequest(\"GET\", reqUrl, nil)\n\n query := req.URL.Query()\n query.Add(\"limit\", \"50\")\n query.Add(\"offset\", \"0\")\n query.Add(\"status\", \"pending\")\n query.Add(\"credential_definition_id\", \"YOUR_CREDENTIAL_DEFINITION_ID\")\n query.Add(\"email\", \"alice@example.com\")\n query.Add(\"reference_id\", \"partner-invitation-1042\")\n req.URL.RawQuery = query.Encode()\n\n if err != nil {\n panic(err)\n }\n req.Header.Add(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n req.Header.Add(\"X-Environment\", \"beta\")\n res, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer res.Body.Close()\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(res)\n fmt.Println(string(body))\n}"},{"lang":"ruby","title":"Ruby","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI('https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations')\nparams = {\n limit: '50',\n offset: '0',\n status: 'pending',\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n email: 'alice@example.com',\n reference_id: 'partner-invitation-1042'\n}\nurl.query = URI.encode_www_form(params)\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest['X-Org-Id'] = '497f6eca-6276-4993-bfeb-53cbbbba6f08'\nrequest['X-Environment'] = 'beta'\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"r","title":"R","source":"library(httr)\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations?limit=50&offset=0&status=pending&credential_definition_id=YOUR_CREDENTIAL_DEFINITION_ID&email=alice%40example.com&reference_id=partner-invitation-1042\"\n\ndata_req <- GET(\n url,\n add_headers(\"X-Org-Id\" = \"497f6eca-6276-4993-bfeb-53cbbbba6f08\", \"X-Environment\" = \"beta\"),\n verbose()\n)\n\ncontent(data_req)"}]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use get when you already have the invitation ID:"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-docs/openapi/credential-invitations-v1.yaml","operationId":"GET:b2b.GetCredentialInvitation","parameters":{"path":{"invitationId":"305ac8b8-299a-4e63-a969-405840e67772"}},"environments":{"https://api.dev.deepcredentials.swiss":{"BearerAuth":"YOUR_ACCESS_TOKEN"}},"environment":"https://api.dev.deepcredentials.swiss","codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X GET \\\n https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/305ac8b8-299a-4e63-a969-405840e67772 \\\n -H 'X-Environment: beta' \\\n -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'"},{"lang":"javascript","title":"JavaScript","source":"const invitationId = '305ac8b8-299a-4e63-a969-405840e67772';\nconst resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/${invitationId}`,\n {\n method: 'GET',\n headers: {\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n }\n }\n);\n\nconst data = await resp.text();\nconsole.log(data);"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n const invitationId = '305ac8b8-299a-4e63-a969-405840e67772';\n const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/${invitationId}`,\n {\n method: 'GET',\n headers: {\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n }\n }\n );\n\n const data = await resp.text();\n console.log(data);\n}\n\nrun();"},{"lang":"python","title":"Python","source":"import requests\n\ninvitation_id = \"305ac8b8-299a-4e63-a969-405840e67772\"\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" + invitation_id\n\nheaders = {\n \"X-Org-Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"X-Environment\": \"beta\"\n}\n\nresponse = requests.get(url, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\n\npublic class App {\n public static void main(String[] args) throws Exception {\n var httpClient = HttpClient.newBuilder().build();\n\n var host = \"https://api.dev.deepcredentials.swiss\";\n var invitationId = \"305ac8b8-299a-4e63-a969-405840e67772\";\n var pathname = \"/b2b/v1/credential-invitations/%7BinvitationId%7D\";\n var request = HttpRequest.newBuilder()\n .GET()\n .uri(URI.create(host + pathname ))\n .header(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n .header(\"X-Environment\", \"beta\")\n .build();\n\n var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\n\npublic class Program\n{\n public static async Task Main()\n {\n System.Net.Http.HttpClient client = new()\n {\n DefaultRequestHeaders =\n {\n {\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\n {\"X-Environment\", \"beta\"},\n }\n };\n\n var InvitationId = \"305ac8b8-299a-4e63-a969-405840e67772\";\n using HttpResponseMessage request = await client.GetAsync(\"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" + InvitationId);\n string response = await request.Content.ReadAsStringAsync();\n\n Console.WriteLine(response);\n }\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\nconst invitationId = \"305ac8b8-299a-4e63-a969-405840e67772\";\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_HTTPHEADER => [\n \"X-Environment: beta\",\n \"X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n CURLOPT_URL => \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" . invitationId,\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n echo \"cURL Error #:\" . $error;\n} else {\n echo $response;\n}"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n \"fmt\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n invitationId := \"305ac8b8-299a-4e63-a969-405840e67772\";\n reqUrl := \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" + invitationId\n req, err := http.NewRequest(\"GET\", reqUrl, nil)\n if err != nil {\n panic(err)\n }\n req.Header.Add(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n req.Header.Add(\"X-Environment\", \"beta\")\n res, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer res.Body.Close()\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(res)\n fmt.Println(string(body))\n}"},{"lang":"ruby","title":"Ruby","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\ninvitation_id = '305ac8b8-299a-4e63-a969-405840e67772'\nurl = URI('https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/' + invitation_id)\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest['X-Org-Id'] = '497f6eca-6276-4993-bfeb-53cbbbba6f08'\nrequest['X-Environment'] = 'beta'\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"r","title":"R","source":"library(httr)\n\ninvitation_id = \"305ac8b8-299a-4e63-a969-405840e67772\"\n\n# create you own operator\n\"%&%\" <- function(x, y)paste0(x,y)\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" %&% invitation_id\n\ndata_req <- GET(\n url,\n add_headers(\"X-Org-Id\" = \"497f6eca-6276-4993-bfeb-53cbbbba6f08\", \"X-Environment\" = \"beta\"),\n verbose()\n)\n\ncontent(data_req)"}]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"recover-from-a-lost-create-response","__idx":12},"children":["Recover from a lost create response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Because create is not idempotent, do not blindly retry after an ambiguous transport failure. Persist the complete create request locally and use a distinct ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference_id"]}," for each intended invitation:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["List with the exact ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_definition_id"]},", normalized ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]},", and your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference_id"]},"; do not restrict the first lookup to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},", because the invitation may have reached a terminal state while the response was unavailable."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If there is exactly one match, compare all returned metadata with your durable request record. Reconcile a terminal match through its status and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemed_offer_id"]}," rather than creating another invitation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Rotate only when the matching invitation is still ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}," and your system can establish that it belongs to this create attempt, then deliver only the replacement code returned by rotate."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If there is no match, retry create. If that returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["already_exists"]},", list by pending status, definition, and email without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference_id"]}," and resolve the conflicting resource manually."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If there is more than one match or the identity is otherwise ambiguous, do not select, rotate, or revoke a resource automatically."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The pending-recipient uniqueness rule prevents two pending invitations for the same organization, environment, credential definition, and normalized email. That rule supports discovery but does not turn ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference_id"]}," into an idempotency key. List/get responses do not expose claims or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validity_seconds"]},", so those hidden inputs can be verified only against the request record retained by your system."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rotate-a-code","__idx":13},"children":["Rotate a code"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-docs/openapi/credential-invitations-v1.yaml","operationId":"POST:b2b.RotateCredentialInvitationCode","parameters":{"path":{"invitationId":"305ac8b8-299a-4e63-a969-405840e67772"}},"requestBody":{"invitation_ttl_seconds":86400},"environments":{"https://api.dev.deepcredentials.swiss":{"BearerAuth":"YOUR_ACCESS_TOKEN"}},"environment":"https://api.dev.deepcredentials.swiss","codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X POST \\\n https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/305ac8b8-299a-4e63-a969-405840e67772/rotate-code \\\n -H 'Content-Type: application/json' \\\n -H 'X-Environment: beta' \\\n -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \\\n -d '{\n \"invitation_ttl_seconds\": 86400\n }'"},{"lang":"javascript","title":"JavaScript","source":"const invitationId = '305ac8b8-299a-4e63-a969-405840e67772';\nconst resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/${invitationId}/rotate-code`,\n {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n },\n body: JSON.stringify({\n invitation_ttl_seconds: 86400\n })\n }\n);\n\nconst data = await resp.json();\nconsole.log(data);"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n const invitationId = '305ac8b8-299a-4e63-a969-405840e67772';\n const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/${invitationId}/rotate-code`,\n {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n },\n body: JSON.stringify({\n invitation_ttl_seconds: 86400\n })\n }\n );\n\n const data = await resp.json();\n console.log(data);\n}\n\nrun();"},{"lang":"python","title":"Python","source":"import requests\n\ninvitation_id = \"305ac8b8-299a-4e63-a969-405840e67772\"\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" + invitation_id + \"/rotate-code\"\n\npayload = {\n \"invitation_ttl_seconds\": 86400\n}\n\nheaders = {\n \"Content-Type\": \"application/json\",\n \"X-Org-Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"X-Environment\": \"beta\"\n}\n\nresponse = requests.post(url, json=payload, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\n\npublic class App {\n public static void main(String[] args) throws Exception {\n var httpClient = HttpClient.newBuilder().build();\n\n var payload = String.join(\"\\n\"\n , \"{\"\n , \" \\\"invitation_ttl_seconds\\\": 86400\"\n , \"}\"\n );\n\n var host = \"https://api.dev.deepcredentials.swiss\";\n var invitationId = \"305ac8b8-299a-4e63-a969-405840e67772\";\n var pathname = \"/b2b/v1/credential-invitations/%7BinvitationId%7D/rotate-code\";\n var request = HttpRequest.newBuilder()\n .POST(HttpRequest.BodyPublishers.ofString(payload))\n .uri(URI.create(host + pathname ))\n .header(\"Content-Type\", \"application/json\")\n .header(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n .header(\"X-Environment\", \"beta\")\n .build();\n\n var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\nusing System.Text;\nusing System.Text.Json;\n\npublic class Program\n{\n public static async Task Main()\n {\n System.Net.Http.HttpClient client = new()\n {\n DefaultRequestHeaders =\n {\n {\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\n {\"X-Environment\", \"beta\"},\n }\n };\n\n string json = JsonSerializer.Serialize(new\n {\n invitation_ttl_seconds = \"86400\"\n });\n\n using StringContent postData = new(json, Encoding.UTF8, \"application/json\");\n var InvitationId = \"305ac8b8-299a-4e63-a969-405840e67772\";\n using HttpResponseMessage request = await client.PostAsync(\"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" + InvitationId + \"/rotate-code\", postData);\n string response = await request.Content.ReadAsStringAsync();\n\n Console.WriteLine(response);\n }\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\nconst invitationId = \"305ac8b8-299a-4e63-a969-405840e67772\";\n$curl = curl_init();\n\n$payload = array(\n \"invitation_ttl_seconds\" => 86400\n);\n\ncurl_setopt_array($curl, [\n CURLOPT_HTTPHEADER => [\n \"Content-Type: application/json\",\n \"X-Environment: beta\",\n \"X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n CURLOPT_POSTFIELDS => json_encode($payload),\n CURLOPT_URL => \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" . invitationId . \"/rotate-code\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n echo \"cURL Error #:\" . $error;\n} else {\n echo $response;\n}"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n \"fmt\"\n \"bytes\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n invitationId := \"305ac8b8-299a-4e63-a969-405840e67772\";\n reqUrl := \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" + invitationId + \"/rotate-code\"\n var data = []byte(`{\n \"invitation_ttl_seconds\": 86400\n }`)\n req, err := http.NewRequest(\"POST\", reqUrl, bytes.NewBuffer(data))\n if err != nil {\n panic(err)\n }\n req.Header.Add(\"Content-Type\", \"application/json\")\n req.Header.Add(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n req.Header.Add(\"X-Environment\", \"beta\")\n res, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer res.Body.Close()\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(res)\n fmt.Println(string(body))\n}"},{"lang":"ruby","title":"Ruby","source":"require 'json'\nrequire 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\ninvitation_id = '305ac8b8-299a-4e63-a969-405840e67772'\nurl = URI('https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/' + invitation_id + '/rotate-code')\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest['Content-Type'] = 'application/json'\nrequest['X-Org-Id'] = '497f6eca-6276-4993-bfeb-53cbbbba6f08'\nrequest['X-Environment'] = 'beta'\nrequest.body = {\n invitation_ttl_seconds: 86400\n}.to_json\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"r","title":"R","source":"library(httr)\n\nbody = '{\n \"invitation_ttl_seconds\": 86400\n}'\n\ninvitation_id = \"305ac8b8-299a-4e63-a969-405840e67772\"\n\n# create you own operator\n\"%&%\" <- function(x, y)paste0(x,y)\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" %&% invitation_id %&% \"/rotate-code\"\n\ndata_req <- POST(\n url,\n add_headers(\"Content-Type\" = \"application/json\", \"X-Org-Id\" = \"497f6eca-6276-4993-bfeb-53cbbbba6f08\", \"X-Environment\" = \"beta\"),\n body = body,\n encode = \"json\",\n verbose()\n)\n\ncontent(data_req)"},{"lang":"json","title":"Payload application/json","source":"{\n \"invitation_ttl_seconds\": 86400\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Rotation is deliberately non-idempotent. Every successful call generates a new code, invalidates the previous one, resets failed attempts, and replaces the expiry. If the response is lost, call rotate again until you receive a response; then use only that response's code. DeepCredentials never emails a B2B replacement code."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"revoke-an-invitation","__idx":14},"children":["Revoke an invitation"]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-docs/openapi/credential-invitations-v1.yaml","operationId":"POST:b2b.RevokeCredentialInvitation","parameters":{"path":{"invitationId":"305ac8b8-299a-4e63-a969-405840e67772"}},"environments":{"https://api.dev.deepcredentials.swiss":{"BearerAuth":"YOUR_ACCESS_TOKEN"}},"environment":"https://api.dev.deepcredentials.swiss","codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X POST \\\n https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/305ac8b8-299a-4e63-a969-405840e67772/revoke \\\n -H 'X-Environment: beta' \\\n -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'"},{"lang":"javascript","title":"JavaScript","source":"const invitationId = '305ac8b8-299a-4e63-a969-405840e67772';\nconst resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/${invitationId}/revoke`,\n {\n method: 'POST',\n headers: {\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n }\n }\n);\n\nconst data = await resp.text();\nconsole.log(data);"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n const invitationId = '305ac8b8-299a-4e63-a969-405840e67772';\n const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/${invitationId}/revoke`,\n {\n method: 'POST',\n headers: {\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n }\n }\n );\n\n const data = await resp.text();\n console.log(data);\n}\n\nrun();"},{"lang":"python","title":"Python","source":"import requests\n\ninvitation_id = \"305ac8b8-299a-4e63-a969-405840e67772\"\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" + invitation_id + \"/revoke\"\n\nheaders = {\n \"X-Org-Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"X-Environment\": \"beta\"\n}\n\nresponse = requests.post(url, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\n\npublic class App {\n public static void main(String[] args) throws Exception {\n var httpClient = HttpClient.newBuilder().build();\n\n var host = \"https://api.dev.deepcredentials.swiss\";\n var invitationId = \"305ac8b8-299a-4e63-a969-405840e67772\";\n var pathname = \"/b2b/v1/credential-invitations/%7BinvitationId%7D/revoke\";\n var request = HttpRequest.newBuilder()\n .POST(HttpRequest.BodyPublishers.ofString(\"some body text\"))\n .uri(URI.create(host + pathname ))\n .header(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n .header(\"X-Environment\", \"beta\")\n .build();\n\n var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\n\npublic class Program\n{\n public static async Task Main()\n {\n System.Net.Http.HttpClient client = new()\n {\n DefaultRequestHeaders =\n {\n {\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\n {\"X-Environment\", \"beta\"},\n }\n };\n\n var InvitationId = \"305ac8b8-299a-4e63-a969-405840e67772\";\n using HttpResponseMessage request = await client.PostAsync(\"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" + InvitationId + \"/revoke\", null);\n string response = await request.Content.ReadAsStringAsync();\n\n Console.WriteLine(response);\n }\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\nconst invitationId = \"305ac8b8-299a-4e63-a969-405840e67772\";\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_HTTPHEADER => [\n \"X-Environment: beta\",\n \"X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n CURLOPT_URL => \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" . invitationId . \"/revoke\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n echo \"cURL Error #:\" . $error;\n} else {\n echo $response;\n}"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n \"fmt\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n invitationId := \"305ac8b8-299a-4e63-a969-405840e67772\";\n reqUrl := \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" + invitationId + \"/revoke\"\n req, err := http.NewRequest(\"POST\", reqUrl, nil)\n if err != nil {\n panic(err)\n }\n req.Header.Add(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n req.Header.Add(\"X-Environment\", \"beta\")\n res, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer res.Body.Close()\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(res)\n fmt.Println(string(body))\n}"},{"lang":"ruby","title":"Ruby","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\ninvitation_id = '305ac8b8-299a-4e63-a969-405840e67772'\nurl = URI('https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/' + invitation_id + '/revoke')\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest['X-Org-Id'] = '497f6eca-6276-4993-bfeb-53cbbbba6f08'\nrequest['X-Environment'] = 'beta'\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"r","title":"R","source":"library(httr)\n\ninvitation_id = \"305ac8b8-299a-4e63-a969-405840e67772\"\n\n# create you own operator\n\"%&%\" <- function(x, y)paste0(x,y)\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-invitations/\" %&% invitation_id %&% \"/revoke\"\n\ndata_req <- POST(\n url,\n add_headers(\"X-Org-Id\" = \"497f6eca-6276-4993-bfeb-53cbbbba6f08\", \"X-Environment\" = \"beta\"),\n verbose()\n)\n\ncontent(data_req)"}]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only a pending invitation can be revoked. Repeating revoke, or revoking an invitation that is already redeemed or expired, returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed_precondition"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-an-offer","__idx":15},"children":["Step 1: Create an offer"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/credential-offers-v1"},"children":["Open in API reference →"]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-docs/openapi/credential-offers-v1.yaml","operationId":"POST:b2b.CreateCredentialOffer","parameters":{},"requestBody":{"credential_definition_id":"YOUR_CREDENTIAL_DEFINITION_ID","claims":{"given_name":"Max","family_name":"Mustermann","is_over_18":true},"reference_id":"employee-12345","validity_seconds":31536000},"environments":{"https://api.dev.deepcredentials.swiss":{"BearerAuth":"YOUR_ACCESS_TOKEN"}},"environment":"https://api.dev.deepcredentials.swiss","codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X POST \\\n https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers \\\n -H 'Content-Type: application/json' \\\n -H 'X-Environment: beta' \\\n -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \\\n -d '{\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"claims\": {\n \"given_name\": \"Max\",\n \"family_name\": \"Mustermann\",\n \"is_over_18\": true\n },\n \"reference_id\": \"employee-12345\",\n \"validity_seconds\": 31536000\n }'"},{"lang":"javascript","title":"JavaScript","source":"const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers`,\n {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n },\n body: JSON.stringify({\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n claims: {\n given_name: 'Max',\n family_name: 'Mustermann',\n is_over_18: true\n },\n reference_id: 'employee-12345',\n validity_seconds: 31536000\n })\n }\n);\n\nconst data = await resp.json();\nconsole.log(data);"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers`,\n {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n },\n body: JSON.stringify({\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n claims: {\n given_name: 'Max',\n family_name: 'Mustermann',\n is_over_18: true\n },\n reference_id: 'employee-12345',\n validity_seconds: 31536000\n })\n }\n );\n\n const data = await resp.json();\n console.log(data);\n}\n\nrun();"},{"lang":"python","title":"Python","source":"import requests\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers\"\n\npayload = {\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"claims\": {\n \"given_name\": \"Max\",\n \"family_name\": \"Mustermann\",\n \"is_over_18\": True\n },\n \"reference_id\": \"employee-12345\",\n \"validity_seconds\": 31536000\n}\n\nheaders = {\n \"Content-Type\": \"application/json\",\n \"X-Org-Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"X-Environment\": \"beta\"\n}\n\nresponse = requests.post(url, json=payload, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\n\npublic class App {\n public static void main(String[] args) throws Exception {\n var httpClient = HttpClient.newBuilder().build();\n\n var payload = String.join(\"\\n\"\n , \"{\"\n , \" \\\"credential_definition_id\\\": \\\"YOUR_CREDENTIAL_DEFINITION_ID\\\",\"\n , \" \\\"claims\\\": {\"\n , \" \\\"given_name\\\": \\\"Max\\\",\"\n , \" \\\"family_name\\\": \\\"Mustermann\\\",\"\n , \" \\\"is_over_18\\\": true\"\n , \" },\"\n , \" \\\"reference_id\\\": \\\"employee-12345\\\",\"\n , \" \\\"validity_seconds\\\": 31536000\"\n , \"}\"\n );\n\n var host = \"https://api.dev.deepcredentials.swiss\";\n var pathname = \"/b2b/v1/credential-offers\";\n var request = HttpRequest.newBuilder()\n .POST(HttpRequest.BodyPublishers.ofString(payload))\n .uri(URI.create(host + pathname ))\n .header(\"Content-Type\", \"application/json\")\n .header(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n .header(\"X-Environment\", \"beta\")\n .build();\n\n var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\nusing System.Text;\nusing System.Text.Json;\n\npublic class Program\n{\n public static async Task Main()\n {\n System.Net.Http.HttpClient client = new()\n {\n DefaultRequestHeaders =\n {\n {\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\n {\"X-Environment\", \"beta\"},\n }\n };\n\n string json = JsonSerializer.Serialize(new\n {\n credential_definition_id = \"YOUR_CREDENTIAL_DEFINITION_ID\",\n claims = new {\n given_name = \"Max\",\n family_name = \"Mustermann\",\n is_over_18 = \"true\"\n },\n reference_id = \"employee-12345\",\n validity_seconds = \"31536000\"\n });\n\n using StringContent postData = new(json, Encoding.UTF8, \"application/json\");\n using HttpResponseMessage request = await client.PostAsync(\"https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers\", postData);\n string response = await request.Content.ReadAsStringAsync();\n\n Console.WriteLine(response);\n }\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\n$curl = curl_init();\n\n$payload = array(\n \"credential_definition_id\" => \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"claims\" => array(\n \"given_name\" => \"Max\",\n \"family_name\" => \"Mustermann\",\n \"is_over_18\" => true\n ),\n \"reference_id\" => \"employee-12345\",\n \"validity_seconds\" => 31536000\n);\n\ncurl_setopt_array($curl, [\n CURLOPT_HTTPHEADER => [\n \"Content-Type: application/json\",\n \"X-Environment: beta\",\n \"X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n CURLOPT_POSTFIELDS => json_encode($payload),\n CURLOPT_URL => \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n echo \"cURL Error #:\" . $error;\n} else {\n echo $response;\n}"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n \"fmt\"\n \"bytes\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n reqUrl := \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers\"\n var data = []byte(`{\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"claims\": {\n \"given_name\": \"Max\",\n \"family_name\": \"Mustermann\",\n \"is_over_18\": true\n },\n \"reference_id\": \"employee-12345\",\n \"validity_seconds\": 31536000\n }`)\n req, err := http.NewRequest(\"POST\", reqUrl, bytes.NewBuffer(data))\n if err != nil {\n panic(err)\n }\n req.Header.Add(\"Content-Type\", \"application/json\")\n req.Header.Add(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n req.Header.Add(\"X-Environment\", \"beta\")\n res, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer res.Body.Close()\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(res)\n fmt.Println(string(body))\n}"},{"lang":"ruby","title":"Ruby","source":"require 'json'\nrequire 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\nurl = URI('https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers')\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest['Content-Type'] = 'application/json'\nrequest['X-Org-Id'] = '497f6eca-6276-4993-bfeb-53cbbbba6f08'\nrequest['X-Environment'] = 'beta'\nrequest.body = {\n credential_definition_id: 'YOUR_CREDENTIAL_DEFINITION_ID',\n claims: {\n given_name: 'Max',\n family_name: 'Mustermann',\n is_over_18: true\n },\n reference_id: 'employee-12345',\n validity_seconds: 31536000\n}.to_json\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"r","title":"R","source":"library(httr)\n\nbody = '{\n \"credential_definition_id\": \"YOUR_CREDENTIAL_DEFINITION_ID\",\n \"claims\": {\n \"given_name\": \"Max\",\n \"family_name\": \"Mustermann\",\n \"is_over_18\": true\n },\n \"reference_id\": \"employee-12345\",\n \"validity_seconds\": 31536000\n}'\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers\"\n\ndata_req <- POST(\n url,\n add_headers(\"Content-Type\" = \"application/json\", \"X-Org-Id\" = \"497f6eca-6276-4993-bfeb-53cbbbba6f08\", \"X-Environment\" = \"beta\"),\n body = body,\n encode = \"json\",\n verbose()\n)\n\ncontent(data_req)"},{"lang":"json","title":"Payload application/json","source":"{\n \"credential_definition_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"claims\": {\n \"given_name\": \"Max\",\n \"family_name\": \"Mustermann\",\n \"date_of_birth\": \"1990-01-15\",\n \"is_over_18\": true\n },\n \"reference_id\": \"order-12345\",\n \"offer_validity_seconds\": 600\n}"}]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["validity_seconds"]}," is optional — omit to inherit the credential definition's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["default_validity_seconds"]},". See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#credential-validity"},"children":["Credential validity"]}," for the full fallback chain."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response","__idx":16},"children":["Response"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../openapi/credential-offers-v1.yaml#/paths/~1b2b~1v1~1credential-offers/post/responses/200/content/application~1json/schema"},"options":{"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/schema"},"issuer.OfferStatus":{"type":"string","enum":["pending","issued","accepted","expired","failed"],"description":"Lifecycle state of a credential offer."},"schema":{"properties":{"claims":{"description":"Claim values for the credential (echoed from the request).","type":"object"},"created_at":{"format":"date-time","description":"When the offer was created (RFC3339).","type":"string"},"deeplink":{"description":"OID4VCI wallet deep link (e.g. openid-credential-offer://...).","type":"string"},"expires_at":{"format":"date-time","description":"Offer TTL deadline (RFC3339).","type":"string"},"id":{"type":"string","format":"uuid","description":"UUID v4 identifier.","example":"550e8400-e29b-41d4-a716-446655440000"},"qr_content_base64":{"description":"Base64-encoded PNG; QR payload is the same URI as deeplink.","type":"string"},"status":{"$ref":"#/components/schemas/issuer.OfferStatus"}},"required":["id","status","deeplink","qr_content_base64","claims","expires_at","created_at"],"type":"object"}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes a QR code and deeplink for the wallet holder."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Claim validation"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Claim values are validated against the credential definition. Boolean claims must be JSON ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},", integer and number claims must be JSON numbers, string claims must be JSON strings. Missing mandatory claims are rejected."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-present-the-qr-code","__idx":17},"children":["Step 2: Present the QR code"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You have two options to present the issuance offer to the wallet holder:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"qr-code-desktop--in-person","__idx":18},"children":["QR code (desktop / in-person)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["qr_content_base64"]}," field is a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["standard Base64-encoded PNG image"]},". Display it directly:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"html","header":{"controls":{"copy":{}}},"source":"\"Scan\n","lang":"html"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"deeplink-mobile","__idx":19},"children":["Deeplink (mobile)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deeplink"]}," field contains a URI that opens the wallet app directly:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"openid-credential-offer://?credential_offer=...\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this when the user is on a mobile device — redirect them to the deeplink instead of showing a QR code."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-track-issuance","__idx":20},"children":["Step 3: Track issuance"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"option-a-polling","__idx":21},"children":["Option A: Polling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Poll ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /b2b/v1/credential-offers/{offerId}"]}," until the status is no longer ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},":"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/openapi/credential-offers-v1"},"children":["Open in API reference →"]}]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"api-docs-docs/openapi/credential-offers-v1.yaml","operationId":"GET:b2b.GetCredentialOffer","parameters":{"path":{"offerId":"770e8400-e29b-41d4-a716-446655440000"}},"environments":{"https://api.dev.deepcredentials.swiss":{"BearerAuth":"YOUR_ACCESS_TOKEN"}},"environment":"https://api.dev.deepcredentials.swiss","codeSamplesResolved":[{"lang":"shell","title":"curl","source":"curl -i -X GET \\\n https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers/770e8400-e29b-41d4-a716-446655440000 \\\n -H 'X-Environment: beta' \\\n -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'"},{"lang":"javascript","title":"JavaScript","source":"const offerId = '770e8400-e29b-41d4-a716-446655440000';\nconst resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers/${offerId}`,\n {\n method: 'GET',\n headers: {\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n }\n }\n);\n\nconst data = await resp.text();\nconsole.log(data);"},{"lang":"javascript","title":"Node.js","source":"import fetch from 'node-fetch';\n\nasync function run() {\n const offerId = '770e8400-e29b-41d4-a716-446655440000';\n const resp = await fetch(\n `https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers/${offerId}`,\n {\n method: 'GET',\n headers: {\n 'X-Org-Id': '497f6eca-6276-4993-bfeb-53cbbbba6f08',\n 'X-Environment': 'beta'\n }\n }\n );\n\n const data = await resp.text();\n console.log(data);\n}\n\nrun();"},{"lang":"python","title":"Python","source":"import requests\n\noffer_id = \"770e8400-e29b-41d4-a716-446655440000\"\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers/\" + offer_id\n\nheaders = {\n \"X-Org-Id\": \"497f6eca-6276-4993-bfeb-53cbbbba6f08\",\n \"X-Environment\": \"beta\"\n}\n\nresponse = requests.get(url, headers=headers)\n\ndata = response.json()\nprint(data)"},{"lang":"java","title":"Java","source":"import java.net.*;\nimport java.net.http.*;\nimport java.util.*;\n\npublic class App {\n public static void main(String[] args) throws Exception {\n var httpClient = HttpClient.newBuilder().build();\n\n var host = \"https://api.dev.deepcredentials.swiss\";\n var offerId = \"770e8400-e29b-41d4-a716-446655440000\";\n var pathname = \"/b2b/v1/credential-offers/%7BofferId%7D\";\n var request = HttpRequest.newBuilder()\n .GET()\n .uri(URI.create(host + pathname ))\n .header(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n .header(\"X-Environment\", \"beta\")\n .build();\n\n var response = httpClient.send(request, HttpResponse.BodyHandlers.ofString());\n\n System.out.println(response.body());\n }\n}"},{"lang":"csharp","title":"C#","source":"using System;\nusing System.Net.Http;\nusing System.Threading.Tasks;\n\npublic class Program\n{\n public static async Task Main()\n {\n System.Net.Http.HttpClient client = new()\n {\n DefaultRequestHeaders =\n {\n {\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\"},\n {\"X-Environment\", \"beta\"},\n }\n };\n\n var OfferId = \"770e8400-e29b-41d4-a716-446655440000\";\n using HttpResponseMessage request = await client.GetAsync(\"https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers/\" + OfferId);\n string response = await request.Content.ReadAsStringAsync();\n\n Console.WriteLine(response);\n }\n}"},{"lang":"php","title":"PHP","source":"/**\n * Requires libcurl\n */\n\nconst offerId = \"770e8400-e29b-41d4-a716-446655440000\";\n$curl = curl_init();\n\ncurl_setopt_array($curl, [\n CURLOPT_HTTPHEADER => [\n \"X-Environment: beta\",\n \"X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08\"\n ],\n CURLOPT_URL => \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers/\" . offerId,\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n]);\n\n$response = curl_exec($curl);\n$error = curl_error($curl);\n\ncurl_close($curl);\n\nif ($error) {\n echo \"cURL Error #:\" . $error;\n} else {\n echo $response;\n}"},{"lang":"go","title":"Go","source":"package main\n\nimport (\n \"fmt\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n offerId := \"770e8400-e29b-41d4-a716-446655440000\";\n reqUrl := \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers/\" + offerId\n req, err := http.NewRequest(\"GET\", reqUrl, nil)\n if err != nil {\n panic(err)\n }\n req.Header.Add(\"X-Org-Id\", \"497f6eca-6276-4993-bfeb-53cbbbba6f08\")\n req.Header.Add(\"X-Environment\", \"beta\")\n res, err := http.DefaultClient.Do(req)\n if err != nil {\n panic(err)\n }\n defer res.Body.Close()\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(res)\n fmt.Println(string(body))\n}"},{"lang":"ruby","title":"Ruby","source":"require 'uri'\nrequire 'net/http'\nrequire 'openssl'\n\noffer_id = '770e8400-e29b-41d4-a716-446655440000'\nurl = URI('https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers/' + offer_id)\n\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest['X-Org-Id'] = '497f6eca-6276-4993-bfeb-53cbbbba6f08'\nrequest['X-Environment'] = 'beta'\n\nresponse = http.request(request)\nputs response.read_body\n"},{"lang":"r","title":"R","source":"library(httr)\n\noffer_id = \"770e8400-e29b-41d4-a716-446655440000\"\n\n# create you own operator\n\"%&%\" <- function(x, y)paste0(x,y)\n\nurl = \"https://api.dev.deepcredentials.swiss/b2b/v1/credential-offers/\" %&% offer_id\n\ndata_req <- GET(\n url,\n add_headers(\"X-Org-Id\" = \"497f6eca-6276-4993-bfeb-53cbbbba6f08\", \"X-Environment\" = \"beta\"),\n verbose()\n)\n\ncontent(data_req)"}]},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-1","__idx":22},"children":["Response"]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../openapi/credential-offers-v1.yaml#/components/schemas/b2b.b2bOfferResponse"},"options":{"requiredPropsFirst":true},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/b2b.b2bOfferResponse"},"b2b.credentialDefinitionRef":{"properties":{"has_logo":{"description":"Whether the credential definition currently has an uploaded logo.","type":"boolean"},"id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"Credential definition UUID. UUID v4 identifier."},"name":{"description":"Human-readable credential definition name.","type":"string"},"vct":{"description":"Verifiable credential type (e.g. \"urn:ietf:params:oauth:vct:PersonId\").","type":"string"}},"required":["id","vct","name","has_logo"],"description":"A compact reference to the credential definition.","type":"object"},"issuer.OfferStatus":{"type":"string","enum":["pending","issued","accepted","expired","failed"],"description":"Lifecycle state of a credential offer."},"b2b.b2bOfferResponse":{"properties":{"claims":{"description":"Claim values for the credential.","type":"object"},"completed_at":{"format":"date-time","description":"Set when the offer leaves pending (issued, failed, or expired).","type":"string"},"created_at":{"format":"date-time","description":"When the offer was created (RFC3339).","type":"string"},"credential_definition":{"allOf":[{"$ref":"#/components/schemas/b2b.credentialDefinitionRef"}],"description":"Credential definition reference."},"credential_validity_seconds":{"format":"int64","description":"Credential lifetime to apply at issuance (SD-JWT exp = iat + N). Absent means the credential will be issued without an exp claim.","type":"integer"},"deeplink":{"description":"Only when status is pending: OID4VCI wallet deep link.","type":"string"},"environment":{"description":"Swiyu environment: \"beta\" or \"production\".","type":"string"},"error_code":{"description":"Machine-readable failure reason when status is failed or expired.","type":"string"},"error_description":{"description":"Human-readable error detail when status is failed or expired.","type":"string"},"expires_at":{"format":"date-time","description":"When a pending offer expires if not completed (RFC3339).","type":"string"},"id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"Offer id (matches the value returned at creation time). UUID v4 identifier."},"invitation_id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"InvitationID / SelfServiceRequestID expose the upstream lineage anchors when this offer was created from one. nil for plain portal or B2B offers."},"issued_credential_id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"Only when status is issued: ID of the issued credential. UUID v4 identifier."},"qr_content_base64":{"description":"Only when status is pending: Base64-encoded PNG QR code (240×240 px).","type":"string"},"reference_id":{"description":"Your reference_id from the create request, if any.","type":"string"},"self_service_request_id":{"type":"string","format":"uuid","description":"UUID v4 identifier.","example":"550e8400-e29b-41d4-a716-446655440000"},"source":{"description":"Source records where this offer originated: \"portal\" (admin UI), \"b2b\" (API caller), \"invitation\" (redeemed email invitation), or \"self\\_service\" (admin approval of a public request). Stable at row level — captured at create and never mutated.","type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/issuer.OfferStatus"}],"description":"Current lifecycle state of the offer."}},"required":["id","environment","credential_definition","status","claims","expires_at","created_at","source"],"description":"The full detail of a credential offer.","type":"object"}}}},"schemaResolvedErrors":[]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["While ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deeplink"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["qr_content_base64"]}," are present. When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," changes to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issued"]},", the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issued_credential_id"]}," field contains the credential ID and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deeplink"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["qr_content_base64"]}," are omitted."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When status is no longer ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deeplink"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["qr_content_base64"]}," are omitted from the response — the wallet flow is complete."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Polling recommendations:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Poll every 2–3 seconds."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Stop when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issued"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Respect the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expires_at"]}," timestamp — stop polling after expiration."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"option-b-webhooks","__idx":23},"children":["Option B: Webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Subscribe to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issuing.status_changed"]}," webhook event to receive a slim terminal-state hint (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offer_id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]},"). Follow every callback with authenticated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /b2b/v1/credential-offers/{offerId}"]}," when you need the authoritative offer snapshot. The webhook does not contain the offer claims or duplicate the GET response."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the delayed branch, also opt in to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credential_invitation.status_changed"]},". It fires only for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redeemed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revoked"]},". A redeemed callback contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["offer_id"]},", which is the handoff to the normal offer lifecycle; expired and revoked callbacks omit it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/webhooks"},"children":["Webhooks guide"]}," for setup, signature verification, and secret rotation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-4-manage-credentials","__idx":24},"children":["Step 4: Manage credentials"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-credential-details","__idx":25},"children":["Get credential details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /b2b/v1/issued-credentials/{credentialId}"]}," to retrieve details about an issued credential, including its current status."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"important-issuance-does-not-confirm-holder-acceptance","__idx":26},"children":["Important: Issuance does not confirm holder acceptance"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Issued ≠ Accepted"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When the offer status changes to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issued"]},", it means the credential was ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["delivered to the wallet"]},". However, the current swiyu wallet does not send a confirmation callback — the issuer has no way to know whether the holder actually accepted the credential or dismissed it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is a known limitation of the swiyu Public Beta infrastructure. The OID4VCI specification defines an optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["notification_endpoint"]}," for this purpose, but the swiyu wallet does not implement it yet."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"recommended-verify-after-issuance","__idx":27},"children":["Recommended: Verify after issuance"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To confirm that a holder actually has the credential in their wallet, use the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/verification-flow"},"children":["Verification API"]}," to request a presentation of the recently issued credential:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Issue the credential"]}," via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /b2b/v1/credential-offers"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Wait for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issued"]}," status"]}," (poll or webhook)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create a verification session"]}," via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /b2b/v1/verification-sessions"]}," using the same credential definition."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Ask the holder to present"]}," the credential by scanning the verification QR code."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["success"]}]}," — the credential is confirmed to be in the holder's wallet and valid."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This \"issue-then-verify\" pattern gives you cryptographic proof that the holder possesses the credential, which ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issued"]}," status alone cannot guarantee."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant You as Your System\n participant API as DeepCredentials API\n participant Wallet as Holder's Wallet\n\n You->>API: POST /credential-offers\n API-->>You: offer (QR code)\n You->>Wallet: Show QR to holder\n Wallet->>API: OID4VCI flow\n API-->>You: status: issued\n\n Note over You: Credential delivered, but accepted?\n\n You->>API: POST /verification-sessions\n API-->>You: verification QR\n You->>Wallet: Show verification QR\n Wallet->>API: OID4VP presentation\n API-->>You: status: success + claims\n\n Note over You: Confirmed — holder has the credential\n","diagramHtml":"Holder's WalletDeepCredentials APIYour SystemHolder's WalletDeepCredentials APIYour SystemCredential delivered, but accepted?Confirmed — holder has the credentialPOST /credential-offersoffer (QR code)Show QR to holderOID4VCI flowstatus: issuedPOST /verification-sessionsverification QRShow verification QROID4VP presentationstatus: success + claims","diagramHtmlDark":"Holder's WalletDeepCredentials APIYour SystemHolder's WalletDeepCredentials APIYour SystemCredential delivered, but accepted?Confirmed — holder has the credentialPOST /credential-offersoffer (QR code)Show QR to holderOID4VCI flowstatus: issuedPOST /verification-sessionsverification QRShow verification QROID4VP presentationstatus: success + claims"},"children":["sequenceDiagram\n participant You as Your System\n participant API as DeepCredentials API\n participant Wallet as Holder's Wallet\n\n You->>API: POST /credential-offers\n API-->>You: offer (QR code)\n You->>Wallet: Show QR to holder\n Wallet->>API: OID4VCI flow\n API-->>You: status: issued\n\n Note over You: Credential delivered, but accepted?\n\n You->>API: POST /verification-sessions\n API-->>You: verification QR\n You->>Wallet: Show verification QR\n Wallet->>API: OID4VP presentation\n API-->>You: status: success + claims\n\n Note over You: Confirmed — holder has the credential\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-handling","__idx":28},"children":["Error handling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["On failure:"]}," the offer status changes to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failed"]},". Create a new offer to retry."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["On expiration:"]}," offers that remain ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]}," past their ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expires_at"]}," transition to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expired"]}," automatically. Default TTL is 10 minutes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/error-handling"},"children":["Error Handling"]}," for a complete list of error codes."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":29},"children":["Next steps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/webhooks"},"children":["Webhooks"]}," — Receive issuance results in real time."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/verification-flow"},"children":["Verification Flow"]}," — Verify credentials from wallet holders."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/guides/error-handling"},"children":["Error Handling"]}," — Handle all possible error scenarios."]}]}]},"headings":[{"value":"Credential Issuance Flow","id":"credential-issuance-flow","depth":1},{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Choose a delivery branch","id":"choose-a-delivery-branch","depth":2},{"value":"Offer lifecycle","id":"offer-lifecycle","depth":2},{"value":"Offer statuses","id":"offer-statuses","depth":3},{"value":"Credential statuses","id":"credential-statuses","depth":3},{"value":"Credential validity","id":"credential-validity","depth":2},{"value":"Partner-delivered invitation flow","id":"partner-delivered-invitation-flow","depth":2},{"value":"Invitation statuses","id":"invitation-statuses","depth":3},{"value":"Create an invitation","id":"create-an-invitation","depth":3},{"value":"Redeem the invitation","id":"redeem-the-invitation","depth":3},{"value":"List and get invitations","id":"list-and-get-invitations","depth":3},{"value":"Recover from a lost create response","id":"recover-from-a-lost-create-response","depth":3},{"value":"Rotate a code","id":"rotate-a-code","depth":3},{"value":"Revoke an invitation","id":"revoke-an-invitation","depth":3},{"value":"Step 1: Create an offer","id":"step-1-create-an-offer","depth":2},{"value":"Response","id":"response","depth":3},{"value":"Step 2: Present the QR code","id":"step-2-present-the-qr-code","depth":2},{"value":"QR code (desktop / in-person)","id":"qr-code-desktop--in-person","depth":3},{"value":"Deeplink (mobile)","id":"deeplink-mobile","depth":3},{"value":"Step 3: Track issuance","id":"step-3-track-issuance","depth":2},{"value":"Option A: Polling","id":"option-a-polling","depth":3},{"value":"Response","id":"response-1","depth":3},{"value":"Option B: Webhooks","id":"option-b-webhooks","depth":3},{"value":"Step 4: Manage credentials","id":"step-4-manage-credentials","depth":2},{"value":"Get credential details","id":"get-credential-details","depth":3},{"value":"Important: Issuance does not confirm holder acceptance","id":"important-issuance-does-not-confirm-holder-acceptance","depth":2},{"value":"Recommended: Verify after issuance","id":"recommended-verify-after-issuance","depth":3},{"value":"Error handling","id":"error-handling","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Credential Issuance Flow"}},"lastModified":"2026-08-19T08:56:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/guides/issuance-flow","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}