curl --request POST \
  --url https://backoffice-hml.idcerberus.com/api/service-api \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "cpf"
}
'

{
  "result": {
    "cpf": "06319423196",
    "status": "REGULAR",
    "statusDate": "2022-05-29T00:00:00",
    "name": "NOME DA PESSOA",
    "motherName": "NOME DA MÃE",
    "birthdate": "1998-07-05",
    "birthCountry": "BRASILEIRA",
    "dead": false,
    "gender": "M",
    "age": 24,
    "origin": "RECEITA FEDERAL",
    "fiscalRegion": "DF-GO-MS-MT-TO",
    "numberOfPeopleWithTheSameName": "3",
    "nameWordCount": "3",
    "nameUniqueScore": "0.994"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Serviços - Pessoas

Executar serviço de dados, risco ou compliance

Endpoint central para executar produtos de dados, risco, biometria, documentos e compliance de pessoa física e pessoa jurídica.

A rota é sempre POST /api/service-api. O produto executado é definido pelo campo service enviado no body. Os demais campos variam conforme o serviço escolhido.

O valor de service é validado contra os services liberados no produto do cliente. Se o produto estiver configurado com alias curto, use esse alias no body, mesmo que o catálogo mostre outro alias documentado.

Exemplos comuns de alias de chamada:

Service
`SERVICE_DIGITAL_DOCUMENTOSCOPY`
`SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT`
`SERVICE_ECONOMIC_RELATIONSHIP`
`SERVICE_EMAIL_VALIDATION`
`SERVICE_PROTEST_CLEARANCE_CERTIFICATE`, `SERVICE_PROTEST_PF`
`SERVICE_PROTEST_PJ`

Este endpoint atende serviços de pessoa física e pessoa jurídica. Nos exemplos, use os itens com prefixo PF - para consultas por CPF e os itens com prefixo PJ - para consultas por CNPJ.

Campos mais comuns:

Campo	Uso
`service`	Código do produto que será executado
`cpf`	Documento principal em serviços de pessoa física
`cnpj`	Documento principal em serviços de pessoa jurídica
`image1`, `image2`	Imagens em base64 para OCR, biometria ou documentos
`image1Url`, `image2Url`	URLs de imagens, quando o serviço aceitar URL
`selfie1`	Selfie usada em documentoscopia e FaceMatch
`key`	Chave de consulta em fluxos assíncronos

Exemplos:

consulta de CPF normalmente usa cpf;
consulta de CNPJ normalmente usa cnpj;
OCR, FaceMatch e documentoscopia usam imagens em base64 ou URL;
serviços assíncronos usam key para consultar o resultado depois.
payloads curtos ajudam a validar acesso ao produto, mas services de documento, OCR e biometria precisam de massa real para retornar dados completos.

A maioria das respostas retorna:

result: dados de negócio da consulta;
status.code: código técnico do processamento;
status.message: mensagem técnica do processamento;
externalId: identificador externo, quando disponível.

Use a lista de exemplos desta operação para selecionar rapidamente o payload do produto desejado.

POST

api

service-api

curl --request POST \
  --url https://backoffice-hml.idcerberus.com/api/service-api \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "cpf"
}
'

{
  "result": {
    "cpf": "06319423196",
    "status": "REGULAR",
    "statusDate": "2022-05-29T00:00:00",
    "name": "NOME DA PESSOA",
    "motherName": "NOME DA MÃE",
    "birthdate": "1998-07-05",
    "birthCountry": "BRASILEIRA",
    "dead": false,
    "gender": "M",
    "age": 24,
    "origin": "RECEITA FEDERAL",
    "fiscalRegion": "DF-GO-MS-MT-TO",
    "numberOfPeopleWithTheSameName": "3",
    "nameWordCount": "3",
    "nameUniqueScore": "0.994"
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Informe o código do serviço no campo service e os parâmetros exigidos por essa consulta. O campo service é obrigatório em todos os casos. Os demais campos dependem do produto selecionado.

Use os exemplos para copiar o payload inicial do serviço desejado.

Payload base do endpoint /api/service-api. O campo service define qual produto será executado; os demais campos são dinâmicos e dependem do serviço escolhido.

Famílias principais:

Cadastro e identidade PF
Documentos e biometria
Risco, validações e compliance PF
Político e eleitoral
Cadastro e regularidade PJ
Sócios, relacionamentos e compliance PJ

service

string

required

Código do serviço que será executado.

Example:

"SERVICE_PERSON_DATA_ENRICHMENT"

cpf

string

CPF usado em consultas de pessoa física.

Example:

"cpf"

cnpj

string

CNPJ usado em consultas de pessoa jurídica.

Example:

"cnpj"

string

E-mail usado na validação de endereço eletrônico.

Example:

"[email protected]"

phone

string

Telefone usado em consultas e validações de contato.

Example:

"11900000000"

zipcode

string

CEP usado em validações de endereço.

Example:

"00000-000"

numberAddress

string

Número do endereço usado em validações de residência.

Example:

"13"

string

Unidade federativa quando o serviço exigir recorte estadual.

Example:

"SP"

image1

string

Imagem em base64 ou conteúdo principal para serviços de OCR, biometria e FaceMatch.

Example:

"base64"

image2

string

Segunda imagem em base64, quando o serviço exigir comparação ou verso de documento.

Example:

"base64"

image1Url

string

URL da primeira imagem, quando a integração usa arquivo hospedado.

Example:

"url_image"

image2Url

string

URL da segunda imagem, quando a integração usa arquivo hospedado.

Example:

"urlImageMatch"

selfie1

string

Selfie em base64 usada em documentoscopia ou comparação facial.

Example:

"base64"

key

string

Chave de consulta usada em serviços assíncronos, como documentoscopia digital.

Example:

"de0cd562-5962-40bd-8f94-5a7184ecde0e"

nit

string

Número de identificação do trabalhador, quando aplicável.

Response

Resultado do serviço executado. A estrutura de result varia de acordo com o código service, mas o objeto status segue o padrão técnico da API.

Resposta padrão dos serviços externos. O objeto result muda conforme o serviço executado, e status informa o resultado técnico da consulta.

Schemas de apoio para os principais retornos estão documentados nos componentes desta referência, como PersonDataEnrichmentResult, RfbPfResult, OcrDocumentResult, FaceMatchResult, PepResult, CorporateDataEnrichmentResult, RfbPjResult e ActiveDebtResult.

result

object

Dados de negócio retornados pela consulta.

status

object

Status técnico comum nas respostas da API.

Show child attributes

externalId

string

Identificador externo da consulta, quando retornado.

Catálogo de services

Endpoints da API

Executar serviço de dados, risco ou compliance

Authorizations

Body

Response