Credential status (DCP)

Specifications and best practice implementations for Verifiable Credentials are currently being developed. This page is expected to be updated, closely following these developments.

The GET request to the /requests/{requestId} endpoint requests the status of a credential issuance process.

The GET request to the /requests/{requestId} is an OPTIONAL endpoint and is part of the iSHARE Framework's Verifiable Credentials support in line with the Decentralised Claims Protocol (DCP).

Get credential request status

get

Retrieves the status of a credential request. This endpoint is used to check the processing status of a previously submitted credential request. The request ID is provided in the Location header of the 201 response from the /credentials endpoint. More information in the DCP specification.

Authorizations

BearerAuth

AuthorizationstringRequired

iSHARE JWT Bearer token authentication

Path parameters

requestIdstring · uriRequired

Unique identifier of the credential request

Example: urn:uuid:550e8400-e29b-41d4-a716-446655440000

Responses

200

Credential request status retrieved successfully

application/json

Responseall of

401

Unauthorized - Invalid or missing authentication

404

Credential request not found

500

Internal Server Error

get

/requests/{requestId}

HTTPcURLJavaScriptPython

GET /requests/{requestId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Request model

The request contains a {requestId} parameter in the URL. This {requestId} corresponds to the ID identified by the location header returned after a Credential Issuance message.

Example request

GET /credentials/3cc1e9be-99d0-43fc-bb48-1f60837163bd HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN

Response model

The model for the CredentialStatus is defined in: https://eclipse-dataspace-dcp.github.io/decentralized-claims-protocol/v1.0/resources/issuance/credential-request-message-schema.json.

• @context Array of Strings. Root level. (Required) Specifies a valid Json-Ld context. Must contain "https://w3id.org/dspace-dcp/v1.0/dcp.jsonld"

• type String. Root level. (Required) A string specifying the CredentialStatus type. Must contain "CredentialStatus"

• issuerPid String. Root level. (Required) A string corresponding to the issuance id on the Issuer side.

• holderPid String. Root level. (Required) A string corresponding to the request id on the Holder side.

• status String. Root level. (Required) A string with a value of RECEIVED, REJECTED, or ISSUED.

Example response

{
  "@context": [
    "https://w3id.org/dspace-dcp/v1.0/dcp.jsonld"
  ],
  "type": "CredentialStatus",
  "issuerPid": "issuerPid",
  "holderPid": "holderPid",
  "status": "RECEIVED"
}