Credential Issuance APIs

Credential claim API

POSThttps://sunbirdrc.dev/api/v1/credentials/issue

Body

appliation/json

Credential payload

credentialverifiableCredentialType (object)

credentialSchemaIdstring

tagsarray of string

Response

201400500

Credential successfully issued!

Body

application/json

credentialall of

credentialSchemaIdstring

tagsarray of string

createdAtstring

updatedAtstring

createdBystring

updatedBystring

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/credentials/issue', {
    method: 'POST',
    headers: {
      "Content-Type": "appliation/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "credential": {
    "context": [
      "text"
    ],
    "id": "text",
    "type": "text",
    "issuer": {},
    "issuanceDate": "2024-11-21T09:08:30.176Z",
    "expirationDate": "2024-11-21T09:08:30.176Z",
    "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"
}

Get credentials by id

GEThttps://sunbirdrc.dev/api/v1/credentials/{id}

Path parameters

id*string

Header parameters

Response

200401404500

OK

Body

appliation/json

contextarray of string

idstring

typestring

issuerobject

issuanceDatestring (date-time)

expirationDatestring (date-time)

credentialSubjectobject

proofobject

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/credentials/{id}', {
    method: 'GET',
    headers: {
      "accept": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "context": [
    "text"
  ],
  "id": "text",
  "type": "text",
  "issuer": {},
  "issuanceDate": "2024-11-21T09:08:30.176Z",
  "expirationDate": "2024-11-21T09:08:30.176Z",
  "credentialSubject": {},
  "proof": {
    "type": "text",
    "created": "2024-11-21T09:08:30.176Z",
    "challenge": "text",
    "domain": "text",
    "nonce": "text",
    "verificationMethod": "text",
    "proofPurpose": "text",
    "jws": "text",
    "proofValue": "text"
  }
}

Revoke credentials by id

DELETEhttps://sunbirdrc.dev/api/v1/credentials/{id}

Path parameters

id*string

Response

200401404500

OK

Body

appliation/json

revocationListIndexstring

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/credentials/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

{
  "revocationListIndex": "text"
}

Search credentials by issuer and subject

POSThttps://sunbirdrc.dev/api/v1/credentials/search

Body

appliation/json

Search payload

issuerobject

subjectobject

typeenum

claimsign

Response

200401404500

OK

Body

appliation/json

contextarray of string

idstring

typestring

issuerobject

issuanceDatestring (date-time)

expirationDatestring (date-time)

credentialSubjectobject

proofobject

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/credentials/search', {
    method: 'POST',
    headers: {
      "Content-Type": "appliation/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

[
  {
    "context": [
      "text"
    ],
    "id": "text",
    "type": "text",
    "issuer": {},
    "issuanceDate": "2024-11-21T09:08:30.176Z",
    "expirationDate": "2024-11-21T09:08:30.176Z",
    "credentialSubject": {},
    "proof": {
      "type": "text",
      "created": "2024-11-21T09:08:30.176Z",
      "challenge": "text",
      "domain": "text",
      "nonce": "text",
      "verificationMethod": "text",
      "proofPurpose": "text",
      "jws": "text",
      "proofValue": "text"
    }
  }
]

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

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

GEThttps://sunbirdrc.dev/api/v1/credentials/{id}/verify

Path parameters

id*string

Response

200

OK

Body

appliation/json

statusenum

ActiveRevokedExpired

checksarray of object

warningsarray of string

errorsarray of string

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/credentials/{id}/verify', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Complete list of revoked credentials (Need to be discussed)

GEThttps://sunbirdrc.dev/api/v1/credentials/revocation-list

Query parameters

Response

200404500

OK

Body

appliation/json

array of object

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/credentials/revocation-list?issuerId=text&page=text&limit=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[]