Credential Offers

OpenAPI documentation for the Credential Offers module

Create credential offers

Endpoint supports bulk credential offers records handling. Once created you are be able to issue a credential offer from agent using /webapp endpoints. If the agent returns error that the action cannot be completed because it is missing credential offer you must first create the resource here and then try again.

POST../private/credential-offers

Authorization

bearer

Body

application/json

correlationId*string

credentialOffers*array of CredentialOfferBodyDto (object)

Response

200400401403500

Body

application/json

id*string (uuid)

createdBy*string

updatedBy*string

createdAt*string (date-time)

updatedAt*string (date-time)

deletedAt*string (date-time)

correlationId*string

credentialNames*array of array

credentialTypes*array of array

credentialId*string

status*enum

ready_to_claimissuingclaimederrorrevoked

credentialDataSupplierInput*object

issuer*string

subject*string

issuedAt*string (date-time)

referenceId*string

revocationId*string

revocationReason*string

revokedAt*string (date-time)

revokedBy*string

Request

JavaScriptCurlPython

const response = await fetch('../private/credential-offers', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "correlationId": "text",
      "credentialOffers": [
        {
          "referenceId": "text",
          "credentialId": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "text",
  "updatedBy": "text",
  "createdAt": "2024-12-04T08:03:39.496Z",
  "updatedAt": "2024-12-04T08:03:39.496Z",
  "deletedAt": "2024-12-04T08:03:39.496Z",
  "correlationId": "text",
  "credentialNames": [
    []
  ],
  "credentialTypes": [
    []
  ],
  "credentialId": "text",
  "status": "ready_to_claim",
  "issuer": "text",
  "subject": "text",
  "issuedAt": "2024-12-04T08:03:39.496Z",
  "referenceId": "text",
  "revocationId": "text",
  "revocationReason": "text",
  "revokedAt": "2024-12-04T08:03:39.496Z",
  "revokedBy": "text"
}

Credential offer pagination

Endpoint returns a paginated result of credential offers.

GET../private/credential-offers

Authorization

bearer

Query parameters

Response

200400401403500

Body

application/json

data*Array of entities

meta*Pagination Metadata

links*Links to pages

dataarray of CredentialOfferDetailDto (object)

metaobject

Request

JavaScriptCurlPython

const response = await fetch('../private/credential-offers', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "text",
      "updatedBy": "text",
      "createdAt": "2024-12-04T08:03:39.496Z",
      "updatedAt": "2024-12-04T08:03:39.496Z",
      "deletedAt": "2024-12-04T08:03:39.496Z",
      "correlationId": "text",
      "credentialNames": [
        []
      ],
      "credentialTypes": [
        []
      ],
      "credentialId": "text",
      "status": "ready_to_claim",
      "issuer": "text",
      "subject": "text",
      "issuedAt": "2024-12-04T08:03:39.496Z",
      "referenceId": "text",
      "revocationId": "text",
      "revocationReason": "text",
      "revokedAt": "2024-12-04T08:03:39.496Z",
      "revokedBy": "text"
    }
  ],
  "meta": {
    "select": [
      "text"
    ],
    "filter": {
      "id": "text",
      "credentialId": "text",
      "credentialNames": "text",
      "credentialTypes": "text",
      "correlationId": "text",
      "search": "text",
      "subject": "text",
      "issuer": "text",
      "status": "text",
      "createdBy": "text",
      "updatedBy": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "issuedAt": "text",
      "revokedAt": "text"
    }
  },
  "links": {
    "first": "text",
    "previous": "text",
    "current": "text",
    "next": "text",
    "last": "text"
  }
}

Retrieve latest usage date of each credential type

Returns an array of objects with the latest usage date of each credential type.

GET../private/credential-offers/type-usage

Authorization

bearer

Response

200401403

Body

application/json

credentialType*string

latestCreatedAt*string

Request

JavaScriptCurlPython

const response = await fetch('../private/credential-offers/type-usage', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

[
  {
    "credentialType": "text",
    "latestCreatedAt": "text"
  }
]

Fetch one credential offer

Fetch one credential offer from issuer

GET../private/credential-offers/{id}

Authorization

bearer

Path parameters

id*string (uuid)

Response

200400401403500

Body

application/json

id*string (uuid)

createdBy*string

updatedBy*string

createdAt*string (date-time)

updatedAt*string (date-time)

deletedAt*string (date-time)

correlationId*string

credentialNames*array of array

credentialTypes*array of array

credentialId*string

status*enum

ready_to_claimissuingclaimederrorrevoked

credentialDataSupplierInput*object

issuer*string

subject*string

issuedAt*string (date-time)

referenceId*string

revocationId*string

revocationReason*string

revokedAt*string (date-time)

revokedBy*string

Request

JavaScriptCurlPython

const response = await fetch('../private/credential-offers/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "text",
  "updatedBy": "text",
  "createdAt": "2024-12-04T08:03:39.496Z",
  "updatedAt": "2024-12-04T08:03:39.496Z",
  "deletedAt": "2024-12-04T08:03:39.496Z",
  "correlationId": "text",
  "credentialNames": [
    []
  ],
  "credentialTypes": [
    []
  ],
  "credentialId": "text",
  "status": "ready_to_claim",
  "issuer": "text",
  "subject": "text",
  "issuedAt": "2024-12-04T08:03:39.496Z",
  "referenceId": "text",
  "revocationId": "text",
  "revocationReason": "text",
  "revokedAt": "2024-12-04T08:03:39.496Z",
  "revokedBy": "text"
}

Retrieve the info to generate QR code

Processes the credential offer id passed and creates the information needed to generate a QR code.

GET../private/credential-offers/{id}/claim

Authorization

bearer

Path parameters

id*string (uuid)

Response

200400401403500

Body

application/json

uri*string

URI containing the credential offer (decoded in example).

Example: "openid-credential-offer://?credential_offer={\\\"grants\\\":{\\\"urn:ietf:params:oauth:grant-type:pre-authorized_code\\\":{\\\"pre-authorized_code\\\":\\\"sWoSmJM9vnD2yL3Ruot3ps\\\",\\\"user_pin_required\\\":false}},\\\"credentials\\\":[\\\"CharacterCredential\\\"],\\\"credential_issuer\\\":\\\"https://1c13-213-172-234-81.ngrok-free.app/nchain\\"

userPinRequired*boolean

Indicates if user pin is required.

Example: false

Request

JavaScriptCurlPython

const response = await fetch('../private/credential-offers/{id}/claim', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "uri": "openid-credential-offer://?credential_offer={\\\"grants\\\":{\\\"urn:ietf:params:oauth:grant-type:pre-authorized_code\\\":{\\\"pre-authorized_code\\\":\\\"sWoSmJM9vnD2yL3Ruot3ps\\\",\\\"user_pin_required\\\":false}},\\\"credentials\\\":[\\\"CharacterCredential\\\"],\\\"credential_issuer\\\":\\\"https://1c13-213-172-234-81.ngrok-free.app/nchain\\",
  "userPinRequired": false
}

Revoke credential offers

Revokes the credential offer using the credential revocation txId stored. You will need to supply the revocation reason to be stored alongside it. When completed the credential will display revoked on the users wallet and also the verifier will return revoked status if user tries to verify with it.

PATCH../private/credential-offers/revoke

Authorization

bearer

Body

application/json

revoke*array of RevokeCredentialOfferDto (object)

Response

200400401403500

Body

application/json

revocations*array of CredentialOfferDetailDto (object)

failed*array of FailedCredentialOfferRevocationDetailDto (object)

Request

JavaScriptCurlPython

const response = await fetch('../private/credential-offers/revoke', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "revoke": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "revocationReason": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200

{
  "revocations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "text",
      "updatedBy": "text",
      "createdAt": "2024-12-04T08:03:39.496Z",
      "updatedAt": "2024-12-04T08:03:39.496Z",
      "deletedAt": "2024-12-04T08:03:39.496Z",
      "correlationId": "text",
      "credentialNames": [
        []
      ],
      "credentialTypes": [
        []
      ],
      "credentialId": "text",
      "status": "ready_to_claim",
      "issuer": "text",
      "subject": "text",
      "issuedAt": "2024-12-04T08:03:39.496Z",
      "referenceId": "text",
      "revocationId": "text",
      "revocationReason": "text",
      "revokedAt": "2024-12-04T08:03:39.496Z",
      "revokedBy": "text"
    }
  ],
  "failed": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "error": "text",
      "code": "credential_offer_already_revoked"
    }
  ]
}