Buscar cliente

cURL

curl "https://admin.kycert.com.br/api/v1/customers/CUSTOMER_ID" \
  -H "x-api-key: $KYCERT_API_KEY"

const res = await fetch(
  `https://admin.kycert.com.br/api/v1/customers/${customerId}`,
  { headers: { 'x-api-key': process.env.KYCERT_API_KEY } },
)
const customer = await res.json()
console.log(customer.name, customer.doc, customer.latest_run?.decision)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://admin.kycert.com.br/api/v1/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.kycert.com.br/api/v1/customers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://admin.kycert.com.br/api/v1/customers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://admin.kycert.com.br/api/v1/customers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
}

GET

api

customers

{id}

cURL

curl "https://admin.kycert.com.br/api/v1/customers/CUSTOMER_ID" \
  -H "x-api-key: $KYCERT_API_KEY"

const res = await fetch(
  `https://admin.kycert.com.br/api/v1/customers/${customerId}`,
  { headers: { 'x-api-key': process.env.KYCERT_API_KEY } },
)
const customer = await res.json()
console.log(customer.name, customer.doc, customer.latest_run?.decision)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://admin.kycert.com.br/api/v1/customers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://admin.kycert.com.br/api/v1/customers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://admin.kycert.com.br/api/v1/customers/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://admin.kycert.com.br/api/v1/customers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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

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

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

Apenas PF

latest_run

object | null

Run de bureau mais recente associado ao cliente

Show child attributes

created_at

string<date-time>

updated_at

string<date-time>

livemode

boolean

Começando

Guias

Webhooks

Referência da API

Buscar cliente

Campo `doc`

Campo `latest_run`

Authorizations

Headers

Path Parameters

Response

​Campo doc

​Campo latest_run

Authorizations

Headers

Path Parameters

Response

Campo `doc`

Campo `latest_run`