Skip to main content
Use this endpoint to retrieve every customer registered under your CertoPay account. The response is an array of customer objects, each containing the same fields returned when a customer is first created. This is useful for building dashboards, reconciling buyer data, or looking up a customer UUID before placing an order.

Request

X-Api-Key
string
required
Your CertoPay secret API key. Include it in every request as X-Api-Key: sk_live_sua_chave_aqui.
This endpoint accepts no request body or query parameters.

Response

A successful request returns HTTP 200 OK with an array of customer objects. Each object in the array has the following shape:
id
string
Unique UUID identifying the customer.
name
string
Full name of the customer.
email
string
Email address of the customer.
document
string
CPF number (11 digits) of the customer.
phone
string
Phone number of the customer.
createdAt
string
ISO 8601 timestamp of when the customer record was created.

Example

curl https://v2.certopaybrasil.com/api/customers \
  -H "X-Api-Key: sk_live_sua_chave_aqui"
200 OK
[
  {
    "id": "uuid-do-customer",
    "name": "João da Silva",
    "email": "joao@email.com",
    "document": "12345678900",
    "phone": "(11) 99999-9999",
    "createdAt": "2026-06-26T10:00:00Z"
  },
  {
    "id": "uuid-do-customer-2",
    "name": "Maria Oliveira",
    "email": "maria@email.com",
    "document": "98765432100",
    "phone": "(21) 97777-7777",
    "createdAt": "2026-06-25T09:30:00Z"
  }
]