Ctrlk
GithubStatusSupportLaunch App
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Boosts

Get OBv3 alignments for a boost

get

Returns OBv3 alignment entries based on the boost's linked framework and aligned skills. Requires issue permission.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
uristringRequired
Responses
200

Successful response

application/json
targetCodestringOptional
targetNamestringOptional
targetDescriptionstringOptional
targetUrlstringOptional
targetFrameworkstringOptional
get/boost/alignments
GET /api/boost/alignments?uri=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "targetCode": "text",
    "targetName": "text",
    "targetDescription": "text",
    "targetUrl": "text",
    "targetFramework": "text"
  }
]

Get aligned skills for a boost

get

Returns skills aligned to a boost via ALIGNED_TO, including proficiencyLevel stored on the relationship.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
uristringRequired
Responses
200

Successful response

application/json
idstringRequired
statementstringRequired
descriptionstringOptional
codestringOptional
iconstringOptional
typestringRequiredDefault: skill
statusstring · enumRequiredDefault: activePossible values:
frameworkIdstringOptional
createdAtstringOptional
updatedAtstringOptional
proficiencyLevelnumberOptional
get/boost/skills
GET /api/boost/skills?uri=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "statement": "text",
    "description": "text",
    "code": "text",
    "icon": "text",
    "type": "skill",
    "status": "active",
    "frameworkId": "text",
    "createdAt": "text",
    "updatedAt": "text",
    "proficiencyLevel": 1
  }
]

Attach framework to boost

post

Ensures a USES_FRAMEWORK relationship from a boost to a SkillFramework. Requires boost admin.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
boostUristringRequired
frameworkIdstringRequired
Responses
200

Successful response

application/json
booleanOptional
post/boost/attach-framework
POST /api/boost/attach-framework HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "boostUri": "text",
  "frameworkId": "text"
}
true

Detach framework from boost

post

Removes a USES_FRAMEWORK relationship from a boost to a SkillFramework. Requires boost admin.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
boostUristringRequired
frameworkIdstringRequired
Responses
200

Successful response

application/json
booleanOptional
post/boost/detach-framework
POST /api/boost/detach-framework HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "boostUri": "text",
  "frameworkId": "text"
}
true

Align skills to boost

post

Ensures ALIGNED_TO relationships from a boost to Skill nodes. Requires boost admin.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
boostUristringRequired
Responses
200

Successful response

application/json
booleanOptional
post/boost/align-skills
POST /api/boost/align-skills HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "boostUri": "text",
  "skills": [
    {
      "frameworkId": "text",
      "id": "text",
      "proficiencyLevel": 1
    }
  ]
}
true

List available skills for a boost

get

Returns skills from frameworks attached to the boost or any of its ancestors. Requires boost admin.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
uristringRequired
Responses
200

Successful response

application/json
get/boost/skills/available
GET /api/boost/skills/available?uri=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "framework": {
      "id": "text",
      "name": "text",
      "description": "text",
      "image": "text",
      "sourceURI": "https://example.com",
      "isPublic": false,
      "status": "active",
      "createdAt": "text",
      "updatedAt": "text"
    },
    "skills": [
      {
        "id": "text",
        "statement": "text",
        "description": "text",
        "code": "text",
        "icon": "text",
        "type": "skill",
        "status": "active",
        "frameworkId": "text"
      }
    ]
  }
]

Search available skills for a boost

post

Returns a flattened, paginated list of skills matching the search query. Supports $regex and $in operators. Searches skills from frameworks attached to the boost or any of its ancestors. Requires boost admin.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
queryany ofRequired
or
limitinteger · min: 1 · max: 200OptionalDefault: 50
cursorstring · nullableOptional
Responses
200

Successful response

application/json
hasMorebooleanRequired
cursorstring · nullableRequired
post/boost/skills/search
POST /api/boost/skills/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "uri": "text",
  "query": {
    "$or": [
      {
        "id": "text",
        "statement": "text",
        "description": "text",
        "code": "text",
        "type": "text",
        "status": "active"
      }
    ]
  },
  "limit": 50,
  "cursor": "text"
}
{
  "records": [
    {
      "id": "text",
      "statement": "text",
      "description": "text",
      "code": "text",
      "icon": "text",
      "type": "skill",
      "status": "active",
      "frameworkId": "text"
    }
  ],
  "hasMore": true,
  "cursor": "text"
}

Allocate Bitstring credential status entries

post

Allocates Bitstring Status List entries for a credential before it is signed.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
listSizeinteger · max: 9007199254740991Optional
Responses
200

Successful response

application/json
idstringRequired
typeconst: BitstringStatusListEntryRequired
statusPurposestring · enumRequiredPossible values:
statusListIndexany ofRequired
stringOptional
or
integer · max: 9007199254740991Optional
statusListCredentialstringRequired
post/boost/status/allocate
POST /api/boost/status/allocate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "statusPurposes": [
    "revocation"
  ],
  "listSize": 1
}
[
  {
    "id": "text",
    "type": "text",
    "statusPurpose": "revocation",
    "statusListIndex": "text",
    "statusListCredential": "text"
  }
]

Send a Boost

post

This endpoint sends a boost to a profile

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
profileIdstringRequired
Body
uristringRequired
credentialany ofRequired
or
Responses
200

Successful response

application/json
stringOptional
post/boost/send/{profileId}
POST /api/boost/send/{profileId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1252

{
  "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": {
      "id": "text",
      "type": [
        "text"
      ],
      "name": "text",
      "narrative": "text",
      "description": "text",
      "genre": "text",
      "audience": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "renderMethod": {
      "type": "text",
      "renderSuite": "text",
      "template": "text",
      "renderProperty": [
        "text"
      ],
      "outputPreference": {
        "mediaType": "text"
      }
    },
    "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

Creates a boost

post

This route creates a boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringOptional
typestringOptional
categorystringOptional
createdstringOptional
statusstring · enumOptionalPossible values:
autoConnectRecipientsbooleanOptional
allowAnyoneToCreateChildrenbooleanOptional
credentialany ofRequired
or
Responses
200

Successful response

application/json
stringOptional
post/boost/create
POST /api/boost/create HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2113

{
  "name": "text",
  "type": "text",
  "category": "text",
  "created": "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": {
      "id": "text",
      "type": [
        "text"
      ],
      "name": "text",
      "narrative": "text",
      "description": "text",
      "genre": "text",
      "audience": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "renderMethod": {
      "type": "text",
      "renderSuite": "text",
      "template": "text",
      "renderProperty": [
        "text"
      ],
      "outputPreference": {
        "mediaType": "text"
      }
    },
    "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",
    "canView": true,
    "canEdit": true,
    "canIssue": true,
    "canRevoke": true,
    "canManagePermissions": true,
    "canIssueChildren": "text",
    "canCreateChildren": "text",
    "canEditChildren": "text",
    "canRevokeChildren": "text",
    "canManageChildrenPermissions": "text",
    "canManageChildrenProfiles": true,
    "canViewAnalytics": true
  },
  "defaultPermissions": {
    "role": "text",
    "canView": true,
    "canEdit": true,
    "canIssue": true,
    "canRevoke": true,
    "canManagePermissions": true,
    "canIssueChildren": "text",
    "canCreateChildren": "text",
    "canEditChildren": "text",
    "canRevokeChildren": "text",
    "canManageChildrenPermissions": "text",
    "canManageChildrenProfiles": true,
    "canViewAnalytics": true
  },
  "skills": [
    {
      "frameworkId": "text",
      "id": "text",
      "proficiencyLevel": 1
    }
  ]
}
text

Creates a boost

post

This route creates a boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
parentUristringRequired
Responses
200

Successful response

application/json
stringOptional
post/boost/create/child
POST /api/boost/create/child HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2142

{
  "parentUri": "text",
  "boost": {
    "name": "text",
    "type": "text",
    "category": "text",
    "created": "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": {
        "id": "text",
        "type": [
          "text"
        ],
        "name": "text",
        "narrative": "text",
        "description": "text",
        "genre": "text",
        "audience": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "renderMethod": {
        "type": "text",
        "renderSuite": "text",
        "template": "text",
        "renderProperty": [
          "text"
        ],
        "outputPreference": {
          "mediaType": "text"
        }
      },
      "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",
      "canView": true,
      "canEdit": true,
      "canIssue": true,
      "canRevoke": true,
      "canManagePermissions": true,
      "canIssueChildren": "text",
      "canCreateChildren": "text",
      "canEditChildren": "text",
      "canRevokeChildren": "text",
      "canManageChildrenPermissions": "text",
      "canManageChildrenProfiles": true,
      "canViewAnalytics": true
    },
    "defaultPermissions": {
      "role": "text",
      "canView": true,
      "canEdit": true,
      "canIssue": true,
      "canRevoke": true,
      "canManagePermissions": true,
      "canIssueChildren": "text",
      "canCreateChildren": "text",
      "canEditChildren": "text",
      "canRevokeChildren": "text",
      "canManageChildrenPermissions": "text",
      "canManageChildrenProfiles": true,
      "canViewAnalytics": true
    }
  },
  "skills": [
    {
      "frameworkId": "text",
      "id": "text",
      "proficiencyLevel": 1
    }
  ]
}
text

Get boost

get

This endpoint gets metadata about a boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
uristringRequired
Responses
200

Successful response

application/json
namestringOptional
typestringOptional
categorystringOptional
createdstringOptional
statusstring · enumOptionalPossible values:
autoConnectRecipientsbooleanOptional
allowAnyoneToCreateChildrenbooleanOptional
uristringRequired
get/boost
GET /api/boost?uri=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "type": "text",
  "category": "text",
  "created": "text",
  "status": "DRAFT",
  "autoConnectRecipients": true,
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "defaultPermissions": {
    "role": "text",
    "canView": true,
    "canEdit": true,
    "canIssue": true,
    "canRevoke": true,
    "canManagePermissions": true,
    "canIssueChildren": "text",
    "canCreateChildren": "text",
    "canEditChildren": "text",
    "canRevokeChildren": "text",
    "canManageChildrenPermissions": "text",
    "canManageChildrenProfiles": true,
    "canViewAnalytics": true
  },
  "allowAnyoneToCreateChildren": true,
  "claimPermissions": {
    "role": "text",
    "canView": true,
    "canEdit": true,
    "canIssue": true,
    "canRevoke": true,
    "canManagePermissions": true,
    "canIssueChildren": "text",
    "canCreateChildren": "text",
    "canEditChildren": "text",
    "canRevokeChildren": "text",
    "canManageChildrenPermissions": "text",
    "canManageChildrenProfiles": true,
    "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": {
      "id": "text",
      "type": [
        "text"
      ],
      "name": "text",
      "narrative": "text",
      "description": "text",
      "genre": "text",
      "audience": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "renderMethod": {
      "type": "text",
      "renderSuite": "text",
      "template": "text",
      "renderProperty": [
        "text"
      ],
      "outputPreference": {
        "mediaType": "text"
      }
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Update a boost

post

This route updates a boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
Responses
200

Successful response

application/json
booleanOptional
post/boost
POST /api/boost HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1812

{
  "uri": "text",
  "updates": {
    "name": "text",
    "type": "text",
    "category": "text",
    "created": "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": {
        "id": "text",
        "type": [
          "text"
        ],
        "name": "text",
        "narrative": "text",
        "description": "text",
        "genre": "text",
        "audience": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "renderMethod": {
        "type": "text",
        "renderSuite": "text",
        "template": "text",
        "renderProperty": [
          "text"
        ],
        "outputPreference": {
          "mediaType": "text"
        }
      },
      "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"
    },
    "defaultPermissions": {
      "role": "text",
      "canView": true,
      "canEdit": true,
      "canIssue": true,
      "canRevoke": true,
      "canManagePermissions": true,
      "canIssueChildren": "text",
      "canCreateChildren": "text",
      "canEditChildren": "text",
      "canRevokeChildren": "text",
      "canManageChildrenPermissions": "text",
      "canManageChildrenProfiles": true,
      "canViewAnalytics": true
    }
  },
  "skills": [
    {
      "frameworkId": "text",
      "id": "text",
      "proficiencyLevel": 1
    }
  ]
}
true

Delete a boost

delete

This route deletes a boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
uristringRequired
Responses
200

Successful response

application/json
booleanOptional
delete/boost
DELETE /api/boost?uri=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

List frameworks used by a boost (paginated)

post

Returns frameworks aligned to a boost via USES_FRAMEWORK with pagination and optional query filtering. Requires boost admin.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
limitinteger · min: 1 · max: 200OptionalDefault: 50
cursorstring · nullableOptional
queryany ofOptional
or
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/frameworks
POST /api/boost/frameworks HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "uri": "text",
  "limit": 50,
  "cursor": "text",
  "query": {
    "$or": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "sourceURI": "text",
        "status": "text"
      }
    ]
  }
}
{
  "cursor": "text",
  "hasMore": true,
  "records": [
    {
      "id": "text",
      "name": "text",
      "description": "text",
      "image": "text",
      "sourceURI": "https://example.com",
      "isPublic": false,
      "status": "active",
      "createdAt": "text",
      "updatedAt": "text"
    }
  ]
}
Deprecated

Get boosts

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
queryany ofOptional
or
Responses
200

Successful response

application/json
namestringOptional
typestringOptional
categorystringOptional
createdstringOptional
statusstring · enumOptionalPossible values:
autoConnectRecipientsbooleanOptional
allowAnyoneToCreateChildrenbooleanOptional
uristringRequired
post/boost/all
POST /api/boost/all HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "query": {
    "$or": [
      {
        "uri": "text",
        "name": "text",
        "type": "text",
        "category": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "DRAFT",
        "autoConnectRecipients": true
      }
    ]
  }
}
[
  {
    "name": "text",
    "type": "text",
    "category": "text",
    "created": "text",
    "status": "DRAFT",
    "autoConnectRecipients": true,
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "defaultPermissions": {
      "role": "text",
      "canView": true,
      "canEdit": true,
      "canIssue": true,
      "canRevoke": true,
      "canManagePermissions": true,
      "canIssueChildren": "text",
      "canCreateChildren": "text",
      "canEditChildren": "text",
      "canRevokeChildren": "text",
      "canManageChildrenPermissions": "text",
      "canManageChildrenProfiles": true,
      "canViewAnalytics": true
    },
    "allowAnyoneToCreateChildren": true,
    "uri": "text"
  }
]

Count managed boosts

post

This endpoint counts the current user's managed boosts.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
queryany ofOptional
or
Responses
200

Successful response

application/json
numberOptional
post/boost/count
POST /api/boost/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "query": {
    "$or": [
      {
        "uri": "text",
        "name": "text",
        "type": "text",
        "category": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "DRAFT",
        "autoConnectRecipients": true
      }
    ]
  }
}
1

Get boosts

post

This endpoint gets the current user's boosts

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
limitnumberOptionalDefault: 25
cursorstringOptional
sortstringOptional
queryany ofOptional
or
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/paginated
POST /api/boost/paginated HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "limit": 25,
  "cursor": "text",
  "sort": "text",
  "query": {
    "$or": [
      {
        "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",
      "created": "text",
      "status": "DRAFT",
      "autoConnectRecipients": true,
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "claimPermissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      },
      "defaultPermissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      },
      "allowAnyoneToCreateChildren": true
    }
  ]
}
Deprecated

Get boost recipients

get

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
uristringRequired
limitnumberOptionalDefault: 25
skipnumberOptional
includeUnacceptedBoostsbooleanOptionalDefault: true
Responses
200

Successful response

application/json
toany ofRequired
or
or
or
fromstringRequired
receivedstringOptional
uristringOptional
statusstring · enumOptionalPossible values:
get/boost/recipients
GET /api/boost/recipients?uri=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "to": {
      "profileId": "text",
      "displayName": "",
      "shortBio": "",
      "image": "text",
      "heroImage": "text",
      "type": "text",
      "isServiceProfile": false,
      "display": {
        "backgroundColor": "text",
        "backgroundImage": "text",
        "fadeBackgroundImage": true,
        "repeatBackgroundImage": true,
        "fontColor": "text",
        "accentColor": "text",
        "accentFontColor": "text",
        "idBackgroundImage": "text",
        "fadeIdBackgroundImage": true,
        "idBackgroundColor": "text",
        "repeatIdBackgroundImage": true
      },
      "bio": "",
      "websiteLink": "text",
      "role": "",
      "highlightedCredentials": [
        "text"
      ],
      "did": "text",
      "email": "text"
    },
    "from": "text",
    "received": "text",
    "uri": "text",
    "status": "active"
  }
]

Get boost recipients

post

This endpoint gets the recipients of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
limitnumberOptionalDefault: 25
cursorstringOptional
sortstringOptional
uristringRequired
includeUnacceptedBoostsbooleanOptionalDefault: true
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/recipients/paginated
POST /api/boost/recipients/paginated HTTP/1.1
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": "",
        "image": "text",
        "heroImage": "text",
        "type": "text",
        "isServiceProfile": false,
        "display": {
          "backgroundColor": "text",
          "backgroundImage": "text",
          "fadeBackgroundImage": true,
          "repeatBackgroundImage": true,
          "fontColor": "text",
          "accentColor": "text",
          "accentFontColor": "text",
          "idBackgroundImage": "text",
          "fadeIdBackgroundImage": true,
          "idBackgroundColor": "text",
          "repeatIdBackgroundImage": true
        },
        "bio": "",
        "websiteLink": "text",
        "role": "",
        "highlightedCredentials": [
          "text"
        ],
        "did": "text",
        "email": "text"
      },
      "from": "text",
      "received": "text",
      "uri": "text",
      "status": "active"
    }
  ]
}

Get boost recipients count

get

This endpoint counts the recipients of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
uristringRequired
includeUnacceptedBoostsbooleanOptionalDefault: true
Responses
200

Successful response

application/json
numberOptional
get/boost/recipients/count
GET /api/boost/recipients/count?uri=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

1

Get connected boost recipients

post

This endpoint gets the recipients of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uristringRequired
Body
limitnumberOptionalDefault: 25
cursorstringOptional
sortstringOptional
includeUnacceptedBoostsbooleanOptionalDefault: true
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/recipients/connected/{uri}
POST /api/boost/recipients/connected/{uri} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "limit": 25,
  "cursor": "text",
  "sort": "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": "",
        "image": "text",
        "heroImage": "text",
        "type": "text",
        "isServiceProfile": false,
        "display": {
          "backgroundColor": "text",
          "backgroundImage": "text",
          "fadeBackgroundImage": true,
          "repeatBackgroundImage": true,
          "fontColor": "text",
          "accentColor": "text",
          "accentFontColor": "text",
          "idBackgroundImage": "text",
          "fadeIdBackgroundImage": true,
          "idBackgroundColor": "text",
          "repeatIdBackgroundImage": true
        },
        "bio": "",
        "websiteLink": "text",
        "role": "",
        "highlightedCredentials": [
          "text"
        ],
        "did": "text",
        "email": "text"
      },
      "from": "text",
      "received": "text",
      "uri": "text",
      "status": "active"
    }
  ]
}

Get boost recipients count

get

This endpoint counts the recipients of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
uristringRequired
Query parameters
includeUnacceptedBoostsbooleanOptionalDefault: true
Responses
200

Successful response

application/json
numberOptional
get/boost/recipients/connected/{uri}/count
GET /api/boost/recipients/connected/{uri}/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

1

Revoke a boost recipient

post

Revokes a credential for a specified recipient. This marks the credential as revoked instead of deleting it, and removes any permissions granted via claim hooks.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
boostUristringRequired
recipientProfileIdstringRequired
credentialUristringOptional
Responses
200

Successful response

application/json
booleanOptional
post/boost/recipients/revoke
POST /api/boost/recipients/revoke HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "boostUri": "text",
  "recipientProfileId": "text",
  "credentialUri": "text"
}
true

Suspend a boost recipient

post

Temporarily suspends a credential for a specified recipient. Suspension is reversible.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
boostUristringRequired
recipientProfileIdstringRequired
credentialUristringOptional
Responses
200

Successful response

application/json
booleanOptional
post/boost/recipients/suspend
POST /api/boost/recipients/suspend HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "boostUri": "text",
  "recipientProfileId": "text",
  "credentialUri": "text"
}
true

Unsuspend a boost recipient

post

Clears a temporary credential suspension for a specified recipient.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
boostUristringRequired
recipientProfileIdstringRequired
credentialUristringOptional
Responses
200

Successful response

application/json
booleanOptional
post/boost/recipients/unsuspend
POST /api/boost/recipients/unsuspend HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "boostUri": "text",
  "recipientProfileId": "text",
  "credentialUri": "text"
}
true

Get Profile Managers that are a child of a boost

post

Get Profile Managers that are a child of a boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
limitnumberOptionalDefault: 25
cursorstringOptional
sortstringOptional
uristringRequired
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/children-profile-managers
POST /api/boost/children-profile-managers HTTP/1.1
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"
    }
  ]
}

Get boost children

post

This endpoint gets the children of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
limitnumberOptionalDefault: 25
cursorstringOptional
sortstringOptional
uristringRequired
queryany ofOptional
or
numberOfGenerationsany ofOptionalDefault: 1
numberOptional
or
numberOptional
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/children
POST /api/boost/children HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "limit": 25,
  "cursor": "text",
  "sort": "text",
  "uri": "text",
  "query": {
    "$or": [
      {
        "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",
      "created": "text",
      "status": "DRAFT",
      "autoConnectRecipients": true,
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "claimPermissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      },
      "defaultPermissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      },
      "allowAnyoneToCreateChildren": true
    }
  ]
}

Get boost recipients with children

post

This endpoint gets the recipients of a boost and all its children boosts

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
limitnumberOptionalDefault: 25
cursorstringOptional
sortstringOptional
uristringRequired
includeUnacceptedBoostsbooleanOptionalDefault: true
numberOfGenerationsany ofOptionalDefault: 1
numberOptional
or
numberOptional
boostQueryany ofOptional
or
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/recipients-with-children/paginated
POST /api/boost/recipients-with-children/paginated HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 444

{
  "limit": 25,
  "cursor": "text",
  "sort": "text",
  "uri": "text",
  "includeUnacceptedBoosts": true,
  "numberOfGenerations": 1,
  "boostQuery": {
    "$or": [
      {
        "uri": "text",
        "name": "text",
        "type": "text",
        "category": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "DRAFT",
        "autoConnectRecipients": true
      }
    ]
  },
  "profileQuery": {
    "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": "",
        "image": "text",
        "heroImage": "text",
        "type": "text",
        "isServiceProfile": false,
        "display": {
          "backgroundColor": "text",
          "backgroundImage": "text",
          "fadeBackgroundImage": true,
          "repeatBackgroundImage": true,
          "fontColor": "text",
          "accentColor": "text",
          "accentFontColor": "text",
          "idBackgroundImage": "text",
          "fadeIdBackgroundImage": true,
          "idBackgroundColor": "text",
          "repeatIdBackgroundImage": true
        },
        "bio": "",
        "websiteLink": "text",
        "role": "",
        "highlightedCredentials": [
          "text"
        ],
        "did": "text",
        "email": "text"
      },
      "from": "text",
      "received": "text",
      "boostUris": [
        "text"
      ],
      "credentialUris": [
        "text"
      ],
      "status": "active"
    }
  ]
}

Count boost recipients with children

post

This endpoint counts distinct recipients of a boost and all its children boosts

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
includeUnacceptedBoostsbooleanOptionalDefault: true
numberOfGenerationsany ofOptionalDefault: 1
numberOptional
or
numberOptional
boostQueryany ofOptional
or
Responses
200

Successful response

application/json
numberOptional
post/boost/recipients-with-children/count
POST /api/boost/recipients-with-children/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 403

{
  "uri": "text",
  "includeUnacceptedBoosts": true,
  "numberOfGenerations": 1,
  "boostQuery": {
    "$or": [
      {
        "uri": "text",
        "name": "text",
        "type": "text",
        "category": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "DRAFT",
        "autoConnectRecipients": true
      }
    ]
  },
  "profileQuery": {
    "profileId": "text",
    "displayName": "text",
    "shortBio": "text",
    "bio": "text",
    "email": "text",
    "websiteLink": "text",
    "isServiceProfile": true,
    "type": "text"
  }
}
1

Count boost children

post

This endpoint counts the children of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
queryany ofOptional
or
numberOfGenerationsany ofOptionalDefault: 1
numberOptional
or
numberOptional
Responses
200

Successful response

application/json
numberOptional
post/boost/children/count
POST /api/boost/children/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "uri": "text",
  "query": {
    "$or": [
      {
        "uri": "text",
        "name": "text",
        "type": "text",
        "category": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "DRAFT",
        "autoConnectRecipients": true
      }
    ]
  },
  "numberOfGenerations": 1
}
1

Get boost siblings

post

This endpoint gets the siblings of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
limitnumberOptionalDefault: 25
cursorstringOptional
sortstringOptional
uristringRequired
queryany ofOptional
or
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/siblings
POST /api/boost/siblings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 222

{
  "limit": 25,
  "cursor": "text",
  "sort": "text",
  "uri": "text",
  "query": {
    "$or": [
      {
        "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",
      "created": "text",
      "status": "DRAFT",
      "autoConnectRecipients": true,
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "claimPermissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      },
      "defaultPermissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      },
      "allowAnyoneToCreateChildren": true
    }
  ]
}

Count boost siblings

post

This endpoint counts the siblings of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
queryany ofOptional
or
Responses
200

Successful response

application/json
numberOptional
post/boost/siblings/count
POST /api/boost/siblings/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "uri": "text",
  "query": {
    "$or": [
      {
        "uri": "text",
        "name": "text",
        "type": "text",
        "category": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "DRAFT",
        "autoConnectRecipients": true
      }
    ]
  }
}
1

Get familial boosts

post

This endpoint gets the parents, children, and siblings of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
limitnumberOptionalDefault: 25
cursorstringOptional
sortstringOptional
uristringRequired
queryany ofOptional
or
parentGenerationsany ofOptionalDefault: 1
numberOptional
or
numberOptional
childGenerationsany ofOptionalDefault: 1
numberOptional
or
numberOptional
includeExtendedFamilybooleanOptionalDefault: false
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/family
POST /api/boost/family HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 295

{
  "limit": 25,
  "cursor": "text",
  "sort": "text",
  "uri": "text",
  "query": {
    "$or": [
      {
        "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",
      "created": "text",
      "status": "DRAFT",
      "autoConnectRecipients": true,
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "claimPermissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      },
      "defaultPermissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      },
      "allowAnyoneToCreateChildren": true
    }
  ]
}

Count familial boosts

post

This endpoint counts the parents, children, and siblings of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
queryany ofOptional
or
parentGenerationsany ofOptionalDefault: 1
numberOptional
or
numberOptional
childGenerationsany ofOptionalDefault: 1
numberOptional
or
numberOptional
includeExtendedFamilybooleanOptionalDefault: false
Responses
200

Successful response

application/json
numberOptional
post/boost/family/count
POST /api/boost/family/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "uri": "text",
  "query": {
    "$or": [
      {
        "uri": "text",
        "name": "text",
        "type": "text",
        "category": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "DRAFT",
        "autoConnectRecipients": true
      }
    ]
  },
  "parentGenerations": 1,
  "childGenerations": 1,
  "includeExtendedFamily": false
}
1

Get boost parents

post

This endpoint gets the parents of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
limitnumberOptionalDefault: 25
cursorstringOptional
sortstringOptional
uristringRequired
queryany ofOptional
or
numberOfGenerationsany ofOptionalDefault: 1
numberOptional
or
numberOptional
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/parents
POST /api/boost/parents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "limit": 25,
  "cursor": "text",
  "sort": "text",
  "uri": "text",
  "query": {
    "$or": [
      {
        "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",
      "created": "text",
      "status": "DRAFT",
      "autoConnectRecipients": true,
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "claimPermissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      },
      "defaultPermissions": {
        "role": "text",
        "canView": true,
        "canEdit": true,
        "canIssue": true,
        "canRevoke": true,
        "canManagePermissions": true,
        "canIssueChildren": "text",
        "canCreateChildren": "text",
        "canEditChildren": "text",
        "canRevokeChildren": "text",
        "canManageChildrenPermissions": "text",
        "canManageChildrenProfiles": true,
        "canViewAnalytics": true
      },
      "allowAnyoneToCreateChildren": true
    }
  ]
}

Count boost parents

post

This endpoint counts the parents of a particular boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
queryany ofOptional
or
numberOfGenerationsany ofOptionalDefault: 1
numberOptional
or
numberOptional
Responses
200

Successful response

application/json
numberOptional
post/boost/parents/count
POST /api/boost/parents/count HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "uri": "text",
  "query": {
    "$or": [
      {
        "uri": "text",
        "name": "text",
        "type": "text",
        "category": "text",
        "meta": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "status": "DRAFT",
        "autoConnectRecipients": true
      }
    ]
  },
  "numberOfGenerations": 1
}
1

Get boost admins

post

This route returns the admins for a boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
limitnumberOptionalDefault: 25
cursorstringOptional
sortstringOptional
includeSelfbooleanOptionalDefault: true
uristringRequired
Responses
200

Successful response

application/json
cursorstringOptional
hasMorebooleanRequired
post/boost/admins
POST /api/boost/admins HTTP/1.1
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": "",
      "image": "text",
      "heroImage": "text",
      "type": "text",
      "isServiceProfile": false,
      "display": {
        "backgroundColor": "text",
        "backgroundImage": "text",
        "fadeBackgroundImage": true,
        "repeatBackgroundImage": true,
        "fontColor": "text",
        "accentColor": "text",
        "accentFontColor": "text",
        "idBackgroundImage": "text",
        "fadeIdBackgroundImage": true,
        "idBackgroundColor": "text",
        "repeatIdBackgroundImage": true
      },
      "bio": "",
      "websiteLink": "text",
      "role": "",
      "highlightedCredentials": [
        "text"
      ],
      "did": "text",
      "email": "text"
    }
  ]
}

Add a Boost admin

post

This route adds a new admin for a boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
profileIdstringRequired
Responses
200

Successful response

application/json
booleanOptional
post/boost/add-admin
POST /api/boost/add-admin HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "uri": "text",
  "profileId": "text"
}
true

Remove a Boost admin

post

This route removes an admin from a boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
profileIdstringRequired
Responses
200

Successful response

application/json
booleanOptional
post/boost/remove-admin
POST /api/boost/remove-admin HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "uri": "text",
  "profileId": "text"
}
true

Get boost permissions

get

This endpoint gets permission metadata about a boost

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
uristringRequired
Responses
200

Successful response

application/json
rolestringRequired
canViewbooleanRequiredDefault: true
canEditbooleanRequired
canIssuebooleanRequired
canRevokebooleanRequired
canManagePermissionsbooleanRequired
canIssueChildrenstringRequired
canCreateChildrenstringRequired
canEditChildrenstringRequired
canRevokeChildrenstringRequired
canManageChildrenPermissionsstringRequired
canManageChildrenProfilesbooleanOptional
canViewAnalyticsbooleanRequired
get/boost/permissions
GET /api/boost/permissions?uri=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "role": "text",
  "canView": true,
  "canEdit": true,
  "canIssue": true,
  "canRevoke": true,
  "canManagePermissions": true,
  "canIssueChildren": "text",
  "canCreateChildren": "text",
  "canEditChildren": "text",
  "canRevokeChildren": "text",
  "canManageChildrenPermissions": "text",
  "canManageChildrenProfiles": true,
  "canViewAnalytics": true
}

Update boost permissions

post

This endpoint updates permission metadata about a boost for the current user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
uristringRequired
Responses
200

Successful response

application/json
booleanOptional
post/boost/permissions
POST /api/boost/permissions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 317

{
  "uri": "text",
  "updates": {
    "canView": true,
    "canEdit": true,
    "canIssue": true,
    "canRevoke": true,
    "canManagePermissions": true,
    "canIssueChildren": "text",
    "canCreateChildren": "text",
    "canEditChildren": "text",
    "canRevokeChildren": "text",
    "canManageChildrenPermissions": "text",
    "canManageChildrenProfiles": true,
    "canViewAnalytics": true
  }
}
true

Get boost permissions for someone else

get

This endpoint gets permission metadata about a boost for someone else

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
profileIdstringRequired
Query parameters
uristringRequired
Responses
200

Successful response

application/json
rolestringRequired
canViewbooleanRequiredDefault: true
canEditbooleanRequired
canIssuebooleanRequired
canRevokebooleanRequired
canManagePermissionsbooleanRequired
canIssueChildrenstringRequired
canCreateChildrenstringRequired
canEditChildrenstringRequired
canRevokeChildrenstringRequired
canManageChildrenPermissionsstringRequired
canManageChildrenProfilesbooleanOptional
canViewAnalyticsbooleanRequired
get/boost/permissions/{profileId}
GET /api/boost/permissions/{profileId}?uri=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "role": "text",
  "canView": true,
  "canEdit": true,
  "canIssue": true,
  "canRevoke": true,
  "canManagePermissions": true,
  "canIssueChildren": "text",
  "canCreateChildren": "text",
  "canEditChildren": "text",
  "canRevokeChildren": "text",
  "canManageChildrenPermissions": "text",
  "canManageChildrenProfiles": true,
  "canViewAnalytics": true
}

Update other profile's boost permissions

post

This endpoint updates permission metadata about a boost for another user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
profileIdstringRequired
Body
uristringRequired
Responses
200

Successful response

application/json
booleanOptional
post/boost/permissions/{profileId}
POST /api/boost/permissions/{profileId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 317

{
  "uri": "text",
  "updates": {
    "canView": true,
    "canEdit": true,
    "canIssue": true,
    "canRevoke": true,
    "canManagePermissions": true,
    "canIssueChildren": "text",
    "canCreateChildren": "text",
    "canEditChildren": "text",
    "canRevokeChildren": "text",
    "canManageChildrenPermissions": "text",
    "canManageChildrenProfiles": true,
    "canViewAnalytics": true
  }
}
true

Generate a claim link for a boost

post

This route creates a challenge that an unknown profile can use to claim a boost.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
boostUristringRequired
challengestringOptional
Responses
200

Successful response

application/json
boostUristringRequired
challengestringRequired
post/boost/generate-claim-link
POST /api/boost/generate-claim-link HTTP/1.1
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"
}

Claim a boost using a claim link

post

Claims a boost using a claim link, including a challenge

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
boostUristringRequired
challengestringRequired
Responses
200

Successful response

application/json
stringOptional
post/boost/claim
POST /api/boost/claim HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "boostUri": "text",
  "challenge": "text"
}
text

Make Boost Parent

post

This endpoint creates a parent/child relationship between two boosts

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
parentUristringRequired
childUristringRequired
Responses
200

Successful response

application/json
booleanOptional
post/boost/make-parent
POST /api/boost/make-parent HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "parentUri": "text",
  "childUri": "text"
}
true

Remove Boost Parent

post

This endpoint removes a parent/child relationship between two boosts

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
parentUristringRequired
childUristringRequired
Responses
200

Successful response

application/json
booleanOptional
post/boost/remove-parent
POST /api/boost/remove-parent HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "parentUri": "text",
  "childUri": "text"
}
true

Send a boost to a profile using a signing authority

post

Issues a boost VC to a recipient profile using a specified signing authority and sends it via the network.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
profileIdstringRequired
Body
boostUristringRequired
Responses
200

Successful response

application/json
stringOptional
post/boost/send/via-signing-authority/{profileId}
POST /api/boost/send/via-signing-authority/{profileId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "boostUri": "text",
  "signingAuthority": {
    "name": "text",
    "endpoint": "text"
  },
  "templateData": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "options": {
    "skipNotification": false
  }
}
text
PreviousCredentials
NextPresentations

Last updated

Was this helpful?