GET
/
v1
/
openid4vc
/
issuance
/
{issuanceId}
Retrieve an OpenID4VCI issuance session
curl --request GET \
  --url https://sandbox.authbound.io/v1/openid4vc/issuance/{issuanceId} \
  --header 'X-Authbound-Key: <api-key>'
{
  "object": "openid4vc_issuance",
  "id": "iss_123",
  "credentialDefinitionId": "pension_credential_v1",
  "credentials": [
    {
      "credentialDefinitionId": "pension_credential_v1",
      "status": "offer_created"
    }
  ],
  "offerUri": "<string>",
  "offerQrUri": "<string>",
  "credentialIssuer": "<string>",
  "txCodeRequired": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Authorizations

X-Authbound-Key
string
header
required

Server-side secret key header. Format: sk_live_* (production) or sk_test_* (testing).

Path Parameters

issuanceId
string
required

Response

Issuance session details

Hosted issuance resource. The customer-controlled deployment uses CustomerControlledOpenId4VcIssuance.

object
enum<string>
required
Available options:
openid4vc_issuance
id
string
required
Example:

"iss_123"

status
enum<string>
required
Available options:
offer_created,
ready_to_issue,
token_issued,
credential_issued,
canceled,
expired,
failed
credentialDefinitionId
string
required
Example:

"pension_credential_v1"

credentials
object[]
required
offerUri
string
required

Wallet deep link URI

offerQrUri
string
required

URI to encode as a QR code

credentialIssuer
string<uri>
required
issuanceMode
enum<string>
required
Available options:
InTime,
Deferred
txCodeRequired
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
expiresAt
string<date-time>
metadata
object

Customer metadata stored with the issuance session.