Profile

A comprehensive guide on how to use all profile-related API calls with the LearnCard Network Plugin

Profile Core

1. Create a Profile

To create a new profile, use the createProfile method. This method accepts an object containing the profile information, excluding the did and isServiceProfile properties.

const profile = {
  displayName: 'John Smith',
  profileId: 'johnsmith',
  image: 'https://example.com/avatar.jpg',
};

await  learnCard.invoke.createProfile(profile);

Create a profile

Creates a profile for a user

POST../api/profile/create

Authorization

Authorization

Body

application/json

profileId*string

displayNamestring

shortBiostring

biostring

isPrivateboolean

emailstring

imagestring

heroImagestring

websiteLinkstring

typestring

notificationsWebhookstring (uri)

Pattern: ^http

displayobject

Response

200default

Successful response

Body

application/json

string

Request

JavaScriptCurlPython

const response = await fetch('../api/profile/create', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "profileId": "text"
    }),
});
const data = await response.json();

Response

200default

text

2. Create a Service Profile

To create a new service profile, use the createServiceProfile method. This method accepts an object containing the profile information, excluding the did and isServiceProfile properties.

const serviceProfile = {
  dipslayName: 'Learning Platform',
  profileId: 'learningplatform',
  image: 'https://example.com/service-avatar.jpg',
};

await learnCard.invoke.createServiceProfile(serviceProfile);

Create a service profile

Creates a service profile

POST../api/profile/create-service

Authorization

Authorization

Body

application/json

profileId*string

displayNamestring

shortBiostring

biostring

isPrivateboolean

emailstring

imagestring

heroImagestring

websiteLinkstring

typestring

notificationsWebhookstring (uri)

Pattern: ^http

displayobject

Response

200default

Successful response

Body

application/json

string

Request

JavaScriptCurlPython

const response = await fetch('../api/profile/create-service', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "profileId": "text"
    }),
});
const data = await response.json();

Response

200default

text

3. Update a Profile

To update an existing profile, use the updateProfile method. This method accepts an object containing the profile information that you want to update, excluding the did and isServiceProfile properties.

const updatedProfile = {
  displayName: 'Jane Smith',
};

await learnCard.invoke.updateProfile(updatedProfile);

Update your profile

This route updates the profile of the current user

POST../api/profile

Authorization

Authorization

Body

application/json

profileIdstring

displayNamestring

shortBiostring

biostring

isPrivateboolean

emailstring

imagestring

heroImagestring

websiteLinkstring

typestring

notificationsWebhookstring (uri)

Pattern: ^http

displayobject

Response

200default

Successful response

Body

application/json

boolean

Request

JavaScriptCurlPython

const response = await fetch('../api/profile', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200default

false

4. Delete a Profile

To delete an existing profile, use the deleteProfile method. This method does not require any parameters.

await learnCard.invoke.deleteProfile();

Delete your profile

This route deletes the profile of the current user

DELETE../api/profile

Authorization

Authorization

Response

200default

Successful response

Body

application/json

boolean

Request

JavaScriptCurlPython

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

Response

200default

false

5. Get a Profile

To retrieve a specific profile, use the getProfile method. This method accepts an optional profileId parameter. If no profileId is provided, it returns the current user's profile.

const profileId = 'johnsmith';

await learnCard.invoke.getProfile(profileId);

Get your profile information

This route uses the request header to grab the profile of the current user

GET../api/profile

Authorization

Authorization

Response

200default

Successful response

Body

application/json

any of

notobject

Request

JavaScriptCurlPython

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

Response

default

{
  "message": "text",
  "code": "text",
  "issues": [
    {
      "message": "text"
    }
  ]
}

Get profile information

This route grabs the profile information of any user, using their profileId

GET../api/profile/{profileId}

Path parameters

profileId*string

Response

200default

Successful response

Body

application/json

any of

notobject

Request

JavaScriptCurlPython

const response = await fetch('../api/profile/{profileId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

default

{
  "message": "text",
  "code": "text",
  "issues": [
    {
      "message": "text"
    }
  ]
}

6. Search Profiles

To search for profiles, use the searchProfiles method. This method accepts an optional profileId parameter and an options object. The options object can contain the following properties:

• limit: Maximum number of profiles to return.

• includeSelf: Whether to include the current user's profile in the results.

• includeConnectionStatus: Whether to include connection status in the results.

const profileId = 'johnsmith';
const options = { limit: 10, includeSelf: false, includeConnectionStatus: true };

learnCard.invoke.searchProfiles(profileId, options);

These are all the profile-related API calls available with the LearnCard Network Plugin. Use these methods to manage and interact with user profiles on the LearnCard Network.

Search profiles

This route searches for profiles based on their profileId

GET../api/search/profiles/{input}

Path parameters

input*string

Query parameters

Response

200default

Successful response

Body

application/json

profileId*string

displayNamestring

shortBiostring

biostring

did*string

isPrivateboolean

emailstring

imagestring

heroImagestring

websiteLinkstring

isServiceProfileboolean

typestring

notificationsWebhookstring (uri)

Pattern: ^http

displayobject

connectionStatusenum

CONNECTEDPENDING_REQUEST_SENTPENDING_REQUEST_RECEIVEDNOT_CONNECTED

Request

JavaScriptCurlPython

const response = await fetch('../api/search/profiles/{input}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

[
  {
    "profileId": "text",
    "displayName": "text",
    "shortBio": "text",
    "bio": "text",
    "did": "text",
    "isPrivate": false,
    "email": "text",
    "image": "text",
    "heroImage": "text",
    "websiteLink": "text",
    "isServiceProfile": false,
    "type": "text",
    "notificationsWebhook": "https://example.com",
    "display": {
      "backgroundColor": "text",
      "backgroundImage": "text",
      "fadeBackgroundImage": false,
      "repeatBackgroundImage": false,
      "fontColor": "text",
      "accentColor": "text",
      "accentFontColor": "text",
      "idBackgroundImage": "text",
      "fadeIdBackgroundImage": false,
      "idBackgroundColor": "text",
      "repeatIdBackgroundImage": false
    },
    "connectionStatus": "CONNECTED"
  }
]

Connections Management

1. Connect with a Profile

To send a connection request to another profile, use the connectWith method. This method accepts a profileId parameter.

const profileId = 'janesmith';

await learnCard.invoke.connectWith(profileId);

Connect with another profile

This route uses the request header to send a connection request to another user based on their profileId

POST../api/profile/{profileId}/connect

Authorization

Authorization

Path parameters

profileId*string

Response

200default

Successful response

Body

application/json

boolean

Request

JavaScriptCurlPython

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

Response

200default

false

2. Connect with a Profile using an Invite

To connect with another profile using an invite, use the connectWithInvite method. This method accepts a profileId and a challenge parameter.

const profileId = 'janesmith';
const challenge = 'your_challenge';

await learnCard.invoke.connectWithInvite(profileId, challenge);

Connect using an invitation

Connects with another profile using an invitation challenge

POST../api/profile/{profileId}/connect/{challenge}

Authorization

Authorization

Path parameters

profileId*string

challenge*string

Response

200default

Successful response

Body

application/json

boolean

Request

JavaScriptCurlPython

const response = await fetch('../api/profile/{profileId}/connect/{challenge}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

false

3. Cancel a Connection Request

To cancel a pending connection request, use the cancelConnectionRequest method. This method accepts a profileId parameter.

const profileId = 'janesmith';

await learnCard.invoke.cancelConnectionRequest(profileId);

Cancel Connection Request

Cancels connection request with another profile

POST../api/profile/{profileId}/cancel-connection-request

Authorization

Authorization

Path parameters

profileId*string

Response

200default

Successful response

Body

application/json

boolean

Request

JavaScriptCurlPython

const response = await fetch('../api/profile/{profileId}/cancel-connection-request', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

false

4. Disconnect with a Profile

To disconnect from an existing connection, use the disconnectWith method. This method accepts a profileId parameter.

const profileId = 'janesmith';

await learnCard.invoke.disconnectWith(profileId);

Disconnect with another profile

This route uses the request header to disconnect with another user based on their profileId

POST../api/profile/{profileId}/disconnect

Authorization

Authorization

Path parameters

profileId*string

Response

200default

Successful response

Body

application/json

boolean

Request

JavaScriptCurlPython

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

Response

200default

false

5. Accept a Connection Request

To accept a connection request from another profile, use the acceptConnectionRequest method. This method accepts a profileId parameter.

const profileId = 'janesmith';

await learnCard.invoke.acceptConnectionRequest(profileId);

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

6. Get Connections

To retrieve all connections, use the getConnections method. This method does not require any parameters.

await learnCard.invoke.getConnections();

View connections

This route shows the current user's connections. Warning! This route is deprecated and currently has a hard limit of returning only the first 50 connections. Please use paginatedConnections instead!

GET../api/profile/connections

Authorization

Authorization

Response

200default

Successful response

Body

application/json

profileId*string

displayNamestring

shortBiostring

biostring

did*string

isPrivateboolean

emailstring

imagestring

heroImagestring

websiteLinkstring

isServiceProfileboolean

typestring

notificationsWebhookstring (uri)

Pattern: ^http

displayobject

Request

JavaScriptCurlPython

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

Response

200default

[
  {
    "profileId": "text",
    "displayName": "text",
    "shortBio": "text",
    "bio": "text",
    "did": "text",
    "isPrivate": false,
    "email": "text",
    "image": "text",
    "heroImage": "text",
    "websiteLink": "text",
    "isServiceProfile": false,
    "type": "text",
    "notificationsWebhook": "https://example.com",
    "display": {
      "backgroundColor": "text",
      "backgroundImage": "text",
      "fadeBackgroundImage": false,
      "repeatBackgroundImage": false,
      "fontColor": "text",
      "accentColor": "text",
      "accentFontColor": "text",
      "idBackgroundImage": "text",
      "fadeIdBackgroundImage": false,
      "idBackgroundColor": "text",
      "repeatIdBackgroundImage": false
    }
  }
]

7. Get Pending Connections

To retrieve all pending connections, use the getPendingConnections method. This method does not require any parameters.

await learnCard.invoke.getPendingConnections();

View pending connections

This route shows the current user's pending connections. Warning! This route is deprecated and currently has a hard limit of returning only the first 50 connections. Please use paginatedPendingConnections instead

GET../api/profile/pending-connections

Authorization

Authorization

Response

200default

Successful response

Body

application/json

profileId*string

displayNamestring

shortBiostring

biostring

did*string

isPrivateboolean

emailstring

imagestring

heroImagestring

websiteLinkstring

isServiceProfileboolean

typestring

notificationsWebhookstring (uri)

Pattern: ^http

displayobject

Request

JavaScriptCurlPython

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

Response

200default

[
  {
    "profileId": "text",
    "displayName": "text",
    "shortBio": "text",
    "bio": "text",
    "did": "text",
    "isPrivate": false,
    "email": "text",
    "image": "text",
    "heroImage": "text",
    "websiteLink": "text",
    "isServiceProfile": false,
    "type": "text",
    "notificationsWebhook": "https://example.com",
    "display": {
      "backgroundColor": "text",
      "backgroundImage": "text",
      "fadeBackgroundImage": false,
      "repeatBackgroundImage": false,
      "fontColor": "text",
      "accentColor": "text",
      "accentFontColor": "text",
      "idBackgroundImage": "text",
      "fadeIdBackgroundImage": false,
      "idBackgroundColor": "text",
      "repeatIdBackgroundImage": false
    }
  }
]

8. Get Connection Requests

To retrieve all connection requests, use the getConnectionRequests method. This method does not require any parameters.

await learnCard.invoke.getConnectionRequests();

View pending connections

This route shows the current user's pending connections. Warning! This route is deprecated and currently has a hard limit of returning only the first 50 connections. Please use paginatedPendingConnections instead

GET../api/profile/pending-connections

Authorization

Authorization

Response

200default

Successful response

Body

application/json

profileId*string

displayNamestring

shortBiostring

biostring

did*string

isPrivateboolean

emailstring

imagestring

heroImagestring

websiteLinkstring

isServiceProfileboolean

typestring

notificationsWebhookstring (uri)

Pattern: ^http

displayobject

Request

JavaScriptCurlPython

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

Response

200default

[
  {
    "profileId": "text",
    "displayName": "text",
    "shortBio": "text",
    "bio": "text",
    "did": "text",
    "isPrivate": false,
    "email": "text",
    "image": "text",
    "heroImage": "text",
    "websiteLink": "text",
    "isServiceProfile": false,
    "type": "text",
    "notificationsWebhook": "https://example.com",
    "display": {
      "backgroundColor": "text",
      "backgroundImage": "text",
      "fadeBackgroundImage": false,
      "repeatBackgroundImage": false,
      "fontColor": "text",
      "accentColor": "text",
      "accentFontColor": "text",
      "idBackgroundImage": "text",
      "fadeIdBackgroundImage": false,
      "idBackgroundColor": "text",
      "repeatIdBackgroundImage": false
    }
  }
]

9. Generate an Invite

To generate an invite, use the generateInvite method. This method accepts an optional challenge parameter.

const challenge = 'your_challenge';

await learnCard.invoke.generateInvite(challenge);

Generate a connection invitation

This route creates a one-time challenge that an unknown profile can use to connect with this account

POST../api/profile/generate-invite

Authorization

Authorization

Body

application/json

expirationnumber

challengestring

Response

200default

Successful response

Body

application/json

profileId*string

challenge*string

expiresIn*nullable number

Request

JavaScriptCurlPython

const response = await fetch('../api/profile/generate-invite', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200default

{
  "profileId": "text",
  "challenge": "text",
  "expiresIn": 0
}

These are all the connection-related API calls available with the LearnCard Network Plugin. Use these methods to manage and interact with connections on the LearnCard Network.

User Blocking

1. Block a Profile

To block a profile, use the blockProfile method. This method accepts a profileId parameter.

const profileId = 'janesmith';

await learnCard.invoke.blockProfile(profileId);

Block another profile

Block another user based on their profileId

POST../api/profile/{profileId}/block

Authorization

Authorization

Path parameters

profileId*string

Response

200default

Successful response

Body

application/json

boolean

Request

JavaScriptCurlPython

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

Response

200default

false

2. Unblock a Profile

To unblock a profile, use the unblockProfile method. This method accepts a profileId parameter.

const profileId = 'janesmith';

await learnCard.invoke.unblockProfile(profileId);

Unblock another profile

Unblock another user based on their profileId

POST../api/profile/{profileId}/unblock

Authorization

Authorization

Path parameters

profileId*string

Response

200default

Successful response

Body

application/json

boolean

Request

JavaScriptCurlPython

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

Response

200default

false

3. Get Blocked Profiles

To retrieve all blocked profiles, use the getBlockedProfiles method. This method does not require any parameters.

await learnCard.invoke.getBlockedProfiles();

View blocked profiles

This route shows the current user's blocked profiles

GET../api/profile/blocked

Authorization

Authorization

Response

200default

Successful response

Body

application/json

profileId*string

displayNamestring

shortBiostring

biostring

did*string

isPrivateboolean

emailstring

imagestring

heroImagestring

websiteLinkstring

isServiceProfileboolean

typestring

notificationsWebhookstring (uri)

Pattern: ^http

displayobject

Request

JavaScriptCurlPython

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

Response

200default

[
  {
    "profileId": "text",
    "displayName": "text",
    "shortBio": "text",
    "bio": "text",
    "did": "text",
    "isPrivate": false,
    "email": "text",
    "image": "text",
    "heroImage": "text",
    "websiteLink": "text",
    "isServiceProfile": false,
    "type": "text",
    "notificationsWebhook": "https://example.com",
    "display": {
      "backgroundColor": "text",
      "backgroundImage": "text",
      "fadeBackgroundImage": false,
      "repeatBackgroundImage": false,
      "fontColor": "text",
      "accentColor": "text",
      "accentFontColor": "text",
      "idBackgroundImage": "text",
      "fadeIdBackgroundImage": false,
      "idBackgroundColor": "text",
      "repeatIdBackgroundImage": false
    }
  }
]

These are all the user-blocking related API calls available with the LearnCard Network Plugin. Use these methods to manage and control user-blocking on the LearnCard Network.