Update Token Documentation

curl --request PATCH \
  --url https://api.sandbox.brickken.com/update-docs \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'tokenSymbol=<string>' \
  --form tokenLogotype=@example-file \
  --form subscriptionAgreement=@example-file \
  --form legalDocs=@example-file

{
  "success": true,
  "tokenSymbol": "<string>",
  "tokenLogotypeRef": "<string>",
  "subscriptionAgreementIpfs": "<string>",
  "legalDocsIpfs": "<string>"
}

Management Endpoints

Update Token Documentation

Description: This endpoint allows you to update token-related documentation and branding materials.

Headers:

x-api-key: YOUR_API_KEY

Request Format: This endpoint accepts multipart/form-data input, which should include:

tokenSymbol (text)
tokenLogotype (image file) - optional
subscriptionAgreement (PDF file) - optional
legalDocs (PDF file) - optional

What the endpoint does:

The tokenLogotype is uploaded to S3.
The subscriptionAgreement and legalDocs are uploaded to IPFS.
The token record (identified by tokenSymbol) is then updated with references to the uploaded files.

Security:

You must provide a valid x-api-key.

PATCH

update-docs

Update Token Documentation

curl --request PATCH \
  --url https://api.sandbox.brickken.com/update-docs \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'tokenSymbol=<string>' \
  --form tokenLogotype=@example-file \
  --form subscriptionAgreement=@example-file \
  --form legalDocs=@example-file

{
  "success": true,
  "tokenSymbol": "<string>",
  "tokenLogotypeRef": "<string>",
  "subscriptionAgreementIpfs": "<string>",
  "legalDocsIpfs": "<string>"
}

Authorizations

x-api-key

string

header

required

Body

multipart/form-data

tokenSymbol

string

required

The symbol of the token being updated.

tokenLogotype

object

Image file for the token's logo.

subscriptionAgreement

object

PDF file for the token's subscription agreement.

legalDocs

object

PDF file containing the legal documentation.

Response

Successful update

success

boolean

Indicates if the operation was successful.

Example:

true

tokenSymbol

string

The token symbol that was updated.

tokenLogotypeRef

string

Reference (e.g., S3 path) to the uploaded token logotype image.

subscriptionAgreementIpfs

string

IPFS CID reference to the uploaded subscription agreement.

legalDocsIpfs

string

IPFS CID reference to the uploaded legal documents.

Get Whitelist Status

API Documentation

Transaction Endpoints

On Behalf Endpoints

Information Endpoints

Management Endpoints

Update Token Documentation

Authorizations

Body

Response