Referência da API/Clientes
POST
Cria um cliente
Cria um cliente
POST
/v1/customershttps://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órioUse a chave ky_... criada em Integrações → Chaves de API no painel KyvoPay.
Requisição
Corpo
documentstringCPF ou CNPJ, só dígitos.
emailstringobrigatórioE-mail.
namestringobrigatórioNome.
phonestringTelefone com DDD, só dígitos.