API Reference/Customers
POST

Create a customer

Create a customer. See the request, response and integration notes.

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": "customer@example.com",
  "name": "Example Customer",
  "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"
}

Authentication

X-API-Keystring · headerrequired

Use the ky_... key created under Integrations → API Keys in the KyvoPay dashboard.

Use this endpoint to create a customer. For safe retries, reuse the same idempotency key for the same business operation.

Request

Note

Private endpoints require the X-API-Key header. Keep credentials on your backend and log the response request_id for diagnostics.

Response

Implementation notes

  • Validate required input before sending the request.
  • Store returned public identifiers without assuming their format.
  • Treat 4xx validation errors as non-retryable until the request is corrected.
  • Retry timeouts, 429 and temporary 5xx responses with exponential backoff.
  • Keep the idempotency key stable across retries.
Need help? Contact support
© 2026 KyvoPay