Identity Service APIs

get

/health

Authorizations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://sunbirdrc.dev/api/v1/health' \
  --header 'Token: YOUR_API_KEY'

200

503

200

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

The Health Check is successful

Generate a new DID

post

/did/generate

Authorizations

Body

alsoKnownAsstring[]required

AlsoKnownAs property is a unique combination aadhaar and username.

Example: [e-mail]

servicesobject[]required

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

Example: { "id": "IdentityHub", "type": "IdentityHub", "serviceEndpoint": { "@context": "schema.identity.foundation/hub", "@type": "UserServiceEndpoint", "instance": [ "did:test:hub.id" ] } }

methodstringrequired

The method of DID.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://sunbirdrc.dev/api/v1/did/generate' \
  --header 'Token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "alsoKnownAs": [
        "[e-mail]"
      ],
      "services": [
        "{ \"id\": \"IdentityHub\", \"type\": \"IdentityHub\", \"serviceEndpoint\": { \"@context\": \"schema.identity.foundation/hub\", \"@type\": \"UserServiceEndpoint\", \"instance\": [ \"did:test:hub.id\" ] } }"
      ],
      "method": "text"
    }
  ]'

200

400

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",
      "publicKeyJwk": {},
      "controller": "did:rcw:71364c7e-0abe-49cf-9269-4661699f274b"
    },
    "authentication": "auth-key"
  }
]

DID Generated

Resolve a DID ID

get

/did/resolve/{id}

Authorizations

Path parameters

idstringrequired

The DID ID to resolve

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

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",
    "publicKeyJwk": {},
    "controller": "did:rcw:71364c7e-0abe-49cf-9269-4661699f274b"
  },
  "authentication": "auth-key"
}

DID resolved

Sign an unsigned VC

post

/utils/sign

Authorizations

Body

DIDstringrequired

The unique DID id of the issuer.

payloadstringrequired

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" } } }

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://sunbirdrc.dev/api/v1/utils/sign' \
  --header 'Token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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\" } } }"
  }'

200

400

500

200

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

VC Signed

Verify a signed VC

post

/utils/verify

Authorizations

Body

DIDstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://sunbirdrc.dev/api/v1/utils/verify' \
  --header 'Token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "DID": "text"
  }'

201

201

true