Issuance API
Get Credential Batch
Retrieve full details of a credential batch including all recipients and their credential URLs.
GET
Overview
Returns complete batch details including every recipient and their uniquecredentialUrl. Use batchId values from the Issue Credentials or List Credential Batches response.
No request body required. Pass the
batchId as a path parameter.Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
batchId | string | Yes | The batchId returned from Issue Credentials or List Batches |
Response Fields
| Field | Type | Description |
|---|---|---|
batchId | string | Unique batch identifier |
programId | string | Programme this batch belongs to |
batchName | string | Name given to this batch |
orgId | string | Organisation |
mode | string | "live" or "test" |
status | string | Batch status |
recipients | array | Array of issued credentials |
recipients[].recipientId | string | Unique credential ID per recipient |
recipients[].name | string | Recipient full name |
recipients[].email | string | Recipient email address |
recipients[].credentialUrl | string | Public URL to view the credential |
issuedAt | string | ISO 8601 timestamp |
Error Codes
| Code | HTTP | Description |
|---|---|---|
UNAUTHORIZED | 401 | Token missing or invalid |
NOT_FOUND | 404 | batchId does not exist or belongs to another org |

