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

post

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

Authorizations

Path parameters

profileIdstringRequired

Body

presentationany ofRequired

or

Responses

200

Successful response

application/json

Responsestring

default

Error response

application/json

post

HTTPcURLJavaScriptPython

POST /api/presentation/send/{profileId} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1294

{
  "presentation": {
    "@context": [
      "text"
    ],
    "id": "text",
    "type": "text",
    "verifiableCredential": {
      "@context": [
        "text"
      ],
      "id": "text",
      "type": [
        "text"
      ],
      "issuer": "text",
      "credentialSubject": {
        "id": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "refreshService": {
        "id": "text",
        "type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "credentialSchema": {
        "id": "text",
        "type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "issuanceDate": "text",
      "expirationDate": "text",
      "credentialStatus": {
        "type": "text",
        "id": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "name": "text",
      "description": "text",
      "validFrom": "text",
      "validUntil": "text",
      "status": {
        "type": "text",
        "id": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "termsOfUse": {
        "type": "text",
        "id": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "evidence": {
        "type": "text",
        "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"
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "holder": "text",
    "proof": {
      "type": "text",
      "created": "text",
      "challenge": "text",
      "domain": "text",
      "nonce": "text",
      "proofPurpose": "text",
      "verificationMethod": "text",
      "jws": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

text

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);

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

get

This endpoint returns the current user's received presentations

Authorizations

Query parameters

limitinteger · max: 100OptionalDefault: 25

fromstringOptional

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /api/presentation/received HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-05-15T06:57:45.620Z",
    "received": "2025-05-15T06:57:45.620Z"
  }
]

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

get

This endpoint returns the current user's sent presentations

Authorizations

Query parameters

limitinteger · max: 100OptionalDefault: 25

tostringOptional

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /api/presentation/sent HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-05-15T06:57:45.620Z",
    "received": "2025-05-15T06:57:45.620Z"
  }
]

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

get

This endpoint returns the current user's incoming presentations

Authorizations

Query parameters

limitinteger · max: 100OptionalDefault: 25

fromstringOptional

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /api/presentation/incoming HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uri": "text",
    "to": "text",
    "from": "text",
    "sent": "2025-05-15T06:57:45.620Z",
    "received": "2025-05-15T06:57:45.620Z"
  }
]

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);