Get a credential offer.

GET

/vci/offers/{id}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/vci/offers/example

Parameters

Path Parameters

id

required

string

Responses

200

Credential offer.

Media type application/json

object

credential_issuer

required

string

credential_configuration_ids

required

Array<string>

grants

object

urn:ietf:params:oauth:grant-type:pre-authorized_code

object

pre-authorized_code

required

string

tx_code

object

input_mode

string

Allowed values: numeric text

length

integer

description

string

authorization_code

object

issuer_state

string

Example

{
  "credential_issuer": "did:web:auth.example.com",
  "credential_configuration_ids": [
    "AuthrimIdentityCredential"
  ],
  "grants": {
    "urn:ietf:params:oauth:grant-type:pre-authorized_code": {
      "pre-authorized_code": "g1:apac:3:co_550e8400-e29b-41d4-a716-446655440000:secret",
      "tx_code": {
        "input_mode": "numeric",
        "length": 6,
        "description": "Enter the PIN you received"
      }
    }
  }
}

400

Error response.

Media type application/json

object

error

required

string

error_description

required

string

Example

{
  "error": "invalid_request",
  "error_description": "The request is invalid."
}

500

Error response.

Media type application/json

object

error

required

string

error_description

required

string

Example

{
  "error": "invalid_request",
  "error_description": "The request is invalid."
}