Receitas prontas

Use esta página quando quiser testar um fluxo comum sem procurar service por service. Todas as consultas abaixo usam:

POST /api/service-api
Authorization: Bearer {jwt_token}
Content-Type: application/json

CPF

Dados cadastrais e enriquecimento de pessoa física.

CNPJ

Dados cadastrais e status de empresa.

OCR

CNH, RG, cartão CNPJ e comprovante.

Face Index

Busca de uma selfie na base facial.

Risco PJ

Score, rating e sinais de risco de empresa.

Score PF

Consulta de score de crédito para CPF.

Antes de testar

Gere token no mesmo ambiente da chamada.
Confirme se o produto tem o service ativo e habilitado para API.
Use massa válida de HML.
Para OCR, use base64 puro, sem prefixo data:image/...;base64,.
Leia result, status.message, onboardingStatus e externalId.

Testar CPF

Use quando quiser validar uma consulta simples de pessoa física.

Item	Valor
Service	`SERVICE_PERSON_DATA_ENRICHMENT`
Campo obrigatório	`cpf`
Exemplo curl	`service-api-cpf.hml.curl`

Payload:

{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "00000000000"
}

Retorno esperado:

{
  "result": {
    "cpf": "00000000000",
    "name": "NOME FICTICIO",
    "birthDate": "2000-01-01",
    "status": "REGULAR"
  },
  "status": {
    "code": 200,
    "message": "Consulta realizada com sucesso"
  },
  "externalId": "..."
}

Erro comum:

{
  "result": {},
  "status": {
    "code": 400,
    "message": "Don't have access to the service"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "..."
}

Testar CNPJ

Use quando quiser validar dados cadastrais de uma empresa.

Item	Valor
Service	`SERVICE_REGISTRATION_DATA_CNPJ`
Campo obrigatório	`cnpj`
Exemplo curl	`service-api-cnpj.hml.curl`

Payload:

{
  "service": "SERVICE_REGISTRATION_DATA_CNPJ",
  "cnpj": "00000000000000"
}

Retorno esperado:

{
  "result": {
    "cnpj": "00000000000000",
    "companyName": "EMPRESA FICTICIA LTDA",
    "tradeName": "EMPRESA FICTICIA",
    "registrationStatus": "ATIVA",
    "openingDate": "2020-01-01"
  },
  "status": {
    "code": 200,
    "message": "Consulta realizada com sucesso"
  },
  "externalId": "..."
}

Erro comum: CNPJ sem dados na massa de HML pode retornar result vazio ou mensagem de documento não encontrado.

Testar OCR CNH

Use quando tiver uma imagem nítida da CNH inteira.

Item	Valor
Service	`SERVICE_OCR`
Campos obrigatórios	`documentType`, `image1`
Exemplo curl	`service-api-ocr-cnh.hml.curl`

Payload:

{
  "service": "SERVICE_OCR",
  "documentType": "CNH",
  "image1": "BASE64_DA_CNH"
}

Retorno esperado:

{
  "result": {
    "cpf": "00000000000",
    "docType": "CNH",
    "name": "NOME FICTICIO",
    "birthDate": "2000-01-01",
    "cnhCategory": "B",
    "cnhNumber": "00000000000",
    "validDate": "2030-01-01"
  },
  "status": {
    "code": 200,
    "message": "OCR realizado com sucesso"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}

Erro comum: imagem ilegível, documento cortado ou documentType diferente do documento enviado.

Testar OCR RG

Use quando tiver frente e verso do RG.

Item	Valor
Service	`SERVICE_OCR`
Campos obrigatórios	`documentType`, `image1`, `image2`
Exemplo curl	`service-api-ocr-rg.hml.curl`

Payload:

{
  "service": "SERVICE_OCR",
  "documentType": "RG",
  "image1": "BASE64_DA_FRENTE",
  "image2": "BASE64_DO_VERSO"
}

Retorno esperado:

{
  "result": {
    "cpf": "00000000000",
    "docType": "RG",
    "name": "NOME FICTICIO",
    "birthDate": "2000-01-01",
    "fatherName": "NOME DO PAI",
    "motherName": "NOME DA MÃE",
    "rgIssuer": "SSP/UF",
    "rgIssueDate": "2024-01-01"
  },
  "status": {
    "code": 200,
    "message": "OCR realizado com sucesso"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}

Erro comum:

{
  "result": {},
  "status": {
    "code": 400,
    "message": "Imagem do verso do documento não encontrada"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "..."
}

Testar OCR cartão CNPJ

Use quando tiver uma imagem legível do cartão CNPJ.

Item	Valor
Service	`SERVICE_OCR_CNPJ_CARD`
Campo obrigatório	`image1`
Exemplo curl	`service-api-ocr-cnpj-card.hml.curl`

Payload:

{
  "service": "SERVICE_OCR_CNPJ_CARD",
  "image1": "BASE64_DO_CARTAO_CNPJ"
}

Retorno esperado:

{
  "result": {
    "cnpj": "00000000000000",
    "docType": "CNPJ_CARD",
    "genericOcr": "texto extraído do cartão CNPJ"
  },
  "status": {
    "code": 200,
    "message": "Cartão CNPJ processado com sucesso!"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}

Erro comum: imagem não contém CNPJ válido ou não é cartão CNPJ.

Testar OCR comprovante

Use quando tiver conta, fatura ou comprovante aceito com endereço visível.

Item	Valor
Service	`SERVICE_OCR_PROOF_OF_ADDRESS`
Campo obrigatório	`image1`
Exemplo curl	`service-api-ocr-proof-of-address.hml.curl`

Payload:

{
  "service": "SERVICE_OCR_PROOF_OF_ADDRESS",
  "image1": "BASE64_DO_COMPROVANTE"
}

Retorno esperado:

{
  "result": {
    "genericOcr": "texto extraído do comprovante",
    "fullName": "NOME FICTICIO",
    "fullAddress": "RUA EXEMPLO, 100, CENTRO, CIDADE - UF",
    "docType": "Conta de consumo",
    "dueDate": "2026-01-10",
    "invoiceAmount": "R$ 100,00"
  },
  "status": {
    "code": 200,
    "message": "Comprovante de endereço obtido com sucesso!"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}

Erro comum: imagem de documento pessoal, nota fiscal sem endereço de residência ou comprovante com baixa qualidade.

Testar Face Index

Use quando quiser buscar uma selfie na base facial.

Item	Valor
Service	`SERVICE_FACE_INDEX`
Campos obrigatórios	`image1`
Exemplo curl	`service-api-face-index.hml.curl`

Payload:

{
  "service": "SERVICE_FACE_INDEX",
  "image1": "BASE64_DA_SELFIE"
}

Retorno esperado quando a face é encontrada:

{
  "result": {
    "cpf": "00000000000",
    "similarity": 99.9,
    "faceFound": true
  },
  "status": {
    "code": 200,
    "message": "Face encontrada na base"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}

Erro comum: usar foto de RG, CNH ou print de documento em vez de selfie real.

Testar risco de crédito PJ

Use quando quiser consultar score, rating e sinais de risco da empresa.

Item	Valor
Service	`SERVICE_CREDIT_RISK_COMPANY`
Campo obrigatório	`cnpj`
Exemplo curl	`service-api-credit-risk-company.hml.curl`

Payload:

{
  "service": "SERVICE_CREDIT_RISK_COMPANY",
  "cnpj": "00000000000000"
}

Retorno esperado:

{
  "result": {
    "cnpj": "00000000000000",
    "creditRisk": {
      "status": "ACTIVE",
      "score": "750",
      "rating": "A",
      "expectedDefault": "LOW",
      "legalProcess": "NOT_FOUND"
    }
  },
  "status": {
    "code": 200,
    "message": "Consulta realizada com sucesso"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}

Erro comum: massa de HML sem score/rating disponível pode retornar menos campos dentro de result.

Testar score de crédito PF

Use quando quiser consultar score de crédito por CPF.

Item	Valor
Service	`SERVICE_CREDIT_SCORE`
Campo obrigatório	`cpf`
Exemplo curl	`service-api-credit-score.hml.curl`

Payload:

{
  "service": "SERVICE_CREDIT_SCORE",
  "cpf": "00000000000"
}

Retorno esperado:

{
  "result": {
    "cpf": "00000000000",
    "score": "650",
    "riskLevel": "MEDIUM",
    "message": "Score consultado com sucesso"
  },
  "status": {
    "code": 200,
    "message": "Consulta realizada com sucesso"
  },
  "onboardingStatus": "APPROVED",
  "externalId": "..."
}

Erro comum: falha de processamento externo ou CPF sem retorno na massa de teste.

Como adaptar uma receita

Troque apenas o service e os campos obrigatórios.
Mantenha o header Authorization: Bearer {jwt_token}.
Use HML para validar payload e massa.
Não trate campo ausente como erro automaticamente.
Guarde externalId quando precisar investigar.

Primeiros passos

Suporte e referência

Fluxos principais

POST /api/service-api

Pessoas

Empresas

Catálogo técnico

Receitas prontas

Receitas prontas

CPF

CNPJ

OCR

Face Index

Risco PJ

Score PF

Antes de testar

Testar CPF

Testar CNPJ

Testar OCR CNH

Testar OCR RG

Testar OCR cartão CNPJ

Testar OCR comprovante

Testar Face Index

Testar risco de crédito PJ

Testar score de crédito PF

Como adaptar uma receita

​Receitas prontas

CPF

CNPJ

OCR

Face Index

Risco PJ

Score PF

​Antes de testar

​Testar CPF

​Testar CNPJ

​Testar OCR CNH

​Testar OCR RG

​Testar OCR cartão CNPJ

​Testar OCR comprovante

​Testar Face Index

​Testar risco de crédito PJ

​Testar score de crédito PF

​Como adaptar uma receita

Receitas prontas

Antes de testar

Testar CPF

Testar CNPJ

Testar OCR CNH

Testar OCR RG

Testar OCR cartão CNPJ

Testar OCR comprovante

Testar Face Index

Testar risco de crédito PJ

Testar score de crédito PF

Como adaptar uma receita