Saltar al contenido

Seguir un dossier

GET/v1/dossie/cpf/{id}

Devuelve el estado del dossier (pending, completed o failed) y, una vez concluido, el resultado completo. Solo la cuenta que creó el dossier puede leerlo.

Parámetros

idstringobligatorio
En la ruta. El dossie_id devuelto por POST /v1/dossie/cpf.

Gratuito. El cobro de 100 créditos ocurre una sola vez, cuando el dossier se concluye.

  • Mientras el estado es pending, la respuesta trae solo el avance. Una vez concluido, el resultado queda guardado en su cuenta y puede consultarse en cualquier momento, sin costo adicional.
  • Un dossier inexistente o de otra cuenta responde 404 con el código DOSSIER_NOT_FOUND.
  • Valores de risk_level: HIGH (sancionado en el CEIS, el CNEP o una lista internacional, expulsado de la administración federal, licitante inidóneo en el TCU o en el registro de trabajo esclavo), MEDIUM (PEP, deuda activa desde R$ 50.000, inhabilitado para la función pública, cuentas irregulares o con implicación electoral en el TCU) y LOW (demás casos).

Campos del resultado

data.statusstring
pending, completed o failed.
data.completed_atstring
Cuándo terminó el dossier. Ausente mientras pending.
data.basic_infoobject
Datos cadastrales del titular.
data.basic_info.full_namestring
Nombre del titular.
data.basic_info.cadastral_statusstring | null
Situación cadastral en la Receita Federal (ej.: REGULAR).
data.basic_info.birth_datestring
Fecha de nacimiento, AAAA-MM-DD.
data.compliance_summary.has_sanctionsboolean
true si hay registro en el CEIS, el CNEP, el CEAF, una lista de sanciones internacional o como licitante inidóneo en el TCU.
data.compliance_summary.is_pepboolean
true si la persona es políticamente expuesta.
data.compliance_summary.has_active_debtsboolean
true si hay deuda activa de la Unión (PGFN).
data.compliance_summary.has_possible_matchesboolean
true si alguna fuente devolvió POSSIBLE_MATCH (búsqueda solo por nombre, puede ser un homónimo). Pide verificación y lleva el riesgo a MEDIUM como mínimo.
data.compliance_summary.risk_levelstring
LOW, MEDIUM o HIGH.
data.details.*.statusstring
Resultado de cada fuente: CLEAR (sin registros), MATCH (consta, encontrado por CPF), POSSIBLE_MATCH (la búsqueda fue solo por nombre y puede ser un homónimo, verifique antes de decidir), NOT_APPLICABLE (faltó un dato necesario, como el nombre) y UNAVAILABLE (la fuente falló tras los reintentos; el dossier entonces falla y no se cobra). Solo MATCH eleva el riesgo a HIGH; POSSIBLE_MATCH lo eleva como máximo a MEDIUM.
data.details.pepobject
is_pep y la fuente (CGU).
data.details.ceisobject
found: hay registro en el CEIS.
data.details.slave_laborobject
found: consta en el Registro de Empleadores del MTE (condiciones análogas a la esclavitud). matches trae, por entrada, match (cpf: el CPF del empleador es igual al consultado; name: empresario individual con el mismo nombre, un indicio), state, fiscal_action_year, workers_involved, decision_date e inclusion_date. data_base es la fecha de publicación de la lista (semestral).
data.details.pgfn_active_debtobject
found, total_amount (BRL), records_count y data_base (fecha de la base de la PGFN) de la deuda activa. El cruce es por 6 dígitos del CPF y nombre: es un indicio.
data.details.international_sanctionsobject
Listas de sanciones de OFAC (EE. UU.), ONU y Unión Europea. found, data_base y matches (source, matched_name, program, citizenship). Las listas no tienen CPF: el cruce es por nombre completo exacto y vale como indicio, verifique antes de concluir.
data.details.cnepobject
found: hay registro en el CNEP (Registro Nacional de Empresas Sancionadas), por CPF completo.
data.details.ceafobject
found: consta en el CEAF (Registro de Expulsiones de la Administración Federal). El Portal de la Transparencia publica el CPF parcialmente oculto, por lo que el cruce usa los dígitos visibles y el nombre completo y vale como indicio. matches trae punishment, published_at y agency.
data.details.tcuobject
Listas del Tribunal de Cuentas de la Unión, todas por CPF: unfit_bidder (licitantes inidóneos), disqualified (inhabilitados para la función pública), irregular_accounts (cuentas juzgadas irregulares) y electoral (cuentas irregulares con posible implicación electoral). Cada una tiene found y, si consta, matches con process, decision, final_judgment_date, end_date y uf.
data.errorobject
Solo cuando failed: code (SOURCE_UNAVAILABLE o CPF_NOT_FOUND) y message. No se cobra nada.

cURL

1curl https://api.brazid.com/v1/dossie/cpf/dos_8f9a2b1c4d5e6f70 \2 -H "x-api-key: $BRAZID_API_KEY"

200 OK · completed

1{2 "success": true,3 "data": {4 "dossie_id": "dos_8f9a2b1c4d5e6f70",5 "status": "completed",6 "created_at": "2026-10-28T22:30:00.000Z",7 "completed_at": "2026-10-28T22:30:04.000Z",8 "query": {9 "cpf": "11144477735",10 "description": "Prevenção à lavagem de dinheiro"11 },12 "basic_info": {13 "full_name": "JOAO DA SILVA",14 "cadastral_status": "REGULAR",15 "birth_date": "1985-05-12"16 },17 "compliance_summary": {18 "has_sanctions": false,19 "is_pep": false,20 "has_active_debts": true,21 "has_possible_matches": false,22 "risk_level": "LOW"23 },24 "details": {25 "pep": {26 "is_pep": false,27 "source": "CGU",28 "status": "CLEAR"29 },30 "ceis": {31 "found": false,32 "status": "CLEAR"33 },34 "slave_labor": {35 "found": false,36 "status": "CLEAR"37 },38 "pgfn_active_debt": {39 "found": true,40 "status": "MATCH",41 "total_amount": 12500.5,42 "records_count": 1,43 "data_base": "2026-09-30"44 },45 "international_sanctions": {46 "found": false,47 "status": "CLEAR",48 "matches": [],49 "data_base": "2026-10-28"50 },51 "cnep": {52 "found": false,53 "status": "CLEAR"54 },55 "ceaf": {56 "found": false,57 "status": "CLEAR"58 },59 "tcu": {60 "unfit_bidder": {61 "found": false,62 "status": "CLEAR"63 },64 "disqualified": {65 "found": false,66 "status": "CLEAR"67 },68 "irregular_accounts": {69 "found": false,70 "status": "CLEAR"71 },72 "electoral": {73 "found": false,74 "status": "CLEAR"75 }76 }77 }78 },79 "credits_remaining": 40080}

200 OK · failed

1{2 "success": true,3 "data": {4 "dossie_id": "dos_3c1d9e7a2b4f8a65",5 "status": "failed",6 "created_at": "2026-10-28T22:41:00.000Z",7 "completed_at": "2026-10-28T22:41:06.000Z",8 "query": {9 "cpf": "86288366757",10 "description": "Prevenção à lavagem de dinheiro"11 },12 "error": {13 "code": "SOURCE_UNAVAILABLE",14 "message": "Could not query: pgfn. Nothing was charged. Please submit the dossier again."15 }16 }17}