Skip to main content
GET
cURL

Campo status

status reflete a decisão de onboarding do cliente (em_analise, aprovado, pendencia, recusado) — derivada do resultado do bureau run mais recente, não do status do run em si (que usa inglês). Veja Status de bureau run vs status de cliente.

Campo doc

O CPF ou CNPJ é retornado mascarado, com dígitos parciais visíveis:
  • CPF: ***456789**
  • CNPJ: **34567890****
O documento nunca é retornado em claro pela API.

Campo latest_run

Retorna o run de bureau mais recente associado ao cliente, ou null se nenhum run foi executado ainda.
Para o resultado completo com todos os checks, use GET /runs/:id/analysis.

Campo facial_verification

Resultado da verificação facial (Face Match + Passive Liveness) da rodada mais recente do cliente. Presente apenas para clientes PF (campo ausente, não null, na resposta de clientes PJ — biometria não roda para PJ). null quando o cliente nunca passou por uma rodada de verificação facial.
Nunca inclui imagem, URL assinada de imagem ou os warnings brutos do provedor — apenas status/score/completed_at por check. Notificação em tempo real via webhook está disponível no evento biometric_check.completed — ver Webhooks.

Campo documents

Resumo dos documentos anexados ao cliente (via POST /customers//documents ou pelo portal de onboarding). Não inclui storage_path nem signed URL — baixar o arquivo continua exclusivo do dashboard.
Cliente sem documentos anexados retorna documents: [].

Campos complementares

nationality, occupation, declared_income (PF) e trade_name, annual_revenue, business_activity, employee_count (PJ) aparecem na resposta apenas quando foram enviados em POST /customers — nenhum valor default é inventado para o que não foi informado.
declared_income e annual_revenue são apenas armazenados — não refletem nenhum recálculo automático de capacidade financeira feito depois da criação do cliente.

Erros

Formato completo do envelope e estratégia de retry em Tratamento de erros. Os códigos deste endpoint: missing_api_key, invalid_api_key, insufficient_scope, invalid_id ({id} da URL ausente ou inválido), customer_not_found.

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"

Path Parameters

id
string<uuid>
required

ID do cliente retornado pelo POST /customers

Response

Dados completos do cliente

customer_id
string<uuid>
object
enum<string>
Available options:
customer
status
enum<string>

em_analise, aprovado, pendencia e recusado são os status de decisão de onboarding (mesmo vocabulário do parâmetro de filtro status). rascunho (cadastro iniciado e ainda não finalizado), inactive (cliente desativado manualmente) e em_monitoramento (aprovado em monitoramento contínuo pós-aprovação) também podem aparecer neste campo, mesmo não sendo filtráveis pelo parâmetro status.

Available options:
em_analise,
aprovado,
pendencia,
recusado,
rascunho,
inactive,
em_monitoramento
type
enum<string>
Available options:
pf,
pj
name
string
email
string | null
phone
string | null
doc
string

CPF/CNPJ mascarado com dígitos parciais visíveis

Example:

"***456789**"

external_id
string | null
birth_date
string<date> | null

Apenas PF

nationality
string | null

Apenas PF — presente somente quando enviado no createCustomer

occupation
string | null

Apenas PF — presente somente quando enviado no createCustomer

declared_income
string | null

Apenas PF — presente somente quando enviado no createCustomer. Apenas armazenado: não aciona recálculo automático de capacidade financeira (motor de renda).

address
object | null

Presente para PF e PJ quando enviado no createCustomer

trade_name
string | null

Apenas PJ — presente somente quando enviado no createCustomer

annual_revenue
string | null

Apenas PJ — presente somente quando enviado no createCustomer. Apenas armazenado: não aciona recálculo automático de capacidade financeira (motor de renda).

business_activity
string | null

Apenas PJ — presente somente quando enviado no createCustomer

employee_count
string | null

Apenas PJ — presente somente quando enviado no createCustomer

documents
object[]

Resumo dos documentos anexados via POST /customers/{id}/documents ou pelo portal de onboarding. Não inclui storage_path nem signed URL — baixar o arquivo continua exclusivo do dashboard.

latest_run
object | null

Run de bureau mais recente associado ao cliente

facial_verification
object | null

Resultado da verificação facial (Face Match + Passive Liveness) da rodada mais recente. Presente apenas para clientes PF — ausente (não null) na resposta de clientes PJ, que não passam por biometria. null quando nenhuma rodada rodou ainda.

created_at
string<date-time>
updated_at
string<date-time>
livemode
boolean