Skip to main content
GET
cURL

Paginação

A listagem usa cursor pagination. Quando has_more: true, o campo next_cursor está presente — passe-o como parâmetro cursor na próxima requisição.

Campo doc

Por privacidade, o campo doc é retornado como *** na listagem. Para ver a versão mascarada com dígitos parciais, use GET /customers/:id.

Authorizations

x-api-key
string
header
required

API key no header x-api-key (recomendado)

Headers

x-kycert-api-version
string
Example:

"2026-06-03"

Query Parameters

type
enum<string>

Filtrar por tipo de pessoa

Available options:
pf,
pj
status
enum<string>

Status de onboarding do cliente (vocabulário do portal de cadastro — distinto do status de bureau run que usa inglês: completed, running, blocked).

  • em_analise — cadastro recebido, bureau em andamento
  • aprovado — bureau concluído, cliente aprovado
  • pendencia — bureau concluído com pendências para revisão manual
  • recusado — cliente recusado pelo compliance
Available options:
em_analise,
aprovado,
pendencia,
recusado
external_id
string

Filtrar pelo identificador interno

doc
string

Filtrar por CPF ou CNPJ (sem formatação) — busca por hash

created_after
string<date-time>

Retornar apenas clientes criados após esta data (ISO 8601)

created_before
string<date-time>

Retornar apenas clientes criados antes desta data (ISO 8601)

limit
integer
default:20

Número máximo de clientes por página

Required range: 1 <= x <= 100
cursor
string

Cursor de paginação retornado em next_cursor da página anterior

Response

Lista de clientes

data
object[]
has_more
boolean
next_cursor
string | null

Cursor para a próxima página (presente quando has_more=true)

livemode
boolean