Background Check PF
Este endpoint monta um dossiê completo de uma pessoa física a partir do CPF. É a resposta mais extensa da API: identificação, endereços, telefones, participações societárias, histórico de emprego, situação fiscal, sanções administrativas, exposição política, processos judiciais e histórico criminal, num único corpo.
Para uma consulta enxuta de identificação — nome, nome da mãe e data de nascimento — use o Bureau PF, que é bem mais barato e rápido.
🚧 O corpo é repassado do provedor, sem transformação
Diferente dos outros endpoints de dados, aqui a API não remonta a resposta: o que o provedor devolve é entregue como está, dentro do envelope padrão. Três consequências práticas:
- Os nomes dos campos estão em português, no vocabulário do provedor (
nome,situacaoCpf,nomeMae), e não nocamelCaseem inglês do resto da API. - Todo bloco é opcional. Um bloco só aparece quando o provedor tem dado para ele. Nunca assuma que uma chave existe: teste antes de acessar.
- Não há garantia de tipo. Como não há conversão no caminho, o mesmo campo pode chegar como número ou como texto conforme a origem do dado. Por isso as tabelas desta página descrevem os campos, mas não fixam tipos.
Request
GET/background-check/v2/natural-person/{CPF}Parâmetros
| Parâmetro | Descrição | Obrigatório |
|---|---|---|
| CPF | CPF da pessoa consultada | Sim |
O CPF pode ser enviado com ou sem máscara (123.456.789-09 ou 12345678909), sempre com os 11 dígitos, incluindo os zeros à esquerda. Um CPF que não passa na validação do dígito verificador devolve 422 antes de qualquer consulta.
Headers
Authorization: ApiKey <sua-chave-de-api>Parâmetros de query são ignorados
Este endpoint não usa parâmetros de query. Um parâmetro desconhecido na URL não gera erro: ele é simplesmente ignorado, e a resposta vem 200 normalmente.
Exemplo Request
curl -i 'https://api.nxcd.app/background-check/v2/natural-person/12345678909' \
--header 'Authorization: ApiKey SUA_CHAVE_AQUI'Response
O envelope é o padrão da API:
| Campo | Descrição | Tipo |
|---|---|---|
| id | Identificador único da requisição | String |
| version | Versão da API que atendeu a chamada | String |
| data | O dossiê. Vem vazio ({}) quando o CPF não é encontrado. | Object |
| metadata | Metadados da requisição | Object |
| metadata.timeSpent | Tempo de processamento da requisição, em milissegundos | Number |
O data é montado com os blocos abaixo. Nenhum deles é garantido — cada um aparece só quando há dado.
| Bloco | O que traz |
|---|---|
| Identificação | Nome, CPF, situação cadastral, filiação, sexo, idade |
| Óbito | Indicadores de falecimento |
| Outros registros | CNS, NIS e PIS |
| Contato e endereços | E-mail, telefones, endereço atual e demais endereços |
| Participação societária | Empresas em que a pessoa figura como sócia |
| Histórico de emprego | Vínculos empregatícios e endereço do emprego |
| Situação fiscal | Restituição de IRPF e dívidas inscritas na PGFN/DAU |
| Sanções e listas restritivas | CEIS, CNEP, Banco Central, MTE |
| Pessoa politicamente exposta | Enquadramento como PEP e relações de primeiro grau |
| Processos judiciais | Totalizadores por tipo e processos do CNJ/CNIA |
| Histórico criminal | Certidão da Polícia Federal e mandados em aberto |
_metadata | Data e fonte de cada bloco |
Identificação
| Campo | Descrição |
|---|---|
nome | Nome completo da pessoa |
cpf | CPF consultado |
situacaoCpf | Situação cadastral do CPF na Receita Federal, por exemplo REGULAR |
cpfDataInscricao | Data de inscrição do CPF |
idade | Idade da pessoa |
dataNascimento | Data de nascimento |
sexo | Sexo, por exemplo FEMININO |
nomeMae | Nome da mãe |
cpfMae | CPF da mãe |
tags | Marcadores atribuídos ao registro pelo provedor |
{
"nome": "MARIA JOAQUINA DE SOUZA",
"cpf": "12345678909",
"situacaoCpf": "REGULAR",
"cpfDataInscricao": "2001-12-20",
"idade": 34,
"dataNascimento": "1991-01-01T12:00:00Z",
"sexo": "FEMININO",
"nomeMae": "ANA MARIA DE SOUZA",
"cpfMae": "98765432100"
}Óbito
| Campo | Descrição |
|---|---|
falecido | Indica registro de falecimento |
falecidoConfirmado | Indica que o falecimento foi confirmado — é o campo mais forte dos dois |
anoFalecimento | Ano do falecimento |
{
"falecido": false,
"falecidoConfirmado": false
}Outros registros
| Campo | Descrição |
|---|---|
cns | Cartão Nacional de Saúde |
nis | Número de Identificação Social |
pis | Programa de Integração Social |
Contato e endereços
endereco é o endereço principal. enderecoOutros é uma lista com os demais endereços conhecidos, e cada item tem os mesmos campos do principal. telefones é uma lista, e cada telefone pode vir com o endereço associado a ele.
| Campo | Descrição |
|---|---|
email | |
endereco.logradouro | Logradouro |
endereco.numero | Número |
endereco.complemento | Complemento |
endereco.bairro | Bairro |
endereco.municipio | Município |
endereco.uf | Unidade federativa |
endereco.cep | CEP |
enderecoOutros[] | Demais endereços, com os mesmos oito campos de endereco |
telefones[].numero | Número do telefone |
telefones[].endereco | Endereço associado ao telefone, com os mesmos campos de endereco |
{
"endereco": {
"logradouro": "R SAO BENTO",
"numero": "1010",
"bairro": "CENTRO",
"municipio": "SAO PAULO",
"uf": "SP",
"cep": "01010000"
},
"enderecoOutros": [{ "uf": "SP" }],
"telefones": [
{
"numero": "1155554444",
"endereco": { "uf": "SP" }
}
]
}Participação societária
São três listas distintas, com os mesmos quinze campos cada. Elas se diferenciam pela fonte do dado, não pelo formato:
| Bloco | O que é |
|---|---|
participacaoSocietariaRF[] | Participações conforme o quadro societário da Receita Federal |
participacaoSocietaria[] | Participações consolidadas pelo provedor |
participacaoSocietariaUnico[] | Terceira visão de participações mantida pelo provedor |
Campos de cada item, nas três listas:
| Campo | Descrição |
|---|---|
cnpj | CNPJ da empresa |
razaoSocial | Razão social da empresa |
descricaoCnae | Descrição do CNAE da empresa |
ramoAtividade | Ramo de atividade |
dataAbertura | Data de abertura da empresa |
municipio | Município da empresa |
uf | Unidade federativa da empresa |
situacao | Situação cadastral da empresa |
dataEntrada | Data de entrada da pessoa no quadro societário |
qualificacao | Qualificação do sócio, por exemplo SOCIO ADMINISTRADOR |
valorParticipacao | Valor da participação |
capitalSocialEmpresa | Capital social da empresa |
participacaoCapitalSocial | Participação da pessoa no capital social |
faixaFaturamentoPresumido | Faixa de faturamento presumido da empresa |
faixaFaturamentoPresumidoGrupo | Faixa de faturamento presumido do grupo econômico da empresa |
Histórico de emprego
| Campo | Descrição |
|---|---|
historicoFuncional[].cnpj | CNPJ do empregador |
historicoFuncional[].razaoSocial | Razão social do empregador |
historicoFuncional[].dataAdmissao | Data de admissão |
historicoFuncional[].dataDesligamento | Data de desligamento |
historicoFuncional[].numeroMesesEmpresa | Tempo de casa, em meses |
enderecoEmpregoRaisNovo.numero | Número do endereço do emprego, conforme a RAIS |
enderecoEmpregoRaisNovo.bairro | Bairro |
enderecoEmpregoRaisNovo.municipio | Município |
enderecoEmpregoRaisNovo.uf | Unidade federativa |
enderecoEmpregoRaisNovo.cep | CEP |
enderecoEmpregoRaisNovo.precisaoGeo | Precisão da geolocalização do endereço |
enderecoEmpregoRaisNovo.EnderecoResidencial | Indica se o endereço é residencial |
enderecoEmpregoRaisNovo.telefone | Telefone do endereço do emprego |
🚧 EnderecoResidencial começa com letra maiúscula
Dentro de enderecoEmpregoRaisNovo, o campo é EnderecoResidencial, com E maiúsculo — diferente de todos os campos vizinhos. É assim que ele chega, e a API não corrige. No bloco de empresa equivalente, o mesmo dado se chama enderecoResidencial, minúsculo.
Situação fiscal
| Campo | Descrição |
|---|---|
irpf.ano | Ano do exercício |
irpf.situacao | Situação da restituição |
irpf.banco | Banco de crédito da restituição |
irpf.agencia | Agência de crédito da restituição |
irpf.lote | Lote da restituição |
irpf.dataDisponibilidade | Data em que a restituição ficou disponível |
irpfRestituicao.exercicios[].anoExercicio | Ano do exercício |
irpfRestituicao.exercicios[].situacao | Situação da restituição naquele exercício |
irpfRestituicao.exercicios[].nomeBanco | Banco de crédito |
irpfRestituicao.exercicios[].numAgencia | Agência de crédito |
irpfRestituicao.exercicios[].numLote | Lote |
irpfRestituicao.exercicios[].dataDisponibilidade | Data de disponibilidade |
debitosPgfnDau[].inscricao | Número da inscrição em dívida ativa da União |
debitosPgfnDau[].natureza | Natureza do débito |
debitosPgfnDau[].valorTotal | Valor total do débito |
debitosPgfnDau[].dataProcessamento | Data de processamento |
irpf e irpfRestituicao cobrem o mesmo assunto
Os dois trazem a restituição de imposto de renda, com nomes de campo diferentes: irpf traz um exercício, e irpfRestituicao.exercicios[] traz a lista. Leia os dois — qual deles vem preenchido depende do que o provedor tem para o CPF.
Sanções e listas restritivas
São blocos independentes, um por cadastro de origem. Cada um aparece só quando há registro.
ceis e pessoaCeis — Cadastro de Empresas Inidôneas e Suspensas. Dois recortes do mesmo cadastro, com formatos diferentes: ceis é a sanção em campos planos, pessoaCeis agrupa as sanções numa lista e traz o indicador possuiCeis.
| Campo | Descrição |
|---|---|
ceis.codigoProcesso | Código do processo |
ceis.tipoSancao | Tipo da sanção |
ceis.dataInicioSancao | Início da sanção |
ceis.dataFimSancao | Fim da sanção |
ceis.fundamentacaoLegal | Fundamentação legal |
ceis.orgaoSancionador | Órgão que aplicou a sanção |
ceis.ufOrgaoSancionador | UF do órgão sancionador |
ceis.origemInformacoes | Origem da informação |
ceis.dataOrigemInformacoes | Data da origem da informação |
pessoaCeis.possuiCeis | Indica se há registro no CEIS |
pessoaCeis.sancoes[].processo | Número do processo |
pessoaCeis.sancoes[].tipoSancao | Tipo da sanção |
pessoaCeis.sancoes[].periodoSancao.inicio | Início do período da sanção |
pessoaCeis.sancoes[].periodoSancao.final | Fim do período da sanção |
pessoaCeis.sancoes[].fundamentacaoLegal | Fundamentação legal |
pessoaCeis.sancoes[].orgaoSancionador | Órgão que aplicou a sanção |
pessoaCeis.sancoes[].complementoOrgao | Complemento do órgão sancionador |
pessoaCeis.sancoes[].uf | UF |
pessoaCeis.sancoes[].origemInformacao | Origem da informação |
pessoaCeis.sancoes[].dataInformacao | Data da informação |
cnep — Cadastro Nacional de Empresas Punidas.
| Campo | Descrição |
|---|---|
cnep.processos[].numeroProcesso | Número do processo |
cnep.processos[].tipoSancao | Tipo da sanção |
cnep.processos[].valorMulta | Valor da multa |
cnep.processos[].dataInicioSancao | Início da sanção |
cnep.processos[].dataFinalSancao | Fim da sanção |
cnep.processos[].orgaoSancionador | Órgão que aplicou a sanção |
cnep.processos[].ufOrgaoSancionador | UF do órgão sancionador |
bancoCentral — inabilitações e acórdãos do Banco Central.
| Campo | Descrição |
|---|---|
bancoCentral.inabilitados[].penalidade | Penalidade aplicada |
bancoCentral.inabilitados[].prazo | Prazo da penalidade |
bancoCentral.inabilitados[].dataPublicacao | Data de publicação |
bancoCentral.inabilitados[].dataPrazoFinalPenalidade | Data final da penalidade |
bancoCentral.acordaos[].numeroRecurso | Número do recurso |
bancoCentral.acordaos[].numeroProcesso | Número do processo |
bancoCentral.acordaos[].numeroAcordaoCRSFN | Número do acórdão no CRSFN |
bancoCentral.acordaos[].recurso | Identificação do recurso |
bancoCentral.acordaos[].parte | Parte envolvida no acórdão |
Na PF há um bloco de inabilitados a mais
No Background Check PJ, bancoCentral traz só acordaos[]. Aqui há também inabilitados[].
mteCnd e mteTrabalhoEscravo — Ministério do Trabalho. mteCnd é a certidão de débitos trabalhistas; mteTrabalhoEscravo é o cadastro de empregadores flagrados em trabalho análogo à escravidão.
| Campo | Descrição |
|---|---|
mteCnd.tipoCertidao | Tipo da certidão |
mteCnd.codigo | Código da certidão |
mteCnd.dataEmissao | Data de emissão |
mteCnd.processos[].numero | Número do processo |
mteCnd.processos[].situacaoProcesso | Situação do processo |
mteCnd.processos[].categoriaInfracao | Categoria da infração |
mteCnd.processos[].capitulacaoInfracao | Capitulação legal da infração |
mteTrabalhoEscravo.estabelecimentos[].anoAcaoFiscal | Ano da ação fiscal |
mteTrabalhoEscravo.estabelecimentos[].dataDecisaoProcedencia | Data da decisão de procedência |
mteTrabalhoEscravo.estabelecimentos[].numeroTrabalhadoresEnvolvidos | Trabalhadores envolvidos |
mteTrabalhoEscravo.estabelecimentos[].estabelecimento | Endereço do estabelecimento, com logradouro, complemento, municipio e uf |
mteCnd.situacaoDebito existe só na PJ; aqui o bloco mteCnd não traz esse campo. Veja o Background Check PJ.
Pessoa politicamente exposta
| Campo | Descrição |
|---|---|
pessoaPoliticamenteExposta.funcao | Função exercida |
pessoaPoliticamenteExposta.orgao | Órgão |
pessoaPoliticamenteExposta.dataInicioExercicio | Início do exercício |
pessoaPoliticamenteExposta.dataFimExercicio | Fim do exercício |
pessoaPoliticamenteExposta.dataFimCarencia | Fim do período de carência após deixar a função |
pessoaPoliticamenteExposta.pessoaPEPNivelPrincipal | Enquadramento da pessoa no nível principal de PEP |
pessoaPoliticamenteExposta.primarios[].nome | Nome da pessoa PEP relacionada |
pessoaPoliticamenteExposta.primarios[].cpf | CPF da pessoa PEP relacionada |
pessoaPoliticamenteExposta.primarios[].funcao | Função da pessoa PEP relacionada |
pessoaPoliticamenteExposta.primarios[].relacao | Tipo de relação com a pessoa consultada |
pessoaPoliticamenteExposta.primarios[].dataInicioExercicio | Início do exercício da pessoa relacionada |
pessoaPoliticamenteExposta.primarios[].dataFimCarencia | Fim da carência da pessoa relacionada |
A lista primarios é sobre outras pessoas
Os campos na raiz de pessoaPoliticamenteExposta descrevem a pessoa consultada. Já primarios[] traz as pessoas de relação primária que são PEP — é por ela que se identifica quem é PEP por relacionamento, e não por exercer a função.
Processos judiciais
processoJudicialTotalizadores.quantidades[] traz uma linha por tipo de processo, com as contagens daquele tipo. O tipo assume valores como NUMERO DE PROCESSOS (o total geral), CRIMINAL, TRIBUTARIO, TRABALHISTA, ELEITORAL, MILITAR e CIVEL / ADMINISTRATIVO.
| Campo | Descrição |
|---|---|
processoJudicialTotalizadores.quantidades[].tipo | Tipo de processo a que as contagens se referem |
processoJudicialTotalizadores.quantidades[].qtdTotal | Total de processos daquele tipo |
processoJudicialTotalizadores.quantidades[].qtdAtivos | Processos ainda em andamento |
processoJudicialTotalizadores.quantidades[].qtdParteAtiva | Processos em que a pessoa é o polo ativo |
processoJudicialTotalizadores.quantidades[].qtdPartePassiva | Processos em que a pessoa é o polo passivo |
processoJudicialTotalizadores.quantidades[].qtdOutrasPartes | Processos em que a pessoa figura em outra posição |
cnjCnia.processos[].numeroProcesso | Número do processo no CNJ/CNIA |
cnjCnia.processos[].dataCadastramento | Data de cadastramento |
cnjCnia.processos[].esfera | Esfera do processo |
cnjCnia.processos[].descricaoOrgao | Órgão julgador |
cnjCnia.processos[].cargoFuncao.uf | UF do cargo ou função relacionada ao processo |
cnjCnia.processos[].assuntosRelacionados | Assuntos relacionados ao processo |
cnjCnia.processos[].ressarcimentoIntegralDano.valor | Valor de ressarcimento integral do dano |
{
"processoJudicialTotalizadores": {
"quantidades": [
{ "tipo": "NUMERO DE PROCESSOS", "qtdTotal": 65, "qtdAtivos": 4, "qtdParteAtiva": 27, "qtdPartePassiva": 3, "qtdOutrasPartes": 35 },
{ "tipo": "CRIMINAL", "qtdTotal": 21, "qtdAtivos": 1, "qtdParteAtiva": 10, "qtdPartePassiva": 1, "qtdOutrasPartes": 10 },
{ "tipo": "TRIBUTARIO", "qtdTotal": 0, "qtdAtivos": 0, "qtdParteAtiva": 0, "qtdPartePassiva": 0, "qtdOutrasPartes": 0 },
{ "tipo": "CIVEL / ADMINISTRATIVO", "qtdTotal": 44, "qtdAtivos": 3, "qtdParteAtiva": 17, "qtdPartePassiva": 2, "qtdOutrasPartes": 25 }
]
}
}Histórico criminal
Traz a consulta ao Sistema Nacional de Informações Criminais (SINIC) e os mandados de prisão em aberto.
| Campo | Descrição |
|---|---|
historicoCriminal.status | Resultado da consulta, por exemplo CERTIDAO EMITIDA |
historicoCriminal.situacao | Texto da certidão emitida pela Polícia Federal |
historicoCriminal.protocolo | Protocolo da consulta |
historicoCriminal.dataConsulta | Data em que a consulta foi feita |
historicoCriminal.possuiMandados | Indica se há mandados em aberto |
historicoCriminal.mandados[].numeroMandado | Número do mandado |
historicoCriminal.mandados[].numeroProcesso | Número do processo do mandado |
historicoCriminal.mandados[].situacaoMandado | Situação do mandado |
historicoCriminal.mandados[].classe | Classe do mandado |
historicoCriminal.mandados[].dataMandado | Data de expedição |
historicoCriminal.mandados[].dataValidade | Data de validade |
{
"historicoCriminal": {
"status": "CERTIDAO EMITIDA",
"situacao": "A POLICIA FEDERAL CERTIFICA APOS PESQUISA NO SISTEMA NACIONAL DE INFORMACOES CRIMINAIS SINIC QUE ATE A PRESENTE DATA NAO CONSTA DECISAO JUDICIAL CONDENATORIA COM TRANSITO EM JULGADO",
"protocolo": "25467342019",
"dataConsulta": "2025-04-23T21:01:12"
}
}_metadata
Fora do metadata do envelope, o próprio data traz um _metadata com a procedência de cada bloco: quando o dado foi coletado, de que fonte veio, e se a busca não encontrou nada.
As chaves de _metadata são os nomes internos das fontes (pessoas, pessoa-ceis, pessoa-cnep, pessoa-banco-central, pessoa-historico-criminal, pessoa-mte-trabalho-escravo…), e variam com os blocos que vieram preenchidos. Cada uma traz alguns destes campos:
| Campo | Descrição |
|---|---|
noMatchFound | true quando a fonte foi consultada e não encontrou registro |
source | Lista com as fontes de origem do dado |
processingTimestamp | Quando a fonte processou o dado |
lastUpdate | Última atualização do dado na base do provedor |
insertDate | Quando o dado entrou na base do provedor |
updatedAt | Quando o registro foi atualizado pela última vez |
noMatchFound é a diferença entre "não tem" e "não foi consultado"
Um bloco ausente do data pode significar duas coisas. Se a fonte correspondente aparece em _metadata com noMatchFound: true, a consulta foi feita e nada foi encontrado — um resultado limpo. Se a fonte não aparece em _metadata, não há essa garantia.
{
"_metadata": {
"pessoas": {
"_metadata": {
"pessoas": {
"processingTimestamp": "2025-05-07T07:07:11Z",
"source": ["RECEITA FEDERAL"]
}
},
"lastUpdate": "2025-10-05T08:44:10.434Z",
"updatedAt": "2025-10-05T10:33:04.887Z"
},
"pessoa-ceis": { "noMatchFound": true },
"pessoa-cnep": { "noMatchFound": true },
"pessoa-banco-central": { "noMatchFound": true },
"pessoa-mte-trabalho-escravo": { "noMatchFound": true },
"pessoa-historico-criminal": {
"insertDate": "2025-04-23T21:01:13.057Z",
"lastUpdate": "2025-04-23T21:01:13Z",
"processingTimestamp": "2025-04-23T21:01:12Z",
"source": ["cac-dpf"],
"updatedAt": "2025-04-23T21:01:14.019Z"
}
}
}Exemplo completo
Uma resposta com os blocos mais comuns preenchidos. Os blocos sem dado simplesmente não aparecem — em uma consulta real, esperar todos eles é o erro mais frequente de integração.
Status Code: 200{
"id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
"version": "v2",
"data": {
"_metadata": {
"pessoas": {
"lastUpdate": "2025-10-05T08:44:10.434Z",
"updatedAt": "2025-10-05T10:33:04.887Z"
},
"pessoa-ceis": { "noMatchFound": true },
"pessoa-cnep": { "noMatchFound": true },
"pessoa-banco-central": { "noMatchFound": true },
"pessoa-mte-trabalho-escravo": { "noMatchFound": true }
},
"nome": "MARIA JOAQUINA DE SOUZA",
"cpf": "12345678909",
"situacaoCpf": "REGULAR",
"cpfDataInscricao": "2001-12-20",
"idade": 34,
"dataNascimento": "1991-01-01T12:00:00Z",
"sexo": "FEMININO",
"nomeMae": "ANA MARIA DE SOUZA",
"cpfMae": "98765432100",
"falecido": false,
"falecidoConfirmado": false,
"endereco": {
"logradouro": "R SAO BENTO",
"numero": "1010",
"bairro": "CENTRO",
"municipio": "SAO PAULO",
"uf": "SP",
"cep": "01010000"
},
"enderecoOutros": [{ "uf": "SP" }],
"telefones": [
{
"numero": "1155554444",
"endereco": { "uf": "SP" }
}
],
"historicoCriminal": {
"status": "CERTIDAO EMITIDA",
"situacao": "A POLICIA FEDERAL CERTIFICA APOS PESQUISA NO SISTEMA NACIONAL DE INFORMACOES CRIMINAIS SINIC QUE ATE A PRESENTE DATA NAO CONSTA DECISAO JUDICIAL CONDENATORIA COM TRANSITO EM JULGADO",
"protocolo": "25467342019",
"dataConsulta": "2025-04-23T21:01:12"
},
"processoJudicialTotalizadores": {
"quantidades": [
{ "tipo": "NUMERO DE PROCESSOS", "qtdTotal": 65, "qtdAtivos": 4, "qtdParteAtiva": 27, "qtdPartePassiva": 3, "qtdOutrasPartes": 35 },
{ "tipo": "CRIMINAL", "qtdTotal": 21, "qtdAtivos": 1, "qtdParteAtiva": 10, "qtdPartePassiva": 1, "qtdOutrasPartes": 10 },
{ "tipo": "CIVEL / ADMINISTRATIVO", "qtdTotal": 44, "qtdAtivos": 3, "qtdParteAtiva": 17, "qtdPartePassiva": 2, "qtdOutrasPartes": 25 }
]
}
},
"metadata": {
"timeSpent": 4200
}
}Quando o CPF não é encontrado
O data vem vazio. A resposta continua sendo 200.
{
"id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
"version": "v2",
"data": {},
"metadata": {
"timeSpent": 1100
}
}Headers de resposta
| Header | Quando aparece |
|---|---|
Nextid-ReqId | Em todas as respostas. Traz o identificador da requisição, o mesmo do campo id do corpo. |
Erros
| Código | Quando ocorre |
|---|---|
| 401 Unauthorized | Chave de API ausente, inválida, ou sem a permissão nextid.bureaus.backgroundCheckPerson. |
| 404 Not Found | A versão informada na URL não existe. Só v2 é aceita. |
| 422 Unprocessable Entity | CPF que não passa na validação do dígito verificador. |
| 500 Internal Server Error | Falha inesperada durante o processamento. |
Exemplo de resposta com CPF inválido:
Status Code: 422{
"id": "13cfec7c-b238-4820-a4d1-5173e4c1418e",
"error": {
"statusCode": 422,
"error": "Unprocessable Entity",
"message": "Invalid Federal Revenue Number"
}
}O formato das respostas de erro está descrito em Códigos HTTP das respostas.
Versões
A única versão é a v2, e ela é a que atende quando a versão é omitida na URL. /background-check/natural-person/{CPF} e /background-check/v2/natural-person/{CPF} são equivalentes.
| Versão | Situação | O que muda |
|---|---|---|
| v2 | Recomendada | Única versão. É o que responde quando a versão é omitida na URL. |
Qualquer outro valor no lugar de v2 devolve 404.
Endpoint relacionado
Para o dossiê de uma empresa, veja o Background Check PJ.