Services de pessoa física

Catálogo explícito dos services de pessoa física disponíveis via API, com campos esperados e exemplos de request. Todos os services usam POST /api/service-api; o produto executado é definido pelo campo service no body.

Use exatamente o valor exibido em Service. Não envie alias interno nem nome de integração.

Antes de testar

Contrato base

Veja token, headers, body padrão, result, status e externalId.

Postman do zero

Configure HML, gere token e execute POST /api/service-api com um payload real.

OCR e imagem

Payloads para CNH, RG, comprovante, cartão CNPJ, base64 e erros de imagem.

Fluxos prontos

Exemplos completos para CPF, OCR, Face Index, risco e score.

Como usar esta página

Escolha a família

Use os cards abaixo para localizar o grupo certo de services.

Abra o service

No catálogo completo, abra o accordion do service e copie o body de exemplo.

Leia o retorno

Use result como contrato público e preserve status, onboardingStatus e externalId.

Como interpretar qualquer retorno

Dados úteis

Leia primeiro o objeto result. Ele concentra os campos de negócio que o cliente deve consumir.

Status técnico

Use status.code e status.message para entender se a chamada processou, recusou ou falhou.

Rastreio

Guarde externalId em testes, suporte e auditoria. Ele é o identificador mais prático da consulta.

Contrato limpo

Não dependa de metadados internos. A integração deve mapear somente os campos públicos documentados.

Famílias de services

Biometria e documentos

7 services: SERVICE_FACE_INDEX, SERVICE_DIGITAL_DOCUMENTOSCOPY, SERVICE_FACE_MATCH e mais 4.

Contatos, sites e relacionamentos

15 services: SERVICE_PF_FINANCIAL_AND_ADDRESS, SERVICE_CONFIRM_PHONE, SERVICE_DOMAINS_CPF e mais 12.

Dados cadastrais e Receita Federal

10 services: SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF, SERVICE_MEI, SERVICE_RFB_PF_ON_DEMAND e mais 7.

Dados eleitorais e PEP

8 services: SERVICE_ELECTION_CANDIDATE_DATA_CPF, SERVICE_ELECTORAL_DONORS_CPF, SERVICE_POLITICAL_INVOLVEMENT e mais 5.

Jurídico, certidões e protestos

7 services: SERVICE_CRIMINAL_RECORD_CIVIL, SERVICE_CRIMINAL_RECORD_FEDERAL, SERVICE_NOTHING_RECORD_LAWSUITS e mais 4.

KYC, compliance e exposição

2 services: SERVICE_MEDIA_PROFILE_EXPOSURE_PF, SEVICE_ONLINE_BETTING_PROPENSITY.

Outros services

9 services: SERVICE_SOCIAL_ASSISTANCE_EXTENDED, SERVICE_FAMILY_SOCIAL_BENEFITS, SERVICE_QUOD_CREDIT_RISK_PERSON e mais 6.

Risco, crédito e dívidas

9 services: SERVICE_BOAVISTA_CREDIT_SCORE_PERSON, SERVICE_ACTIVE_DEBT_PF, SERVICE_FINANCIAL_INFORMATION e mais 6.

Catálogo completo

Abra um service para ver quando usar, campos obrigatórios, body, curl e response resumido.

Busca de face na base

Service: SERVICE_FACE_INDEXQuando usar: Use para comparar duas imagens faciais e retornar a similaridade entre elas.O que retorna: Busca uma selfie na base de faces indexadas e retorna se encontrou face, CPF associado e similaridade quando disponíveis.

Entrada

Campos obrigatórios: service, image1.

Resultado

Principais campos em result: cpf, faceFound, similarity.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, image1Campos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

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

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_INDEX",
  "image1": "base64"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_INDEX",
  "image1": "base64"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`image1`	Sim	Primeira imagem enviada em base64 ou referência equivalente, conforme o produto.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.faceFound`	Indica se a busca facial encontrou uma face correspondente na base.
`result.similarity`	Percentual de similaridade retornado em validações biométricas ou faciais.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "faceFound": true,
    "similarity": 98.42
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Busca uma selfie na base de faces indexadas e retorna se encontrou face, CPF associado e similaridade quando disponíveis.

Documentoscopia digital

Service: SERVICE_DIGITAL_DOCUMENTOSCOPYQuando usar: Use para avaliar documento, selfie e biometria dentro do fluxo de documentoscopia.O que retorna: Retorna status da documentoscopia, chave da consulta, dados extraídos do documento, validações de documento/selfie e resultado de aprovacao.

Entrada

Campos obrigatórios: service, key, image1, image2, selfie1.

Resultado

Principais campos em result: key, status, documentData, validations.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, key, image1, image2, selfie1Campos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
  "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
  "image1": "base64",
  "image2": "base64",
  "selfie1": "base64"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
  "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
  "image1": "base64",
  "image2": "base64",
  "selfie1": "base64"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
  "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
  "image1": "base64",
  "image2": "base64",
  "selfie1": "base64"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`key`	Sim	Chave da documentoscopia usada para iniciar ou consultar o processamento.
`image1`	Sim	Primeira imagem enviada em base64 ou referência equivalente, conforme o produto.
`image2`	Sim	Segunda imagem enviada em base64 ou referência equivalente, quando o produto compara duas imagens.
`selfie1`	Sim	Selfie enviada para validações de documentoscopia e biometria.

Campos principais do result

Campo	Descrição
`result.key`	Campo retornado no objeto result para consumo do cliente.
`result.status`	Situação principal retornada pelo produto consultado.
`result.documentData`	Campo retornado no objeto result para consumo do cliente.
`result.validations`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "key": "{key}",
    "status": "APPROVED",
    "documentData": {
      "name": "Nome extraído",
      "cpf": "cpf"
    },
    "validations": [
      {
        "name": "faceMatch",
        "status": "APPROVED"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna status da documentoscopia, chave da consulta, dados extraídos do documento, validações de documento/selfie e resultado de aprovacao.

FaceMatch

Service: SERVICE_FACE_MATCHQuando usar: Use para comparar duas imagens faciais e retornar a similaridade entre elas.O que retorna: Retorna comparacao facial entre duas imagens, com score de similaridade, status do match e mensagem de aprovacao ou reprovacao.

Entrada

Campos obrigatórios: service, image1, image2.

Resultado

Principais campos em result: match, similarity, status.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, image1, image2Campos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_FACE_MATCH",
  "image1": "base64",
  "image2": "base64"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_MATCH",
  "image1": "base64",
  "image2": "base64"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_MATCH",
  "image1": "base64",
  "image2": "base64"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`image1`	Sim	Primeira imagem enviada em base64 ou referência equivalente, conforme o produto.
`image2`	Sim	Segunda imagem enviada em base64 ou referência equivalente, quando o produto compara duas imagens.

Campos principais do result

Campo	Descrição
`result.match`	Campo retornado no objeto result para consumo do cliente.
`result.similarity`	Percentual de similaridade retornado em validações biométricas ou faciais.
`result.status`	Situação principal retornada pelo produto consultado.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "match": true,
    "similarity": 98.2,
    "status": "APPROVED"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna comparacao facial entre duas imagens, com score de similaridade, status do match e mensagem de aprovacao ou reprovacao.

OCR de emancipação

Service: SERVICE_OCR_EMANCIPATIONQuando usar: Use para extrair dados de documentos enviados em base64 ou por URL.O que retorna: Retorna texto OCR do documento de emancipacao e dados objetivos extraídos quando existirem, sem reprovar pela ausencia de campos variaveis.

Entrada

Campos obrigatórios: service, image1.

Resultado

Principais campos em result: docType, genericOcr, extractedFields, analysis.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, image1Campos opcionais: Nenhum campo opcional mapeado neste exemplo.

Guia de OCR

Para payloads prontos, qualidade de imagem e diagnóstico de erro, consulte OCR via Service API.

Payload mínimo

{
  "service": "SERVICE_OCR_EMANCIPATION",
  "image1": "BASE64_DO_DOCUMENTO"
}

Retorno limpo esperado

{
  "result": {
    "docType": "EMANCIPATION_DOCUMENT",
    "genericOcr": "texto extraído",
    "extractedFields": {
      "cpf": "cpf",
      "dates": [
        "yyyy-MM-dd"
      ]
    },
    "analysis": {
      "isEmancipationRelated": true,
      "confidence": "MEDIUM"
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Erro comum

{
  "result": {},
  "status": {
    "code": 400,
    "message": "Não foi possível ler o documento de emancipação"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "{externalId}"
}

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_OCR_EMANCIPATION",
  "image1": "base64"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR_EMANCIPATION",
  "image1": "base64"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR_EMANCIPATION",
  "image1": "base64"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`image1`	Sim	Primeira imagem enviada em base64 ou referência equivalente, conforme o produto.

Campos principais do result

Campo	Descrição
`result.docType`	Tipo de documento identificado no processamento.
`result.genericOcr`	Texto bruto extraído do documento por OCR.
`result.extractedFields`	Campo extraído do documento enviado para OCR.
`result.analysis`	Campo extraído do documento enviado para OCR.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "docType": "EMANCIPATION_DOCUMENT",
    "genericOcr": "texto extraído",
    "extractedFields": {
      "cpf": "cpf",
      "dates": [
        "yyyy-MM-dd"
      ]
    },
    "analysis": {
      "isEmancipationRelated": true,
      "confidence": "MEDIUM"
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna texto OCR do documento de emancipacao e dados objetivos extraídos quando existirem, sem reprovar pela ausencia de campos variaveis.

OCR React

Service: SERVICE_OCRQuando usar: Use para extrair dados de documentos enviados em base64 ou por URL.O que retorna: Retorna dados extraídos de documentos de identificação enviados por imagem, como RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identificação automatica.

Entrada

Campos obrigatórios: service, documentType, image1.

Resultado

Principais campos em result: cpf, docType, name, birthDate, cnhCategory, cnhNumber.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

image2

Endpoint: POST /api/service-apiCampos obrigatórios: service, documentType, image1Campos opcionais: image2

Guia de OCR

Para payloads prontos, qualidade de imagem e diagnóstico de erro, consulte OCR via Service API.

Payload mínimo

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

Retorno limpo esperado

{
  "result": {
    "cpf": "cpf",
    "docType": "CNH",
    "name": "Nome extraído",
    "birthDate": "yyyy-MM-dd",
    "cnhCategory": "B",
    "cnhNumber": "00000000000"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Erro comum

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

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_OCR",
  "documentType": "IDENTIFICATION_DOCUMENT",
  "image1": "base64",
  "image2": "base64 (opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR",
  "documentType": "IDENTIFICATION_DOCUMENT",
  "image1": "base64",
  "image2": "base64 (opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR",
  "documentType": "IDENTIFICATION_DOCUMENT",
  "image1": "base64",
  "image2": "base64 (opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`documentType`	Sim	Parametro usado pelo service SERVICE_OCR.
`image1`	Sim	Primeira imagem enviada em base64 ou referência equivalente, conforme o produto.
`image2`	Não	Segunda imagem enviada em base64 ou referência equivalente, quando o produto compara duas imagens.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.docType`	Tipo de documento identificado no processamento.
`result.name`	Nome completo retornado pela consulta quando disponível.
`result.birthDate`	Data retornada pela consulta, conforme o contexto do service.
`result.cnhCategory`	Campo extraído do documento enviado para OCR.
`result.cnhNumber`	Campo extraído do documento enviado para OCR.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "docType": "CNH",
    "name": "Nome extraído",
    "birthDate": "yyyy-MM-dd",
    "cnhCategory": "B",
    "cnhNumber": "00000000000"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados extraídos de documentos de identificação enviados por imagem, como RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identificação automatica.

Resultado da documentoscopia digital

Service: SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULTQuando usar: Use para avaliar documento, selfie e biometria dentro do fluxo de documentoscopia.O que retorna: Retorna o resultado ja processado da documentoscopia pela chave informada, com status, campos extraídos, regras avaliadas e evidencias.

Entrada

Campos obrigatórios: service, key.

Resultado

Principais campos em result: key, status, fields, rules.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, keyCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
  "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
  "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
  "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`key`	Sim	Chave da documentoscopia usada para iniciar ou consultar o processamento.

Campos principais do result

Campo	Descrição
`result.key`	Campo retornado no objeto result para consumo do cliente.
`result.status`	Situação principal retornada pelo produto consultado.
`result.fields`	Campo retornado no objeto result para consumo do cliente.
`result.rules`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "key": "{key}",
    "status": "APPROVED",
    "fields": [
      {
        "name": "cpf",
        "value": "cpf"
      }
    ],
    "rules": [
      {
        "name": "document",
        "status": "APPROVED"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna o resultado ja processado da documentoscopia pela chave informada, com status, campos extraídos, regras avaliadas e evidencias.

Score biométrico

Service: SERVICE_DATAVALID_CNHQuando usar: Use para comparar a imagem enviada com bases biométricas disponíveis e retornar a similaridade.O que retorna: Retorna validação validação documental da CNH, incluindo score biométrico, similaridade facial, status de validação e campos conferidos.

Entrada

Campos obrigatórios: service, cpf, image1.

Resultado

Principais campos em result: cpf, biometricScore, validated, validationStatus.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpf, image1Campos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_DATAVALID_CNH",
  "cpf": "cpf",
  "image1": "{base64Image}"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DATAVALID_CNH",
  "cpf": "cpf",
  "image1": "{base64Image}"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DATAVALID_CNH",
  "cpf": "cpf",
  "image1": "{base64Image}"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`image1`	Sim	Primeira imagem enviada em base64 ou referência equivalente, conforme o produto.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.biometricScore`	Campo retornado no objeto result para consumo do cliente.
`result.validated`	Data retornada pela consulta, conforme o contexto do service.
`result.validationStatus`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "biometricScore": 0.98,
    "validated": true,
    "validationStatus": "APPROVED"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna validação validação documental da CNH, incluindo score biométrico, similaridade facial, status de validação e campos conferidos.

Dados financeiros e endereços

Service: SERVICE_PF_FINANCIAL_AND_ADDRESSQuando usar: Use para consultar informações financeiras associadas à pessoa.O que retorna: Retorna dados financeiros e endereços do CPF em uma consulta combinada, incluindo renda estimada, indicadores financeiros e endereços encontrados.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, estimatedIncome, addresses, financialIndicators.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

birthDate

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: birthDate

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`birthDate`	Não	Data de nascimento usada para aumentar a precisão da consulta quando exigida.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.estimatedIncome`	Campo retornado no objeto result para consumo do cliente.
`result.addresses`	Endereço, lista de endereços ou validação de endereço retornada pela consulta.
`result.financialIndicators`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "estimatedIncome": "5000-10000",
    "addresses": [
      {
        "city": "Sao Paulo",
        "state": "SP"
      }
    ],
    "financialIndicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados financeiros e endereços do CPF em uma consulta combinada, incluindo renda estimada, indicadores financeiros e endereços encontrados.

Dados pelo telefone

Service: SERVICE_CONFIRM_PHONEQuando usar: Use para consultar, validar ou enriquecer dados de telefone.O que retorna: Retorna dados associados ao telefone informado, como possível titular, documento relacionado, status de confirmacao e atributos disponíveis.

Entrada

Campos obrigatórios: service, phone.

Resultado

Principais campos em result: phone, matched, person.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, phoneCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_CONFIRM_PHONE",
  "phone": "+5561123456789"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CONFIRM_PHONE",
  "phone": "+5561123456789"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CONFIRM_PHONE",
  "phone": "+5561123456789"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`phone`	Sim	Telefone usado para consulta ou validação, de preferência com DDD.

Campos principais do result

Campo	Descrição
`result.phone`	Telefone, histórico de telefones ou validação de telefone retornada pela consulta.
`result.matched`	Campo retornado no objeto result para consumo do cliente.
`result.person`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "phone": "+5561123456789",
    "matched": true,
    "person": {
      "name": "Nome encontrado",
      "document": "cpf"
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados associados ao telefone informado, como possível titular, documento relacionado, status de confirmacao e atributos disponíveis.

Domínios

Service: SERVICE_DOMAINS_CPFQuando usar: Use para consultar dados de sites vinculados à pessoa.O que retorna: Retorna domínios, sites e sinais digitais associados ao CPF, incluindo quantidade e registros encontrados quando disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, totalDomains, domains.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_DOMAINS_CPF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DOMAINS_CPF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DOMAINS_CPF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.totalDomains`	Campo retornado no objeto result para consumo do cliente.
`result.domains`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "totalDomains": 1,
    "domains": [
      {
        "domain": "exemplo.com.br",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna domínios, sites e sinais digitais associados ao CPF, incluindo quantidade e registros encontrados quando disponíveis.

E-mails de Pessoas Relacionadas

Service: SERVICE_RELATED_PEOPLE_EMAILSQuando usar: Use para validar ou consultar histórico de e-mails relacionados ao documento.O que retorna: Retorna e-mails associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada e-mail.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, totalRelatedPeopleEmails, relatedPeopleEmailsList, relatedPeopleEmails.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_RELATED_PEOPLE_EMAILS",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_EMAILS",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_EMAILS",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.totalRelatedPeopleEmails`	Quantidade de e-mails encontrados para pessoas relacionadas ao CPF consultado.
`result.relatedPeopleEmailsList`	Lista resumida de e-mails encontrados para pessoas relacionadas ao CPF consultado.
`result.relatedPeopleEmails`	Lista estruturada dos e-mails de pessoas relacionadas, com relacionamento e sinais de uso de cada e-mail, usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "totalRelatedPeopleEmails": 2,
    "relatedPeopleEmailsList": "[email protected] - NOME DA PESSOA - 00000000000 - CONJUGE",
    "relatedPeopleEmails": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "CONJUGE",
        "type": "PESSOAL",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "email": "[email protected]",
        "domain": "email.com",
        "validationStatus": "VALID"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna e-mails associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada e-mail.

Endereços

Service: SERVICE_ADDRESSQuando usar: Use para consultar ou validar endereços associados ao documento.O que retorna: Retorna endereços associados ao CPF, incluindo logradouro, número, bairro, cidade, UF, CEP, país, tipo e indicadores de atualidade quando disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, totalAddresses, addresses.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ADDRESS",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ADDRESS",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ADDRESS",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.totalAddresses`	Endereço, lista de endereços ou validação de endereço retornada pela consulta.
`result.addresses`	Endereço, lista de endereços ou validação de endereço retornada pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "totalAddresses": 2,
    "addresses": [
      {
        "address": "Rua Exemplo",
        "number": "100",
        "neighborhood": "Centro",
        "city": "Sao Paulo",
        "state": "SP",
        "zipcode": "01001000"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna endereços associados ao CPF, incluindo logradouro, número, bairro, cidade, UF, CEP, país, tipo e indicadores de atualidade quando disponíveis.

Endereços de Pessoas Relacionadas

Service: SERVICE_RELATED_PEOPLE_ADDRESSESQuando usar: Use para consultar ou validar endereços associados ao documento.O que retorna: Retorna endereços associados a pessoas relacionadas ao CNPJ informado, com o relacionamento identificado e sinais de uso de cada endereço.

Entrada

Campos obrigatórios: service, cnpj.

Resultado

Principais campos em result: cnpj, totalRelatedPeopleAddresses, relatedPeopleAddressesList, relatedPeopleAddresses.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cnpjCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_RELATED_PEOPLE_ADDRESSES",
  "cnpj": "cnpj"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_ADDRESSES",
  "cnpj": "cnpj"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_ADDRESSES",
  "cnpj": "cnpj"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cnpj`	Sim	CNPJ da empresa consultada.

Campos principais do result

Campo	Descrição
`result.cnpj`	CNPJ relacionado ao resultado da consulta.
`result.totalRelatedPeopleAddresses`	Quantidade de endereços encontrados para pessoas relacionadas ao CNPJ consultado.
`result.relatedPeopleAddressesList`	Lista resumida de endereços encontrados para pessoas relacionadas ao CNPJ consultado.
`result.relatedPeopleAddresses`	Lista estruturada dos endereços de pessoas relacionadas, com relacionamento e sinais de uso de cada endereço, usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cnpj": "cnpj",
    "totalRelatedPeopleAddresses": 1,
    "relatedPeopleAddressesList": "RUA EXEMPLO, 100 - NOME DA PESSOA - 00000000000 - SOCIO",
    "relatedPeopleAddresses": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "SOCIO",
        "type": "RESIDENCIAL",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "address": "RUA EXEMPLO",
        "zipcode": "00000000",
        "state": "SP",
        "city": "SAO PAULO",
        "neighborhood": "CENTRO",
        "number": "100",
        "complement": "",
        "isRatified": true
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna endereços associados a pessoas relacionadas ao CNPJ informado, com o relacionamento identificado e sinais de uso de cada endereço.

Histórico de e-mails

Service: SERVICE_EMAILS_EXTENDEDQuando usar: Use para validar ou consultar histórico de e-mails relacionados ao documento.O que retorna: Retorna e-mails associados ao CPF, incluindo prioridade, status de validação, origem, data de atualização e sinais de uso quando disponíveis.

Entrada

Campos obrigatórios: service, cpf, limit.

Resultado

Principais campos em result: cpf, emails.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpf, limitCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_EMAILS_EXTENDED",
  "cpf": "cpf",
  "limit": "10"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_EMAILS_EXTENDED",
  "cpf": "cpf",
  "limit": "10"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_EMAILS_EXTENDED",
  "cpf": "cpf",
  "limit": "10"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`limit`	Sim	Quantidade máxima de registros que devem ser retornados quando o produto suporta limite.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.emails`	E-mail, histórico de e-mails ou validação de e-mail retornada pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "emails": [
      {
        "email": "[email protected]",
        "priority": 1,
        "isValid": true,
        "lastUpdate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna e-mails associados ao CPF, incluindo prioridade, status de validação, origem, data de atualização e sinais de uso quando disponíveis.

Histórico de telefones

Service: SERVICE_PHONE_HISTORYQuando usar: Use para consultar, validar ou enriquecer dados de telefone.O que retorna: Retorna histórico de telefones associados ao CPF, incluindo número, tipo de linha, operadora, prioridade, status e recência quando disponíveis.

Entrada

Campos obrigatórios: service, cpf, limit.

Resultado

Principais campos em result: cpf, phones.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

birthDate

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpf, limitCampos opcionais: birthDate

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PHONE_HISTORY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "limit": "10"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PHONE_HISTORY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "limit": "10"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PHONE_HISTORY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "limit": "10"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`birthDate`	Não	Data de nascimento usada para aumentar a precisão da consulta quando exigida.
`limit`	Sim	Quantidade máxima de registros que devem ser retornados quando o produto suporta limite.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.phones`	Telefone, histórico de telefones ou validação de telefone retornada pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "phones": [
      {
        "phone": "11900000000",
        "lineType": "MOBILE",
        "priority": 1,
        "lastUpdate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna histórico de telefones associados ao CPF, incluindo número, tipo de linha, operadora, prioridade, status e recência quando disponíveis.

OCR de comprovante de endereço

Service: SERVICE_OCR_PROOF_OF_ADDRESSQuando usar: Use para extrair dados de documentos enviados em base64 ou por URL.O que retorna: Retorna dados extraídos do comprovante de endereço por OCR, como texto OCR, nome, endereço, tipo do documento, datas e valores quando encontrados.

Entrada

Campos obrigatórios: service, image1.

Resultado

Principais campos em result: genericOcr, fullName, fullAddress, docType, dueDate, invoiceAmount.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, image1Campos opcionais: Nenhum campo opcional mapeado neste exemplo.

Guia de OCR

Para payloads prontos, qualidade de imagem e diagnóstico de erro, consulte OCR via Service API.

Payload mínimo

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

Retorno limpo esperado

{
  "result": {
    "genericOcr": "texto extraído",
    "fullName": "Nome extraído",
    "fullAddress": "Endereço extraído",
    "docType": "Conta de consumo",
    "dueDate": "yyyy-MM-dd",
    "invoiceAmount": "R$ 100,00"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Erro comum

{
  "result": {},
  "status": {
    "code": 400,
    "message": "Não foi possível ler o comprovante de endereço"
  },
  "onboardingStatus": "REFUSED",
  "externalId": "{externalId}"
}

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

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

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR_PROOF_OF_ADDRESS",
  "image1": "base64"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR_PROOF_OF_ADDRESS",
  "image1": "base64"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`image1`	Sim	Primeira imagem enviada em base64 ou referência equivalente, conforme o produto.

Campos principais do result

Campo	Descrição
`result.genericOcr`	Texto bruto extraído do documento por OCR.
`result.fullName`	Nome completo retornado pela consulta quando disponível.
`result.fullAddress`	Endereço, lista de endereços ou validação de endereço retornada pela consulta.
`result.docType`	Tipo de documento identificado no processamento.
`result.dueDate`	Data retornada pela consulta, conforme o contexto do service.
`result.invoiceAmount`	Valor monetário, estimativa ou montante retornado pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "genericOcr": "texto extraído",
    "fullName": "Nome extraído",
    "fullAddress": "Endereço extraído",
    "docType": "Conta de consumo",
    "dueDate": "yyyy-MM-dd",
    "invoiceAmount": "R$ 100,00"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados extraídos do comprovante de endereço por OCR, como texto OCR, nome, endereço, tipo do documento, datas e valores quando encontrados.

Pessoas relacionadas

Service: SERVICE_RELATED_PEOPLEQuando usar: Use para consultar vínculos, sócios ou relacionamentos associados à pessoa.O que retorna: Retorna pessoas relacionadas ao CPF, com nome, documento mascarado, tipo de relação, nível de proximidade e origem do vinculo.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, relatedPeople.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

birthDate

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: birthDate

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_RELATED_PEOPLE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`birthDate`	Não	Data de nascimento usada para aumentar a precisão da consulta quando exigida.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.relatedPeople`	Vínculos, pessoas, sócios ou relacionamentos retornados pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "relatedPeople": [
      {
        "name": "Pessoa relacionada",
        "relationshipType": "FAMILIAR",
        "confidence": "HIGH"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna pessoas relacionadas ao CPF, com nome, documento mascarado, tipo de relação, nível de proximidade e origem do vinculo.

Relacionamentos econômicos

Service: SERVICE_ECONOMIC_RELATIONSHIPQuando usar: Use para consultar vínculos, sócios ou relacionamentos associados à pessoa.O que retorna: Retorna vínculos econômicos associados ao CPF, como empresas relacionadas, participações, relações profissionais e indicadores de relacionamento.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, relationships.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ECONOMIC_RELATIONSHIP",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ECONOMIC_RELATIONSHIP",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ECONOMIC_RELATIONSHIP",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.relationships`	Vínculos, pessoas, sócios ou relacionamentos retornados pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "relationships": [
      {
        "type": "OWNER",
        "relatedDocument": "cnpj",
        "relatedName": "Empresa relacionada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna vínculos econômicos associados ao CPF, como empresas relacionadas, participações, relações profissionais e indicadores de relacionamento.

Telefones de Pessoas Relacionadas

Service: SERVICE_RELATED_PEOPLE_PHONESQuando usar: Use para consultar, validar ou enriquecer dados de telefone.O que retorna: Retorna telefones associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada telefone.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, totalRelatedPeoplePhones, relatedPeoplePhonesList, relatedPeoplePhones.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_RELATED_PEOPLE_PHONES",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_PHONES",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_PHONES",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.totalRelatedPeoplePhones`	Quantidade de telefones encontrados para pessoas relacionadas ao CPF consultado.
`result.relatedPeoplePhonesList`	Lista resumida de telefones encontrados para pessoas relacionadas ao CPF consultado.
`result.relatedPeoplePhones`	Lista estruturada dos telefones de pessoas relacionadas, com relacionamento e sinais de uso de cada telefone, usada para renderização em tabela.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "totalRelatedPeoplePhones": 1,
    "relatedPeoplePhonesList": "11900000000 - NOME DA PESSOA - 00000000000 - FILHO",
    "relatedPeoplePhones": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "FILHO",
        "type": "CELULAR",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "areaCode": "11",
        "number": "900000000",
        "phone": "11900000000",
        "isInDoNotCallList": false
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna telefones associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada telefone.

Validação de CPF com endereço

Service: SERVICE_CPF_ADDRESS_VALIDATIONQuando usar: Use para consultar ou validar endereços associados ao documento.O que retorna: Retorna se o endereço informado tem associação com o CPF, incluindo nível de match, endereço normalizado e sinais usados na validação.

Entrada

Campos obrigatórios: service, cpf, zipcode, numberAddress.

Resultado

Principais campos em result: cpf, zipcode, match, confidence, normalizedAddress.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpf, zipcode, numberAddressCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_CPF_ADDRESS_VALIDATION",
  "cpf": "cpf",
  "zipcode": "00000-000",
  "numberAddress": "13"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CPF_ADDRESS_VALIDATION",
  "cpf": "cpf",
  "zipcode": "00000-000",
  "numberAddress": "13"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CPF_ADDRESS_VALIDATION",
  "cpf": "cpf",
  "zipcode": "00000-000",
  "numberAddress": "13"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`zipcode`	Sim	CEP usado na validação de endereço.
`numberAddress`	Sim	Numero do endereço usado na validação.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.zipcode`	Campo retornado no objeto result para consumo do cliente.
`result.match`	Campo retornado no objeto result para consumo do cliente.
`result.confidence`	Campo retornado no objeto result para consumo do cliente.
`result.normalizedAddress`	Endereço, lista de endereços ou validação de endereço retornada pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "zipcode": "01001000",
    "match": true,
    "confidence": "HIGH",
    "normalizedAddress": "Rua Exemplo, 100"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna se o endereço informado tem associação com o CPF, incluindo nível de match, endereço normalizado e sinais usados na validação.

Validação de CPF com telefone

Service: SERVICE_CPF_PHONE_VALIDATIONQuando usar: Use para consultar, validar ou enriquecer dados de telefone.O que retorna: Retorna validação da associação entre CPF e telefone, com status de match, mensagem da consulta e dados retornados na consulta.

Entrada

Campos obrigatórios: service, cpf, phone.

Resultado

Principais campos em result: cpf, phone, match, statusMessage.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpf, phoneCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_CPF_PHONE_VALIDATION",
  "cpf": "cpf",
  "phone": "11900000000"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CPF_PHONE_VALIDATION",
  "cpf": "cpf",
  "phone": "11900000000"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CPF_PHONE_VALIDATION",
  "cpf": "cpf",
  "phone": "11900000000"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`phone`	Sim	Telefone usado para consulta ou validação, de preferência com DDD.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.phone`	Telefone, histórico de telefones ou validação de telefone retornada pela consulta.
`result.match`	Campo retornado no objeto result para consumo do cliente.
`result.statusMessage`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "phone": "11900000000",
    "match": true,
    "statusMessage": "Telefone associado ao documento"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna validação da associação entre CPF e telefone, com status de match, mensagem da consulta e dados retornados na consulta.

Validação de e-mail

Service: SERVICE_EMAIL_VALIDATIONQuando usar: Use para validar ou consultar histórico de e-mails relacionados ao documento.O que retorna: Retorna validação do e-mail informado, incluindo formato, existencia provável, domínio, entregabilidade e indicadores de risco.

Entrada

Campos obrigatórios: service, email.

Resultado

Principais campos em result: email, validFormat, deliverable, domain, riskLevel.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, emailCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_EMAIL_VALIDATION",
  "email": "[email protected]"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_EMAIL_VALIDATION",
  "email": "[email protected]"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_EMAIL_VALIDATION",
  "email": "[email protected]"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`email`	Sim	E-mail que será validado ou consultado.

Campos principais do result

Campo	Descrição
`result.email`	E-mail, histórico de e-mails ou validação de e-mail retornada pela consulta.
`result.validFormat`	Campo retornado no objeto result para consumo do cliente.
`result.deliverable`	Campo retornado no objeto result para consumo do cliente.
`result.domain`	Campo retornado no objeto result para consumo do cliente.
`result.riskLevel`	Indicador de risco retornado pelo produto.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "email": "[email protected]",
    "validFormat": true,
    "deliverable": true,
    "domain": "email.com",
    "riskLevel": "LOW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna validação do e-mail informado, incluindo formato, existencia provável, domínio, entregabilidade e indicadores de risco.

Cartão SUS

Service: SERVICE_ONDEMAND_SUS_CARD_PERSON_CPFQuando usar: Use este service quando precisar executar a consulta “Cartão SUS” via API.O que retorna: Retorna os dados do Cartão Nacional de Saúde (Cartão SUS) localizados para o CPF informado, com número do cartão, fonte e data da captura, dados de nascimento, indicação de evidência disponível e um resumo da consulta.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, sus_card_success, sus_card_number, sus_card_source, sus_card_capture_date, sus_card_birth_date e mais 6.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.sus_card_success`	Campo retornado no objeto result para consumo do cliente.
`result.sus_card_number`	Campo retornado no objeto result para consumo do cliente.
`result.sus_card_source`	Campo retornado no objeto result para consumo do cliente.
`result.sus_card_capture_date`	Data retornada pela consulta, conforme o contexto do service.
`result.sus_card_birth_date`	Data retornada pela consulta, conforme o contexto do service.
`result.sus_card_birth_city`	Campo retornado no objeto result para consumo do cliente.
`result.sus_card_birth_state`	Campo retornado no objeto result para consumo do cliente.
`result.sus_card_has_evidence`	Campo retornado no objeto result para consumo do cliente.
`result.sus_card_raw_result_file`	Campo retornado no objeto result para consumo do cliente.
`result.sus_card_raw_result_file_type`	Campo retornado no objeto result para consumo do cliente.
`result.sus_card_summary`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "sus_card_success": "Sim",
    "sus_card_number": "126000000000009",
    "sus_card_source": "BA",
    "sus_card_capture_date": "08/25/2025 20:07:36",
    "sus_card_birth_date": "03/13/1980 00:00:00",
    "sus_card_birth_city": "CHORROCHO",
    "sus_card_birth_state": "BA",
    "sus_card_has_evidence": "Não",
    "sus_card_raw_result_file": "https://example.com/documents/sus-card.pdf",
    "sus_card_raw_result_file_type": "pdf",
    "sus_card_summary": "Cartão SUS localizado"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna os dados do Cartão Nacional de Saúde (Cartão SUS) localizados para o CPF informado, com número do cartão, fonte e data da captura, dados de nascimento, indicação de evidência disponível e um resumo da consulta.

Consulta de MEI

Service: SERVICE_MEIQuando usar: Use este service quando precisar executar a consulta “Consulta de MEI” via API.O que retorna: Retorna empresas MEI associadas ao CPF, incluindo CNPJ, razão social, situação, atividades, endereço e datas cadastrais quando disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, meiCompanies.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_MEI",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_MEI",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_MEI",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.meiCompanies`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "meiCompanies": [
      {
        "cnpj": "cnpj",
        "officialName": "MEI EXEMPLO",
        "status": "ATIVA"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna empresas MEI associadas ao CPF, incluindo CNPJ, razão social, situação, atividades, endereço e datas cadastrais quando disponíveis.

CPF na Receita Federal on-demand

Service: SERVICE_RFB_PF_ON_DEMANDQuando usar: Use para consultar ou validar dados cadastrais da pessoa em bases da Receita Federal.O que retorna: Retorna situação atualizada do CPF consultada sob demanda na Receita Federal, com nome, nascimento, status cadastral e protocolo.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, name, birthDate, registrationStatus, protocol.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_RFB_PF_ON_DEMAND",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF_ON_DEMAND",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF_ON_DEMAND",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.name`	Nome completo retornado pela consulta quando disponível.
`result.birthDate`	Data retornada pela consulta, conforme o contexto do service.
`result.registrationStatus`	Campo retornado no objeto result para consumo do cliente.
`result.protocol`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "registrationStatus": "REGULAR",
    "protocol": "protocolo"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna situação atualizada do CPF consultada sob demanda na Receita Federal, com nome, nascimento, status cadastral e protocolo.

Dados demográficos

Service: SERVICE_DEMOGRAPHIC_DATA_CPFQuando usar: Use para consultar dados demograficos associados à pessoa.O que retorna: Retorna dados demograficos associados ao CPF, com dados regionais, estimativas e indicadores retornados pela base consultada.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, demographicData, totalIndicators.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

birthDate

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: birthDate

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_DEMOGRAPHIC_DATA_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DEMOGRAPHIC_DATA_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DEMOGRAPHIC_DATA_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`birthDate`	Não	Data de nascimento usada para aumentar a precisão da consulta quando exigida.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.demographicData`	Campo retornado no objeto result para consumo do cliente.
`result.totalIndicators`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "demographicData": [
      {
        "indicator": "Faixa de renda",
        "value": "Media"
      }
    ],
    "totalIndicators": 1
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados demograficos associados ao CPF, com dados regionais, estimativas e indicadores retornados pela base consultada.

Dados PIS

Service: SERVICE_PIS_CONSULTATIONQuando usar: Use este service quando precisar executar a consulta “Dados PIS” via API.O que retorna: Retorna dados de PIS/NIS associados ao CPF, incluindo número encontrado, status, dados cadastrais relacionados e mensagens da consulta.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, pis, status.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PIS_CONSULTATION",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PIS_CONSULTATION",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PIS_CONSULTATION",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.pis`	Campo retornado no objeto result para consumo do cliente.
`result.status`	Situação principal retornada pelo produto consultado.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "pis": "00000000000",
    "status": "FOUND"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados de PIS/NIS associados ao CPF, incluindo número encontrado, status, dados cadastrais relacionados e mensagens da consulta.

Enriquecimento de dados

Service: SERVICE_PERSON_DATA_ENRICHMENTQuando usar: Use para complementar dados cadastrais da pessoa a partir do documento informado.O que retorna: Retorna dados cadastrais do CPF, incluindo nome, nascimento, situação cadastral, filiação, óbito, idade, gênero e atributos disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, name, birthDate, registrationStatus, motherName.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

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

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.name`	Nome completo retornado pela consulta quando disponível.
`result.birthDate`	Data retornada pela consulta, conforme o contexto do service.
`result.registrationStatus`	Campo retornado no objeto result para consumo do cliente.
`result.motherName`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "registrationStatus": "REGULAR",
    "motherName": "Nome da mãe"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados cadastrais do CPF, incluindo nome, nascimento, situação cadastral, filiação, óbito, idade, gênero e atributos disponíveis.

Prêmios e certificações

Service: SERVICE_AWARDS_AND_CERTIFICATIONS_CPFQuando usar: Use este service quando precisar executar a consulta “Prêmios e certificações” via API.O que retorna: Retorna a quantidade e os registros de premios e certificacoes encontrados para o CPF, quando a base consultada possuir dados.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, totalAwards, totalCertifications, awards, certifications.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.totalAwards`	Campo retornado no objeto result para consumo do cliente.
`result.totalCertifications`	Campo retornado no objeto result para consumo do cliente.
`result.awards`	Campo retornado no objeto result para consumo do cliente.
`result.certifications`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "totalAwards": 0,
    "totalCertifications": 0,
    "awards": [],
    "certifications": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna a quantidade e os registros de premios e certificacoes encontrados para o CPF, quando a base consultada possuir dados.

Status do CPF na Receita Federal

Service: SERVICE_RFB_PFQuando usar: Use para consultar ou validar dados cadastrais da pessoa em bases da Receita Federal.O que retorna: Retorna situação do CPF na Receita Federal, incluindo nome, nascimento, status cadastral, comprovante/protocolo e dados fiscais disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, name, birthDate, registrationStatus, protocol.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

dataDeNascimento

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: dataDeNascimento

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "dataDeNascimento": "yyyy-MM-dd (opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`dataDeNascimento`	Não	Data de nascimento usada para aumentar a precisão da consulta quando exigida.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.name`	Nome completo retornado pela consulta quando disponível.
`result.birthDate`	Data retornada pela consulta, conforme o contexto do service.
`result.registrationStatus`	Campo retornado no objeto result para consumo do cliente.
`result.protocol`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "registrationStatus": "REGULAR",
    "protocol": "protocolo"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna situação do CPF na Receita Federal, incluindo nome, nascimento, status cadastral, comprovante/protocolo e dados fiscais disponíveis.

TSE - Local de votação

Service: SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPFQuando usar: Use este service quando precisar executar a consulta “TSE - Local de votação” via API.O que retorna: Retorna local de votação, situação eleitoral e biometria atual da pessoa no TSE, a partir do CPF informado.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, status, pollingPlace, pollingPlaceAddress, city, uf e mais 7.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

birthDate, motherName

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: birthDate, motherName

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "motherName": "nome da mãe (opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "motherName": "nome da mãe (opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "motherName": "nome da mãe (opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`birthDate`	Não	Data de nascimento usada para aumentar a precisão da consulta quando exigida.
`motherName`	Não	Nome da mãe usado para aumentar a assertividade da consulta.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.status`	Situação principal retornada pelo produto consultado.
`result.pollingPlace`	Nome do local de votação retornado pelo TSE.
`result.pollingPlaceAddress`	Endereço vigente do local de votação retornado pelo TSE.
`result.city`	Campo retornado no objeto result para consumo do cliente.
`result.uf`	Campo retornado no objeto result para consumo do cliente.
`result.zipcode`	Campo retornado no objeto result para consumo do cliente.
`result.electoralZone`	Zona eleitoral do local de votação.
`result.electoralSection`	Seção eleitoral do local de votação.
`result.hasBiometrics`	Indica se o TSE retornou biometria cadastrada para a pessoa.
`result.queryDate`	Data retornada pela fonte de dados para a consulta.
`result.source`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "status": "REGULAR",
    "pollingPlace": "ESCOLA CLASSE 01",
    "pollingPlaceAddress": "QUADRA 01, BRASILIA - DF",
    "city": "BRASILIA",
    "uf": "DF",
    "zipcode": "70000000",
    "electoralZone": "001",
    "electoralSection": "0001",
    "hasBiometrics": true,
    "queryDate": "2026-08-01",
    "source": "TSE-LOCALVOTACAO",
    "onlineQuery": "Situação, local, endereço, zona e seção retornados com sucesso"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna local de votação, situação eleitoral e biometria atual da pessoa no TSE, a partir do CPF informado.

Validação do E-Social

Service: SERVICE_ESOCIAL_REGISTRATION_QUALIFICATIONQuando usar: Use este service quando precisar executar a consulta “Validação do E-Social” via API.O que retorna: Retorna qualificação cadastral no eSocial, com status de consistencia entre CPF, NIT/PIS e dados cadastrais informados.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, nit, qualified, inconsistencies.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

nit

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: nit

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
  "cpf": "cpf",
  "nit": "(opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
  "cpf": "cpf",
  "nit": "(opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
  "cpf": "cpf",
  "nit": "(opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`nit`	Não	NIT/PIS/PASEP usado na qualificação cadastral.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.nit`	Campo retornado no objeto result para consumo do cliente.
`result.qualified`	Campo retornado no objeto result para consumo do cliente.
`result.inconsistencies`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "nit": "nit",
    "qualified": true,
    "inconsistencies": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna qualificação cadastral no eSocial, com status de consistencia entre CPF, NIT/PIS e dados cadastrais informados.

Dados eleitorais de candidato

Service: SERVICE_ELECTION_CANDIDATE_DATA_CPFQuando usar: Use para consultar informações eleitorais relacionadas à pessoa.O que retorna: Retorna histórico de candidaturas eleitorais do CPF, incluindo cargo, partido, ano, unidade eleitoral, bens declarados e situação quando disponível.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, candidacies.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.candidacies`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "candidacies": [
      {
        "year": 2024,
        "role": "VEREADOR",
        "party": "PARTIDO",
        "status": "DEFERIDO"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna histórico de candidaturas eleitorais do CPF, incluindo cargo, partido, ano, unidade eleitoral, bens declarados e situação quando disponível.

Doações eleitorais

Service: SERVICE_ELECTORAL_DONORS_CPFQuando usar: Use para consultar informações eleitorais relacionadas à pessoa.O que retorna: Retorna doações eleitorais realizadas pelo CPF, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, donations.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ELECTORAL_DONORS_CPF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ELECTORAL_DONORS_CPF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ELECTORAL_DONORS_CPF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.donations`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "donations": [
      {
        "year": 2024,
        "recipient": "Candidato",
        "amount": "500.00"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna doações eleitorais realizadas pelo CPF, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.

Envolvimento político

Service: SERVICE_POLITICAL_INVOLVEMENTQuando usar: Use este service quando precisar executar a consulta “Envolvimento político” via API.O que retorna: Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, politicalInvolvement.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_POLITICAL_INVOLVEMENT",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_POLITICAL_INVOLVEMENT",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_POLITICAL_INVOLVEMENT",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.politicalInvolvement`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "politicalInvolvement": [
      {
        "type": "CANDIDACY",
        "year": 2024,
        "details": "Candidatura encontrada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.

Envolvimento político PF

Service: SERVICE_POLITICAL_INVOLVEMENT_CPFQuando usar: Use este service quando precisar executar a consulta “Envolvimento político PF” via API.O que retorna: Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, politicalInvolvement.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_POLITICAL_INVOLVEMENT_CPF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_POLITICAL_INVOLVEMENT_CPF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_POLITICAL_INVOLVEMENT_CPF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.politicalInvolvement`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "politicalInvolvement": [
      {
        "type": "DONATION",
        "year": 2024,
        "details": "Doacao encontrada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.

Histórico familiar político

Service: SERVICE_FAMILY_POLITICAL_HISTORY_CPFQuando usar: Use este service quando precisar executar a consulta “Histórico familiar político” via API.O que retorna: Retorna histórico político familiar do CPF, incluindo familiares com candidaturas, doações, cargos, partidos e vínculos eleitorais quando encontrados.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, familyPoliticalHistory.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.familyPoliticalHistory`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "familyPoliticalHistory": [
      {
        "relativeName": "Nome relacionado",
        "relationship": "PARENTE",
        "role": "Candidato"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna histórico político familiar do CPF, incluindo familiares com candidaturas, doações, cargos, partidos e vínculos eleitorais quando encontrados.

KYC e compliance

Service: SERVICE_PERSON_KYCQuando usar: Use para executar checagens de KYC e compliance da pessoa.O que retorna: Retorna checagem de KYC da pessoa, incluindo PEP, sanções, mídia, processos, alertas de compliance e sinais de risco.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, isPep, sanctions, mediaExposure, riskAlerts.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

birthDate

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: birthDate

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PERSON_KYC",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_KYC",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_KYC",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`birthDate`	Não	Data de nascimento usada para aumentar a precisão da consulta quando exigida.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.isPep`	Campo retornado no objeto result para consumo do cliente.
`result.sanctions`	Campo retornado no objeto result para consumo do cliente.
`result.mediaExposure`	Notícias, exposição em mídia ou indicadores públicos associados ao documento.
`result.riskAlerts`	Indicador de risco retornado pelo produto.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "isPep": false,
    "sanctions": [],
    "mediaExposure": [],
    "riskAlerts": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna checagem de KYC da pessoa, incluindo PEP, sanções, mídia, processos, alertas de compliance e sinais de risco.

Pessoa politicamente exposta

Service: SERVICE_PEPQuando usar: Use para verificar exposição política ou vínculo com Pessoa Politicamente Exposta.O que retorna: Retorna se o CPF e PEP ou relacionado a PEP, com cargo, órgão, nível de exposição, período e vínculos encontrados quando disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, isPep, positions.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PEP",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PEP",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PEP",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.isPep`	Campo retornado no objeto result para consumo do cliente.
`result.positions`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "isPep": false,
    "positions": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna se o CPF e PEP ou relacionado a PEP, com cargo, órgão, nível de exposição, período e vínculos encontrados quando disponíveis.

Prestadores de serviço eleitorais

Service: SERVICE_ELECTORAL_PROVIDERS_CPFQuando usar: Use para consultar informações eleitorais relacionadas à pessoa.O que retorna: Retorna prestações de serviço eleitorais vinculadas ao CPF, com campanha, candidato/partido, valor, ano e natureza do serviço.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, campos.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ELECTORAL_PROVIDERS_CPF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ELECTORAL_PROVIDERS_CPF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ELECTORAL_PROVIDERS_CPF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.campos`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "campos": [
      {
        "year": 2024,
        "campaign": "Campanha",
        "amount": "800.00",
        "serviceType": "Servico"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna prestações de serviço eleitorais vinculadas ao CPF, com campanha, candidato/partido, valor, ano e natureza do serviço.

Antecedentes criminais civis

Service: SERVICE_CRIMINAL_RECORD_CIVILQuando usar: Use para consultar certidões, processos ou informações jurídicas da pessoa.O que retorna: Retorna resultado de antecedentes criminais civis, com status da certidão, ocorrências encontradas, UF, RG e mensagens da consulta.

Entrada

Campos obrigatórios: service, cpf, rg, uf.

Resultado

Principais campos em result: cpf, rg, state, hasRecords, records.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpf, rg, ufCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_CRIMINAL_RECORD_CIVIL",
  "cpf": "cpf",
  "rg": "rg",
  "uf": "uf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CRIMINAL_RECORD_CIVIL",
  "cpf": "cpf",
  "rg": "rg",
  "uf": "uf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CRIMINAL_RECORD_CIVIL",
  "cpf": "cpf",
  "rg": "rg",
  "uf": "uf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`rg`	Sim	Numero do RG usado em certidões ou validações documentais.
`uf`	Sim	UF usada para limitar a consulta estadual ou jurídica.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.rg`	Campo retornado no objeto result para consumo do cliente.
`result.state`	Campo retornado no objeto result para consumo do cliente.
`result.hasRecords`	Campo retornado no objeto result para consumo do cliente.
`result.records`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "rg": "rg",
    "state": "SP",
    "hasRecords": false,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna resultado de antecedentes criminais civis, com status da certidão, ocorrências encontradas, UF, RG e mensagens da consulta.

Antecedentes criminais federais

Service: SERVICE_CRIMINAL_RECORD_FEDERALQuando usar: Use para consultar certidões, processos ou informações jurídicas da pessoa.O que retorna: Retorna resultado de antecedentes criminais federais, com status da certidão, ocorrências encontradas e mensagens da consulta.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, hasFederalCriminalRecord, records.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_CRIMINAL_RECORD_FEDERAL",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CRIMINAL_RECORD_FEDERAL",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CRIMINAL_RECORD_FEDERAL",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.hasFederalCriminalRecord`	Campo retornado no objeto result para consumo do cliente.
`result.records`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "hasFederalCriminalRecord": false,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna resultado de antecedentes criminais federais, com status da certidão, ocorrências encontradas e mensagens da consulta.

Certidão de Nada Consta

Service: SERVICE_NOTHING_RECORD_LAWSUITSQuando usar: Use para consultar certidões, processos ou informações jurídicas da pessoa.O que retorna: Retorna certidão de nada consta para a esfera/tribunal informado, com status, mensagem, ocorrências e dados usados na consulta.

Entrada

Campos obrigatórios: service, cpf, court, uf, sphere.

Resultado

Principais campos em result: cpf, court, sphere, nothingFound, records.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpf, court, uf, sphereCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
  "cpf": "cpf",
  "court": "TRF1",
  "uf": "uf",
  "sphere": "CIVIL"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
  "cpf": "cpf",
  "court": "TRF1",
  "uf": "uf",
  "sphere": "CIVIL"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
  "cpf": "cpf",
  "court": "TRF1",
  "uf": "uf",
  "sphere": "CIVIL"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`court`	Sim	Tribunal ou órgão usado na consulta de certidão/processo.
`uf`	Sim	UF usada para limitar a consulta estadual ou jurídica.
`sphere`	Sim	Esfera da consulta, como civil, criminal ou federal.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.court`	Campo retornado no objeto result para consumo do cliente.
`result.sphere`	Campo retornado no objeto result para consumo do cliente.
`result.nothingFound`	Campo retornado no objeto result para consumo do cliente.
`result.records`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "court": "TRF1",
    "sphere": "CIVIL",
    "nothingFound": true,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna certidão de nada consta para a esfera/tribunal informado, com status, mensagem, ocorrências e dados usados na consulta.

Certidão negativa de protesto

Service: SERVICE_PROTEST_CLEARANCE_CERTIFICATEQuando usar: Use para consultar protestos associados ao documento da pessoa.O que retorna: Retorna certidão/consulta de protestos para CPF, com status de nada consta ou lista de protestos, cartório, valor e datas.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, hasProtests, protests.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.hasProtests`	Campo retornado no objeto result para consumo do cliente.
`result.protests`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "hasProtests": false,
    "protests": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna certidão/consulta de protestos para CPF, com status de nada consta ou lista de protestos, cartório, valor e datas.

Certidão negativa de protesto PF

Service: SERVICE_PROTEST_PFQuando usar: Use para consultar protestos associados ao documento da pessoa.O que retorna: Retorna certidão/consulta de protestos para CPF, com status, cartórios consultados, protestos e mensagens.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, hasProtests, notaryOffices, protests.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PROTEST_PF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROTEST_PF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROTEST_PF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.hasProtests`	Campo retornado no objeto result para consumo do cliente.
`result.notaryOffices`	Campo retornado no objeto result para consumo do cliente.
`result.protests`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "hasProtests": false,
    "notaryOffices": [],
    "protests": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna certidão/consulta de protestos para CPF, com status, cartórios consultados, protestos e mensagens.

Mandado de prisão

Service: SERVICE_ARREST_WARRANTQuando usar: Use este service quando precisar executar a consulta “Mandado de prisão” via API.O que retorna: Retorna indicativos de mandado de prisão para os dados informados, com situação, órgão, processo e detalhes encontrados quando houver ocorrência.

Entrada

Campos obrigatórios: service, nome, motherName, fatherName, birthDate, cpf.

Resultado

Principais campos em result: cpf, hasArrestWarrant, warrants.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, nome, motherName, fatherName, birthDate, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ARREST_WARRANT",
  "nome": "nome",
  "motherName": "nome da mãe",
  "fatherName": "nome do pai",
  "birthDate": "dd/MM/yyyy",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ARREST_WARRANT",
  "nome": "nome",
  "motherName": "nome da mãe",
  "fatherName": "nome do pai",
  "birthDate": "dd/MM/yyyy",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ARREST_WARRANT",
  "nome": "nome",
  "motherName": "nome da mãe",
  "fatherName": "nome do pai",
  "birthDate": "dd/MM/yyyy",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`nome`	Sim	Nome completo usado na consulta quando não ha documento suficiente.
`motherName`	Sim	Nome da mãe usado para aumentar a assertividade da consulta.
`fatherName`	Sim	Nome do pai usado para aumentar a assertividade da consulta.
`birthDate`	Sim	Data de nascimento usada para aumentar a precisão da consulta quando exigida.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.hasArrestWarrant`	Campo retornado no objeto result para consumo do cliente.
`result.warrants`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "hasArrestWarrant": false,
    "warrants": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna indicativos de mandado de prisão para os dados informados, com situação, órgão, processo e detalhes encontrados quando houver ocorrência.

Processos jurídicos e administrativos

Service: SERVICE_JURIDICAL_PROCESSESQuando usar: Use para consultar certidões, processos ou informações jurídicas da pessoa.O que retorna: Retorna processos jurídicos e administrativos vinculados ao CPF, com tribunal, classe, assunto, partes, status e datas quando disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, totalProcesses, processes.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_JURIDICAL_PROCESSES",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_JURIDICAL_PROCESSES",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_JURIDICAL_PROCESSES",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.totalProcesses`	Campo retornado no objeto result para consumo do cliente.
`result.processes`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "totalProcesses": 1,
    "processes": [
      {
        "court": "TJSP",
        "processNumber": "0000000-00.0000.0.00.0000",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna processos jurídicos e administrativos vinculados ao CPF, com tribunal, classe, assunto, partes, status e datas quando disponíveis.

Exposição e perfil na mídia

Service: SERVICE_MEDIA_PROFILE_EXPOSURE_PFQuando usar: Use este service quando precisar executar a consulta “Exposição e perfil na mídia” via API.O que retorna: Retorna exposição e perfil de mídia da pessoa, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, mediaMentions, exposureLevel.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.mediaMentions`	Notícias, exposição em mídia ou indicadores públicos associados ao documento.
`result.exposureLevel`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "mediaMentions": [
      {
        "title": "Noticia encontrada",
        "source": "Fonte",
        "sentiment": "NEUTRAL"
      }
    ],
    "exposureLevel": "LOW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna exposição e perfil de mídia da pessoa, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.

Propensão a apostas online

Service: SEVICE_ONLINE_BETTING_PROPENSITYQuando usar: Use este service quando precisar executar a consulta “Propensão a apostas online” via API.O que retorna: Retorna propensão do CPF a apostas online, com score, faixa de propensão, indicadores comportamentais e sinais associados quando disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, propensityScore, propensityLevel, indicators.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SEVICE_ONLINE_BETTING_PROPENSITY",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SEVICE_ONLINE_BETTING_PROPENSITY",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SEVICE_ONLINE_BETTING_PROPENSITY",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.propensityScore`	Campo retornado no objeto result para consumo do cliente.
`result.propensityLevel`	Campo retornado no objeto result para consumo do cliente.
`result.indicators`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "propensityScore": 78,
    "propensityLevel": "HIGH",
    "indicators": [
      "sinal encontrado"
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna propensão do CPF a apostas online, com score, faixa de propensão, indicadores comportamentais e sinais associados quando disponíveis.

Benefícios sociais estendidos

Service: SERVICE_SOCIAL_ASSISTANCE_EXTENDEDQuando usar: Use este service quando precisar executar a consulta “Benefícios sociais estendidos” via API.O que retorna: Retorna benefícios sociais estendidos vinculados ao CPF, com programas, indicadores, situação e detalhes encontrados quando disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, totalBenefits, benefits, indicators.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_SOCIAL_ASSISTANCE_EXTENDED",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_SOCIAL_ASSISTANCE_EXTENDED",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_SOCIAL_ASSISTANCE_EXTENDED",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.totalBenefits`	Campo retornado no objeto result para consumo do cliente.
`result.benefits`	Campo retornado no objeto result para consumo do cliente.
`result.indicators`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "totalBenefits": 1,
    "benefits": [
      {
        "program": "Programa social",
        "status": "ACTIVE"
      }
    ],
    "indicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna benefícios sociais estendidos vinculados ao CPF, com programas, indicadores, situação e detalhes encontrados quando disponíveis.

Benefícios sociais familiares

Service: SERVICE_FAMILY_SOCIAL_BENEFITSQuando usar: Use este service quando precisar executar a consulta “Benefícios sociais familiares” via API.O que retorna: Retorna benefícios sociais familiares vinculados ao CPF, com programas, situação, quantidade e registros encontrados quando disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, totalBenefits, benefits.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_FAMILY_SOCIAL_BENEFITS",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FAMILY_SOCIAL_BENEFITS",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FAMILY_SOCIAL_BENEFITS",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.totalBenefits`	Campo retornado no objeto result para consumo do cliente.
`result.benefits`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "totalBenefits": 1,
    "benefits": [
      {
        "program": "Programa social",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna benefícios sociais familiares vinculados ao CPF, com programas, situação, quantidade e registros encontrados quando disponíveis.

Flags Negativos

Service: SERVICE_QUOD_CREDIT_RISK_PERSONQuando usar: Use este service quando precisar executar a consulta “Flags Negativos” via API.O que retorna: Retorna flags negativos de crédito de pessoa física pelo CPF informado, com nível e classificação de risco, indicativo de restrições e quantidade de flags negativos.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, riskLevel, riskClassification, hasRestrictions, negativeFlagsCount, creditBureauSummary e mais 3.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_QUOD_CREDIT_RISK_PERSON",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_QUOD_CREDIT_RISK_PERSON",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_QUOD_CREDIT_RISK_PERSON",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.riskLevel`	Nível de risco de crédito retornado na consulta.
`result.riskClassification`	Classificação de risco de crédito retornada na consulta.
`result.hasRestrictions`	Indica se foram retornadas restrições de crédito.
`result.negativeFlagsCount`	Quantidade de flags negativos retornados na consulta.
`result.creditBureauSummary`	Resumo textual dos principais dados de bureau de crédito retornados.
`result.creditBureauDetails`	Dados estruturados de bureau de crédito para consumo via API.
`result.origin`	Origem funcional da consulta executada.
`result.queryDate`	Data retornada pela fonte de dados para a consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "riskLevel": "BAIXO",
    "riskClassification": "A",
    "hasRestrictions": false,
    "negativeFlagsCount": 0,
    "creditBureauSummary": "Nenhum flag negativo encontrado",
    "creditBureauDetails": {},
    "origin": "Quod",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna flags negativos de crédito de pessoa física pelo CPF informado, com nível e classificação de risco, indicativo de restrições e quantidade de flags negativos.

Histórico profissional

Service: SERVICE_PROFESSIONAL_HISTORYQuando usar: Use este service quando precisar executar a consulta “Histórico profissional” via API.O que retorna: Retorna histórico profissional do CPF, incluindo empresas, cargos, datas, vínculos empregaticios ou societários e indicadores profissionais.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, professionalHistory.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PROFESSIONAL_HISTORY",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROFESSIONAL_HISTORY",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROFESSIONAL_HISTORY",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.professionalHistory`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "professionalHistory": [
      {
        "companyName": "Empresa Exemplo",
        "role": "Analista",
        "startDate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna histórico profissional do CPF, incluindo empresas, cargos, datas, vínculos empregaticios ou societários e indicadores profissionais.

Histórico profissional do titular

Service: SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLYQuando usar: Use este service quando precisar executar a consulta “Histórico profissional do titular” via API.O que retorna: Retorna histórico profissional em que a pessoa aparece como titular, sócio ou proprietario, com empresas, cargos e datas de vinculo.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, ownerHistory.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

birthDate

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: birthDate

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`birthDate`	Não	Data de nascimento usada para aumentar a precisão da consulta quando exigida.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.ownerHistory`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "ownerHistory": [
      {
        "companyName": "Empresa Exemplo",
        "cnpj": "cnpj",
        "qualification": "SOCIO"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna histórico profissional em que a pessoa aparece como titular, sócio ou proprietario, com empresas, cargos e datas de vinculo.

Indicadores de atividades

Service: SERVICE_ACTIVITIES_INDICATORSQuando usar: Use este service quando precisar executar a consulta “Indicadores de atividades” via API.O que retorna: Retorna indicadores de atividades vinculadas ao CPF, como sinais profissionais, segmentos, ocupacoes e registros disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, activityIndicators, hasActivityIndicators.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ACTIVITIES_INDICATORS",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ACTIVITIES_INDICATORS",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ACTIVITIES_INDICATORS",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.activityIndicators`	Campo retornado no objeto result para consumo do cliente.
`result.hasActivityIndicators`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "activityIndicators": [
      {
        "type": "PROFESSIONAL",
        "description": "Indicador encontrado"
      }
    ],
    "hasActivityIndicators": true
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna indicadores de atividades vinculadas ao CPF, como sinais profissionais, segmentos, ocupacoes e registros disponíveis.

Modelagem de dados

Service: SERVICE_PERSON_DATA_MODELINGQuando usar: Use este service quando precisar executar a consulta “Modelagem de dados” via API.O que retorna: Retorna modelagem consolidada da pessoa, reunindo dados cadastrais, contatos, endereços, vínculos, indicadores e resumos derivados.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, profileSummary, contacts, addresses, relationships.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PERSON_DATA_MODELING",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_DATA_MODELING",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_DATA_MODELING",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.profileSummary`	Campo retornado no objeto result para consumo do cliente.
`result.contacts`	Campo retornado no objeto result para consumo do cliente.
`result.addresses`	Endereço, lista de endereços ou validação de endereço retornada pela consulta.
`result.relationships`	Vínculos, pessoas, sócios ou relacionamentos retornados pela consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "profileSummary": "Resumo consolidado",
    "contacts": [],
    "addresses": [],
    "relationships": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna modelagem consolidada da pessoa, reunindo dados cadastrais, contatos, endereços, vínculos, indicadores e resumos derivados.

Prompt de IA para pessoa

Service: SERVICE_PERSON_AI_PROMPTQuando usar: Use este service quando precisar executar a consulta “Prompt de IA para pessoa” via API.O que retorna: Retorna uma resposta textual consolidada por IA a partir dos dados da pessoa, com resumo, pontos de atenção e leitura operacional.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, answer, highlights.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PERSON_AI_PROMPT",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_AI_PROMPT",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_AI_PROMPT",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.answer`	Campo retornado no objeto result para consumo do cliente.
`result.highlights`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "answer": "Resumo analitico gerado pela IA",
    "highlights": [
      "ponto relevante"
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna uma resposta textual consolidada por IA a partir dos dados da pessoa, com resumo, pontos de atenção e leitura operacional.

Servidores públicos

Service: SERVICE_PUBLIC_SERVANTSQuando usar: Use este service quando precisar executar a consulta “Servidores públicos” via API.O que retorna: Retorna registros de servidor publico associados ao CPF, incluindo órgão, cargo, vinculo, remuneracao/faixa e período quando disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, publicServantRecords.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_PUBLIC_SERVANTS",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PUBLIC_SERVANTS",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PUBLIC_SERVANTS",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.publicServantRecords`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "publicServantRecords": [
      {
        "agency": "Orgao publico",
        "role": "Cargo",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna registros de servidor publico associados ao CPF, incluindo órgão, cargo, vinculo, remuneracao/faixa e período quando disponíveis.

Dados Restritivos

Service: SERVICE_BOAVISTA_CREDIT_SCORE_PERSONQuando usar: Use para avaliar risco, score ou propensão associada à pessoa.O que retorna: Retorna dados restritivos de crédito de pessoa física pelo CPF informado, incluindo score, indicativo e quantidade de restrições encontradas.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, score, hasRestrictions, restrictionCount, creditBureauSummary, creditBureauDetails e mais 2.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_BOAVISTA_CREDIT_SCORE_PERSON",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_BOAVISTA_CREDIT_SCORE_PERSON",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_BOAVISTA_CREDIT_SCORE_PERSON",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.score`	Score de crédito retornado pelo bureau para o CNPJ consultado.
`result.hasRestrictions`	Indica se foram retornadas restrições de crédito.
`result.restrictionCount`	Quantidade de restrições retornadas na consulta.
`result.creditBureauSummary`	Resumo textual dos principais dados de bureau de crédito retornados.
`result.creditBureauDetails`	Dados estruturados de bureau de crédito para consumo via API.
`result.origin`	Origem funcional da consulta executada.
`result.queryDate`	Data retornada pela fonte de dados para a consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "score": 705,
    "hasRestrictions": false,
    "restrictionCount": 0,
    "creditBureauSummary": "Nenhuma restrição de crédito encontrada",
    "creditBureauDetails": {},
    "origin": "Boa Vista",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dados restritivos de crédito de pessoa física pelo CPF informado, incluindo score, indicativo e quantidade de restrições encontradas.

Dívida ativa

Service: SERVICE_ACTIVE_DEBT_PFQuando usar: Use para consultar débitos ou dívidas associadas à pessoa.O que retorna: Retorna dívidas ativas vinculadas ao CPF, com origem do débito, valores, situação, órgão credor e status da consulta.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, totalDebts, totalValue, debts.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_ACTIVE_DEBT_PF",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ACTIVE_DEBT_PF",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ACTIVE_DEBT_PF",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.totalDebts`	Campo retornado no objeto result para consumo do cliente.
`result.totalValue`	Valor monetário, estimativa ou montante retornado pela consulta.
`result.debts`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "totalDebts": 2,
    "totalValue": "1234.56",
    "debts": [
      {
        "source": "PGFN",
        "value": "1234.56",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna dívidas ativas vinculadas ao CPF, com origem do débito, valores, situação, órgão credor e status da consulta.

Informações financeiras

Service: SERVICE_FINANCIAL_INFORMATIONQuando usar: Use para consultar informações financeiras associadas à pessoa.O que retorna: Retorna informações financeiras estimadas do CPF, como renda presumida, poder aquisitivo, classe econômica e indicadores financeiros disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, estimatedIncome, purchasingPower, financialIndicators.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_FINANCIAL_INFORMATION",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FINANCIAL_INFORMATION",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FINANCIAL_INFORMATION",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.estimatedIncome`	Campo retornado no objeto result para consumo do cliente.
`result.purchasingPower`	Campo retornado no objeto result para consumo do cliente.
`result.financialIndicators`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "estimatedIncome": "5000-10000",
    "purchasingPower": "MEDIUM",
    "financialIndicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna informações financeiras estimadas do CPF, como renda presumida, poder aquisitivo, classe econômica e indicadores financeiros disponíveis.

Risco financeiro

Service: SERVICE_FINANCIAL_RISK_SCOREQuando usar: Use para consultar informações financeiras associadas à pessoa.O que retorna: Retorna score de risco financeiro do CPF, faixa de risco, recomendação resumida e fatores que influenciam a avaliação.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, score, riskLevel, recommendation.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

birthDate

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: birthDate

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_FINANCIAL_RISK_SCORE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FINANCIAL_RISK_SCORE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FINANCIAL_RISK_SCORE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`birthDate`	Não	Data de nascimento usada para aumentar a precisão da consulta quando exigida.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.score`	Pontuação calculada pelo produto para o indicador consultado.
`result.riskLevel`	Indicador de risco retornado pelo produto.
`result.recommendation`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "score": 681,
    "riskLevel": "MEDIUM",
    "recommendation": "REVIEW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna score de risco financeiro do CPF, faixa de risco, recomendação resumida e fatores que influenciam a avaliação.

Score de crédito

Service: SERVICE_CREDIT_SCOREQuando usar: Use para avaliar risco, score ou propensão associada à pessoa.O que retorna: Retorna score de crédito associado ao CPF, com pontuação, faixa de risco e mensagem da consulta quando disponíveis.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, score, riskLevel, message.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

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

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CREDIT_SCORE",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CREDIT_SCORE",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.score`	Pontuação calculada pelo produto para o indicador consultado.
`result.riskLevel`	Indicador de risco retornado pelo produto.
`result.message`	Mensagem de leitura do resultado ou do processamento.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "score": 750,
    "riskLevel": "LOW",
    "message": "Score calculado com sucesso"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna score de crédito associado ao CPF, com pontuação, faixa de risco e mensagem da consulta quando disponíveis.

Score de Crédito

Service: SERVICE_QUOD_CREDIT_SCORE_PERSONQuando usar: Use para avaliar risco, score ou propensão associada à pessoa.O que retorna: Retorna score de crédito de pessoa física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, score, riskLevel, riskClassification, reasonCodes, creditBureauSummary e mais 3.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_QUOD_CREDIT_SCORE_PERSON",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_QUOD_CREDIT_SCORE_PERSON",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_QUOD_CREDIT_SCORE_PERSON",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.score`	Score de crédito retornado pelo bureau para o CNPJ consultado.
`result.riskLevel`	Nível de risco de crédito retornado na consulta.
`result.riskClassification`	Classificação de risco de crédito retornada na consulta.
`result.reasonCodes`	Motivos, códigos ou fatores retornados para explicar o score.
`result.creditBureauSummary`	Resumo textual dos principais dados de bureau de crédito retornados.
`result.creditBureauDetails`	Dados estruturados de bureau de crédito para consumo via API.
`result.origin`	Origem funcional da consulta executada.
`result.queryDate`	Data retornada pela fonte de dados para a consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "score": 680,
    "riskLevel": "MEDIO",
    "riskClassification": "B",
    "reasonCodes": [
      "Tempo de relacionamento com o mercado",
      "Renda declarada baixa"
    ],
    "creditBureauSummary": "Score de crédito dentro da média do perfil",
    "creditBureauDetails": {},
    "origin": "Quod",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna score de crédito de pessoa física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

Score de Crédito Multidados

Service: SERVICE_BOAVISTA_ONE_SCORE_PERSONQuando usar: Use para avaliar risco, score ou propensão associada à pessoa.O que retorna: Retorna score de crédito multidados de pessoa física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, score, riskLevel, riskClassification, reasonCodes, creditBureauSummary e mais 3.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_BOAVISTA_ONE_SCORE_PERSON",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_BOAVISTA_ONE_SCORE_PERSON",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_BOAVISTA_ONE_SCORE_PERSON",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.score`	Score de crédito retornado pelo bureau para o CNPJ consultado.
`result.riskLevel`	Nível de risco de crédito retornado na consulta.
`result.riskClassification`	Classificação de risco de crédito retornada na consulta.
`result.reasonCodes`	Motivos, códigos ou fatores retornados para explicar o score.
`result.creditBureauSummary`	Resumo textual dos principais dados de bureau de crédito retornados.
`result.creditBureauDetails`	Dados estruturados de bureau de crédito para consumo via API.
`result.origin`	Origem funcional da consulta executada.
`result.queryDate`	Data retornada pela fonte de dados para a consulta.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "score": 710,
    "riskLevel": "BAIXO",
    "riskClassification": "A",
    "reasonCodes": [
      "Bom histórico de pagamentos"
    ],
    "creditBureauSummary": "Score de crédito multidados acima da média do perfil",
    "creditBureauDetails": {},
    "origin": "Boa Vista",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna score de crédito multidados de pessoa física pelo CPF informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta.

Score de inadimplência

Service: SERVICE_DEFAULT_RISK_SCOREQuando usar: Use para avaliar risco, score ou propensão associada à pessoa.O que retorna: Retorna score de risco de inadimplência para CPF, com pontuação, faixa de risco e probabilidade estimada quando disponível.

Entrada

Campos obrigatórios: service, cpf.

Resultado

Principais campos em result: cpf, score, riskLevel, defaultProbability.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpfCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_DEFAULT_RISK_SCORE",
  "cpf": "cpf"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DEFAULT_RISK_SCORE",
  "cpf": "cpf"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DEFAULT_RISK_SCORE",
  "cpf": "cpf"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.score`	Pontuação calculada pelo produto para o indicador consultado.
`result.riskLevel`	Indicador de risco retornado pelo produto.
`result.defaultProbability`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "score": 690,
    "riskLevel": "MEDIUM",
    "defaultProbability": "8%"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna score de risco de inadimplência para CPF, com pontuação, faixa de risco e probabilidade estimada quando disponível.

Score de risco de fraude

Service: SERVICE_FRAUD_RISK_SCOREQuando usar: Use para avaliar risco, score ou propensão associada à pessoa.O que retorna: Retorna score de risco de fraude do CPF, fator analisado, nível de risco, score numérico e sinais que suportam a decisão.

Entrada

Campos obrigatórios: service, cpf, factor.

Resultado

Principais campos em result: cpf, factor, score, riskLevel, indicators.

Status da chamada

Use status.code e status.message para entender se a consulta processou corretamente.

Campos opcionais

Nenhum campo opcional mapeado neste exemplo.

Endpoint: POST /api/service-apiCampos obrigatórios: service, cpf, factorCampos opcionais: Nenhum campo opcional mapeado neste exemplo.

Passo a passo

Gere o token em POST /api/token-generate e envie no header Authorization: Bearer {jwt_token}.
Monte o body com o service exato e os campos obrigatórios listados abaixo.
Execute POST /api/service-api no ambiente escolhido.
Confira status.code e status.message para validar o processamento técnico.
Mapeie os campos de result conforme o resumo e o exemplo de response deste service.

Copiar e testar

Body JSON
Curl HML
Curl produção

Use este body no Postman em Body > raw > JSON. Troque apenas os valores de teste.

{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}

curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}'

curl --location 'https://backoffice.idcerberus.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}'

Campos do body

Campo	Obrigatório	Descrição
`service`	Sim	Código exato do produto que será executado pelo endpoint central.
`cpf`	Sim	CPF da pessoa física consultada.
`factor`	Sim	Fator de risco solicitado no payload, como risco mínimo ou atrito mínimo.

Campos principais do result

Campo	Descrição
`result.cpf`	CPF relacionado ao resultado da consulta.
`result.factor`	Fator, faixa ou classificação usada para interpretar o score.
`result.score`	Pontuação calculada pelo produto para o indicador consultado.
`result.riskLevel`	Indicador de risco retornado pelo produto.
`result.indicators`	Campo retornado no objeto result para consumo do cliente.

Como consumir o retorno

result

Dados públicos do service. É o objeto principal para mapear no sistema do cliente.

status

Status técnico da chamada, com code e message.

onboardingStatus

Quando retornado, resume o desfecho operacional: APPROVED, REFUSED ou ERROR.

externalId

Identificador para rastrear a consulta em suporte, logs ou auditoria.

Response resumido

{
  "result": {
    "cpf": "cpf",
    "factor": "minRisk",
    "score": 720,
    "riskLevel": "LOW",
    "indicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Neste service, o objeto result representa: Retorna score de risco de fraude do CPF, fator analisado, nível de risco, score numérico e sinais que suportam a decisão.

Checklist antes de abrir chamado

Acesso

Confirme se o token pertence ao produto certo e se o service está ativo para API.

Payload

Confirme o valor exato de service e os campos obrigatórios listados no accordion.

Ambiente

Valide se a chamada foi feita em HML ou produção com o token do mesmo ambiente.

Evidência

Separe body sem dados sensíveis, horário, ambiente, status.message e externalId.

Padrões de erro

Os exemplos abaixo mostram formatos comuns. A mensagem pode variar conforme validação, produto e ambiente.

Token ausente ou inválido

{
  "status": {
    "code": 401,
    "message": "Unauthorized"
  }
}

Parâmetro obrigatório ausente

{
  "status": {
    "code": 400,
    "message": "Required field is missing or invalid"
  }
}

Service não liberado ou indisponível

{
  "status": {
    "code": 403,
    "message": "Service unavailable or not enabled for this client"
  }
}

​Antes de testar

Contrato base

Postman do zero

OCR e imagem

Fluxos prontos

​Como usar esta página

​Como interpretar qualquer retorno

Dados úteis

Status técnico

Rastreio

Contrato limpo

​Famílias de services

Biometria e documentos

Contatos, sites e relacionamentos

Dados cadastrais e Receita Federal

Dados eleitorais e PEP

Jurídico, certidões e protestos

KYC, compliance e exposição

Outros services

Risco, crédito e dívidas

​Catálogo completo

Entrada

Resultado

Status da chamada

Campos opcionais

​Passo a passo

​Copiar e testar

​Campos do body

​Campos principais do result

​Como consumir o retorno

result

status

onboardingStatus

externalId

​Response resumido

Entrada

Resultado

Status da chamada

Campos opcionais

​Passo a passo

​Copiar e testar

​Campos do body

​Campos principais do result

​Como consumir o retorno

result

status

onboardingStatus

externalId

​Response resumido

Entrada

Resultado

Status da chamada

Campos opcionais

​Passo a passo

​Copiar e testar

​Campos do body

​Campos principais do result

​Como consumir o retorno

result

status

onboardingStatus

externalId

​Response resumido

Entrada

Resultado

Status da chamada

Campos opcionais

​Guia de OCR

​Payload mínimo

​Retorno limpo esperado

​Erro comum

​Passo a passo

​Copiar e testar

​Campos do body

​Campos principais do result

​Como consumir o retorno

result

status

onboardingStatus

externalId

Antes de testar

Como usar esta página

Como interpretar qualquer retorno

Famílias de services

Catálogo completo

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Guia de OCR

Payload mínimo

Retorno limpo esperado

Erro comum

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Guia de OCR

Payload mínimo

Retorno limpo esperado

Erro comum

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido

Passo a passo

Copiar e testar

Campos do body

Campos principais do result

Como consumir o retorno

Response resumido