{ "info": { "_postman_id": "a1b2c3d4-0000-4000-8000-000000000001", "name": "Nextcode APIs", "description": "Collection oficial das APIs da Nextcode.\n\nAntes de rodar qualquer requisição, preencha as duas variáveis da collection:\n\n- `baseUrl` — `https://api-homolog.nxcd.app` (homologação) ou `https://api.nxcd.app` (produção).\n- `apiKey` — a sua chave de API. Para obtê-la, fale com o nosso time comercial.\n\nA autenticação está configurada no nível da collection e envia o header\n`Authorization: ApiKey {{apiKey}}` em todas as requisições.\n\nOs endpoints de upload usam `multipart/form-data`: abra a aba **Body** da requisição\ne selecione o arquivo no campo do tipo *file* antes de enviar.\n\nOs CPF e CNPJ usados nos exemplos (`12345678909` e `11222333000181`) são sintéticos:\npassam na validação do dígito verificador e não pertencem a nenhuma pessoa real.\n\nDocumentação completa: https://docs.nxcd.app", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization", "type": "string" }, { "key": "value", "value": "ApiKey {{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api-homolog.nxcd.app", "type": "string", "description": "Homologação: https://api-homolog.nxcd.app · Produção: https://api.nxcd.app" }, { "key": "apiKey", "value": "", "type": "string", "description": "Sua chave de API." }, { "key": "livenessRequestId", "value": "", "type": "string", "description": "O `id` devolvido por uma chamada ao Liveness, usado no Face Match for Liveness." } ], "item": [ { "name": "Começando", "description": "Autenticação.", "item": [ { "name": "Token JWT", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"federalRevenueNumber\": \"12345678909\",\n \"ttl\": \"15m\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/auth-jwt", "host": [ "{{baseUrl}}" ], "path": [ "auth-jwt" ] }, "description": "Emite um token JWT de curta duração a partir da sua chave de API, para uso nos SDKs.\n\nTodos os campos do corpo são opcionais. O `ttl` precisa ser uma **string com a unidade**\n(`\"15m\"`, `\"1h\"`): enviar um número faz a emissão falhar com `500`, e uma string sem\nunidade (`\"900\"`) é lida como milissegundos.\n\nReferência: https://docs.nxcd.app/getting-started/auth-jwt" }, "response": [] } ] }, { "name": "Identidades", "description": "Tipificação de documentos e recuperação do documento pela face.", "item": [ { "name": "Classificador", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "Documento a classificar: PNG, JPEG ou PDF, até 15 MB. Um arquivo por chamada." } ] }, "url": { "raw": "{{baseUrl}}/classify/v3", "host": [ "{{baseUrl}}" ], "path": [ "classify", "v3" ] }, "description": "Identifica o tipo e o subtipo do documento enviado.\n\n**Informe sempre a versão na URL.** `POST /classify`, sem versão, é atendido pela **v2**,\nque responde em outro formato e com o vocabulário antigo de tipos.\n\nReferência: https://docs.nxcd.app/apis/ids/classify" }, "response": [] }, { "name": "OCR por Face (Non-Doc)", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "Selfie da pessoa: PNG ou JPEG, até 15 MB. Um arquivo por chamada." } ] }, "url": { "raw": "{{baseUrl}}/ocr-by-face/v1/tax-id/12345678909", "host": [ "{{baseUrl}}" ], "path": [ "ocr-by-face", "v1", "tax-id", "12345678909" ], "query": [ { "key": "document_types[]", "value": "federal-id", "description": "Opcional. Sem ele, a busca cobre apenas RG e CNH.", "disabled": true }, { "key": "document_types[]", "value": "passport", "description": "Opcional. Pode ser repetido para somar tipos.", "disabled": true } ] }, "description": "Recupera o documento de identidade da pessoa a partir do CPF e de uma selfie.\n\nO CPF vai no caminho da URL, com ou sem máscara, e é validado pelo dígito verificador.\n\nReferência: https://docs.nxcd.app/apis/ids/ocr-by-face" }, "response": [] } ] }, { "name": "OCR", "description": "Extração de dados de documentos e de comprovantes de residência.", "item": [ { "name": "Full OCR", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "frente", "type": "file", "src": [], "description": "Frente do documento: PNG, JPEG ou PDF, até 15 MB." }, { "key": "verso", "type": "file", "src": [], "description": "Verso do documento. Opcional — até 7 arquivos por chamada." } ] }, "url": { "raw": "{{baseUrl}}/full-ocr/v4", "host": [ "{{baseUrl}}" ], "path": [ "full-ocr", "v4" ], "query": [ { "key": "federalRevenueNumber", "value": "12345678909", "description": "Opcional. CPF conhecido, para orientar a consulta à Receita Federal.", "disabled": true }, { "key": "returnsFaceInfo", "value": "true", "description": "Opcional. Só liga com a string exata `true`.", "disabled": true }, { "key": "documentscopy", "value": "true", "description": "Opcional. Roda a documentoscopia sobre CNH e RG. Só tem efeito na v4.", "disabled": true } ] }, "description": "Classifica o documento, extrai os dados e cruza com a Receita Federal em uma única chamada.\n\n**Informe sempre a versão na URL.** `POST /full-ocr`, sem versão, é atendido pela **v2**,\nque responde em outro formato e ignora todos os parâmetros de query.\n\nReferência: https://docs.nxcd.app/apis/ocr/full-ocr" }, "response": [] }, { "name": "Comprovante de Residência", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "Comprovante de residência: PDF, PNG ou JPEG, até 15 MB. Um arquivo por chamada." } ] }, "url": { "raw": "{{baseUrl}}/proof-of-residence/v3", "host": [ "{{baseUrl}}" ], "path": [ "proof-of-residence", "v3" ] }, "description": "Extrai o endereço de um comprovante de residência e confere com a base dos Correios.\n\n**Informe sempre a versão na URL.** `POST /proof-of-residence`, sem versão, é atendido\npela **v2**, que responde em outro formato.\n\nReferência: https://docs.nxcd.app/apis/ocr/proof-of-residence" }, "response": [] }, { "name": "Full OCR + Datavalid", "request": { "method": "POST", "header": [ { "key": "x-customer-key", "value": "", "description": "Suas credenciais da SERPRO. Obrigatórias apenas com o escopo `customerKeys`; se enviadas, são sempre usadas.", "disabled": true }, { "key": "x-customer-secret", "value": "", "description": "Par do `x-customer-key`. Enviar só um dos dois é o mesmo que não enviar nenhum.", "disabled": true } ], "body": { "mode": "formdata", "formdata": [ { "key": "frente", "type": "file", "src": [], "description": "Frente do documento: PDF, PNG ou JPEG, até 15 MB." }, { "key": "verso", "type": "file", "src": [], "description": "Verso do documento. Opcional — até 7 arquivos por chamada." } ] }, "url": { "raw": "{{baseUrl}}/full-ocr-and-datavalid/v3?federalRevenueNumber=12345678909", "host": [ "{{baseUrl}}" ], "path": [ "full-ocr-and-datavalid", "v3" ], "query": [ { "key": "federalRevenueNumber", "value": "12345678909", "description": "CPF conhecido da pessoa. Sem um CPF resolvido, a etapa do Datavalid é pulada e `datavalid` volta como `{}`." } ] }, "description": "Extração dos dados do documento somada à validação no Datavalid da SERPRO.\n\n**Informe sempre a versão na URL.** `POST /full-ocr-and-datavalid`, sem versão, é atendido\npela **v2**, que responde em outro formato. Não existe v4 aqui.\n\nReferência: https://docs.nxcd.app/apis/ocr/full-ocr-and-datavalid" }, "response": [] } ] }, { "name": "Biometria", "description": "Liveness, detecção de faces e comparação biométrica.", "item": [ { "name": "Liveness", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "Selfie de selfie: PNG ou JPEG, até 15 MB. Um arquivo por chamada." } ] }, "url": { "raw": "{{baseUrl}}/liveness/v2", "host": [ "{{baseUrl}}" ], "path": [ "liveness", "v2" ] }, "description": "Detecção de liveness a partir de uma imagem de selfie.\n\n**Informe sempre a versão no caminho.** A **v2** é a versão suportada, e é ela que devolve\no `isAlive` dentro de `data`.\n\nO `id` da resposta é o que alimenta o Face Match for Liveness.\n\nReferência: https://docs.nxcd.app/apis/biometrics/liveness" }, "response": [] }, { "name": "Face Match for Liveness", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "Imagem a comparar com a face da sessão de liveness: PNG ou JPEG, até 15 MB." } ] }, "url": { "raw": "{{baseUrl}}/face-match-for-liveness/{{livenessRequestId}}/v2", "host": [ "{{baseUrl}}" ], "path": [ "face-match-for-liveness", "{{livenessRequestId}}", "v2" ] }, "description": "Compara uma imagem com a face capturada em uma sessão de liveness anterior.\n\nPreencha a variável `livenessRequestId` com o `id` devolvido pelo Liveness.\n\nO corpo devolvido tem um único campo, o `matched`. Chamar sem versão usa a v2.\n\nReferência: https://docs.nxcd.app/apis/biometrics/face-match-for-liveness" }, "response": [] }, { "name": "Face", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "Imagem: PNG ou JPEG, até 15 MB. Este endpoint não aceita PDF." } ] }, "url": { "raw": "{{baseUrl}}/face/v1", "host": [ "{{baseUrl}}" ], "path": [ "face", "v1" ], "query": [ { "key": "shouldReturnConfidence", "value": "true", "description": "Opcional. Só liga com a string exata `true`.", "disabled": true }, { "key": "shouldRotateFace", "value": "true", "description": "Opcional. Só liga com a string exata `true`.", "disabled": true }, { "key": "faceCropProportion", "value": "1.5", "description": "Opcional. Proporção do recorte. Padrão: `1`.", "disabled": true } ] }, "description": "Detecta e recorta as faces presentes em uma imagem.\n\nReferência: https://docs.nxcd.app/apis/biometrics/face" }, "response": [] }, { "name": "Face Match", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "documento", "type": "file", "src": [], "description": "Primeira imagem: PNG, JPEG ou PDF, até 15 MB." }, { "key": "selfie", "type": "file", "src": [], "description": "Segunda imagem. Este endpoint exige exatamente 2 arquivos." } ] }, "url": { "raw": "{{baseUrl}}/face-match/v2", "host": [ "{{baseUrl}}" ], "path": [ "face-match", "v2" ], "query": [ { "key": "returnsFaceInfo", "value": "true", "description": "Opcional. Traz o objeto `face` em cada item de `resources`.", "disabled": true } ] }, "description": "Comparação biométrica entre as faces encontradas em duas imagens.\n\nA **v2** é a versão recomendada e a usada nesta requisição. A rota sem versão também é atendida por ela.\nUm parâmetro de query fora da lista documentada derruba a requisição com `422`.\n\nReferência: https://docs.nxcd.app/apis/biometrics/face-match" }, "response": [] }, { "name": "Face Match + Datavalid", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "documento", "type": "file", "src": [], "description": "Imagem do documento: PNG, JPEG ou PDF, até 15 MB." }, { "key": "selfie", "type": "file", "src": [], "description": "Selfie da pessoa. Este endpoint exige exatamente 2 arquivos." } ] }, "url": { "raw": "{{baseUrl}}/face-match-and-datavalid/v2/natural-person/12345678909", "host": [ "{{baseUrl}}" ], "path": [ "face-match-and-datavalid", "v2", "natural-person", "12345678909" ], "query": [ { "key": "faceToDatavalid", "value": "Selfie", "description": "Opcional. `IdCard` (padrão) ou `Selfie`. É preferência, não garantia.", "disabled": true }, { "key": "returnsFaceInfo", "value": "true", "description": "Opcional. A simples presença do parâmetro já o liga — inclusive `returnsFaceInfo=false`.", "disabled": true } ] }, "description": "Comparação entre duas imagens somada à validação da face na base do Datavalid (SERPRO).\n\nUsa sempre o acesso da Nextcode à SERPRO: os headers `x-customer-key` e\n`x-customer-secret` são ignorados aqui.\n\nReferência: https://docs.nxcd.app/apis/biometrics/face-match-and-datavalid" }, "response": [] }, { "name": "Face Validation", "request": { "method": "POST", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": [], "description": "Selfie: PNG ou JPEG, até 15 MB. PDF não é aceito." } ] }, "url": { "raw": "{{baseUrl}}/face-validation/v1/natural-person/12345678909", "host": [ "{{baseUrl}}" ], "path": [ "face-validation", "v1", "natural-person", "12345678909" ], "query": [ { "key": "returnsFaceInfo", "value": "true", "description": "Opcional. Aceita apenas `true` ou `false`; qualquer outro valor devolve `422`.", "disabled": true } ] }, "description": "Valida uma face contra a biometria oficial de um CPF, a partir de uma única imagem.\n\nEste endpoint aceita **apenas** `multipart/form-data` — um corpo em `application/json`\né recusado com `415`. A query string é estrita: um parâmetro desconhecido devolve `422`.\n\nReferência: https://docs.nxcd.app/apis/biometrics/face-validation" }, "response": [] } ] }, { "name": "Dados", "description": "Consultas cadastrais, background check, listas restritivas e processos judiciais.", "item": [ { "name": "Bureau PF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bureau/v2/natural-person/12345678909", "host": [ "{{baseUrl}}" ], "path": [ "bureau", "v2", "natural-person", "12345678909" ] }, "description": "Dados cadastrais de um CPF na Receita Federal: nome, nome da mãe e data de nascimento.\n\nReferência: https://docs.nxcd.app/apis/data/bureau-pf" }, "response": [] }, { "name": "Bureau PF Online", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bureau-pf-online/12345678909", "host": [ "{{baseUrl}}" ], "path": [ "bureau-pf-online", "12345678909" ] }, "description": "Consulta em tempo real dos dados cadastrais de um CPF na Receita Federal, com a situação cadastral.\n\nEste endpoint **não aceita nenhum parâmetro de query**: qualquer um devolve `422`.\nTambém não existe versão na URL — `/bureau-pf-online/v2/{CPF}` devolve `404`.\n\nReferência: https://docs.nxcd.app/apis/data/bureau-pf-online" }, "response": [] }, { "name": "Endereços da PF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/bureau/v2/person-addresses/12345678909", "host": [ "{{baseUrl}}" ], "path": [ "bureau", "v2", "person-addresses", "12345678909" ] }, "description": "Lista os endereços conhecidos de um CPF.\n\nReferência: https://docs.nxcd.app/apis/data/person-addresses" }, "response": [] }, { "name": "Background Check PF", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/background-check/v2/natural-person/12345678909", "host": [ "{{baseUrl}}" ], "path": [ "background-check", "v2", "natural-person", "12345678909" ] }, "description": "Dossiê completo de uma pessoa física: identificação, vínculos societários, sanções, processos e histórico criminal.\n\nReferência: https://docs.nxcd.app/apis/data/background-check-person" }, "response": [] }, { "name": "Background Check PJ", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/background-check/v2/legal-entity/11222333000181", "host": [ "{{baseUrl}}" ], "path": [ "background-check", "v2", "legal-entity", "11222333000181" ] }, "description": "Dossiê completo de uma empresa: cadastro, quadro societário, saúde tributária, sanções, processos e patrimônio.\n\nAceita também o CNPJ alfanumérico da IN RFB 2.229/2024.\n\nReferência: https://docs.nxcd.app/apis/data/background-check-company" }, "response": [] }, { "name": "Listas Restritivas", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/restricted-lists/v2?taxId=12345678909&list=pep", "host": [ "{{baseUrl}}" ], "path": [ "restricted-lists", "v2" ], "query": [ { "key": "taxId", "value": "12345678909", "description": "CPF ou CNPJ consultado. Informe `taxId` ou `name`; com os dois, o `taxId` vence." }, { "key": "list", "value": "pep", "description": "Lista desejada. `todas` soma a tarifa de cada lista e exige a permissão `allLists`." }, { "key": "name", "value": "Joao da Silva", "description": "Busca por trecho contido no nome, entre 3 e 200 caracteres.", "disabled": true } ] }, "description": "Busca por nome ou por CPF/CNPJ em listas restritivas, sancionatórias e de PEP.\n\n**Informe sempre a versão na URL.** `GET /restricted-lists`, sem versão, é atendido pela **v1**,\nem que `data` é um objeto com `found`. Na **v2**, recomendada, `data` é uma **lista** — e a\nresposta vazia é `[]`, não `{ \"found\": false }`.\n\nReferência: https://docs.nxcd.app/apis/data/restricted-lists" }, "response": [] }, { "name": "Processos", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/lawsuits/v2?taxId=12345678909", "host": [ "{{baseUrl}}" ], "path": [ "lawsuits", "v2" ], "query": [ { "key": "taxId", "value": "12345678909", "description": "CPF ou CNPJ de uma das partes. Informe um entre `taxId`, `partName` e `exactPartName`." }, { "key": "partName", "value": "JOAO DA SILVA", "description": "Nome de uma das partes, por trecho contido. Só é usado se não houver `taxId`.", "disabled": true }, { "key": "exactPartName", "value": "JOAO DA SILVA", "description": "Nome exato de uma das partes. Última na ordem de precedência.", "disabled": true } ] }, "description": "Busca de processos judiciais por CPF, CNPJ ou nome da parte.\n\n**Informe sempre a versão no caminho.** `/lawsuits/v2` é a única versão suportada desta consulta.\n\n**Os parâmetros de filtro não estão sendo aplicados.** `grade`, `courts`, `partPole`,\n`distributionDate` e os demais são aceitos pela API, mas não chegam ao provedor: a resposta\né a mesma com ou sem filtro. Filtre no seu lado, sobre a lista devolvida.\n\nReferência: https://docs.nxcd.app/apis/data/lawsuits" }, "response": [] }, { "name": "Sumário de Processos", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/lawsuits-summary/v1?taxId=12345678909", "host": [ "{{baseUrl}}" ], "path": [ "lawsuits-summary", "v1" ], "query": [ { "key": "taxId", "value": "12345678909", "description": "CPF ou CNPJ da parte, com ou sem máscara. Obrigatório." } ] }, "description": "Contagem dos processos judiciais de um CPF ou CNPJ, agrupada por tribunal, segmento de justiça e ano.\n\nA versão é obrigatória na URL: `/lawsuits-summary` sem versão devolve `404`.\n\nReferência: https://docs.nxcd.app/apis/data/lawsuits-summary" }, "response": [] }, { "name": "Sintegra", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/receita-federal-and-sintegra/v1?cnpj=11222333000181", "host": [ "{{baseUrl}}" ], "path": [ "receita-federal-and-sintegra", "v1" ], "query": [ { "key": "cnpj", "value": "11222333000181", "description": "Busca por CNPJ. Use um dos três conjuntos: `cnpj`, `cpf`+`uf` ou `ie`+`uf`." }, { "key": "cpf", "value": "12345678909", "description": "Busca por CPF. Exige `uf` junto.", "disabled": true }, { "key": "uf", "value": "SP", "description": "UF. Obrigatória nas buscas por CPF e por inscrição estadual.", "disabled": true }, { "key": "ie", "value": "111222333", "description": "Inscrição estadual. Exige `uf` junto.", "disabled": true } ] }, "description": "Cadastro na Receita Federal e inscrições estaduais de um contribuinte, por CNPJ, por CPF ou por inscrição estadual.\n\nSem nenhum identificador a chamada não é barrada na entrada: ela segue para o provedor,\nque responde sem resultado. Aceita o CNPJ alfanumérico da IN RFB 2.229/2024.\n\nReferência: https://docs.nxcd.app/apis/data/sintegra" }, "response": [] }, { "name": "QSA CNPJ", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/receita-federal-cnpj-qsa/v1?taxId=11222333000181", "host": [ "{{baseUrl}}" ], "path": [ "receita-federal-cnpj-qsa", "v1" ], "query": [ { "key": "taxId", "value": "11222333000181", "description": "CNPJ, com ou sem máscara. Obrigatório — sem ele, a resposta é `422`." } ] }, "description": "Quadro societário e de administradores de um CNPJ, na Receita Federal.\n\nAceita também o CNPJ alfanumérico da IN RFB 2.229/2024.\n\nReferência: https://docs.nxcd.app/apis/data/qsa" }, "response": [] }, { "name": "E-Social", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/esocial-qualificacao-cadastral/v1?taxId=12345678909&name=Maria%20da%20Silva&birthdate=01%2F01%2F2001&nis=00000000000", "host": [ "{{baseUrl}}" ], "path": [ "esocial-qualificacao-cadastral", "v1" ], "query": [ { "key": "taxId", "value": "12345678909", "description": "CPF. Único dos quatro validado pela API." }, { "key": "name", "value": "Maria da Silva", "description": "Nome. Repassado ao provedor sem validação de formato." }, { "key": "birthdate", "value": "01/01/2001", "description": "Data de nascimento. Repassada ao provedor sem validação de formato." }, { "key": "nis", "value": "00000000000", "description": "NIS. Repassado ao provedor sem validação de formato." } ] }, "description": "Consulta de qualificação cadastral do eSocial: confere se o CPF e o NIS estão aptos para uso.\n\nOs quatro parâmetros são obrigatórios: faltando qualquer um deles, a chamada é recusada com `422`.\n\nReferência: https://docs.nxcd.app/apis/data/e-social" }, "response": [] } ] } ] }