--- title: "Dossiê Completo de Servidor Federal" description: "API Dossiê Completo de Servidor Federal" lang: pt-BR canonical: https://doc.apibrasil.io/apis/creditos/908fa79f-9af5-4dce-90c8-f83a416bbd5c markdown: https://doc.apibrasil.io/apis/creditos/908fa79f-9af5-4dce-90c8-f83a416bbd5c.md source: apibrasil-documentation --- # Dossiê Completo de Servidor Federal > API Dossiê Completo de Servidor Federal - **Categoria:** Antifraude e Compliance - **Cobrança:** por consulta, só com o Bearer Token - **Preço:** R$ 5,05 por consulta - **Limite:** 990.000 por mês - **Cadastro:** exige CNPJ - **Versão:** v2 - **Publicada por:** APIBrasil - **Especificação OpenAPI:** https://doc.apibrasil.io/apis/creditos/908fa79f-9af5-4dce-90c8-f83a416bbd5c/openapi.json ## Como chamar **Endereço base:** `https://gateway.apibrasil.io/api/v2` Autenticação: cabeçalho `Authorization: Bearer `. Nada além disso. Com `homolog: true` no corpo, o gateway responde de uma base fixa, com a forma real da resposta, e não cobra. O CPF 00000000000 é dessa base e não é de ninguém: use-o nos testes, nunca em produção. ## Endpoints (1 endpoint) ### 1. POST /consulta/cpf/credits Envie um POST com tipo=transparencia-servidores-completa e o cpf (11 dígitos, com ou sem máscara; o dígito verificador é conferido). A resposta vem em data.dados e traz documento, nome, uf, situacao (consta ou nada_consta), possui_registros, observacoes, totais (vinculos_vigentes, remuneracoes e historico_vinculos), vinculos_vigentes, remuneracoes (mensais, com deduções e verbas indenizatórias), historico_vinculos, resumo (alerta) e o link pdf do relatório. A cobrança acontece quando o CPF é consultado e a resposta é HTTP 200, inclusive com situação nada_consta (CPF sem registro de servidor federal, que é o resultado da triagem de PEP); retorno vazio ou não localizado responde HTTP 404, sem cobrança; campo cpf ausente ou inválido é recusado com HTTP 400, sem cobrança. Fonte indisponível responde HTTP 502, 503 ou 504, também sem cobrança. Em homologação (homolog=true) a resposta é uma amostra fictícia completa, sem cobrança, para qualquer cpf válido. - **Método:** `POST` - **Endereço:** `https://gateway.apibrasil.io/api/v2/consulta/cpf/credits` - **Versão da rota:** v2 **Cabeçalhos** | Cabeçalho | Valor | | --- | --- | | `Content-Type` | `application/json` | | `Authorization` | `Bearer $APIBRASIL_TOKEN` | **Corpo da requisição** ```json { "tipo": "transparencia-servidores-completa", "cpf": "12345678909", "homolog": true } ``` **Em cURL** ```bash curl -X POST "https://gateway.apibrasil.io/api/v2/consulta/cpf/credits" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $APIBRASIL_TOKEN" \ -d '{"tipo":"transparencia-servidores-completa","cpf":"12345678909","homolog":true}' ``` Este endpoint aceita `homolog: true` no corpo: a resposta volta com dados válidos, `api_limit_for` igual a `homolog` e sem tarifação. **Resposta de exemplo, do catálogo** ```json { "user": { "first_name": "[omitido]", "email": "[omitido]", "cellphone": "[omitido]", "notification": "yes" }, "balance": "394,950", "balance_before": "400,000", "tax": "5,050", "status_code": 200, "error": false, "message": "Dados validos! Voce foi tarifado em R$ 5,05.", "valor_consulta": 5.05, "api_limit_for": "credit", "homolog": false, "data": { "dados": { "documento": "123.456.789-09", "historico_vinculos": [ { "cargo": "ANALISTA DE TESTE", "data_inicio": "01/02/2020", "data_termino": null, "local_exercicio": "BRASILIA", "orgao_lotacao": "ORGAO DE TESTE", "tipo_vinculo": "Servidor" } ], "nome": "FULANO DE TESTE", "observacoes": "Amostra de homologação.", "pdf": "(link do PDF da consulta)", "possui_registros": true, "remuneracoes": [ { "abate_teto_gratificacao_natalina": 0, "abate_teto_remuneracao_basica": 0, "ferias": 0, "fundo_saude": 0, "gratificacao_natalina": 0, "honorarios_advocaticios": [], "imposto_retido_na_fonte": 1500, "mes_ano": "10/2026", "observacoes": [ "Valores fictícios." ], "outras_deducoes_obrigatorias": 0, "outras_remuneracoes_eventuais": 0, "pensao_militar": 0, "previdencia_oficial": 1100, "remuneracao_basica_bruta": 10000, "taxa_ocupacao_imovel_funcional": 0, "tipo_ficha": "Ficha de teste", "total_apos_deducoes": 7400, "total_honorarios_advocaticios": 0, "total_verbas_indenizatorias": 500, "verbas_indenizatorias": [ { "descricao": "AUXILIO DE TESTE", "valor": 500 } ] } ], "resumo": { "alerta": "Há registro na base de servidores do Poder Executivo Federal para o CPF informado: 1 vínculo(s) vigente(s) e 1 no histórico." }, "situacao": "consta", "totais": { "historico_vinculos": 1, "remuneracoes": 1, "vinculos_vigentes": 1 }, "uf": "DF", "vinculos_vigentes": [ { "afastado": false, "ato_nomeacao_contratacao": "PORTARIA 1/2020", "cargo": "ANALISTA DE TESTE", "classe_cargo": "A", "cpf_instituidor": null, "cpf_representante_legal": null, "data_ingresso_cargo": "01/02/2020", "data_ingresso_orgao_lotacao": "01/02/2020", "data_ingresso_servico_publico": "01/02/2020", "data_inicio_pensao": null, "data_publicacao_documento_ingresso": "15/01/2020", "data_reforma_reserva": null, "exercicio": { "orgao": "ORGAO DE TESTE", "orgao_superior": "MINISTERIO DE TESTE", "uf": "DF", "unidade_organizacional": "UNIDADE DE TESTE" }, "forma_ingresso": "CONCURSO PUBLICO", "funcao": null, "jornada_trabalho": "40 HORAS SEMANAIS", "local_trabalho": "BRASILIA", "lotacao": { "orgao": "ORGAO DE TESTE", "orgao_superior": "MINISTERIO DE TESTE", "uf": "DF", "unidade_organizacional": "UNIDADE DE TESTE" }, "matricula": "0000001", "nivel_cargo": "SUPERIOR", "nome_instituidor": null, "nome_representante_legal": null, "padrao_cargo": "I", "proporcao_pensao": null, "regime_juridico": "REGIME JURIDICO UNICO", "situacao_vinculo": "ATIVO PERMANENTE", "tipo_pensao": null, "tipo_reforma_reserva": null, "tipo_vinculo": "Servidor" } ] } } } ``` Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica. ## Armadilhas: o que uma integração erra sem avisar Apuradas nas respostas que o próprio catálogo publica. Em todas elas o código funciona no caminho feliz e falha em silêncio no resto: 1. **O erro chega no CORPO, com HTTP 200.** A resposta traz um campo `error` booleano e uma `message`. Checar só `response.ok` ou o status HTTP deixa passar falha como sucesso. Confira SEMPRE `error === false` antes de ler `data`. 2. **`balance`, `tax` e `extra_charges.total` são STRING em formato brasileiro — e o formato varia entre APIs.** Valores observados no catálogo: `"154,380"`, `"497,84"`, `"0,000"` e `"0.19"`. Vírgula em umas, ponto em outra; três casas decimais em umas, duas em outra. Em JavaScript, `parseFloat("154,380")` devolve `154` e perde os centavos sem erro nenhum, e `Number("154,380")` devolve `NaN`. Escreva um conversor que trate os dois separadores, e nunca use esses campos numa decisão financeira sem convertê-los. 3. **Cada chamada custa dinheiro.** Retry cego multiplica a conta. Nunca repita automaticamente um 4xx: parâmetro errado repetido continua errado e continua cobrando. Repita só tempo esgotado e 5xx, com recuo exponencial e um teto pequeno de tentativas. 4. **HTTP 402 é saldo insuficiente, e repetir não resolve.** É o único status que exige ação humana — recarregar. Trate-o como erro terminal, com mensagem própria, e não o jogue no mesmo balde dos 4xx genéricos. 5. **`extra_charges` cobra à parte do preço da consulta.** Quando o corpo pede serviços adicionais, a resposta traz cada um com o preço e um `total` que NÃO está incluso no valor base. Se você mostra custo a quem usa, some os dois. ## Ver também - Especificação OpenAPI: https://doc.apibrasil.io/apis/creditos/908fa79f-9af5-4dce-90c8-f83a416bbd5c/openapi.json - Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md) - SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md) - Índice da documentação: https://doc.apibrasil.io/llms.txt - Versão HTML desta página: https://doc.apibrasil.io/apis/creditos/908fa79f-9af5-4dce-90c8-f83a416bbd5c