Skip to main content
GET
/
api
/
v1
/
bureau
/
runs
Listar runs
curl --request GET \
  --url https://admin.kycert.com.br/api/v1/bureau/runs \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "run_id": "550e8400-e29b-41d4-a716-446655440000",
      "template_id": "661e9511-f3ac-52e5-b827-557766551111",
      "status": "completed",
      "decision": "approved",
      "risk_band": "baixo",
      "subject_type": "pf",
      "external_id": "cust_abc123",
      "metadata": {
        "channel": "app_mobile"
      },
      "created_at": "2026-06-12T14:00:00Z",
      "completed_at": "2026-06-12T14:00:18Z"
    }
  ],
  "has_more": false,
  "livemode": true
}

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

​
template_id
string<uuid>

Filtrar por template

​
status
enum<string>

Filtrar por status

Available options:
queued,
pending,
running,
completed,
blocked,
pending_review,
partial,
failed
​
external_id
string

Filtrar pelo seu identificador interno

​
created_after
string<date-time>

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

​
created_before
string<date-time>

Retornar apenas runs criados antes desta data (ISO 8601)

​
limit
integer
default:20

Número máximo de runs 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 runs

​
data
object[]
​
has_more
boolean
​
next_cursor
string | null

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

​
livemode
boolean