Boosts

Send a Boost

post

This endpoint sends a boost to a profile

Authorizations

Path parameters

profileIdstringRequired

Body

uristringRequired

credentialany ofRequired

or

Responses

200

Successful response

application/json

Responsestring

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Creates a boost

post

This route creates a boost

Authorizations

Body

namestringOptional

typestringOptional

categorystringOptional

statusstring · enumOptionalPossible values:

autoConnectRecipientsbooleanOptional

credentialany ofRequired

or

Responses

200

Successful response

application/json

Responsestring

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

{
  "name": "text",
  "type": "text",
  "category": "text",
  "status": "DRAFT",
  "autoConnectRecipients": true,
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "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

Creates a boost

post

This route creates a boost

Authorizations

Body

parentUristringRequired

Responses

200

Successful response

application/json

Responsestring

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

{
  "parentUri": "text",
  "boost": {
    "name": "text",
    "type": "text",
    "category": "text",
    "status": "DRAFT",
    "autoConnectRecipients": true,
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "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

Get boost

get

This endpoint gets metadata about a boost

Authorizations

Query parameters

uristringRequired

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

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"
  },
  "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"
  }
}

Update a boost

post

This route updates a boost

Authorizations

Body

uristringRequired

Responses

200

Successful response

application/json

Responseboolean

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

{
  "uri": "text",
  "updates": {
    "name": "text",
    "type": "text",
    "category": "text",
    "status": "DRAFT",
    "autoConnectRecipients": true,
    "meta": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "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

Delete a boost

delete

This route deletes a boost

Authorizations

Query parameters

uristringRequired

Responses

200

Successful response

application/json

Responseboolean

default

Error response

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/boost?uri=text HTTP/1.1
Host: ..
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

true

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

Body

Responses

200

Successful response

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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"
    },
    "uri": "text"
  }
]

Count managed boosts

post

This endpoint counts the current user's managed boosts.

Authorizations

Body

Responses

200

Successful response

application/json

Responsenumber

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Get boosts

post

This endpoint gets the current user's boosts

Authorizations

Body

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

Responses

200

Successful response

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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
      }
    }
  ]
}

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

Query parameters

uristringRequired

limitany ofOptionalDefault: 25

notOptional

or

numberOptional

skipnumberOptional

includeUnacceptedBoostsbooleanOptionalDefault: true

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

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"
  }
]

Get boost recipients

post

This endpoint gets the recipients of a particular boost

Authorizations

Body

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

uristringRequired

includeUnacceptedBoostsbooleanOptionalDefault: true

Responses

200

Successful response

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Get boost recipients count

get

This endpoint counts the recipients of a particular boost

Authorizations

Query parameters

uristringRequired

includeUnacceptedBoostsbooleanOptionalDefault: true

Responses

200

Successful response

application/json

Responsenumber

default

Error response

application/json

get

HTTPcURLJavaScriptPython

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

post

Get Profile Managers that are a child of a boost

Authorizations

Body

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

uristringRequired

Responses

200

Successful response

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Get boost children

post

This endpoint gets the children of a particular boost

Authorizations

Body

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

uristringRequired

numberOfGenerationsnumberOptionalDefault: 1

Responses

200

Successful response

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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
      }
    }
  ]
}

Count boost children

post

This endpoint counts the children of a particular boost

Authorizations

Body

uristringRequired

numberOfGenerationsnumberOptionalDefault: 1

Responses

200

Successful response

application/json

Responsenumber

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Get boost siblings

post

This endpoint gets the siblings of a particular boost

Authorizations

Body

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

uristringRequired

Responses

200

Successful response

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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
      }
    }
  ]
}

Count boost siblings

post

This endpoint counts the siblings of a particular boost

Authorizations

Body

uristringRequired

Responses

200

Successful response

application/json

Responsenumber

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Get familial boosts

post

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

Authorizations

Body

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

uristringRequired

parentGenerationsnumberOptionalDefault: 1

childGenerationsnumberOptionalDefault: 1

includeExtendedFamilybooleanOptionalDefault: false

Responses

200

Successful response

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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
      }
    }
  ]
}

Count familial boosts

post

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

Authorizations

Body

uristringRequired

parentGenerationsnumberOptionalDefault: 1

childGenerationsnumberOptionalDefault: 1

includeExtendedFamilybooleanOptionalDefault: false

Responses

200

Successful response

application/json

Responsenumber

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Get boost parents

post

This endpoint gets the parents of a particular boost

Authorizations

Body

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

uristringRequired

numberOfGenerationsnumberOptionalDefault: 1

Responses

200

Successful response

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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
      }
    }
  ]
}

Count boost parents

post

This endpoint counts the parents of a particular boost

Authorizations

Body

uristringRequired

numberOfGenerationsnumberOptionalDefault: 1

Responses

200

Successful response

application/json

Responsenumber

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Get boost admins

post

This route returns the admins for a boost

Authorizations

Body

limitnumberOptionalDefault: 25

cursorstringOptional

sortstringOptional

includeSelfbooleanOptionalDefault: true

uristringRequired

Responses

200

Successful response

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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": ""
    }
  ]
}

Add a Boost admin

post

This route adds a new admin for a boost

Authorizations

Body

uristringRequired

profileIdstringRequired

Responses

200

Successful response

application/json

Responseboolean

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Remove a Boost admin

post

This route removes an admin from a boost

Authorizations

Body

uristringRequired

profileIdstringRequired

Responses

200

Successful response

application/json

Responseboolean

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Get boost permissions

get

This endpoint gets permission metadata about a boost

Authorizations

Query parameters

uristringRequired

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

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
}

Update boost permissions

post

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

Authorizations

Body

uristringRequired

Responses

200

Successful response

application/json

Responseboolean

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Get boost permissions for someone else

get

This endpoint gets permission metadata about a boost for someone else

Authorizations

Path parameters

profileIdstringRequired

Query parameters

uristringRequired

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

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
}

Update other profile's boost permissions

post

This endpoint updates permission metadata about a boost for another user

Authorizations

Path parameters

profileIdstringRequired

Body

uristringRequired

Responses

200

Successful response

application/json

Responseboolean

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Generate a claim link for a boost

post

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

Authorizations

Body

boostUristringRequired

challengestringOptional

Responses

200

Successful response

application/json

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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"
}

Claim a boost using a claim link

post

Claims a boost using a claim link, including a challenge

Authorizations

Body

boostUristringRequired

challengestringRequired

Responses

200

Successful response

application/json

Responsestring

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Make Boost Parent

post

This endpoint creates a parent/child relationship between two boosts

Authorizations

Body

parentUristringRequired

childUristringRequired

Responses

200

Successful response

application/json

Responseboolean

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

Remove Boost Parent

post

This endpoint removes a parent/child relationship between two boosts

Authorizations

Body

parentUristringRequired

childUristringRequired

Responses

200

Successful response

application/json

Responseboolean

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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

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

Path parameters

profileIdstringRequired

Body

boostUristringRequired

Responses

200

Successful response

application/json

Responsestring

default

Error response

application/json

post

HTTPcURLJavaScriptPython

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