Identity Service APIs

GEThttps://sunbirdrc.dev/api/v1/health

Response

200503

The Health Check is successful

Body

application/json

statusstring

Example: "ok"

infonullable object

errornullable object

detailsobject

Request

JavaScriptCurlPython

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

Response

200503

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}

Generate a new DID

POSThttps://sunbirdrc.dev/api/v1/did/generate

Body

application/json

alsoKnownAs*array of string

AlsoKnownAs property is a unique combination aadhaar and username.

services*array of object

An array of services that are used, for example a user registration service.

method*string

The method of DID.

Response

200400

DID Generated

Body

application/json

idstring

Example: "did:rcw:71364c7e-0abe-49cf-9269-4661699f274b"

alsoKnownAsarray of string

AlsoKnownAs property is a unique combination aadhaar and username.

servicearray of object

An array of services that are used, for example a user registration service.

verificationMethodobject

The method of DID

authenticationstring

Example: "auth-key"

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/did/generate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "alsoKnownAs": [
          "[e-mail]"
        ],
        "services": [
          "{ \"id\": \"IdentityHub\", \"type\": \"IdentityHub\", \"serviceEndpoint\": { \"@context\": \"schema.identity.foundation/hub\", \"@type\": \"UserServiceEndpoint\", \"instance\": [ \"did:test:hub.id\" ] } }"
        ],
        "method": "text"
      }
    ]),
});
const data = await response.json();

Response

200

[
  {
    "id": "did:rcw:71364c7e-0abe-49cf-9269-4661699f274b",
    "alsoKnownAs": [
      "[e-mail]"
    ],
    "service": [
      "{ \"id\": \"IdentityHub\", \"type\": \"IdentityHub\", \"serviceEndpoint\": { \"@context\": \"schema.identity.foundation/hub\", \"@type\": \"UserServiceEndpoint\", \"instance\": [ \"did:test:hub.id\" ] } }"
    ],
    "verificationMethod": {
      "id": "auth-key",
      "type": "RS256",
      "controller": "did:rcw:71364c7e-0abe-49cf-9269-4661699f274b"
    },
    "authentication": "auth-key"
  }
]

Resolve a DID ID

GEThttps://sunbirdrc.dev/api/v1/did/resolve/{id}

Path parameters

id*string

The DID ID to resolve

Response

200400404

DID resolved

Body

application/json

idstring

Example: "did:rcw:71364c7e-0abe-49cf-9269-4661699f274b"

alsoKnownAsarray of string

AlsoKnownAs property is a unique combination aadhaar and username.

servicearray of object

An array of services that are used, for example a user registration service.

verificationMethodobject

The method of DID

authenticationstring

Example: "auth-key"

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "did:rcw:71364c7e-0abe-49cf-9269-4661699f274b",
  "alsoKnownAs": [
    "[e-mail]"
  ],
  "service": [
    "{ \"id\": \"IdentityHub\", \"type\": \"IdentityHub\", \"serviceEndpoint\": { \"@context\": \"schema.identity.foundation/hub\", \"@type\": \"UserServiceEndpoint\", \"instance\": [ \"did:test:hub.id\" ] } }"
  ],
  "verificationMethod": {
    "id": "auth-key",
    "type": "RS256",
    "controller": "did:rcw:71364c7e-0abe-49cf-9269-4661699f274b"
  },
  "authentication": "auth-key"
}

Sign an unsigned VC

POSThttps://sunbirdrc.dev/api/v1/utils/sign

Body

application/json

DID*string

The unique DID id of the issuer.

payload*string

JSON string of the unsigned VC.

Example: "{ \"@context\": [ \"https://www.w3.org/2018/credentials/v1\", \"https://www.w3.org/2018/credentials/examples/v1\" ], \"id\": \"did:ulp:b4a191af-d86e-453c-9d0e-dd4771067235\", \"type\": [ \"VerifiableCredential\", \"UniversityDegreeCredential\" ], \"issuer\": \"did:rcw:6b9d7b31-bc7f-454a-be30-b6c7447b1cff\", \"expirationDate\": \"2023-02-08T11:56:27.259Z\", \"credentialSubject\": { \"id\": \"did:rcw:6b9d7b31-bc7f-454a-be30-b6c7447b1cff\", \"grade\": \"9.23\", \"programme\": \"B.Tech\", \"certifyingInstitute\": \"IIIT Sonepat\", \"evaluatingInstitute\": \"NIT Kurukshetra\" }, \"options\": { \"created\": \"2020-04-02T18:48:36Z\", \"credentialStatus\": { \"type\": \"RevocationList2020Status\" } } }"

Response

200400500

VC Signed

Body

application/json

publicKeyobject

Public Key of issuer

Example: "{\"kty\": \"EC\",\"crv\": \"secp256k1\",\"x\": \"1iTtnvgP141NM-4qC6BgmkeTAjV7u-gZWni71G7cAKo\",\"y\": \"VSGqq6yS0w7riXXRqFxXwKvHgIpQaUNMlFQKh-xgKMI\"}"

signedstring

Signed VC

Request

JavaScriptCurlPython

const response = await fetch('https://sunbirdrc.dev/api/v1/utils/sign', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "DID": "text",
      "payload": "{ \"@context\": [ \"https://www.w3.org/2018/credentials/v1\", \"https://www.w3.org/2018/credentials/examples/v1\" ], \"id\": \"did:ulp:b4a191af-d86e-453c-9d0e-dd4771067235\", \"type\": [ \"VerifiableCredential\", \"UniversityDegreeCredential\" ], \"issuer\": \"did:rcw:6b9d7b31-bc7f-454a-be30-b6c7447b1cff\", \"expirationDate\": \"2023-02-08T11:56:27.259Z\", \"credentialSubject\": { \"id\": \"did:rcw:6b9d7b31-bc7f-454a-be30-b6c7447b1cff\", \"grade\": \"9.23\", \"programme\": \"B.Tech\", \"certifyingInstitute\": \"IIIT Sonepat\", \"evaluatingInstitute\": \"NIT Kurukshetra\" }, \"options\": { \"created\": \"2020-04-02T18:48:36Z\", \"credentialStatus\": { \"type\": \"RevocationList2020Status\" } } }"
    }),
});
const data = await response.json();

Response

200

{
  "publicKey": "{\"kty\": \"EC\",\"crv\": \"secp256k1\",\"x\": \"1iTtnvgP141NM-4qC6BgmkeTAjV7u-gZWni71G7cAKo\",\"y\": \"VSGqq6yS0w7riXXRqFxXwKvHgIpQaUNMlFQKh-xgKMI\"}",
  "signed": "text"
}

Verify a signed VC

POSThttps://sunbirdrc.dev/api/v1/utils/verify

Body

application/json

DID*string

Response

201

Body

application/json

boolean

Example: true

Request

JavaScriptCurlPython

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

Response

201

true