Credential Issuance APIs
Authorizations
Body
credentialSchemaIdstringOptional
tagsstring[]Optional
Responses
201
Credential successfully issued!
application/json
400
Invalid Input
500
error
post
POST /api/v1/credentials/issue HTTP/1.1
Host: sunbirdrc.dev
Token: YOUR_API_KEY
Content-Type: appliation/json
Accept: */*
Content-Length: 226
{
"credential": {
"context": [
"text"
],
"id": "text",
"type": "text",
"issuer": {},
"issuanceDate": "2025-07-03T05:15:47.643Z",
"expirationDate": "2025-07-03T05:15:47.643Z",
"credentialSubject": {}
},
"credentialSchemaId": "text",
"tags": [
"text"
]
}
{
"credential": {
"context": [
"text"
],
"id": "text",
"type": "text",
"issuer": {},
"issuanceDate": "2025-07-03T05:15:47.643Z",
"expirationDate": "2025-07-03T05:15:47.643Z",
"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"
}
Authorizations
Path parameters
idstringRequired
Header parameters
templateIdstringOptional
acceptstring · enumRequiredPossible values:
Responses
200
OK
appliation/json
401
Not Authorized
404
Not Found
500
Error
get
GET /api/v1/credentials/{id} HTTP/1.1
Host: sunbirdrc.dev
Token: YOUR_API_KEY
accept: application/json
Accept: */*
{
"context": [
"text"
],
"id": "text",
"type": "text",
"issuer": {},
"issuanceDate": "2025-07-03T05:15:47.643Z",
"expirationDate": "2025-07-03T05:15:47.643Z",
"credentialSubject": {},
"proof": {
"type": "text",
"created": "2025-07-03T05:15:47.643Z",
"challenge": "text",
"domain": "text",
"nonce": "text",
"verificationMethod": "text",
"proofPurpose": "text",
"jws": "text",
"proofValue": "text"
}
}
Authorizations
Body
typestring · enumOptionalPossible values:
Responses
200
OK
appliation/json
401
Not Authorized
404
Not Found
500
Error
post
POST /api/v1/credentials/search HTTP/1.1
Host: sunbirdrc.dev
Token: YOUR_API_KEY
Content-Type: appliation/json
Accept: */*
Content-Length: 63
{
"issuer": {
"id": "text"
},
"subject": {
"id": "text"
},
"type": "claim"
}
[
{
"context": [
"text"
],
"id": "text",
"type": "text",
"issuer": {},
"issuanceDate": "2025-07-03T05:15:47.643Z",
"expirationDate": "2025-07-03T05:15:47.643Z",
"credentialSubject": {},
"proof": {
"type": "text",
"created": "2025-07-03T05:15:47.643Z",
"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.
Authorizations
Path parameters
idstringRequired
Responses
200
OK
appliation/json
get
GET /api/v1/credentials/{id}/verify HTTP/1.1
Host: sunbirdrc.dev
Token: YOUR_API_KEY
Accept: */*
200
OK
{
"status": "Active",
"checks": [
{
"active": "OK",
"revoked": "OK",
"expired": "OK",
"proof": "OK"
}
],
"warnings": [
"text"
],
"errors": [
"text"
]
}
Authorizations
Query parameters
issuerIdstringRequired
The ID of the issuer
pagestringRequired
The page number
limitstringRequired
The limit of items per page
Responses
200
OK
appliation/json
Responseobject[]
404
Not Found
500
Error
get
GET /api/v1/credentials/revocation-list HTTP/1.1
Host: sunbirdrc.dev
Token: YOUR_API_KEY
Accept: */*
[
{}
]
Last updated