Cadastro do cliente

Cada cliente é uma pessoa física identificada pelo CPF. Um CPF aprovado em qualquer loja da plataforma não precisa refazer o KYC: ele é aprovado na hora na sua loja também.

`POST /crypto/customers` → `201`

Requer scope CRYPTO_WRITE.

curl -X POST https://api.gestaotechnology.com/api/crypto/customers \
  -H "X-Api-Key: <SECRET_KEY>" -H "Content-Type: application/json" \
  -d '{
    "name": "Fulano da Silva",
    "email": "[email protected]",
    "document": "12345678901",
    "phone": "+5511999999999",
    "externalRef": "cliente-42"
  }'

Campo	Obrigatório	Regra
`name`	sim	Nome completo igual ao documento. 3 a 255 caracteres.
`email`	sim	E-mail do cliente.
`document`	sim	CPF, com ou sem pontuação (11 dígitos).
`phone`	não	Até 20 caracteres.
`externalRef`	não	Seu id do cliente. Serve no lugar do `customerId` em todas as chamadas.

Resposta (201):

{
  "customerId": "aaa61c8a-f702-4f02-aa16-0a803a232e0e",
  "status": "PENDING",
  "tosLink": "https://…",
  "kycLink": "https://…",
  "brCode": null
}

Mande os dois links ao cliente, nessa ordem. Quando o KYC for aprovado você recebe o webhook crypto.customer.updated com status: "ACTIVE" e o brCode.

sequenceDiagram
  participant S as Seu sistema
  participant G as Plataforma
  participant C as Cliente
  S->>G: POST /crypto/customers
  G-->>S: 201 PENDING + tosLink + kycLink
  S->>C: envia os dois links
  C->>G: aceita termos e envia documentos
  G-->>S: webhook crypto.customer.updated (ACTIVE, brCode)

Cadastro de cliente novo. Cliente já aprovado em outra loja volta ACTIVE direto na resposta do POST, já com o brCode da sua loja.

Passo a passo com webhooks: Guia › Cripto: cadastrar cliente.

`GET /crypto/customers/:customerId` → `200`

Requer scope CRYPTO_READ. O parâmetro aceita o customerId ou a sua externalRef.

curl -s https://api.gestaotechnology.com/api/crypto/customers/cliente-42 \
  -H "X-Api-Key: <SECRET_KEY>"

Status do cliente

Status	Significado	O que fazer
`PENDING`	Cadastro criado, KYC não enviado.	Reenvie os links ao cliente.
`IN_REVIEW`	Documentos em análise no provedor.	Aguarde o webhook.
`ACTIVE`	Aprovado. `brCode` disponível.	Pode depositar e sacar.
`REJECTED`	KYC recusado.	O cliente pode tentar de novo pelos links.
`RESTRICTED` / `DISABLED`	Bloqueado pelo provedor.	Fale com o suporte.