Profile

In our platform, we utilize DID Identities by allowing you to connect with your wallet. This way, you can initiate a DID Sessions and perform your operations with it.

The Profile model represents user profiles within the Index Network, containing personal information such as a controller DID, name, bio, and an optional avatar.

After signing with your session, it is possible to create a profile for that DID. Profile data is created using a Profile Model.

Decentralized Identifier (DID) identities in technology refer to a new type of identifier that enables a verifiable, self-sovereign identity. Unlike traditional identifiers such as email addresses or usernames that are typically controlled by external organizations (like email providers or social media platforms), DIDs are fully controlled by the individual or entity to which they refer.

Here is an example of how you can create and update your profile using our SDK.

// Provide your avatar image file
const avatarCID = indexClient.uploadAvatar(yourFile);

// Update it by using your information
await indexClient.updateProfile({
    name: "John Doe",
    bio: "Building amazing things",
    avatar: avatarCID
})

API Endpoint Reference

The corresponding API endpoint for profile is described below:

Upload avatar image

POSThttps://dev.index.network/api/profile/upload_avatar

Body

multipart/form-data

filestring (binary)

Image file for avatar

Response

200400

Avatar uploaded successfully

Request

JavaScriptCurlPython

const response = await fetch('https://dev.index.network/api/profile/upload_avatar', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Update profile information

PATCHhttps://dev.index.network/api/profile

Body

application/json

name*string

Name of the user

bio*string

Biography of the user

avatar*string

CID of the avatar image

Response

200400

Profile updated successfully

Request

JavaScriptCurlPython

const response = await fetch('https://dev.index.network/api/profile', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "bio": "text",
      "avatar": "text"
    }),
});
const data = await response.json();