Skip to main content
GET
/
api
/
v1
/
customers
/
{id}
cURL
curl "https://admin.kycert.com.br/api/v1/customers/CUSTOMER_ID" \
  -H "x-api-key: $KYCERT_API_KEY"
{
  "customer_id": "661e9511-f3ac-52e5-b827-557766551111",
  "object": "customer",
  "status": "em_analise",
  "type": "pf",
  "name": "João Silva",
  "email": "joao@example.com",
  "doc": "***456789**",
  "external_id": "cust_abc123",
  "birth_date": "1990-05-15",
  "latest_run": {
    "run_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "completed",
    "decision": "approved",
    "risk_band": "baixo",
    "completed_at": "2026-06-12T14:00:18Z"
  },
  "created_at": "2026-06-12T14:00:00Z",
  "updated_at": "2026-06-12T14:00:18Z",
  "livemode": true
}

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.
{
  "latest_run": {
    "run_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "completed",
    "decision": "approved",
    "risk_band": "baixo",
    "completed_at": "2026-06-12T14:00:18Z"
  }
}
Para o resultado completo com todos os checks, use GET /runs/:id/analysis.

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
string
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

address
object

Apenas PF

latest_run
object

Run de bureau mais recente associado ao cliente

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