Profiles

Create a profile

post

Creates a profile for a user

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

profileIdstring · min: 3 · max: 40Required

Unique, URL-safe identifier for the profile.

displayNamestringOptional

Human-readable display name for the profile.

Default: ""

shortBiostringOptional

Short bio for the profile.

Default: ""

biostringOptional

Longer bio for the profile.

Default: ""

isPrivatebooleanOptional

Whether the profile is private or not and shows up in search results.

emailstringOptional

Contact email address for the profile. (deprecated)

imagestringOptional

Profile image URL for the profile.

heroImagestringOptional

Hero image URL for the profile.

websiteLinkstringOptional

Website link for the profile.

typestringOptional

Profile type: e.g. "person", "organization", "service".

notificationsWebhookstring · uriOptional

URL to send notifications to.

Pattern: ^http.*

highlightedCredentialsstring[] · max: 5Optional

Up to 5 unique boost URIs to highlight on the profile.

rolestringOptional

Role of the profile: e.g. "teacher", "student".

Default: ""

dobstringOptional

Date of birth of the profile: e.g. "1990-01-01".

Default: ""

countrystringOptional

Country for the profile.

approvedbooleanOptional

Approval status for the profile.

Responses

200

Successful response

application/json

Responsestring

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/create

HTTPcURLJavaScriptPython

POST /api/profile/create HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 589

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

text

Create a service profile

post

Creates a service profile

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

profileIdstring · min: 3 · max: 40Required

Unique, URL-safe identifier for the profile.

displayNamestringOptional

Human-readable display name for the profile.

Default: ""

shortBiostringOptional

Short bio for the profile.

Default: ""

biostringOptional

Longer bio for the profile.

Default: ""

isPrivatebooleanOptional

Whether the profile is private or not and shows up in search results.

emailstringOptional

Contact email address for the profile. (deprecated)

imagestringOptional

Profile image URL for the profile.

heroImagestringOptional

Hero image URL for the profile.

websiteLinkstringOptional

Website link for the profile.

typestringOptional

Profile type: e.g. "person", "organization", "service".

notificationsWebhookstring · uriOptional

URL to send notifications to.

Pattern: ^http.*

highlightedCredentialsstring[] · max: 5Optional

Up to 5 unique boost URIs to highlight on the profile.

rolestringOptional

Role of the profile: e.g. "teacher", "student".

Default: ""

dobstringOptional

Date of birth of the profile: e.g. "1990-01-01".

Default: ""

countrystringOptional

Country for the profile.

approvedbooleanOptional

Approval status for the profile.

Responses

200

Successful response

application/json

Responsestring

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/create-service

HTTPcURLJavaScriptPython

POST /api/profile/create-service HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 589

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

text

Create a managed service profile

post

Creates a managed service profile

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

profileIdstring · min: 3 · max: 40Required

Unique, URL-safe identifier for the profile.

displayNamestringOptional

Human-readable display name for the profile.

Default: ""

shortBiostringOptional

Short bio for the profile.

Default: ""

biostringOptional

Longer bio for the profile.

Default: ""

isPrivatebooleanOptional

Whether the profile is private or not and shows up in search results.

emailstringOptional

Contact email address for the profile. (deprecated)

imagestringOptional

Profile image URL for the profile.

heroImagestringOptional

Hero image URL for the profile.

websiteLinkstringOptional

Website link for the profile.

typestringOptional

Profile type: e.g. "person", "organization", "service".

notificationsWebhookstring · uriOptional

URL to send notifications to.

Pattern: ^http.*

highlightedCredentialsstring[] · max: 5Optional

Up to 5 unique boost URIs to highlight on the profile.

rolestringOptional

Role of the profile: e.g. "teacher", "student".

Default: ""

dobstringOptional

Date of birth of the profile: e.g. "1990-01-01".

Default: ""

countrystringOptional

Country for the profile.

approvedbooleanOptional

Approval status for the profile.

Responses

200

Successful response

application/json

Responsestring

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/create-managed-service

HTTPcURLJavaScriptPython

POST /api/profile/create-managed-service HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 589

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

text

Get your profile information

get

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

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/profile

HTTPcURLJavaScriptPython

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

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

Update your profile

post

This route updates the profile of the current user

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

profileIdstring · min: 3 · max: 40Optional

Unique, URL-safe identifier for the profile.

displayNamestringOptional

Human-readable display name for the profile.

Default: ""

shortBiostringOptional

Short bio for the profile.

Default: ""

biostringOptional

Longer bio for the profile.

Default: ""

isPrivatebooleanOptional

Whether the profile is private or not and shows up in search results.

emailstringOptional

Contact email address for the profile. (deprecated)

imagestringOptional

Profile image URL for the profile.

heroImagestringOptional

Hero image URL for the profile.

websiteLinkstringOptional

Website link for the profile.

typestringOptional

Profile type: e.g. "person", "organization", "service".

notificationsWebhookstring · uriOptional

URL to send notifications to.

Pattern: ^http.*

highlightedCredentialsstring[] · max: 5Optional

Up to 5 unique boost URIs to highlight on the profile.

rolestringOptional

Role of the profile: e.g. "teacher", "student".

Default: ""

dobstringOptional

Date of birth of the profile: e.g. "1990-01-01".

Default: ""

countrystringOptional

Country for the profile.

approvedbooleanOptional

Approval status for the profile.

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile

HTTPcURLJavaScriptPython

POST /api/profile HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 589

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

true

Delete your profile

delete

This route deletes the profile of the current user

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

Responseboolean

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

delete

/profile

HTTPcURLJavaScriptPython

DELETE /api/profile HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Get profile information

get

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

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

profileIdstringRequired

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/profile/{profileId}

HTTPcURLJavaScriptPython

GET /api/profile/{profileId} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Available Profiles

post

This route gets all of your available profiles. That is, profiles you directly or indirectly manage

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/available-profiles

HTTPcURLJavaScriptPython

POST /api/profile/available-profiles HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "limit": 25,
  "cursor": "text",
  "sort": "text",
  "query": {
    "profileId": "text",
    "displayName": "text",
    "shortBio": "text",
    "bio": "text",
    "email": "text",
    "websiteLink": "text",
    "isServiceProfile": true,
    "type": "text"
  }
}

{
  "cursor": "text",
  "hasMore": true,
  "records": [
    {
      "profile": {
        "profileId": "text",
        "displayName": "",
        "shortBio": "",
        "bio": "",
        "did": "text",
        "isPrivate": true,
        "email": "text",
        "image": "text",
        "heroImage": "text",
        "websiteLink": "text",
        "isServiceProfile": false,
        "type": "text",
        "notificationsWebhook": "https://example.com",
        "display": {
          "backgroundColor": "text",
          "backgroundImage": "text",
          "fadeBackgroundImage": true,
          "repeatBackgroundImage": true,
          "fontColor": "text",
          "accentColor": "text",
          "accentFontColor": "text",
          "idBackgroundImage": "text",
          "fadeIdBackgroundImage": true,
          "idBackgroundColor": "text",
          "repeatIdBackgroundImage": true
        },
        "highlightedCredentials": [
          "text"
        ],
        "role": "",
        "dob": "",
        "country": "text",
        "approved": true
      },
      "manager": {
        "id": "text",
        "created": "text",
        "displayName": "",
        "shortBio": "",
        "bio": "",
        "email": "text",
        "image": "text",
        "heroImage": "text",
        "did": "text"
      }
    }
  ]
}

Managed Service Profiles

get

This route gets all of your managed service profiles

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

idstringOptional

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/profile/managed-services

HTTPcURLJavaScriptPython

GET /api/profile/managed-services HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Search profiles

get

This route searches for profiles based on their profileId

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

inputstringRequired

Query parameters

limitintegerOptionalDefault: 25

includeSelfbooleanOptionalDefault: false

includeConnectionStatusbooleanOptionalDefault: false

includeServiceProfilesbooleanOptionalDefault: false

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/search/profiles/{input}

HTTPcURLJavaScriptPython

GET /api/search/profiles/{input} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Connect with another profile

post

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

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

profileIdstringRequired

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/{profileId}/connect

HTTPcURLJavaScriptPython

POST /api/profile/{profileId}/connect HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Cancel Connection Request

post

Cancels connection request with another profile

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

profileIdstringRequired

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/{profileId}/cancel-connection-request

HTTPcURLJavaScriptPython

POST /api/profile/{profileId}/cancel-connection-request HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Connect using an invitation

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

profileIdstringRequired

challengestringRequired

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/{profileId}/connect/{challenge}

HTTPcURLJavaScriptPython

POST /api/profile/{profileId}/connect/{challenge} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Disconnect with another profile

post

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

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

profileIdstringRequired

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/{profileId}/disconnect

HTTPcURLJavaScriptPython

POST /api/profile/{profileId}/disconnect HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Accept Connection Request

post

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

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

profileIdstringRequired

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/{profileId}/accept-connection

HTTPcURLJavaScriptPython

POST /api/profile/{profileId}/accept-connection HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Deprecated

View connections

get

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!

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/profile/connections

HTTPcURLJavaScriptPython

GET /api/profile/connections HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

View connections

get

This route shows the current user's connections

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/profile/connections/paginated

HTTPcURLJavaScriptPython

GET /api/profile/connections/paginated HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Deprecated

View pending connections

get

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

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/profile/pending-connections

HTTPcURLJavaScriptPython

GET /api/profile/pending-connections HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

View pending connections

get

This route shows the current user's pending connections

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/profile/pending-connections/paginated

HTTPcURLJavaScriptPython

GET /api/profile/pending-connections/paginated HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Deprecated

View connection requests

get

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

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/profile/connection-requests

HTTPcURLJavaScriptPython

GET /api/profile/connection-requests HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

View connection requests

get

This route shows the current user's connection requests

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/profile/connection-requests/paginated

HTTPcURLJavaScriptPython

GET /api/profile/connection-requests/paginated HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Generate a connection invitation

post

Generate a connection invitation challenge. By default, invites are single-use; set maxUses > 1 for multi-use, or maxUses = 0 for unlimited. Expiration is in seconds (default 30 days); set expiration = 0 for no expiration.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

expirationnumberOptionalDefault: 2592000

challengestringOptional

maxUsesinteger · max: 9007199254740991OptionalDefault: 1

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/generate-invite

HTTPcURLJavaScriptPython

POST /api/profile/generate-invite HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "expiration": 2592000,
  "challenge": "text",
  "maxUses": 1
}

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

List valid connection invitations

get

List all valid connection invitation links you've created. Each item includes: challenge, expiresIn (seconds or null), usesRemaining (number or null), and maxUses (number or null). Exhausted invites are omitted.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/profile/invites

HTTPcURLJavaScriptPython

GET /api/profile/invites HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "challenge": "text",
    "expiresIn": 1,
    "usesRemaining": 1,
    "maxUses": 1
  }
]

Invalidate an invitation

post

Invalidate a specific connection invitation by its challenge string. Idempotent: returns true even if the invite was already invalid or missing.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

challengestringRequired

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/invite/{challenge}/invalidate

HTTPcURLJavaScriptPython

POST /api/profile/invite/{challenge}/invalidate HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Block another profile

post

Block another user based on their profileId

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

profileIdstringRequired

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/{profileId}/block

HTTPcURLJavaScriptPython

POST /api/profile/{profileId}/block HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

Unblock another profile

post

Unblock another user based on their profileId

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

profileIdstringRequired

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/{profileId}/unblock

HTTPcURLJavaScriptPython

POST /api/profile/{profileId}/unblock HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

View blocked profiles

get

This route shows the current user's blocked profiles

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/profile/blocked

HTTPcURLJavaScriptPython

GET /api/profile/blocked HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Register a Signing Authority

post

This route is used to register a signing authority that can sign credentials on the current user's behalf

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

endpointstringRequired

namestring · max: 15RequiredPattern: ^[a-z0-9-]+$

didstringRequired

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/signing-authority/register

HTTPcURLJavaScriptPython

POST /api/profile/signing-authority/register HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "endpoint": "text",
  "name": "text",
  "did": "text"
}

true

Get Signing Authorities for user

get

This route is used to get registered signing authorities that can sign credentials on the current user's behalf

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/profile/signing-authority/get/all

HTTPcURLJavaScriptPython

GET /api/profile/signing-authority/get/all HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "signingAuthority": {
      "endpoint": "text"
    },
    "relationship": {
      "name": "text",
      "did": "text",
      "isPrimary": true
    }
  }
]

Get Signing Authority for user

get

This route is used to get a named signing authority that can sign credentials on the current user's behalf

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

endpointstringRequired

namestringRequired

Responses

200

Successful response

application/json

Responseany of

or

anyOptional

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/profile/signing-authority/get

HTTPcURLJavaScriptPython

GET /api/profile/signing-authority/get?endpoint=text&name=text HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "signingAuthority": {
    "endpoint": "text"
  },
  "relationship": {
    "name": "text",
    "did": "text",
    "isPrimary": true
  }
}

Set Primary Signing Authority

post

This route is used to set a signing authority as the primary one for the current user

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

endpointstringRequired

namestring · max: 15RequiredPattern: ^[a-z0-9-]+$

Responses

200

Successful response

application/json

Responseboolean

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/signing-authority/set-primary

HTTPcURLJavaScriptPython

POST /api/profile/signing-authority/set-primary HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "endpoint": "text",
  "name": "text"
}

true

Get primary Signing Authority for user

get

This route is used to get the primary signing authority that can sign credentials on the current user's behalf

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

Responseany of

or

anyOptional

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

get

/profile/signing-authority/get-primary

HTTPcURLJavaScriptPython

GET /api/profile/signing-authority/get-primary HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "signingAuthority": {
    "endpoint": "text"
  },
  "relationship": {
    "name": "text",
    "did": "text",
    "isPrimary": true
  }
}

Create a managed profile

post

Creates a managed profile

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

profileIdstring · min: 3 · max: 40Required

Unique, URL-safe identifier for the profile.

displayNamestringOptional

Human-readable display name for the profile.

Default: ""

shortBiostringOptional

Short bio for the profile.

Default: ""

biostringOptional

Longer bio for the profile.

Default: ""

isPrivatebooleanOptional

Whether the profile is private or not and shows up in search results.

emailstringOptional

Contact email address for the profile. (deprecated)

imagestringOptional

Profile image URL for the profile.

heroImagestringOptional

Hero image URL for the profile.

websiteLinkstringOptional

Website link for the profile.

isServiceProfilebooleanOptional

Whether the profile is a service profile or not.

Default: false

typestringOptional

Profile type: e.g. "person", "organization", "service".

notificationsWebhookstring · uriOptional

URL to send notifications to.

Pattern: ^http.*

highlightedCredentialsstring[] · max: 5Optional

Up to 5 unique boost URIs to highlight on the profile.

rolestringOptional

Role of the profile: e.g. "teacher", "student".

Default: ""

dobstringOptional

Date of birth of the profile: e.g. "1990-01-01".

Default: ""

countrystringOptional

Country for the profile.

approvedbooleanOptional

Approval status for the profile.

Responses

200

Successful response

application/json

Responsestring

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/create-managed-profile

HTTPcURLJavaScriptPython

POST /api/profile/create-managed-profile HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 614

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

text

Managed Profiles

post

This route gets all of your managed profiles

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/profile/managed-profiles

HTTPcURLJavaScriptPython

POST /api/profile/managed-profiles HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "limit": 25,
  "cursor": "text",
  "sort": "text",
  "query": {
    "profileId": "text",
    "displayName": "text",
    "shortBio": "text",
    "bio": "text",
    "email": "text",
    "websiteLink": "text",
    "isServiceProfile": true,
    "type": "text"
  }
}

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

Send Guardian Approval Email

post

Generates a one-time approval token and emails a link to the guardian. When the link is consumed, the requester's profile will be marked as approved.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

guardianEmailstring · emailRequiredPattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

ttlHoursinteger · max: 720Optional

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/inbox/guardian-approval/send

HTTPcURLJavaScriptPython

POST /api/inbox/guardian-approval/send HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "guardianEmail": "[email protected]",
  "ttlHours": 1,
  "template": {
    "id": "text",
    "model": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

{
  "message": "text",
  "approvalUrl": "text"
}

Approve Guardian Request

post

Consumes a guardian approval token and marks the requesting user profile as approved.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

tokenstringRequired

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/inbox/guardian-approval/approve

HTTPcURLJavaScriptPython

POST /api/inbox/guardian-approval/approve HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "token": "text"
}

{
  "message": "text"
}

Approve Guardian Request (GET)

get

GET endpoint to consume guardian approval token from URL path.

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequired

Responses

200

Successful response

application/json

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/inbox/guardian-approval/{token}

HTTPcURLJavaScriptPython

GET /api/inbox/guardian-approval/{token} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text"
}