Credentials

Credentials Management

1. Send a Credential

To send a credential to another profile, use the sendCredential method. This method accepts a profileId, a vc object (which can be an UnsignedVC or VC), and an optional encrypt parameter.

const profileId = 'janesmith';
const vc = await networkLearnCard.invoke.issueCredential(networkLearnCard.invoke.newCredential())
const encrypt = true;

learnCard.invoke.sendCredential(profileId, vc, encrypt);

Send a Credential

This endpoint sends a credential to a user based on their profileId

POST../api/credential/send/{profileId}

Authorization

Authorization

Path parameters

profileId*string

Body

application/json

credential*any of

objectobjectobject

Response

200default

Successful response

Body

application/json

string

Request

JavaScriptCurlPython

const response = await fetch('../api/credential/send/{profileId}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "credential": {
        "@context": [
          "text"
        ],
        "type": [
          "text"
        ],
        "issuer": "text",
        "issuanceDate": "text",
        "credentialSubject": {}
      }
    }),
});
const data = await response.json();

Response

200default

text

2. Accept a Credential

To accept a credential, use the acceptCredential method. This method accepts a uri parameter.

const uri = 'your_credential_uri';

learnCard.invoke.acceptCredential(uri);

Accept a Credential

This endpoint accepts a credential

POST../api/credential/accept/{uri}

Authorization

Authorization

Path parameters

uri*string

Response

200default

Successful response

Body

application/json

boolean

Request

JavaScriptCurlPython

const response = await fetch('../api/credential/accept/{uri}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

false

3. Get Received Credentials

To retrieve all received credentials, use the getReceivedCredentials method. This method accepts an optional from parameter.

const from = 'johnsmith';

learnCard.invoke.getReceivedCredentials(from);

Get received credentials

This endpoint returns the current user's received credentials

GET../api/credentials/received

Authorization

Authorization

Query parameters

Response

200default

Successful response

Body

application/json

uri*string

to*string

from*string

sent*string (date-time)

receivedstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('../api/credentials/received', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2024-11-21T06:29:18.533Z",
    "received": "2024-11-21T06:29:18.533Z"
  }
]

4. Get Sent Credentials

To retrieve all sent credentials, use the getSentCredentials method. This method accepts an optional to parameter.

const to = 'janesmith';

learnCard.invoke.getSentCredentials(to);

Get sent credentials

This endpoint returns the current user's sent credentials

GET../api/credentials/sent

Authorization

Authorization

Query parameters

Response

200default

Successful response

Body

application/json

uri*string

to*string

from*string

sent*string (date-time)

receivedstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('../api/credentials/sent', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2024-11-21T06:29:18.533Z",
    "received": "2024-11-21T06:29:18.533Z"
  }
]

5. Get Incoming Credentials

To retrieve all incoming credentials, use the getIncomingCredentials method. This method accepts an optional from parameter.

const from = 'johnsmith';

learnCard.invoke.getIncomingCredentials(from);

Get incoming credentials

This endpoint returns the current user's incoming credentials

GET../api/credentials/incoming

Authorization

Authorization

Query parameters

Response

200default

Successful response

Body

application/json

uri*string

to*string

from*string

sent*string (date-time)

receivedstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('../api/credentials/incoming', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2024-11-21T06:29:18.533Z",
    "received": "2024-11-21T06:29:18.533Z"
  }
]

6. Delete a Credential

To delete a credential, use the deleteCredential method. This method accepts a uri parameter.

const uri = 'your_credential_uri';

learnCard.invoke.deleteCredential(uri);

Delete a credential

This endpoint deletes a credential

DELETE../api/credential/{uri}

Authorization

Authorization

Path parameters

uri*string

Response

200default

Successful response

Body

application/json

boolean

Request

JavaScriptCurlPython

const response = await fetch('../api/credential/{uri}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

false