API
/issue
post
An endpoint to request a new status index for a GOV.UK wallet credential. This API will use the issuer’s /.well-known/jwks.json endpoint to locate the signing keys to verify the signature.
Responses
| Status | Description | Schema |
|---|---|---|
| 200 |
A response that contains a status index and a uri to the status list where this newly issued
|
IssueResponse |
| 400 |
Bad request (invalid JWT, missing fields, wrong content-type, etc.)
|
Issue400ErrorResponse |
| 401 |
Unauthorized (client not found)
|
Issue401ErrorResponse |
| 403 |
Forbidden (JWT signature verification failure)
|
Issue403ErrorResponse |
| 500 |
Internal server error
|
Issue500ErrorResponse |
Schemas
IssueResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| idx | number | true | The assigned status list index. This index position is unique within the status list identified by the URI |
|
| uri | string | true | The URI of the status list that holds the issued credential. It is used in combination with the index to retrieve the status list entry |
Issue400ErrorResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| error | string | true | An error code - must be |
|
| error_description | string | false | A human-readable explanation of the error. |
Issue401ErrorResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| error | string | true | An error code - must be |
|
| error_description | string | false | A human-readable explanation of the error. |
Issue403ErrorResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| error | string | true | An error code - must be |
|
| error_description | string | false | A human-readable explanation of the error. |
Issue500ErrorResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| error | string | true | An error code - must be |
|
| error_description | string | false | A human-readable explanation of the error. |