Credential Issuance APIs

Credential claim API

post

Authorizations

Body

credentialobjectoptional

credentialSchemaIdstringoptional

tagsstring[]optional

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": {
      "context": [
        "text"
      ],
      "id": "text",
      "type": "text",
      "issuer": {},
      "issuanceDate": "2025-03-26T02:20:08.494Z",
      "expirationDate": "2025-03-26T02:20:08.494Z",
      "credentialSubject": {}
    },
    "credentialSchemaId": "text",
    "tags": [
      "text"
    ]
  }'

201

400

500

201

{
  "credential": {
    "context": [
      "text"
    ],
    "id": "text",
    "type": "text",
    "issuer": {},
    "issuanceDate": "2025-03-26T02:20:08.494Z",
    "expirationDate": "2025-03-26T02:20:08.494Z",
    "credentialSubject": {},
    "proof": {
      "type": "text",
      "created": "text",
      "challenge": "text",
      "domain": "text",
      "nonce": "text",
      "verificationMethod": "text",
      "proofPurpose": "text",
      "jws": "text",
      "proofValue": "text"
    }
  },
  "credentialSchemaId": "text",
  "tags": [
    "text"
  ],
  "createdAt": "text",
  "updatedAt": "text",
  "createdBy": "text",
  "updatedBy": "text"
}

Credential successfully issued!

Get credentials by id

get

Authorizations

Path parameters

idstringrequired

Header parameters

templateIdstringoptional

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

{
  "context": [
    "text"
  ],
  "id": "text",
  "type": "text",
  "issuer": {},
  "issuanceDate": "2025-03-26T02:20:08.494Z",
  "expirationDate": "2025-03-26T02:20:08.494Z",
  "credentialSubject": {},
  "proof": {
    "type": "text",
    "created": "2025-03-26T02:20:08.494Z",
    "challenge": "text",
    "domain": "text",
    "nonce": "text",
    "verificationMethod": "text",
    "proofPurpose": "text",
    "jws": "text",
    "proofValue": "text"
  }
}

OK

Revoke credentials by id

delete

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

Authorizations

Body

issuerobjectoptional

subjectobjectoptional

typestring · enumoptional

Options: claim, sign

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 '{
    "issuer": {
      "id": "text"
    },
    "subject": {
      "id": "text"
    },
    "type": "claim"
  }'

200

401

404

500

200

[
  {
    "context": [
      "text"
    ],
    "id": "text",
    "type": "text",
    "issuer": {},
    "issuanceDate": "2025-03-26T02:20:08.494Z",
    "expirationDate": "2025-03-26T02:20:08.494Z",
    "credentialSubject": {},
    "proof": {
      "type": "text",
      "created": "2025-03-26T02:20:08.494Z",
      "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.

get

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

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",
  "checks": [
    {
      "active": "OK",
      "revoked": "OK",
      "expired": "OK",
      "proof": "OK"
    }
  ],
  "warnings": [
    "text"
  ],
  "errors": [
    "text"
  ]
}

OK

Complete list of revoked credentials (Need to be discussed)

get

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