Issue a credential
GENERATED — DO NOT EDIT DIRECTLY. Produced from the canonical OpenAPI specification by
developer-docs/tools/generate-reference.mjs. Edits are overwritten on the next run.
/v1.0/credentials/issuanceScope: credentials.issue. Name the issuer explicitly with issuerId - an API key is a tenant credential, not a credential bound to one issuer, so the issuer cannot be inferred. Supply Idempotency-Key to make retries safe: the same key with the same payload replays the original result, and the same key with a different payload is rejected with 409. Claims are validated against the credential configuration; unrecognised claims are rejected. Authenticate with Authorization: ApiKey {key}. Every response carries x-ms-request-id, X-Correlation-Id and X-Request-Id; quote the request id in any support request. Returns 201 on success.
| Operation ID | Credentials_Issue |
| Plane | Product |
| Versioning | In the path |
| Authentication | Authorization: ApiKey {key} |
| Required scope | credentials.issue |
| Concurrency | Not applicable |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Idempotency-Key |
string |
No | Replays the original result for a repeated call. The same key with a different payload is rejected with 409. |
x-ms-client-request-id |
string |
No | Optional caller-supplied correlation value, echoed back on the response and recorded in diagnostics. It never influences authentication, tenant or environment selection, resource lookup or idempotency. |
Request body
Type: CreateIssuanceTransactionRequest
| Field | Type | Required | Description |
|---|---|---|---|
callbackReference |
string, nullable |
No | |
claims |
object, nullable |
No | |
credentialConfiguration |
string |
Yes | |
delivery |
— | No | |
externalSubjectReference |
string, nullable |
No | |
issuerId |
string, nullable |
No |
Responses
| Status | Body | Meaning |
|---|---|---|
201 |
ApiEnvelopeOfIssuanceTransactionResponse |
Created. |
400 |
ErrorEnvelope |
The request was not valid. See error model. |
401 |
ErrorEnvelope |
Authentication failed — the API key is missing, malformed, revoked or expired. |
403 |
ErrorEnvelope |
Authenticated, but the key does not carry the required scope. |
404 |
ErrorEnvelope |
Not visible to this caller. A resource in another tenant or environment reports as not found. |
409 |
ErrorEnvelope |
The request conflicts with the resource state, or an idempotency key was reused with a different payload. |
429 |
ErrorEnvelope |
Throttled. See rate limits. |
Response headers: x-ms-request-id
Example
curl -X POST "https://api.example.diligence.id/v1.0/credentials/issuance" \
-H "Authorization: ApiKey YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ }'