POST
/
v1
/
openid4vc
/
issuance
/
offer
Create an OpenID4VCI credential offer
curl --request POST \
  --url https://sandbox.authbound.io/v1/openid4vc/issuance/offer \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Authbound-Key: <api-key>' \
  --data '
{
  "credentialDefinitionId": "pension_credential_v1",
  "claims": {
    "Person": {
      "given_name": "Sergio",
      "family_name": "Jack"
    },
    "Pension": {
      "startDate": "2025-01-01T00:00:00.000Z"
    }
  },
  "vct": "urn:vc:authbound:pension:1.0",
  "issuanceMode": "InTime",
  "txCode": "<string>",
  "metadata": {}
}
'
{
  "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).

Headers

Idempotency-Key
string
required
Maximum string length: 255

Body

application/json

Hosted create offer contract. The customer-controlled deployment uses CustomerControlledCreateOpenId4VcIssuanceOfferRequest.

credentialDefinitionId
string
required

Approved Authbound credential definition ID

Example:

"pension_credential_v1"

claims
object
required

Credential claims. Use nested objects for nested claim paths.

Example:
{
"Person": {
"given_name": "Sergio",
"family_name": "Jack"
},
"Pension": { "startDate": "2025-01-01T00:00:00.000Z" }
}
vct
string

SD-JWT VC type identifier resolved by the issuer

Example:

"urn:vc:authbound:pension:1.0"

issuanceMode
enum<string>
default:InTime
Available options:
InTime,
Deferred
txCode
string

Optional transaction code. Authbound maps this to the issuer PIN.

urlScheme
enum<string>
Available options:
openid-credential-offer://,
haip://
metadata
object

Customer metadata accepted by the public contract.

Response

Issuance offer created

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.