Postman

O Postman é um cliente HTTP para testar APIs. A nossa collection reúne, já montadas, as requisições de todos os endpoints documentados aqui: você importa o arquivo, preenche a sua chave de API e dispara a primeira chamada.

⬇️ Download

nextcode-apis.postman_collection.json

O que vem na collection

São 24 requisições, organizadas nas mesmas pastas do menu desta documentação:

Pasta	Requisições
Começando	Token JWT
Identidades	Classificador, OCR por Face (Non-Doc)
OCR	Full OCR, Comprovante de Residência, Full OCR + Datavalid
Biometria	Liveness, Face Match for Liveness, Face, Face Match, Face Match + Datavalid, Face Validation
Dados	Bureau PF, Bureau PF Online, Endereços da PF, Background Check PF, Background Check PJ, Listas Restritivas, Processos, Sumário de Processos, Sintegra, QSA CNPJ, E-Social

Cada requisição traz uma descrição curta, o link para a página de referência correspondente e os parâmetros opcionais já escritos e desligados — basta habilitar o que você quiser usar.

Os avisos vieram junto

As armadilhas documentadas nas páginas de referência estão repetidas nas descrições das requisições: rotas em que omitir a versão entrega a chamada para uma versão legada e os filtros de /lawsuits/v2 que não chegam ao provedor.

Como importar

1. No Postman, clique em Import, no canto superior esquerdo da barra lateral.
2. Arraste o arquivo nextcode-apis.postman_collection.json para a janela, ou clique em files e selecione o arquivo baixado.
3. Confirme em Import.

A collection Nextcode APIs aparece na barra lateral, com as cinco pastas.

Como configurar as variáveis

A collection usa variáveis para não repetir o ambiente nem a chave em cada requisição.

1. Clique com o botão direito na collection Nextcode APIs e escolha Edit.
2. Abra a aba Variables.
3. Preencha a coluna Current value:

Variável	Valor
baseUrl	https://api-homolog.nxcd.app (homologação) ou https://api.nxcd.app (produção)
apiKey	A sua chave de API
livenessRequestId	O id devolvido pelo Liveness — só é usado pelo Face Match for Liveness

Ao final, clique em Save.

A baseUrl já vem preenchida com o ambiente de homologação. Os dois ambientes estão descritos em Autenticação e Ambientes.

🚧 A chave de API é uma informação sensível

O Current value de uma variável não é exportado quando você compartilha a collection, e é onde a sua chave deve ficar. Não a coloque em Initial value, que viaja junto na exportação.

Autenticação

A autenticação está configurada no nível da collection, na aba Authorization, como API Key:

Authorization: ApiKey {{apiKey}}

Todas as requisições herdam essa configuração — nenhuma delas precisa de header de autenticação próprio.

Endpoints com upload de arquivo

Os endpoints de OCR e de biometria recebem os arquivos em multipart/form-data. Na collection, esses campos já existem no corpo da requisição, mas vazios: o arquivo sai do seu computador e o Postman não tem como escolhê-lo por você.

1. Abra a requisição e vá até a aba Body, com form-data selecionado.
2. Na linha do campo (file, ou frente e verso, ou documento e selfie), clique em Select Files e escolha a imagem ou o PDF.
3. Envie.

O nome do campo é livre — ele volta na resposta, em metadata.filesInfo, e é por ele que você identifica qual arquivo é qual. Os limites de formato, quantidade e tamanho estão em Envio de arquivos e na página de cada endpoint.

Face Match e Face Match + Datavalid precisam de dois arquivos

Esses dois endpoints exigem exatamente 2 arquivos por chamada. Preencha os dois campos, documento e selfie, antes de enviar.

Dados de exemplo

O CPF 12345678909 e o CNPJ 11222333000181, usados nas requisições, são sintéticos: passam na validação do dígito verificador e não pertencem a nenhuma pessoa ou empresa real. Troque-os pelos documentos que você quer consultar.

Outras ferramentas

O mesmo arquivo é importado nativamente pelo Insomnia e pelo Bruno.