Boosts
This endpoint sends a boost to a profile
POST /api/boost/send/{profileId} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1027
{
"uri": "text",
"credential": {
"@context": [
"text"
],
"id": "text",
"type": [
"text"
],
"issuer": "text",
"credentialSubject": {
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"refreshService": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"credentialSchema": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"issuanceDate": "text",
"expirationDate": "text",
"credentialStatus": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name": "text",
"description": "text",
"validFrom": "text",
"validUntil": "text",
"status": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"termsOfUse": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"evidence": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"proof": {
"type": "text",
"created": "text",
"challenge": "text",
"domain": "text",
"nonce": "text",
"proofPurpose": "text",
"verificationMethod": "text",
"jws": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"options": {
"skipNotification": false
}
}
text
This route creates a boost
POST /api/boost/create HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1462
{
"name": "text",
"type": "text",
"category": "text",
"status": "DRAFT",
"autoConnectRecipients": true,
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"allowAnyoneToCreateChildren": true,
"credential": {
"@context": [
"text"
],
"id": "text",
"type": [
"text"
],
"issuer": "text",
"credentialSubject": {
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"refreshService": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"credentialSchema": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"issuanceDate": "text",
"expirationDate": "text",
"credentialStatus": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name": "text",
"description": "text",
"validFrom": "text",
"validUntil": "text",
"status": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"termsOfUse": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"evidence": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"proof": {
"type": "text",
"created": "text",
"challenge": "text",
"domain": "text",
"nonce": "text",
"proofPurpose": "text",
"verificationMethod": "text",
"jws": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"claimPermissions": {
"role": "text",
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
}
}
text
This route creates a boost
POST /api/boost/create/child HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1491
{
"parentUri": "text",
"boost": {
"name": "text",
"type": "text",
"category": "text",
"status": "DRAFT",
"autoConnectRecipients": true,
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"allowAnyoneToCreateChildren": true,
"credential": {
"@context": [
"text"
],
"id": "text",
"type": [
"text"
],
"issuer": "text",
"credentialSubject": {
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"refreshService": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"credentialSchema": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"issuanceDate": "text",
"expirationDate": "text",
"credentialStatus": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name": "text",
"description": "text",
"validFrom": "text",
"validUntil": "text",
"status": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"termsOfUse": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"evidence": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"proof": {
"type": "text",
"created": "text",
"challenge": "text",
"domain": "text",
"nonce": "text",
"proofPurpose": "text",
"verificationMethod": "text",
"jws": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"claimPermissions": {
"role": "text",
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
}
}
}
text
This endpoint gets metadata about a boost
GET /api/boost?uri=text HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"name": "text",
"type": "text",
"category": "text",
"status": "DRAFT",
"autoConnectRecipients": true,
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"allowAnyoneToCreateChildren": true,
"claimPermissions": {
"role": "text",
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
},
"uri": "text",
"boost": {
"@context": [
"text"
],
"id": "text",
"type": [
"text"
],
"issuer": "text",
"credentialSubject": {
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"refreshService": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"credentialSchema": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"issuanceDate": "text",
"expirationDate": "text",
"credentialStatus": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name": "text",
"description": "text",
"validFrom": "text",
"validUntil": "text",
"status": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"termsOfUse": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"evidence": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
This route updates a boost
POST /api/boost HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1175
{
"uri": "text",
"updates": {
"name": "text",
"type": "text",
"category": "text",
"status": "DRAFT",
"autoConnectRecipients": true,
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"allowAnyoneToCreateChildren": true,
"credential": {
"@context": [
"text"
],
"id": "text",
"type": [
"text"
],
"issuer": "text",
"credentialSubject": {
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"refreshService": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"credentialSchema": {
"id": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"issuanceDate": "text",
"expirationDate": "text",
"credentialStatus": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"name": "text",
"description": "text",
"validFrom": "text",
"validUntil": "text",
"status": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"termsOfUse": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"evidence": {
"type": "text",
"id": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"proof": {
"type": "text",
"created": "text",
"challenge": "text",
"domain": "text",
"nonce": "text",
"proofPurpose": "text",
"verificationMethod": "text",
"jws": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
}
true
This route deletes a boost
DELETE /api/boost?uri=text HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
true
This endpoint gets the current user's boosts. Warning! This route is deprecated and currently has a hard limit of returning only the first 50 boosts. Please use getPaginatedBoosts instead
POST /api/boost/all HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 158
{
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
}
}
[
{
"name": "text",
"type": "text",
"category": "text",
"status": "DRAFT",
"autoConnectRecipients": true,
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"allowAnyoneToCreateChildren": true,
"uri": "text"
}
]
This endpoint counts the current user's managed boosts.
POST /api/boost/count HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 158
{
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
}
}
1
This endpoint gets the current user's boosts
25
POST /api/boost/paginated HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 199
{
"limit": 25,
"cursor": "text",
"sort": "text",
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
}
}
{
"cursor": "text",
"hasMore": true,
"records": [
{
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"status": "DRAFT",
"autoConnectRecipients": true,
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"claimPermissions": {
"role": "text",
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
},
"allowAnyoneToCreateChildren": true
}
]
}
This endpoint gets the recipients of a particular boost. Warning! This route is deprecated and currently has a hard limit of returning only the first 50 boosts. Please use getPaginatedBoostRecipients instead
25
true
GET /api/boost/recipients?uri=text HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"to": {
"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": ""
},
"from": "text",
"received": "text",
"uri": "text"
}
]
This endpoint gets the recipients of a particular boost
25
true
POST /api/boost/recipients/paginated HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 241
{
"limit": 25,
"cursor": "text",
"sort": "text",
"uri": "text",
"includeUnacceptedBoosts": true,
"query": {
"profileId": "text",
"displayName": "text",
"shortBio": "text",
"bio": "text",
"email": "text",
"websiteLink": "text",
"isServiceProfile": true,
"type": "text"
}
}
{
"cursor": "text",
"hasMore": true,
"records": [
{
"to": {
"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": ""
},
"from": "text",
"received": "text",
"uri": "text"
}
]
}
This endpoint counts the recipients of a particular boost
true
GET /api/boost/recipients/count?uri=text HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
1
Get Profile Managers that are a child of a boost
25
POST /api/boost/children-profile-managers HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 144
{
"limit": 25,
"cursor": "text",
"sort": "text",
"uri": "text",
"query": {
"id": "text",
"displayName": "text",
"shortBio": "text",
"bio": "text",
"email": "text"
}
}
{
"cursor": "text",
"hasMore": true,
"records": [
{
"id": "text",
"created": "text",
"displayName": "",
"shortBio": "",
"bio": "",
"email": "text",
"image": "text",
"heroImage": "text",
"did": "text"
}
]
}
This endpoint gets the children of a particular boost
25
1
POST /api/boost/children HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236
{
"limit": 25,
"cursor": "text",
"sort": "text",
"uri": "text",
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
},
"numberOfGenerations": 1
}
{
"cursor": "text",
"hasMore": true,
"records": [
{
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"status": "DRAFT",
"autoConnectRecipients": true,
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"claimPermissions": {
"role": "text",
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
},
"allowAnyoneToCreateChildren": true
}
]
}
This endpoint counts the children of a particular boost
1
POST /api/boost/children/count HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195
{
"uri": "text",
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
},
"numberOfGenerations": 1
}
1
This endpoint gets the siblings of a particular boost
25
POST /api/boost/siblings HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 212
{
"limit": 25,
"cursor": "text",
"sort": "text",
"uri": "text",
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
}
}
{
"cursor": "text",
"hasMore": true,
"records": [
{
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"status": "DRAFT",
"autoConnectRecipients": true,
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"claimPermissions": {
"role": "text",
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
},
"allowAnyoneToCreateChildren": true
}
]
}
This endpoint counts the siblings of a particular boost
POST /api/boost/siblings/count HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 171
{
"uri": "text",
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
}
}
1
This endpoint gets the parents, children, and siblings of a particular boost
25
1
1
false
POST /api/boost/family HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 285
{
"limit": 25,
"cursor": "text",
"sort": "text",
"uri": "text",
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
},
"parentGenerations": 1,
"childGenerations": 1,
"includeExtendedFamily": false
}
{
"cursor": "text",
"hasMore": true,
"records": [
{
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"status": "DRAFT",
"autoConnectRecipients": true,
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"claimPermissions": {
"role": "text",
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
},
"allowAnyoneToCreateChildren": true
}
]
}
This endpoint counts the parents, children, and siblings of a particular boost
1
1
false
POST /api/boost/family/count HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 244
{
"uri": "text",
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
},
"parentGenerations": 1,
"childGenerations": 1,
"includeExtendedFamily": false
}
1
This endpoint gets the parents of a particular boost
25
1
POST /api/boost/parents HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236
{
"limit": 25,
"cursor": "text",
"sort": "text",
"uri": "text",
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
},
"numberOfGenerations": 1
}
{
"cursor": "text",
"hasMore": true,
"records": [
{
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"status": "DRAFT",
"autoConnectRecipients": true,
"meta": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"claimPermissions": {
"role": "text",
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
},
"allowAnyoneToCreateChildren": true
}
]
}
This endpoint counts the parents of a particular boost
1
POST /api/boost/parents/count HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195
{
"uri": "text",
"query": {
"uri": "text",
"name": "text",
"type": "text",
"category": "text",
"meta": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"status": "DRAFT",
"autoConnectRecipients": true
},
"numberOfGenerations": 1
}
1
This route returns the admins for a boost
25
true
POST /api/boost/admins HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74
{
"limit": 25,
"cursor": "text",
"sort": "text",
"includeSelf": true,
"uri": "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": ""
}
]
}
This route adds a new admin for a boost
POST /api/boost/add-admin HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"uri": "text",
"profileId": "text"
}
true
This route removes an admin from a boost
POST /api/boost/remove-admin HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"uri": "text",
"profileId": "text"
}
true
This endpoint gets permission metadata about a boost
GET /api/boost/permissions?uri=text HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"role": "text",
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
}
This endpoint updates permission metadata about a boost for the current user
POST /api/boost/permissions HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 303
{
"uri": "text",
"updates": {
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
}
}
true
This endpoint gets permission metadata about a boost for someone else
GET /api/boost/permissions/{profileId}?uri=text HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"role": "text",
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
}
This endpoint updates permission metadata about a boost for another user
POST /api/boost/permissions/{profileId} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 303
{
"uri": "text",
"updates": {
"canEdit": true,
"canIssue": true,
"canRevoke": true,
"canManagePermissions": true,
"canIssueChildren": "text",
"canCreateChildren": "text",
"canEditChildren": "text",
"canRevokeChildren": "text",
"canManageChildrenPermissions": "text",
"canManageChildrenProfiles": false,
"canViewAnalytics": true
}
}
true
This route creates a challenge that an unknown profile can use to claim a boost.
POST /api/boost/generate-claim-link HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140
{
"boostUri": "text",
"challenge": "text",
"claimLinkSA": {
"endpoint": "text",
"name": "text",
"did": "text"
},
"options": {
"ttlSeconds": 1,
"totalUses": 1
}
}
{
"boostUri": "text",
"challenge": "text"
}
Claims a boost using a claim link, including a challenge
POST /api/boost/claim HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"boostUri": "text",
"challenge": "text"
}
text
This endpoint creates a parent/child relationship between two boosts
POST /api/boost/make-parent HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"parentUri": "text",
"childUri": "text"
}
true
This endpoint removes a parent/child relationship between two boosts
POST /api/boost/remove-parent HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"parentUri": "text",
"childUri": "text"
}
true
Issues a boost VC to a recipient profile using a specified signing authority and sends it via the network.
POST /api/boost/send/via-signing-authority/{profileId} HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"boostUri": "text",
"signingAuthority": {
"name": "text",
"endpoint": "text"
},
"options": {
"skipNotification": false
}
}
text
Was this helpful?