Credential Issuance APIs

Credential claim API

post

/credentials/issue

Authorizations

Body

credentialobject

credentialSchemaIdstring

tagsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://sunbirdrc.dev/api/v1/credentials/issue' \
  --header 'Token: YOUR_API_KEY' \
  --header 'Content-Type: appliation/json' \
  --data '{"credential":{"issuer":{},"credentialSubject":{},"context":[null]},"tags":[null]}'

201

400

500

201

{
  "credentialSchemaId": "text",
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text",
  "tags": [
    "text"
  ],
  "credential": {
    "id": "text",
    "type": "text",
    "issuanceDate": "2025-02-21T18:11:46.340Z",
    "expirationDate": "2025-02-21T18:11:46.340Z",
    "issuer": {},
    "credentialSubject": {},
    "context": [
      "text"
    ],
    "proof": {
      "type": "text",
      "created": "text",
      "challenge": "text",
      "domain": "text",
      "nonce": "text",
      "verificationMethod": "text",
      "proofPurpose": "text",
      "jws": "text",
      "proofValue": "text"
    }
  }
}

Credential successfully issued!

Get credentials by id

get

/credentials/{id}

Authorizations

Path parameters

idstringrequired

Header parameters

templateIdstring

acceptstring · enumrequired

Options: application/json, application/vc+ld+json, text/html, image/svg+xml, text/plain, image/jpeg

Responses

appliation/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://sunbirdrc.dev/api/v1/credentials/{id}' \
  --header 'Token: YOUR_API_KEY' \
  --header 'accept: application/json'

200

401

404

500

200

{
  "id": "text",
  "type": "text",
  "issuanceDate": "2025-02-21T18:11:46.340Z",
  "expirationDate": "2025-02-21T18:11:46.340Z",
  "issuer": {},
  "credentialSubject": {},
  "context": [
    "text"
  ],
  "proof": {
    "type": "text",
    "created": "2025-02-21T18:11:46.340Z",
    "challenge": "text",
    "domain": "text",
    "nonce": "text",
    "verificationMethod": "text",
    "proofPurpose": "text",
    "jws": "text",
    "proofValue": "text"
  }
}

OK

Revoke credentials by id

delete

/credentials/{id}

Authorizations

Path parameters

idstringrequired

Responses

appliation/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://sunbirdrc.dev/api/v1/credentials/{id}' \
  --header 'Token: YOUR_API_KEY'

200

401

404

500

200

{
  "revocationListIndex": "text"
}

OK

Search credentials by issuer and subject

post

/credentials/search

Authorizations

Body

typestring · enum

Options: claim, sign

issuerobject

subjectobject

Responses

appliation/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://sunbirdrc.dev/api/v1/credentials/search' \
  --header 'Token: YOUR_API_KEY' \
  --header 'Content-Type: appliation/json' \
  --data '{"type":"claim","issuer":{},"subject":{}}'

200

401

404

500

200

[
  {
    "id": "text",
    "type": "text",
    "issuanceDate": "2025-02-21T18:11:46.340Z",
    "expirationDate": "2025-02-21T18:11:46.340Z",
    "issuer": {},
    "credentialSubject": {},
    "context": [
      "text"
    ],
    "proof": {
      "type": "text",
      "created": "2025-02-21T18:11:46.340Z",
      "challenge": "text",
      "domain": "text",
      "nonce": "text",
      "verificationMethod": "text",
      "proofPurpose": "text",
      "jws": "text",
      "proofValue": "text"
    }
  }
]

OK

Verifies a verifiableCredential and returns a verificationResult in the response body.

Verifies a verifiableCredential and returns a verificationResult in the response body.

get

/credentials/{id}/verify

Authorizations

Path parameters

idstringrequired

Responses

appliation/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://sunbirdrc.dev/api/v1/credentials/{id}/verify' \
  --header 'Token: YOUR_API_KEY'

200

200

{
  "status": "Active",
  "warnings": [
    "text"
  ],
  "errors": [
    "text"
  ],
  "checks": [
    {
      "active": "OK",
      "revoked": "OK",
      "expired": "OK",
      "proof": "OK"
    }
  ]
}

OK

Complete list of revoked credentials (Need to be discussed)

get

/credentials/revocation-list

Authorizations

Query parameters

issuerIdstringrequired

The ID of the issuer

pagestringrequired

The page number

limitstringrequired

The limit of items per page

Responses

appliation/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://sunbirdrc.dev/api/v1/credentials/revocation-list?issuerId=text&page=text&limit=text' \
  --header 'Token: YOUR_API_KEY'

200

404

500

200

[
  {}
]

OK