Acompanhar um dossiê
GET/v1/dossie/cpf/{id}
Devolve o estado do dossiê (pending, completed ou failed) e, quando concluído, o resultado completo. Só a conta que criou o dossiê consegue ler.
Parâmetros
- idstringobrigatório
- No caminho. O
dossie_iddevolvido peloPOST /v1/dossie/cpf.
Gratuito. A cobrança de 100 créditos acontece uma única vez, quando o dossiê é concluído.
- Enquanto o status é
pending, a resposta traz apenas o andamento. Depois de concluído, o resultado fica guardado na sua conta e pode ser consultado a qualquer momento, sem novo custo. - Dossiê inexistente ou de outra conta responde 404 com o código
DOSSIER_NOT_FOUND. - Os valores de
risk_level:HIGH(sancionado no CEIS, CNEP ou em lista internacional, expulso da administração federal, licitante inidôneo no TCU ou no cadastro de trabalho escravo),MEDIUM(PEP, dívida ativa a partir de R$ 50.000, inabilitado para função pública, contas julgadas irregulares ou com implicação eleitoral no TCU) eLOW(demais casos).
Campos do resultado
- data.statusstring
pending,completedoufailed.- data.completed_atstring
- Quando o dossiê terminou. Ausente enquanto
pending. - data.basic_infoobject
- Dados cadastrais do titular.
- data.basic_info.full_namestring
- Nome do titular.
- data.basic_info.cadastral_statusstring | null
- Situação cadastral na Receita Federal (ex.: REGULAR).
- data.basic_info.birth_datestring
- Data de nascimento,
AAAA-MM-DD. - data.compliance_summary.has_sanctionsboolean
truese houver registro no CEIS, no CNEP, no CEAF, em lista de sanções internacional ou como licitante inidôneo no TCU.- data.compliance_summary.is_pepboolean
truese a pessoa for politicamente exposta.- data.compliance_summary.has_active_debtsboolean
truese houver dívida ativa da União (PGFN).- data.compliance_summary.has_possible_matchesboolean
truese alguma fonte devolveuPOSSIBLE_MATCH(busca só por nome, pode ser um homônimo). Pede conferência e leva o risco a, no mínimo,MEDIUM.- data.compliance_summary.risk_levelstring
LOW,MEDIUMouHIGH.- data.details.*.statusstring
- Resultado de cada fonte:
CLEAR(nada consta),MATCH(consta, encontrado pelo CPF),POSSIBLE_MATCH(possível correspondência: a busca foi só por nome e pode ser um homônimo, confira antes de decidir),NOT_APPLICABLE(faltou um dado necessário, como o nome do titular) eUNAVAILABLE(a fonte falhou depois das tentativas; o dossiê então falha e não é cobrado). SóMATCHeleva o risco aHIGH;POSSIBLE_MATCHeleva no máximo aMEDIUM. - data.details.pepobject
is_pepe a fonte (CGU).- data.details.ceisobject
found: há registro no CEIS.- data.details.slave_laborobject
found: consta no Cadastro de Empregadores do MTE (trabalho análogo ao de escravo).matchestraz, para cada entrada,match(cpf: CPF do empregador igual ao consultado;name: empresário individual com o mesmo nome, indício),state,fiscal_action_year,workers_involved,decision_dateeinclusion_date.data_baseé a data da publicação da lista (semestral).- data.details.pgfn_active_debtobject
found,total_amount(R$),records_countedata_base(data da base da PGFN) da dívida ativa. O cruzamento é por 6 dígitos do CPF e nome: é um indício.- data.details.international_sanctionsobject
- Listas de sanções da OFAC (EUA), ONU e União Europeia.
found,data_baseematches(source,matched_name,program,citizenship). As listas não têm CPF: o cruzamento é pelo nome completo exato e vale como indício, confira antes de concluir. - data.details.cnepobject
found: há registro no CNEP (Cadastro Nacional de Empresas Punidas), pelo CPF completo.- data.details.ceafobject
found: consta no CEAF (Cadastro de Expulsões da Administração Federal). O Portal da Transparência publica o CPF parcialmente oculto, então o cruzamento usa os dígitos visíveis e o nome completo e vale como indício.matchestrazpunishment,published_ateagency.- data.details.tcuobject
- Listas do Tribunal de Contas da União, todas pelo CPF:
unfit_bidder(licitantes inidôneos),disqualified(inabilitados para função pública),irregular_accounts(contas julgadas irregulares) eelectoral(contas irregulares com possível implicação eleitoral). Cada uma temfounde, quando consta,matchescomprocess,decision,final_judgment_date,end_dateeuf. - data.errorobject
- Só quando
failed:code(SOURCE_UNAVAILABLEouCPF_NOT_FOUND) emessage. Nada é cobrado.
cURL
1curl https://api.brazid.com/v1/dossie/cpf/dos_8f9a2b1c4d5e6f70 \2 -H "x-api-key: $BRAZID_API_KEY"
1const res = await fetch('https://api.brazid.com/v1/dossie/cpf/dos_8f9a2b1c4d5e6f70', {2 headers: { 'x-api-key': process.env.BRAZID_API_KEY },3});4 5const data = await res.json();6console.log(res.status, data);
1import os2import requests3 4res = requests.get(5 "https://api.brazid.com/v1/dossie/cpf/dos_8f9a2b1c4d5e6f70",6 headers={"x-api-key": os.environ["BRAZID_API_KEY"]},7)8 9print(res.status_code, res.json())
1$ch = curl_init("https://api.brazid.com/v1/dossie/cpf/dos_8f9a2b1c4d5e6f70");2curl_setopt_array($ch, [3 CURLOPT_RETURNTRANSFER => true,4 CURLOPT_HTTPHEADER => ["x-api-key: " . getenv("BRAZID_API_KEY")],5]);6 7$data = json_decode(curl_exec($ch), true);8$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
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}