CreateOfferRequest

authenticationMethodstring

Authentication method for the OID4VCI flow. Optional; defaults to PRE_AUTHORIZED.

Possible values: [PRE_AUTHORIZED]

Default value: PRE_AUTHORIZED

Example: PRE_AUTHORIZED

credentialConfigurationIdstringrequired

Identifies the credential type configuration.

Example: VerifiedPerson_vc+sd-jwt

credentialData objectrequired

Key-value pairs of credential claims to embed in the issued credential. Must be a non-empty JSON object.

property name*any

Key-value pairs of credential claims to embed in the issued credential. Must be a non-empty JSON object.

Example: {"givenName":"Alice","familyName":"Smith","dateOfBirth":"1990-01-15"}

externalIdstring

Your internal correlation ID, echoed verbatim in all responses. Up to 255 characters. See Using externalId for Correlation.

Possible values: <= 255 characters

Example: order-12345

offerTtlSecondsinteger

Time-to-live for the offer in seconds. Omit it (or send 0) to use your configuration's default. Negative values and values from 1 to 59 return 400; values above your configuration's maximum are capped to it.

Example: 300

selectiveDisclosure object

SD-JWT selective disclosure configuration. Every key in fields must exactly match a key in credentialData — a mismatch results in a 400 error. Fields absent from fields are always disclosed. Omit selectiveDisclosure entirely rather than sending null.

fields objectrequired

Map of credential data keys to disclosure configuration. Keys must match credentialData keys exactly. 1–100 entries; credentialStatus is reserved and cannot be listed.

property name* SelectiveDisclosureField

sdboolean

When true, the field is wrapped as an individually disclosable claim in the SD-JWT credential, letting the holder choose whether to share it with a verifier.

Example: true

audiencestring[]

Binds the credential to one verifier: its Network Member URN becomes the credential's aud claim, and presentations to any other verifier fail with audience_mismatch. Exactly one URN is supported today. Omit to allow any verifier in the trust network.

Possible values: >= 1, <= 1

Example: ["urn:iden2:id:network-member:202503:acme-verifier"]

CreateOfferRequest

{
  "authenticationMethod": "PRE_AUTHORIZED",
  "credentialConfigurationId": "VerifiedPerson_vc+sd-jwt",
  "credentialData": {
    "givenName": "Alice",
    "familyName": "Smith",
    "dateOfBirth": "1990-01-15"
  },
  "externalId": "order-12345",
  "offerTtlSeconds": 300,
  "selectiveDisclosure": {
    "fields": {
      "givenName": {
        "sd": true
      },
      "familyName": {
        "sd": true
      },
      "dateOfBirth": {
        "sd": true
      }
    }
  },
  "audience": [
    "urn:iden2:id:network-member:202503:acme-verifier"
  ]
}