Update Token Documentation

curl --request PATCH \
  --url https://api.sandbox.brickken.com/patch-token-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'

import requests

url = "https://api.sandbox.brickken.com/patch-token-docs"

files = {
    "tokenLogotype": ("example-file", open("example-file", "rb")),
    "subscriptionAgreement": ("example-file", open("example-file", "rb")),
    "legalDocs": ("example-file", open("example-file", "rb"))
}
payload = { "tokenSymbol": "<string>" }
headers = {"x-api-key": "<api-key>"}

response = requests.patch(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('tokenSymbol', '<string>');
form.append('tokenLogotype', '{}');
form.append('subscriptionAgreement', '{}');
form.append('legalDocs', '{}');

const options = {method: 'PATCH', headers: {'x-api-key': '<api-key>'}};

options.body = form;

fetch('https://api.sandbox.brickken.com/patch-token-docs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.brickken.com/patch-token-docs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenSymbol\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenLogotype\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subscriptionAgreement\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legalDocs\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.brickken.com/patch-token-docs"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenSymbol\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenLogotype\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subscriptionAgreement\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legalDocs\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sandbox.brickken.com/patch-token-docs")
  .header("x-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenSymbol\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenLogotype\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subscriptionAgreement\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legalDocs\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.brickken.com/patch-token-docs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenSymbol\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenLogotype\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subscriptionAgreement\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legalDocs\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>"
}

Management Endpoints

Update Token Documentation

Description: This endpoint allows you to update token-related documentation and branding materials. It is fully off-chain and does not prepare or require a blockchain transaction.

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.
No txId, transaction payload, or signed transaction is produced.

Security:

You must provide a valid x-api-key.
API key requests do not require signerAddress.

PATCH

patch-token-docs

Update Token Documentation

curl --request PATCH \
  --url https://api.sandbox.brickken.com/patch-token-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'

import requests

url = "https://api.sandbox.brickken.com/patch-token-docs"

files = {
    "tokenLogotype": ("example-file", open("example-file", "rb")),
    "subscriptionAgreement": ("example-file", open("example-file", "rb")),
    "legalDocs": ("example-file", open("example-file", "rb"))
}
payload = { "tokenSymbol": "<string>" }
headers = {"x-api-key": "<api-key>"}

response = requests.patch(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('tokenSymbol', '<string>');
form.append('tokenLogotype', '{}');
form.append('subscriptionAgreement', '{}');
form.append('legalDocs', '{}');

const options = {method: 'PATCH', headers: {'x-api-key': '<api-key>'}};

options.body = form;

fetch('https://api.sandbox.brickken.com/patch-token-docs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.brickken.com/patch-token-docs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenSymbol\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenLogotype\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subscriptionAgreement\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legalDocs\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.brickken.com/patch-token-docs"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenSymbol\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenLogotype\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subscriptionAgreement\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legalDocs\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.sandbox.brickken.com/patch-token-docs")
  .header("x-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenSymbol\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenLogotype\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subscriptionAgreement\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legalDocs\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.brickken.com/patch-token-docs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenSymbol\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"tokenLogotype\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subscriptionAgreement\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"legalDocs\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>"
}

Overview

The PATCH /patch-token-docs endpoint allows you to update token-related documentation and branding materials for existing tokens. This endpoint handles file uploads for token logos, subscription agreements, and legal documents.

Key Features

Token Logo Upload: Upload token logotype images to S3 storage
Legal Document Management: Upload subscription agreements and legal documents to IPFS
Multipart Form Data: Supports file uploads through multipart/form-data format
Selective Updates: All file fields are optional - update only what you need
Off-chain Update: This endpoint does not prepare or require any blockchain transaction

Request Format

This endpoint accepts multipart/form-data with the following fields:

Required Fields

tokenSymbol (string): The symbol of the token being updated

Optional File Fields

tokenLogotype (image file): Logo image for the token (uploaded to S3)
subscriptionAgreement (PDF file): Subscription agreement document (uploaded to IPFS)
legalDocs (PDF file): Legal documentation (uploaded to IPFS)

Example Request

curl -X PATCH "https://api.sandbox.brickken.com/patch-token-docs" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "tokenSymbol=MYTOKEN" \
  -F "tokenLogotype=@logo.png" \
  -F "subscriptionAgreement=@agreement.pdf" \
  -F "legalDocs=@legal.pdf"

Response Format

Success Response (200)

{
  "success": true,
  "tokenSymbol": "MYTOKEN",
  "tokenLogotypeRef": "s3://bucket/path/to/logo.png",
  "subscriptionAgreementIpfs": "QmXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXxXx",
  "legalDocsIpfs": "QmYyYyYyYyYyYyYyYyYyYyYyYyYyYyYyYyYyYyYy"
}

Response Fields

Field	Type	Description
`success`	boolean	Indicates if the operation was successful
`tokenSymbol`	string	The token symbol that was updated
`tokenLogotypeRef`	string	S3 path reference to the uploaded logo (if provided)
`subscriptionAgreementIpfs`	string	IPFS CID for the subscription agreement (if provided)
`legalDocsIpfs`	string	IPFS CID for the legal documents (if provided)

File Storage Details

Token Logotype

Storage: Amazon S3
Supported Formats: Image files (PNG, JPG, etc.)
Access: Direct S3 URL reference
Use Case: Token branding and display

Legal Documents

Storage: IPFS (InterPlanetary File System)
Supported Formats: PDF files
Access: IPFS CID (Content Identifier)
Use Case: Immutable legal document storage

Security & Authorization

API Key Required: Include your API key in the x-api-key header
Token Ownership: You can only update documentation for tokens associated with your account
File Validation: Files are validated for type and size before upload
No Transaction Signature: API key requests do not require signerAddress, txId, or signed transactions

Error Handling

Common Error Responses

400 Bad Request

{
  "message": "tokenSymbol is required"
}

401 Unauthorized

{
  "message": "No email found in token. Unauthorized."
}

Use Cases

Brand Updates: Update token logos for better visual representation
Legal Compliance: Upload updated subscription agreements and legal documents
Documentation Management: Maintain current legal and compliance documentation
Token Maintenance: Keep token information up-to-date post-creation

Important Notes

Only the tokenSymbol field is required - all file uploads are optional
Files are processed and uploaded to different storage systems based on their purpose
IPFS storage ensures immutable document storage for legal compliance
S3 storage provides fast access for branding materials
This endpoint is fully off-chain: token logos are uploaded to S3, documents are uploaded to IPFS, and the token database record is updated without preparing a blockchain transaction
The endpoint validates file types and user permissions before processing uploads

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

​Overview

​Key Features

​Request Format

​Required Fields

​Optional File Fields

​Example Request

​Response Format

​Success Response (200)

​Response Fields

​File Storage Details

​Token Logotype

​Legal Documents

​Security & Authorization

​Error Handling

​Common Error Responses

​Use Cases

​Important Notes

Authorizations

Body

Response

Overview

Key Features

Request Format

Required Fields

Optional File Fields

Example Request

Response Format

Success Response (200)

Response Fields

File Storage Details

Token Logotype

Legal Documents

Security & Authorization

Error Handling

Common Error Responses

Use Cases

Important Notes