TokenOne Core API — Guia de Início Rápido#
Bem-vindo à TokenOne Core API. Este guia apresenta, de forma objetiva, como autenticar, fazer suas primeiras chamadas e operar os principais fluxos: Customers (KYC), Transactions (on/off-ramp e transfer), Offers, Tokens, Issuers e Distributors.
Sumário#
Visão geral#
Base URL (prod): https://api.tokenone.com.br/v1
Base URL (sandbox): https://sandbox.tokenone.com.br/v1
Autenticação: Header X-API-Key: <sua-chave>
Content-Type: application/json (exceto upload de documento multipart/form-data)
Idempotência (POST): Idempotency-Key: <uuid-único>
Paginação: limit, offset ⇒ resposta com { data, paging }
Autenticação#
Inclua sua API Key em todas as requisições:
Idempotência#
Para POST (criação/ordens/transações), envie:Idempotency-Key: <uuid-único>
Isso evita duplicidades em reenvios.
Paginação#
Listagens aceitam ?limit= e ?offset= e retornam:{
"data": [ ],
"paging": { "limit": 20, "offset": 0, "total": 123 }
}
Modelo de erro#
{
"code": "NOT_FOUND",
"message": "Recurso não encontrado",
"trace_id": "req-xxxx"
}
1) Customers (PF/PJ) + KYC#
Criar um cliente#
{
"id": "7f2a1b2c-1111-2222-3333-aaaaaaaaaaaa",
"type": "INDIVIDUAL",
"country": "BR",
"email": "ana.silva@example.com",
"name": "Ana Silva",
"verification": { "status": "PENDING", "level": "basic", "updated_at": "2025-09-17T19:00:00Z" },
"created_at": "2025-09-17T19:00:00Z"
}
Listar clientes#
Ler um cliente#
Upload de documento (KYC)#
{
"id": "d01a9c00-7777-8888-9999-cccccccccccc",
"customer_id": "7f2a1b2c-1111-2222-3333-aaaaaaaaaaaa",
"status": "RECEIVED",
"created_at": "2025-09-17T19:00:00Z"
}
Verificação KYC#
2) Transactions (on-ramp, off-ramp, transfer)#
Listar transações#
Ler uma transação#
On-ramp (BRL → USDC)#
Off-ramp (USDC → BRL)#
Transfer (P2P interno em USDC)#
Status típicos: AWAITING_FUNDS → PROCESSING → SUCCESS/FAILED.
3) Offers (ofertas de investimento)#
Listar ofertas#
Criar oferta#
Ler oferta#
Comprar oferta#
Observação: criação do Token é feita após oferta finalizada (FINALIZED).
4) Tokens#
Listar tokens#
Criar token (baseado em oferta finalizada)#
Ler token#
5) Issuers (emissores)#
Listar emissores#
Criar emissor#
Ler emissor#
Atualizar emissor#
6) Distributors (distribuidores)#
Listar distribuidores#
Criar distribuidor#
Ler distribuidor#
Atualizar distribuidor#
Códigos de status comuns#
200 OK — sucesso em leituras/atualizações.
201 Created — recurso criado.
202 Accepted — recebido e em processamento (ex.: on/off-ramp, buy).
400 Bad Request — payload inválido.
404 Not Found — recurso inexistente.
429 Too Many Requests — limite de requisições excedido.
500 Internal Server Error — erro interno.
Boas práticas#
Envie Idempotency-Key em todo POST.
Valide decimais como string (ex.: "1000.00").
Trate estados assíncronos (ex.: transações): faça polling pelo id.
Logue trace_id quando presente para suporte.
Próximos passos#
Testar as chamadas acima no sandbox.
Integrar o fluxo completo: Customer → KYC → On-ramp → Buy Offer → Token.
(Opcional) Definir webhooks para eventos de transação/compra (quando habilitados).
OpenAPI#
Modificado em 2025-09-18 00:34:14