Credential Offers

Create credential offer

post

Creates a credential offer. The credential offer object can be retrieved via the uri in the response.

claims will be validated against the registered credentialTemplate.schema

An authorization_code or urn:ietf:params:oauth:grant-type:authorized_code grant MUST be provided. However, issuer_state and pre-authorized_code are optional. If not provided, Wallet will generate random values for them.

user_id can only be used if Resource Hook is configured. user_id can only be used with Pre-authorized Code Grant. user_id will be sent to the external resource server via the resource hook.

One of claims OR user_id MUST be provided.

Credential offers expire. Expiration is controlled by runtime configuration - issuer.issuance_policy.credential_offer_expiry.

Supported Standards

• OpenID for Verifiable Credential Issuance 1.0 - Credential Offer Endpoint

Authorizations

bearerAuthmutualTLS

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Body

application/json

claimsobjectOptional

Claims to be included in the issued verifiable credential

credential_configuration_idsstring[]Required

Credential configuration identifiers to include in the offer.

user_idstringOptional

user_id sent to the external resource server via resource hook

Responses

200

OK

application/json

credential_offer_uristringOptional

credential offer URI

tx_codestringOptional

randomly generated code that will be required when claiming the credential offer

400Error

application/json

post/issuer/offers

HTTPcURLJavaScriptPython

POST /issuer/offers HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "claims": {},
  "credential_configuration_ids": [
    "text"
  ],
  "grants": {
    "authorization_code": {
      "issuer_state": "text"
    },
    "urn:ietf:params:oauth:grant-type:pre-authorized_code": {
      "pre-authorized_code": "text",
      "tx_code": {
        "length": 1
      }
    }
  },
  "user_id": "text"
}

{
  "credential_offer_uri": "text",
  "tx_code": "text"
}

Get credential offer by ID

get

Get credential offer by ID. The credential offer object contains necessary information for the wallet to proceed with credential issuance.

id path parameter refers to the issuer_state or pre-authorized_code of the credential offer.

Expired credential offers cannot be retrieved by using this endpoint.

Path parameters

idstringRequired

ID of the credential offer to retrieve

Responses

200

OK

application/json

credential_issuerstringOptionalExample: https://issuer.example.com

credential_configuration_idsstring[]Optional

Credential configuration identifiers included in the offer.

get/issuer/offers/{id}

HTTPcURLJavaScriptPython

GET /issuer/offers/{id} HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Accept: */*

200

OK

{
  "credential_issuer": "https://issuer.example.com",
  "credential_configuration_ids": [
    "text"
  ],
  "grants": {
    "authorization_code": {
      "issuer_state": "text"
    },
    "urn:ietf:params:oauth:grant-type:pre-authorized_code": {
      "pre-authorized_code": "text",
      "tx_code": {
        "input_mode": "numeric",
        "length": 1,
        "description": "text"
      }
    }
  }
}

Delete credential offer by ID

delete

Delete credential offer by ID. Deleted credential offers can no longer be retrieved or used for credential issuance. Ensure to review the implications before deleting a credential offer.

id path parameter refers to the issuer_state or pre-authorized_code of the credential offer.

Expired credential offers can be deleted by using this endpoint.

Authorizations

bearerAuthmutualTLS

AuthorizationstringOptional

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the credential offer to delete

Responses

204

Credential offer deleted

No content

delete/issuer/offers/{id}

HTTPcURLJavaScriptPython

DELETE /issuer/offers/{id} HTTP/1.1
Host: zyfla-wallet-sandbox.meeco.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

Credential offer deleted

No content