Referência da API/Clientes
POST

Cria um cliente

Cria um cliente

POST/v1/customers
https://integrate.api.kyvopay.com.br
cURL
curl -X POST https://integrate.api.kyvopay.com.br/v1/customers \
  -H "X-API-Key: ky_XXXXX-XXXXX-XXXXX" \
  -H "Content-Type: application/json" \
  -d '{
  "document": "12345678909",
  "email": "cliente@example.com",
  "name": "Cliente Exemplo",
  "phone": "11999999999"
}'
Resposta200 OK
{
  "data": {
    "document": "12345678909",
    "email": "cliente@example.com",
    "id": "01HZ8K3M5N",
    "is_blocked": false,
    "name": "Cliente Exemplo",
    "phone": "11999999999"
  },
  "error": {
    "code": "string",
    "details": {},
    "message": "string"
  },
  "request_id": "req_01HZ8K3M5N"
}

Autenticação

X-API-Keystring · headerobrigatório

Use a chave ky_... criada em Integrações → Chaves de API no painel KyvoPay.

Requisição

Corpo

documentstring

CPF ou CNPJ, só dígitos.

emailstringobrigatório

E-mail.

namestringobrigatório

Nome.

phonestring

Telefone com DDD, só dígitos.

Precisa de ajuda? Fale com o suporte
© 2026 KyvoPay