Presentations

Presentations Management

1. Send a Presentation

To send a presentation to another profile, use the sendPresentation method. This method accepts a profileId, a vp object, and an optional encrypt parameter.

const profileId = 'janesmith';
const vp = your_presentation;
const encrypt = true;

await learnCard.invoke.sendPresentation(profileId, vp, encrypt);

Send a Presentation

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

post

/presentation/send/{profileId}

Authorizations

Path parameters

profileIdstringrequired

Body

presentationany ofrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '../api/presentation/send/{profileId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "presentation": {
      "id": "text",
      "holder": "text",
      "type": "text",
      "@context": [
        "text"
      ],
      "proof": {
        "type": "text",
        "created": "text",
        "challenge": "text",
        "domain": "text",
        "nonce": "text",
        "proofPurpose": "text",
        "verificationMethod": "text",
        "jws": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "verifiableCredential": {
        "id": "text",
        "issuanceDate": "text",
        "expirationDate": "text",
        "type": [
          "text"
        ],
        "credentialStatus": {
          "type": "text",
          "id": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "refreshService": {
          "id": "text",
          "type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "@context": [
          "text"
        ],
        "credentialSchema": [
          {
            "id": "text",
            "type": "text",
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ],
        "credentialSubject": {
          "id": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "proof": {
          "type": "text",
          "created": "text",
          "challenge": "text",
          "domain": "text",
          "nonce": "text",
          "proofPurpose": "text",
          "verificationMethod": "text",
          "jws": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "issuer": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }'

200

default

200

text

Successful response

2. Accept a Presentation

To accept a presentation, use the acceptPresentation method. This method accepts a uri parameter.

const uri = 'your_presentation_uri';

await learnCard.invoke.acceptPresentation(uri);

Accept a Presentation

This endpoint accepts a presentation

post

/presentation/accept/{uri}

Authorizations

Path parameters

uristringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

true

Successful response

3. Get Received Presentations

To retrieve all received presentations, use the getReceivedPresentations method. This method accepts an optional from parameter.

const from = 'johnsmith';

await learnCard.invoke.getReceivedPresentations(from);

Get received presentations

This endpoint returns the current user's received presentations

get

/presentation/received

Authorizations

Query parameters

limitinteger · max: 100 · default: 25

fromstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-02-28T01:28:45.724Z",
    "received": "2025-02-28T01:28:45.724Z"
  }
]

Successful response

4. Get Sent Presentations

To retrieve all sent presentations, use the getSentPresentations method. This method accepts an optional to parameter.

const to = 'janesmith';

await learnCard.invoke.getSentPresentations(to);

Get sent presentations

This endpoint returns the current user's sent presentations

get

/presentation/sent

Authorizations

Query parameters

limitinteger · max: 100 · default: 25

tostring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-02-28T01:28:45.724Z",
    "received": "2025-02-28T01:28:45.724Z"
  }
]

Successful response

5. Get Incoming Presentations

To retrieve all incoming presentations, use the getIncomingPresentations method. This method accepts an optional from parameter.

const from = 'johnsmith';

await learnCard.invoke.getIncomingPresentations(from);

Get incoming presentations

This endpoint returns the current user's incoming presentations

get

/presentation/incoming

Authorizations

Query parameters

limitinteger · max: 100 · default: 25

fromstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-02-28T01:28:45.724Z",
    "received": "2025-02-28T01:28:45.724Z"
  }
]

Successful response

6. Delete a Presentation

To delete a presentation, use the deletePresentation method. This method accepts a uri parameter.

const uri = 'your_presentation_uri';

await learnCard.invoke.deletePresentation(uri);

Delete a presentation

This endpoint deletes a presentation

delete

/presentation/{uri}

Authorizations

Path parameters

uristringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

true

Successful response