Quick Start — primeiro resultado em minutos

​

Pré-requisito: você precisa de

• Uma API key sk_test_... (sandbox)
• Um template ativo no seu tenant
• Uma URL de webhook para receber o resultado

​

Passo 1 — Obter sua API key

1. Acesse Integrações & API → API Keys no dashboard kycert
2. Clique em Nova chave
3. Selecione o escopo runs:write
4. Copie a chave (sk_test_...) imediatamente — ela não é exibida novamente

​

Passo 2 — Obter o template_id

​

Passo 3 — Configurar o endpoint de webhook

​

Passo 4 — Criar o primeiro run

curl -X POST https://admin.kycert.com.br/api/v1/bureau/runs \
  -H "x-api-key: sk_test_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "template_id": "SEU_TEMPLATE_ID",
    "subject": {
      "type": "pf",
      "doc":  "00000000191"
    },
    "webhook_url": "https://webhook.site/SEU_ID"
  }'

{
  "run_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "livemode": false
}

​

Passo 5 — Receber o resultado via webhook

{
  "id": "evt_abc123",
  "event": "run.completed",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "completed",
    "decision": "approved",
    "risk_band": "baixo",
    "subject_type": "pf"
  }
}

​

Passo 6 — Próximos passos

• Autenticação — escopos, versionamento e boas práticas de segurança
• Guia de webhook — validação de assinatura, retry e idempotência
• Sandbox — todos os CPFs e CNPJs de cenário disponíveis