Profiles
Creates a profile for a user
Unique, URL-safe identifier for the profile.
Human-readable display name for the profile.
""
Short bio for the profile.
""
Longer bio for the profile.
""
Whether the profile is private or not and shows up in search results.
Contact email address for the profile.
Profile image URL for the profile.
Hero image URL for the profile.
Website link for the profile.
Profile type: e.g. "person", "organization", "service".
URL to send notifications to.
^http
Role of the profile: e.g. "teacher", "student".
""
Date of birth of the profile: e.g. "1990-01-01".
""
POST /api/profile/create HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 522
{
"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
},
"role": "",
"dob": ""
}
text
Creates a service profile
Unique, URL-safe identifier for the profile.
Human-readable display name for the profile.
""
Short bio for the profile.
""
Longer bio for the profile.
""
Whether the profile is private or not and shows up in search results.
Contact email address for the profile.
Profile image URL for the profile.
Hero image URL for the profile.
Website link for the profile.
Profile type: e.g. "person", "organization", "service".
URL to send notifications to.
^http
Role of the profile: e.g. "teacher", "student".
""
Date of birth of the profile: e.g. "1990-01-01".
""
POST /api/profile/create-service HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 522
{
"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
},
"role": "",
"dob": ""
}
text
Creates a managed service profile
Unique, URL-safe identifier for the profile.
Human-readable display name for the profile.
""
Short bio for the profile.
""
Longer bio for the profile.
""
Whether the profile is private or not and shows up in search results.
Contact email address for the profile.
Profile image URL for the profile.
Hero image URL for the profile.
Website link for the profile.
Profile type: e.g. "person", "organization", "service".
URL to send notifications to.
^http
Role of the profile: e.g. "teacher", "student".
""
Date of birth of the profile: e.g. "1990-01-01".
""
POST /api/profile/create-managed-service HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 522
{
"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
},
"role": "",
"dob": ""
}
text
This route uses the request header to grab the profile of the current user
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
},
"role": "",
"dob": ""
}
This route updates the profile of the current user
Unique, URL-safe identifier for the profile.
Human-readable display name for the profile.
""
Short bio for the profile.
""
Longer bio for the profile.
""
Whether the profile is private or not and shows up in search results.
Contact email address for the profile.
Profile image URL for the profile.
Hero image URL for the profile.
Website link for the profile.
Profile type: e.g. "person", "organization", "service".
URL to send notifications to.
^http
Role of the profile: e.g. "teacher", "student".
""
Date of birth of the profile: e.g. "1990-01-01".
""
POST /api/profile HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 522
{
"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
},
"role": "",
"dob": ""
}
true
This route deletes the profile of the current user
DELETE /api/profile HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
This route grabs the profile information of any user, using their profileId
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
},
"role": "",
"dob": ""
}
This route gets all of your available profiles. That is, profiles you directly or indirectly manage
25
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
},
"role": "",
"dob": ""
},
"manager": {
"id": "text",
"created": "text",
"displayName": "",
"shortBio": "",
"bio": "",
"email": "text",
"image": "text",
"heroImage": "text",
"did": "text"
}
}
]
}
This route gets all of your managed service profiles
25
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
},
"role": "",
"dob": ""
}
]
}
This route searches for profiles based on their profileId
25
false
false
false
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
},
"role": "",
"dob": "",
"connectionStatus": "CONNECTED"
}
]
This route uses the request header to send a connection request to another user based on their profileId
POST /api/profile/{profileId}/connect HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
Cancels connection request with another profile
POST /api/profile/{profileId}/cancel-connection-request HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
Connects with another profile using an invitation challenge
POST /api/profile/{profileId}/connect/{challenge} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
This route uses the request header to disconnect with another user based on their profileId
POST /api/profile/{profileId}/disconnect HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
This route uses the request header to accept a connection request from another user based on their profileId
POST /api/profile/{profileId}/accept-connection HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
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 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
},
"role": "",
"dob": ""
}
]
This route shows the current user's connections
25
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
},
"role": "",
"dob": ""
}
]
}
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 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
},
"role": "",
"dob": ""
}
]
This route shows the current user's pending connections
25
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
},
"role": "",
"dob": ""
}
]
}
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
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
},
"role": "",
"dob": ""
}
]
This route shows the current user's connection requests
25
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
},
"role": "",
"dob": ""
}
]
}
This route creates a one-time challenge that an unknown profile can use to connect with this account
2592000
POST /api/profile/generate-invite HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"expiration": 2592000,
"challenge": "text"
}
{
"profileId": "text",
"challenge": "text",
"expiresIn": 1
}
Block another user based on their profileId
POST /api/profile/{profileId}/block HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
Unblock another user based on their profileId
POST /api/profile/{profileId}/unblock HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
This route shows the current user's blocked profiles
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
},
"role": "",
"dob": ""
}
]
This route is used to register a signing authority that can sign credentials on the current user's behalf
^[a-z0-9-]+$
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
This route is used to get registered signing authorities that can sign credentials on the current user's behalf
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"
}
}
]
This route is used to get a named signing authority that can sign credentials on the current user's behalf
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"
}
}
Creates a managed profile
Unique, URL-safe identifier for the profile.
Human-readable display name for the profile.
""
Short bio for the profile.
""
Longer bio for the profile.
""
Whether the profile is private or not and shows up in search results.
Contact email address for the profile.
Profile image URL for the profile.
Hero image URL for the profile.
Website link for the profile.
Whether the profile is a service profile or not.
false
Profile type: e.g. "person", "organization", "service".
URL to send notifications to.
^http
Role of the profile: e.g. "teacher", "student".
""
Date of birth of the profile: e.g. "1990-01-01".
""
POST /api/profile/create-managed-profile HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 547
{
"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
},
"role": "",
"dob": ""
}
text
This route gets all of your managed profiles
25
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
},
"role": "",
"dob": ""
}
]
}
Was this helpful?