Credential Offers

OpenAPI documentation for the Credential Offers module

Last updated 3 months ago

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.

<hr /> The endpoint is not available if API is running in DEMO MODE<hr />**Claim-based access control:** <code>Issuer_Admin</code>, <code>Issuer_User</code>

post

/private/credential-offers

Authorizations

Body

correlationIdstringrequired

credentialOffersobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '../private/credential-offers' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"correlationId":"text","credentialOffers":[{"referenceId":"text","credentialId":"text","credentialDataSupplierInput":{}}]}'

200

400

401

403

500

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "text",
  "updatedBy": "text",
  "createdAt": "2025-02-22T23:12:44.346Z",
  "updatedAt": "2025-02-22T23:12:44.346Z",
  "deletedAt": "2025-02-22T23:12:44.346Z",
  "correlationId": "text",
  "credentialId": "text",
  "credentialDataSupplierInput": {},
  "issuer": "text",
  "subject": "text",
  "issuedAt": "2025-02-22T23:12:44.346Z",
  "referenceId": "text",
  "revocationId": "text",
  "revocationReason": "text",
  "revokedAt": "2025-02-22T23:12:44.346Z",
  "revokedBy": "text",
  "status": "ready_to_claim",
  "credentialNames": [
    []
  ],
  "credentialTypes": [
    []
  ]
}

Credential offer pagination

Endpoint returns a paginated result of credential offers.

<hr /> The endpoint is not available if API is running in DEMO MODE<hr />**Claim-based access control:** <code>Issuer_Admin</code>, <code>Issuer_User</code>, <code>Issuer_Auditor</code>

get

/private/credential-offers

Authorizations

Query parameters

pagenumber

Page number to retrieve.If you provide invalid value the default page number will applied <p> <b>Example: </b> 1 </p> <p> <b>Default Value: </b> 1 </p>

limitnumber

Number of records per page. <p> <b>Example: </b> 20 </p> <p> <b>Default Value: </b> 20 </p> <p> <b>Max Value: </b> 100 </p>

  If provided value is greater than max value, max value will be applied.

filter.idstring[]

Filter by id query param. <p> <b>Format: </b> filter.id={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.id=$not:$like:John Doe&filter.id=like:John </p> <h4>Available Operations</h4><ul><li>$in</li></ul>

filter.credentialIdstring[]

Filter by credentialId query param. <p> <b>Format: </b> filter.credentialId={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.credentialId=$not:$like:John Doe&filter.credentialId=like:John </p> <h4>Available Operations</h4><ul><li>$eq</li></ul>

filter.credentialNamesstring[]

Filter by credentialNames query param. <p> <b>Format: </b> filter.credentialNames={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.credentialNames=$not:$like:John Doe&filter.credentialNames=like:John </p> <h4>Available Operations</h4><ul><li>$contains</li></ul>

filter.credentialTypesstring[]

Filter by credentialTypes query param. <p> <b>Format: </b> filter.credentialTypes={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.credentialTypes=$not:$like:John Doe&filter.credentialTypes=like:John </p> <h4>Available Operations</h4><ul><li>$contains</li></ul>

filter.correlationIdstring[]

Filter by correlationId query param. <p> <b>Format: </b> filter.correlationId={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.correlationId=$not:$like:John Doe&filter.correlationId=like:John </p> <h4>Available Operations</h4><ul><li>$eq</li></ul>

filter.searchstring[]

Filter by search query param. <p> <b>Format: </b> filter.search={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.search=$not:$like:John Doe&filter.search=like:John </p> <h4>Available Operations</h4><ul><li>$fulltext</li></ul>

filter.subjectstring[]

Filter by subject query param. <p> <b>Format: </b> filter.subject={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.subject=$not:$like:John Doe&filter.subject=like:John </p> <h4>Available Operations</h4><ul><li>$contains</li>

filter.issuerstring[]

Filter by issuer query param. <p> <b>Format: </b> filter.issuer={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.issuer=$not:$like:John Doe&filter.issuer=like:John </p> <h4>Available Operations</h4><ul><li>$contains</li>

filter.statusstring[]

Filter by status query param. <p> <b>Format: </b> filter.status={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.status=$not:$like:John Doe&filter.status=like:John </p> <h4>Available Operations</h4><ul><li>$eq</li></ul>

filter.createdBystring[]

Filter by createdBy query param. <p> <b>Format: </b> filter.createdBy={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.createdBy=$not:$like:John Doe&filter.createdBy=like:John </p> <h4>Available Operations</h4><ul><li>$eq</li></ul>

filter.updatedBystring[]

Filter by updatedBy query param. <p> <b>Format: </b> filter.updatedBy={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.updatedBy=$not:$like:John Doe&filter.updatedBy=like:John </p> <h4>Available Operations</h4><ul><li>$eq</li></ul>

filter.createdAtstring[]

Filter by createdAt query param. <p> <b>Format: </b> filter.createdAt={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.createdAt=$not:$like:John Doe&filter.createdAt=like:John </p> <h4>Available Operations</h4><ul><li>$gt</li>

filter.updatedAtstring[]

Filter by updatedAt query param. <p> <b>Format: </b> filter.updatedAt={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.updatedAt=$not:$like:John Doe&filter.updatedAt=like:John </p> <h4>Available Operations</h4><ul><li>$gt</li>

filter.issuedAtstring[]

Filter by issuedAt query param. <p> <b>Format: </b> filter.issuedAt={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.issuedAt=$not:$like:John Doe&filter.issuedAt=like:John </p> <h4>Available Operations</h4><ul><li>$gt</li>

filter.revokedAtstring[]

Filter by revokedAt query param. <p> <b>Format: </b> filter.revokedAt={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.revokedAt=$not:$like:John Doe&filter.revokedAt=like:John </p> <h4>Available Operations</h4><ul><li>$gt</li>

sortBystring · enum[]

Parameter to sort by. <p>To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting</p> <p> <b>Format: </b> fieldName:DIRECTION </p> <p> <b>Example: </b> sortBy=id:DESC&sortBy=createdAt:ASC </p> <p> <b>Default Value: </b> updatedAt:DESC </p> <h4>Available Fields</h4><ul><li>createdAt</li>

<li>updatedAt</li> <li>issuedAt</li> <li>status</li></ul>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '../private/credential-offers' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

500

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "text",
      "updatedBy": "text",
      "createdAt": "2025-02-22T23:12:44.346Z",
      "updatedAt": "2025-02-22T23:12:44.346Z",
      "deletedAt": "2025-02-22T23:12:44.346Z",
      "correlationId": "text",
      "credentialId": "text",
      "credentialDataSupplierInput": {},
      "issuer": "text",
      "subject": "text",
      "issuedAt": "2025-02-22T23:12:44.346Z",
      "referenceId": "text",
      "revocationId": "text",
      "revocationReason": "text",
      "revokedAt": "2025-02-22T23:12:44.346Z",
      "revokedBy": "text",
      "status": "ready_to_claim",
      "credentialNames": [
        []
      ],
      "credentialTypes": [
        []
      ]
    }
  ],
  "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.

<hr /> The endpoint is not available if API is running in DEMO MODE<hr />**Claim-based access control:** <code>Issuer_User</code>, <code>Issuer_Admin</code>, <code>Issuer_Auditor</code>

get

/private/credential-offers/type-usage

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '../private/credential-offers/type-usage' \
  --header 'Authorization: Bearer JWT'

200

401

403

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

Fetch one credential offer

Fetch one credential offer from issuer

<hr /> The endpoint is not available if API is running in DEMO MODE<hr />**Claim-based access control:** <code>Issuer_Admin</code>, <code>Issuer_User</code>, <code>Issuer_Auditor</code>

get

/private/credential-offers/{id}

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '../private/credential-offers/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

500

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "text",
  "updatedBy": "text",
  "createdAt": "2025-02-22T23:12:44.346Z",
  "updatedAt": "2025-02-22T23:12:44.346Z",
  "deletedAt": "2025-02-22T23:12:44.346Z",
  "correlationId": "text",
  "credentialId": "text",
  "credentialDataSupplierInput": {},
  "issuer": "text",
  "subject": "text",
  "issuedAt": "2025-02-22T23:12:44.346Z",
  "referenceId": "text",
  "revocationId": "text",
  "revocationReason": "text",
  "revokedAt": "2025-02-22T23:12:44.346Z",
  "revokedBy": "text",
  "status": "ready_to_claim",
  "credentialNames": [
    []
  ],
  "credentialTypes": [
    []
  ]
}

Retrieve the info to generate QR code

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

<hr /> The endpoint is not available if API is running in DEMO MODE<hr />**Claim-based access control:** <code>Issuer_Admin</code>, <code>Issuer_User</code>

get

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

Authorizations

Path parameters

idstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '../private/credential-offers/{id}/claim' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

500

{
  "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.

<hr /> The endpoint is not available if API is running in DEMO MODE<hr />**Claim-based access control:** <code>Issuer_Admin</code>, <code>Issuer_User</code>

patch

/private/credential-offers/revoke

Authorizations

Body

revokeobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '../private/credential-offers/revoke' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"revoke":[{"id":"123e4567-e89b-12d3-a456-426614174000","revocationReason":"text"}]}'

200

400

401

403

500

{
  "revocations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "text",
      "updatedBy": "text",
      "createdAt": "2025-02-22T23:12:44.346Z",
      "updatedAt": "2025-02-22T23:12:44.346Z",
      "deletedAt": "2025-02-22T23:12:44.346Z",
      "correlationId": "text",
      "credentialId": "text",
      "credentialDataSupplierInput": {},
      "issuer": "text",
      "subject": "text",
      "issuedAt": "2025-02-22T23:12:44.346Z",
      "referenceId": "text",
      "revocationId": "text",
      "revocationReason": "text",
      "revokedAt": "2025-02-22T23:12:44.346Z",
      "revokedBy": "text",
      "status": "ready_to_claim",
      "credentialNames": [
        []
      ],
      "credentialTypes": [
        []
      ]
    }
  ],
  "failed": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "error": "text",
      "code": "credential_offer_already_revoked"
    }
  ]
}