Obter status de um run
curl --request GET \
--url https://admin.kycert.com.br/api/v1/bureau/runs/{run_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://admin.kycert.com.br/api/v1/bureau/runs/{run_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://admin.kycert.com.br/api/v1/bureau/runs/{run_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/bureau/runs/{run_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/bureau/runs/{run_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))
}HttpResponse<String> response = Unirest.get("https://admin.kycert.com.br/api/v1/bureau/runs/{run_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://admin.kycert.com.br/api/v1/bureau/runs/{run_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{
"run_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "completed",
"decision": "approved",
"operative_decision": null,
"risk_band": "baixo",
"external_id": "cust_abc123",
"metadata": {
"channel": "app_mobile"
},
"created_at": "2026-06-12T14:00:00Z",
"completed_at": "2026-06-12T14:00:18Z",
"livemode": true
}Bureau Runs
Obter status de um run
Retorna o status e resultado de um run específico.
- Run em execução →
202comstatus: running - Run finalizado →
200com decisão completa
GET
/
api
/
v1
/
bureau
/
runs
/
{run_id}
Obter status de um run
curl --request GET \
--url https://admin.kycert.com.br/api/v1/bureau/runs/{run_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://admin.kycert.com.br/api/v1/bureau/runs/{run_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://admin.kycert.com.br/api/v1/bureau/runs/{run_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/bureau/runs/{run_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/bureau/runs/{run_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))
}HttpResponse<String> response = Unirest.get("https://admin.kycert.com.br/api/v1/bureau/runs/{run_id}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://admin.kycert.com.br/api/v1/bureau/runs/{run_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{
"run_id": "550e8400-e29b-41d4-a716-446655440000",
"status": "completed",
"decision": "approved",
"operative_decision": null,
"risk_band": "baixo",
"external_id": "cust_abc123",
"metadata": {
"channel": "app_mobile"
},
"created_at": "2026-06-12T14:00:00Z",
"completed_at": "2026-06-12T14:00:18Z",
"livemode": true
}Authorizations
ApiKeyHeaderBearerToken
API key no header x-api-key (recomendado)
Headers
Example:
"2026-06-03"
Path Parameters
ID do run retornado pelo POST /runs
Response
Run finalizado — resultado disponível
Status atual do run:
- queued / pending / running — em processamento
- completed — finalizado com resultado
- blocked — bloqueado por regra crítica
- pending_review — aguardando análise manual do compliance officer
- partial — resultado parcial (algumas fontes falharam)
- failed — falha técnica — reenvie o run
Available options:
queued, pending, running, completed, blocked, pending_review, partial, failed Decisão do bureau:
- approved — aprovado para prosseguir
- rejected — bloqueado por regra crítica (run com status blocked)
- review — requer análise manual do compliance officer
- null — run ainda em andamento ou com falha técnica
Available options:
approved, rejected, review Decisão operacional — difere de decision apenas quando fontes tier-1 falharam
por erro técnico durante a execução.
Valores possíveis: approved, rejected, hold, null.
- hold — fontes críticas não concluíram; resultado incerto (ver
/analysispara detalhes) - rejected — fonte crítica retornou INVALID com bloqueio
- approved — todas as fontes críticas concluíram sem restrição
Quando operative_decision é null: run_analysis ainda não foi gerado — tratar decision como definitivo.
Available options:
approved, rejected, hold Classificação de risco calculada pelo engine:
- baixo — risco baixo, sem apontamentos relevantes
- medio — risco médio, apontamentos de pendência identificados
- alto — risco alto, apontamentos críticos identificados
- null — run ainda não concluído
Available options:
baixo, medio, alto Nome do template usado neste run
Mensagem human-readable da decisão gerada pelo engine
true quando o run está aguardando revisão manual do compliance officer