Credential issuance - CREDEBL Platform

Credential issuance is the process of an issuer creating and delivering a verifiable credential to a holder. CREDEBL supports several issuance flows:

Connection-based offer — issue a credential directly to a holder over an established DIDComm connection.
Out-of-band (OOB) offer — generate a credential offer that can be accepted without a prior connection, delivered as a URL or QR code.
OOB via email — send OOB credential offers to one or more holders by email.
Bulk CSV issuance — upload a CSV file to issue credentials to many holders simultaneously.

Both AnonCreds (Indy) and W3C JSON-LD credential types are supported. Specify the type using the credentialType query parameter (INDY or JSONLD).

Base path

All endpoints are rooted at /orgs/:orgId/credentials.

Authentication

Every endpoint requires a JWT bearer token.

Authorization: Bearer <your-jwt-token>

Role-based access

Operation	Required roles
Issue credentials, OOB offers	`owner`, `admin`, `issuer`
Read issued credentials	`owner`, `admin`, `issuer`, `verifier`, `member`, `holder`
Delete issuance records	`owner`
Bulk upload templates	`owner`, `admin`, `issuer`, `verifier`

Endpoints

Issue credential (connection)

POST /orgs/:orgId/credentials/offer — Issue to a connected holder.

Issue credential (OOB)

POST /orgs/:orgId/credentials/oob/offer — Create an OOB credential offer.

Issue via email (OOB)

POST /orgs/:orgId/credentials/oob/email — Send OOB offers via email.

List credentials

GET /orgs/:orgId/credentials — Retrieve all issued credential records.

Get credential

GET /orgs/:orgId/credentials/:credentialRecordId — Get a specific credential record.

Bulk templates

GET /orgs/:orgId/credentials/bulk/template — List or download a CSV template for bulk issuance.

Upload CSV

POST /orgs/:orgId/bulk/upload — Upload a filled CSV file for bulk issuance.

Execute bulk issuance

POST /orgs/:orgId/:requestId/bulk — Trigger bulk credential issuance for an uploaded file.

Delete issuance records

DELETE /orgs/:orgId/issuance-records — Delete all issuance records for an organization.

Issue credential (connection-based)

POST /orgs/:orgId/credentials/offer Issue one or more verifiable credentials to holders over established DIDComm connections. Required roles: owner, admin, issuer

Path parameters

string

required

UUID of the issuing organization.

Query parameters

string

required

Credential format. Enum: INDY (default) or JSONLD.

boolean

Validate credential attributes against the schema before issuing. Defaults to true.

Request body

string

The ledger credential definition ID. Required when credentialType is INDY. Example: "WgWxqztrNooG92RXvxSTWv:3:CL:123:default".

string

Optional human-readable comment attached to the credential offer.

string

DIDComm protocol version. Example: "v1" or "v2".

string

Auto-acceptance mode. Enum: always, contentApproved, never.

string

A goal code for the credential offer thread.

string

Parent thread ID to attach this offer to an existing thread.

boolean

Whether the issuer confirms receipt of the presentation.

string

Label for the credential offer message.

string

Image URL to include with the credential offer.

boolean

Reuse an existing connection if available. Defaults to true.

boolean

Shorten the OOB URL in the response.

object[]

required

Array of credential offers. Each element targets a specific connection.

Show credentialData item

string

required

UUID of the established connection to issue the credential over.

object[]

Array of credential attribute values. Required for INDY type. Each attribute must include:

name (string, required) — Attribute name matching the schema.
value (string, required) — Attribute value.
isRequired (boolean, optional, default false) — Whether the attribute is required.

object

W3C Verifiable Credential object. Required for JSONLD type. Must include @context, type, issuer, issuanceDate, and credentialSubject.

object

Linked Data proof options. Required for JSONLD type. Must include proofType and proofPurpose.

Examples

curl --request POST \
  --url "http://localhost:5000/v1/orgs/3fa85f64-5717-4562-b3fc-2c963f66afa6/credentials/offer?credentialType=INDY" \
  --header "Authorization: Bearer <your-jwt-token>" \
  --header "Content-Type: application/json" \
  --data '{
    "credentialDefinitionId": "WgWxqztrNooG92RXvxSTWv:3:CL:123:default",
    "comment": "Welcome to Acme Corp",
    "autoAcceptCredential": "always",
    "credentialData": [
      {
        "connectionId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "attributes": [
          { "name": "firstName", "value": "Alice" },
          { "name": "lastName", "value": "Smith" },
          { "name": "employeeId", "value": "EMP-1042" },
          { "name": "department", "value": "Engineering" },
          { "name": "startDate", "value": "2024-01-15" }
        ]
      }
    ]
  }'

curl --request POST \
  --url "http://localhost:5000/v1/orgs/3fa85f64-5717-4562-b3fc-2c963f66afa6/credentials/offer?credentialType=JSONLD" \
  --header "Authorization: Bearer <your-jwt-token>" \
  --header "Content-Type: application/json" \
  --data '{
    "credentialData": [
      {
        "connectionId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "credential": {
          "@context": [
            "https://www.w3.org/2018/credentials/v1",
            "https://www.w3.org/2018/credentials/examples/v1"
          ],
          "type": ["VerifiableCredential", "UniversityDegreeCredential"],
          "issuer": {
            "id": "did:key:z6Mkn72LVp3mq1fWSefkSMh5V7qrmGfCV4KH3K6SoTM21ouM"
          },
          "issuanceDate": "2024-01-15T10:00:00.000Z",
          "credentialSubject": {
            "id": "did:key:z6MkrJVnaZkeFzdQyMZu1cgjkzzddaiTegS97hqhFYGrwZPU",
            "degree": {
              "type": "BachelorDegree",
              "name": "Bachelor of Science and Arts"
            }
          }
        },
        "options": {
          "proofType": "Ed25519Signature2018",
          "proofPurpose": "assertionMethod"
        }
      }
    ]
  }'

curl --request POST \
  --url "http://localhost:5000/v1/orgs/3fa85f64-5717-4562-b3fc-2c963f66afa6/credentials/offer?credentialType=INDY" \
  --header "Authorization: Bearer <your-jwt-token>" \
  --header "Content-Type: application/json" \
  --data '{
    "credentialDefinitionId": "WgWxqztrNooG92RXvxSTWv:3:CL:123:default",
    "credentialData": [
      {
        "connectionId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "attributes": [
          { "name": "firstName", "value": "Alice" },
          { "name": "lastName", "value": "Smith" },
          { "name": "employeeId", "value": "EMP-1042" }
        ]
      },
      {
        "connectionId": "a1b2c3d4-1234-5678-90ab-cdef12345678",
        "attributes": [
          { "name": "firstName", "value": "Bob" },
          { "name": "lastName", "value": "Jones" },
          { "name": "employeeId", "value": "EMP-1043" }
        ]
      }
    ]
  }'

201 response

{
  "statusCode": 201,
  "message": "Credential offer sent successfully",
  "data": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "state": "offer-sent",
      "connectionId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "credentialDefinitionId": "WgWxqztrNooG92RXvxSTWv:3:CL:123:default",
      "schemaId": "WgWxqztrNooG92RXvxSTWv:2:EmployeeCredential:1.0",
      "threadId": "b0f49aa6-1516-4b21-9190-b13e92c0c865",
      "protocolVersion": "v1",
      "createdAt": "2024-01-15T11:00:00.000Z"
    }
  ]
}

Status	Description
`400 Bad Request`	Missing `credentialDefinitionId` for INDY type, or missing `credential`/`options` for JSONLD.
`401 Unauthorized`	Missing or invalid bearer token.
`403 Forbidden`	User lacks the required role.
`404 Not Found`	Invalid `credentialType` value.

Create out-of-band credential offer

POST /orgs/:orgId/credentials/oob/offer Create an out-of-band credential offer that can be accepted by a holder without a pre-existing connection. The response contains an invitation URL. Required roles: owner, admin, issuer

Path parameters

string

required

UUID of the issuing organization.

Query parameters

string

required

Credential format. Enum: INDY (default) or JSONLD.

boolean

Validate attributes against the schema. Defaults to true.

Request body

string

Ledger credential definition ID. Required for INDY type.

string

Optional comment attached to the credential offer.

string

DIDComm protocol version.

string

Auto-acceptance mode. Enum: always, contentApproved, never.

boolean

Whether to return a shortened invitation URL.

boolean

Attempt to reuse an existing connection.

object[]

Credential attribute name/value pairs. Required for INDY type.

Show attribute object

string

required

Attribute name matching the schema.

string

required

Attribute value.

boolean

Defaults to false.

object

W3C Verifiable Credential object. Required for JSONLD type.

object

Linked Data proof options. Required for JSONLD type.

Examples

curl --request POST \
  --url "http://localhost:5000/v1/orgs/3fa85f64-5717-4562-b3fc-2c963f66afa6/credentials/oob/offer?credentialType=INDY" \
  --header "Authorization: Bearer <your-jwt-token>" \
  --header "Content-Type: application/json" \
  --data '{
    "credentialDefinitionId": "WgWxqztrNooG92RXvxSTWv:3:CL:123:default",
    "comment": "Your employee credential from Acme Corp",
    "autoAcceptCredential": "always",
    "attributes": [
      { "name": "firstName", "value": "Alice" },
      { "name": "lastName", "value": "Smith" },
      { "name": "employeeId", "value": "EMP-1042" },
      { "name": "department", "value": "Engineering" },
      { "name": "startDate", "value": "2024-01-15" }
    ]
  }'

201 response

{
  "statusCode": 201,
  "message": "Credential offer created successfully",
  "data": {
    "invitationUrl": "http://agent.example.com?oob=eyJAdHlwZSI6...",
    "credentialOffer": {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "state": "offer-sent",
      "credentialDefinitionId": "WgWxqztrNooG92RXvxSTWv:3:CL:123:default",
      "createdAt": "2024-01-15T11:00:00.000Z"
    }
  }
}

Issue credential via email

POST /orgs/:orgId/credentials/oob/email Create OOB credential offers and deliver them to holders by email. Each element in credentialOffer targets a specific email address. Required roles: owner, admin, issuer

Path parameters

string

required

UUID of the issuing organization.

Query parameters

string

required

Credential format. Enum: INDY (default) or JSONLD.

boolean

Validate attributes against the schema. Defaults to true.

Request body

string

Ledger credential definition ID. Required for INDY type.

string

Optional comment for all offers in this batch.

string

DIDComm protocol version.

boolean

Attempt to reuse an existing connection with each recipient.

object[]

required

Array of per-recipient credential offers. The maximum number of entries is controlled by the OOB_BATCH_SIZE environment variable.

Show credentialOffer item

string

required

Recipient’s email address. Max 256 characters.

object[]

Credential attribute name/value pairs for this recipient. Required for INDY type.

name (string, required)
value (string, required)

object

W3C Verifiable Credential object. Required for JSONLD type.

object

Linked Data proof options. Required for JSONLD type.

Examples

curl --request POST \
  --url "http://localhost:5000/v1/orgs/3fa85f64-5717-4562-b3fc-2c963f66afa6/credentials/oob/email?credentialType=INDY" \
  --header "Authorization: Bearer <your-jwt-token>" \
  --header "Content-Type: application/json" \
  --data '{
    "credentialDefinitionId": "WgWxqztrNooG92RXvxSTWv:3:CL:123:default",
    "comment": "Your Acme Corp employee credential is ready",
    "credentialOffer": [
      {
        "emailId": "alice@example.com",
        "attributes": [
          { "name": "firstName", "value": "Alice" },
          { "name": "lastName", "value": "Smith" },
          { "name": "employeeId", "value": "EMP-1042" },
          { "name": "department", "value": "Engineering" },
          { "name": "startDate", "value": "2024-01-15" }
        ]
      },
      {
        "emailId": "bob@example.com",
        "attributes": [
          { "name": "firstName", "value": "Bob" },
          { "name": "lastName", "value": "Jones" },
          { "name": "employeeId", "value": "EMP-1043" },
          { "name": "department", "value": "Finance" },
          { "name": "startDate", "value": "2024-02-01" }
        ]
      }
    ]
  }'

201 response

{
  "statusCode": 201,
  "message": "OOB credential offer created successfully",
  "data": [
    {
      "emailId": "alice@example.com",
      "invitationUrl": "http://agent.example.com?oob=eyJAdHlwZSI6...",
      "credentialOfferId": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
    },
    {
      "emailId": "bob@example.com",
      "invitationUrl": "http://agent.example.com?oob=eyJAdHlwZSI6...",
      "credentialOfferId": "a1b2c3d4-1234-5678-90ab-cdef12345678"
    }
  ]
}

List issued credentials

GET /orgs/:orgId/credentials Retrieve all issued credential records for an organization. Supports pagination, search, and sorting. Required roles: owner, admin, issuer, verifier, member, holder

Path parameters

string

required

UUID of the organization.

Query parameters

number

Page to retrieve. Min 1. Defaults to 1.

number

Records per page. Min 1, max 100. Defaults to 10.

string

Free-text search across credential records.

string

Field to sort by. Enum: createDateTime (default).

string

Sort direction. ASC or DESC (default).

Examples

curl --request GET \
  --url "http://localhost:5000/v1/orgs/3fa85f64-5717-4562-b3fc-2c963f66afa6/credentials?pageNumber=1&pageSize=10&sortBy=DESC" \
  --header "Authorization: Bearer <your-jwt-token>"

200 response

{
  "statusCode": 200,
  "message": "Credentials fetched successfully",
  "data": {
    "totalItems": 3,
    "hasNextPage": false,
    "data": [
      {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "state": "done",
        "connectionId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "credentialDefinitionId": "WgWxqztrNooG92RXvxSTWv:3:CL:123:default",
        "schemaId": "WgWxqztrNooG92RXvxSTWv:2:EmployeeCredential:1.0",
        "threadId": "b0f49aa6-1516-4b21-9190-b13e92c0c865",
        "protocolVersion": "v1",
        "createdAt": "2024-01-15T11:00:00.000Z",
        "updatedAt": "2024-01-15T11:00:30.000Z"
      }
    ]
  }
}

Get credential by record ID

GET /orgs/:orgId/credentials/:credentialRecordId Retrieve the details of a single credential issuance record. Required roles: owner, admin, issuer, verifier, member, holder

Path parameters

string

required

UUID of the organization.

string

required

UUID of the credential record to retrieve.

Examples

curl --request GET \
  --url "http://localhost:5000/v1/orgs/3fa85f64-5717-4562-b3fc-2c963f66afa6/credentials/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  --header "Authorization: Bearer <your-jwt-token>"

200 response

{
  "statusCode": 200,
  "message": "Credential fetched successfully",
  "data": {
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "state": "done",
    "connectionId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "credentialDefinitionId": "WgWxqztrNooG92RXvxSTWv:3:CL:123:default",
    "schemaId": "WgWxqztrNooG92RXvxSTWv:2:EmployeeCredential:1.0",
    "credentialAttributes": [
      { "name": "firstName", "value": "Alice" },
      { "name": "lastName", "value": "Smith" },
      { "name": "employeeId", "value": "EMP-1042" }
    ],
    "autoAcceptCredential": "always",
    "threadId": "b0f49aa6-1516-4b21-9190-b13e92c0c865",
    "protocolVersion": "v1",
    "outOfBandId": null,
    "createdAt": "2024-01-15T11:00:00.000Z",
    "updatedAt": "2024-01-15T11:00:30.000Z"
  }
}

Status	Description
`400 Bad Request`	`credentialRecordId` is not a valid UUID.
`404 Not Found`	No credential record found with that ID.

Bulk issuance

CREDEBL supports issuing credentials to large numbers of holders by uploading a filled CSV file. The bulk issuance flow has three steps:

Download a CSV template

Use GET /orgs/:orgId/credentials/bulk/template to list available templates, or POST /orgs/:orgId/credentials/bulk/template to download a CSV template file pre-filled with the correct column headers for a specific credential definition.

Upload the filled CSV

Fill in the CSV with one row per holder and upload it via POST /orgs/:orgId/bulk/upload. The server returns a requestId.

Trigger issuance

Call POST /orgs/:orgId/:requestId/bulk to start the issuance process for all rows in the uploaded file.

Download CSV template

POST /orgs/:orgId/credentials/bulk/template Download a CSV template with column headers derived from a credential definition’s schema. Required roles: owner, admin, issuer, verifier

Request body

string

required

The ledger credential definition ID to use as a template. Example: "WgWxqztrNooG92RXvxSTWv:3:CL:123:default".

string

required

Schema type. Enum: INDY or W3C.

Examples

curl --request POST \
  --url "http://localhost:5000/v1/orgs/3fa85f64-5717-4562-b3fc-2c963f66afa6/credentials/bulk/template" \
  --header "Authorization: Bearer <your-jwt-token>" \
  --header "Content-Type: application/json" \
  --output template.csv \
  --data '{
    "templateId": "WgWxqztrNooG92RXvxSTWv:3:CL:123:default",
    "schemaType": "INDY"
  }'

Upload CSV for bulk issuance

POST /orgs/:orgId/bulk/upload Upload a filled CSV file for bulk issuance. The file is uploaded as multipart/form-data. Required roles: owner, admin, issuer, verifier

Path parameters

string

required

UUID of the organization.

Query parameters

string

required

Schema type of the CSV data. Enum: INDY or W3C.

string

required

The credential definition ID used as the template.

boolean

Validate rows against the schema on upload. Defaults to true.

Request body

Upload a file field as multipart/form-data containing the CSV binary. Optionally include a fileName field.

Examples

curl --request POST \
  --url "http://localhost:5000/v1/orgs/3fa85f64-5717-4562-b3fc-2c963f66afa6/bulk/upload?schemaType=INDY&templateId=WgWxqztrNooG92RXvxSTWv:3:CL:123:default" \
  --header "Authorization: Bearer <your-jwt-token>" \
  --form "file=@employees.csv" \
  --form "fileName=employees.csv"

201 response

{
  "statusCode": 201,
  "message": "CSV imported successfully",
  "data": {
    "requestId": "c2e43f80-9f3a-4b12-835d-ecb9e4f12abc",
    "fileName": "employees.csv",
    "totalRecords": 50,
    "status": "PROCESS_STARTED"
  }
}

Execute bulk issuance

POST /orgs/:orgId/:requestId/bulk Start the bulk credential issuance process for a previously uploaded CSV file. Required roles: owner, admin, issuer, verifier

Path parameters

string

required

UUID of the organization.

string

required

The requestId returned when the CSV was uploaded.

Query parameters

boolean

Validate rows against the schema before issuing. Defaults to true.

string

Override the credential definition ID for this issuance run.

Request body

string

Client identifier for tracking the bulk job.

string

Name of the CSV file being processed.

boolean

When true, allows selective issuance for specific rows.

string

URL of the organization’s logo to include in credential emails.

string

Platform name to include in credential emails.

Delete issuance records

DELETE /orgs/:orgId/issuance-records Delete all issuance records for an organization. This action is irreversible. Required roles: owner

Path parameters

string

required

UUID of the organization.

Examples

curl --request DELETE \
  --url "http://localhost:5000/v1/orgs/3fa85f64-5717-4562-b3fc-2c963f66afa6/issuance-records" \
  --header "Authorization: Bearer <your-jwt-token>"

200 response

{
  "statusCode": 200,
  "message": "Issuance records deleted successfully"
}

Status	Description
`400 Bad Request`	`orgId` is not a valid UUID.
`401 Unauthorized`	Missing or invalid bearer token.
`403 Forbidden`	User does not have the `owner` role.

​Base path

​Authentication

​Role-based access

​Endpoints

Issue credential (connection)

Issue credential (OOB)

Issue via email (OOB)

List credentials

Get credential

Bulk templates

Upload CSV

Execute bulk issuance

Delete issuance records

​Issue credential (connection-based)

​Path parameters

​Query parameters

​Request body

​Examples

​Create out-of-band credential offer

​Path parameters

​Query parameters

​Request body

​Examples

​Issue credential via email

​Path parameters

​Query parameters

​Request body

​Examples

​List issued credentials

​Path parameters

​Query parameters

​Examples

​Get credential by record ID

​Path parameters

​Examples

​Bulk issuance

​Download CSV template

​Request body

​Examples

​Upload CSV for bulk issuance

​Path parameters

​Query parameters

​Request body

​Examples

​Execute bulk issuance

​Path parameters

​Query parameters

​Request body

​Delete issuance records

​Path parameters

​Examples

Base path

Authentication

Role-based access

Endpoints

Issue credential (connection-based)

Path parameters

Query parameters

Request body

Examples

Create out-of-band credential offer

Path parameters

Query parameters

Request body

Examples

Issue credential via email

Path parameters

Query parameters

Request body

Examples

List issued credentials

Path parameters

Query parameters

Examples

Get credential by record ID

Path parameters

Examples

Bulk issuance

Download CSV template

Request body

Examples

Upload CSV for bulk issuance

Path parameters

Query parameters

Request body

Examples

Execute bulk issuance

Path parameters

Query parameters

Request body

Delete issuance records

Path parameters

Examples