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

/credential/send/{profileId}

Authorizations

Path parameters

profileIdstringrequired

Body

credentialany ofrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '../api/credential/send/{profileId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"credential":{"issuanceDate":"text","type":[null],"credentialStatus":{"type":"text","id":"text","ANY_ADDITIONAL_PROPERTY":"anything"},"refreshService":{"id":"text","type":"text","ANY_ADDITIONAL_PROPERTY":"anything"},"@context":[],"credentialSchema":[{"id":"text","type":"text","ANY_ADDITIONAL_PROPERTY":"anything"}],"credentialSubject":{"ANY_ADDITIONAL_PROPERTY":"anything"},"ANY_ADDITIONAL_PROPERTY":"anything"}}'

200

default

200

text

Successful response

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

/credential/accept/{uri}

Authorizations

Path parameters

uristringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '../api/credential/accept/{uri}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

true

Successful response

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

/credentials/received

Authorizations

Query parameters

limitinteger · max: 100 · default: 25

fromstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '../api/credentials/received' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-02-22T08:50:42.402Z",
    "received": "2025-02-22T08:50:42.402Z"
  }
]

Successful response

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

/credentials/sent

Authorizations

Query parameters

limitinteger · max: 100 · default: 25

tostring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '../api/credentials/sent' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-02-22T08:50:42.402Z",
    "received": "2025-02-22T08:50:42.402Z"
  }
]

Successful response

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

/credentials/incoming

Authorizations

Query parameters

limitinteger · max: 100 · default: 25

fromstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '../api/credentials/incoming' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-02-22T08:50:42.402Z",
    "received": "2025-02-22T08:50:42.402Z"
  }
]

Successful response

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

/credential/{uri}

Authorizations

Path parameters

uristringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '../api/credential/{uri}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

true

Successful response