Documentação
InícioTokenOne
Outras documentações
  • Branding
  • Investidor
InícioTokenOne
Outras documentações
  • Branding
  • Investidor
  1. Introdução
  • Introdução
    • Introdução
  • TokenOne APIs
    • Customers
      • createCustomer
      • listCustomers
      • getCustomer
      • uploadCustomerDocument
      • getCustomerVerification
      • startCustomerVerification
    • Transactions
      • listTransactions
      • getTransaction
      • createOnRamp
      • createOffRamp
      • createTransfer
    • Offers
      • listOffers
      • createOffer
      • getOffer
      • buyOffer
    • Tokens
      • listTokens
      • createToken
      • getToken
    • Issuers
      • listIssuers
      • createIssuer
      • getIssuer
      • updateIssuer
    • Distributors
      • listDistributors
      • createDistributor
      • getDistributor
      • updateDistributor
    • Esquemas
      • Schemas
        • Error
        • PageMeta
        • CustomerType
        • VerificationStatus
        • Customer
        • CustomerCreate
        • CustomersPage
        • DocumentUploadResponse
        • Verification
        • FiatTxType
        • FiatTxStatus
        • Transaction
        • TransactionsPage
        • OnRampCreate
        • OffRampCreate
        • TransferCreate
        • OfferStatus
        • Offer
        • OffersPage
        • OfferCreate
        • OfferBuyRequest
        • TokenStandard
        • Token
        • TokensPage
        • TokenCreate
        • Issuer
        • IssuersPage
        • IssuerCreate
        • IssuerUpdate
        • Distributor
        • DistributorsPage
        • DistributorCreate
        • DistributorUpdate
  1. Introdução

Introdução

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
Autenticação
Idempotência
Paginação
Modelo de erro
Customers (PF/PJ) + KYC
Transactions (on-ramp, off-ramp, transfer)
Offers
Tokens
Issuers
Distributors
Códigos de status
Boas práticas
Próximos passos
OpenAPI

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:
X-API-Key: <sua-chave>
Exemplo (curl):

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": [ /* itens */ ],
  "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#

201
{
  "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)#

201
{
  "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#

Iniciar:
Consultar status:

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#

Spec minimal (consolidado): tokenone_minimal.yaml
Spec com exemplos: tokenone_minimal_examples.yaml
Modificado em 2025-09-18 00:34:14
Próxima página
createCustomer
Built with