# idCerberus API Reference - resumo operacional para LLM Use este arquivo para gerar exemplos de request, explicar chamadas da API e escolher o `service` correto sem depender do OpenAPI completo. ## Regras obrigatórias - Não invente endpoints, parâmetros ou services. - Use homologação para testes: `https://backoffice-hml.idcerberus.com`. - Use produção somente quando o usuário pedir explicitamente: `https://backoffice.idcerberus.com`. - Nunca exponha `client`, `secret`, JWT real, CPF real, CNPJ real ou imagens reais em exemplos. - Quando faltar um service no catálogo, diga que ele precisa ser confirmado antes de documentar ou integrar. ## Autenticação ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/token-generate' \ --header 'Content-Type: application/json' \ --data '{ "client": "{client}", "secret": "{secret}" }' ``` ## Pessoa Física ### Antecedentes criminais civis - Service: `SERVICE_CRIMINAL_RECORD_CIVIL` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `rg`, `uf` - Termos de busca: PF - Antecedentes criminais civis - Retorno principal: Retorna resultado de antecedentes criminais civis, com status da certidão, ocorrências encontradas, UF, RG e mensagens da consulta. Response resumido: ```json { "result": { "cpf": "cpf", "rg": "rg", "state": "SP", "hasRecords": false, "records": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Antecedentes criminais federais - Service: `SERVICE_CRIMINAL_RECORD_FEDERAL` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Antecedentes criminais federais - Retorno principal: Retorna resultado de antecedentes criminais federais, com status da certidão, ocorrências encontradas e mensagens da consulta. Response resumido: ```json { "result": { "cpf": "cpf", "hasFederalCriminalRecord": false, "records": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Benefícios sociais estendidos - Service: `SERVICE_SOCIAL_ASSISTANCE_EXTENDED` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Benefícios sociais estendidos - Retorno principal: Retorna benefícios sociais estendidos vinculados ao CPF, com programas, indicadores, situação e detalhes encontrados quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "totalBenefits": 1, "benefits": [ { "program": "Programa social", "status": "ACTIVE" } ], "indicators": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Benefícios sociais familiares - Service: `SERVICE_FAMILY_SOCIAL_BENEFITS` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Benefícios sociais familiares - Retorno principal: Retorna benefícios sociais familiares vinculados ao CPF, com programas, situação, quantidade e registros encontrados quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "totalBenefits": 1, "benefits": [ { "program": "Programa social", "status": "ACTIVE" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Busca de face na base - Service: `SERVICE_FACE_INDEX` - Endpoint: `POST /api/service-api` - Campos do request: `image1` - Termos de busca: PF - Busca de face na base, comparação facial biometria selfie rosto, face index busca facial selfie CPF base de faces - Retorno principal: Busca uma selfie na base de faces indexadas e retorna se encontrou face, CPF associado e similaridade quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "faceFound": true, "similarity": 98.42 }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Cartão SUS - Service: `SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: CPF Receita Federal, PF - Cartão SUS - Retorno principal: 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. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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" }' ``` ### Certidão de Nada Consta - Service: `SERVICE_NOTHING_RECORD_LAWSUITS` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `court`, `uf`, `sphere` - Termos de busca: PF - Certidão de Nada Consta, processos judiciais jurídicos tribunal certidão - Retorno principal: Retorna certidão de nada consta para a esfera/tribunal informado, com status, mensagem, ocorrências e dados usados na consulta. Response resumido: ```json { "result": { "cpf": "cpf", "court": "TRF1", "sphere": "CIVIL", "nothingFound": true, "records": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Certidão negativa de protesto - Service: `SERVICE_PROTEST_CLEARANCE_CERTIFICATE` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Certidão negativa de protesto - Retorno principal: Retorna certidão/consulta de protestos para CPF, com status de nada consta ou lista de protestos, cartório, valor e datas. Response resumido: ```json { "result": { "cpf": "cpf", "hasProtests": false, "protests": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Certidão negativa de protesto PF - Service: `SERVICE_PROTEST_PF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Certidão negativa de protesto PF - Retorno principal: Retorna certidão/consulta de protestos para CPF, com status, cartórios consultados, protestos e mensagens. Response resumido: ```json { "result": { "cpf": "cpf", "hasProtests": false, "notaryOffices": [], "protests": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Consulta de MEI - Service: `SERVICE_MEI` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Consulta de MEI - Retorno principal: Retorna empresas MEI associadas ao CPF, incluindo CNPJ, razão social, situação, atividades, endereço e datas cadastrais quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "meiCompanies": [ { "cnpj": "cnpj", "officialName": "MEI EXEMPLO", "status": "ATIVA" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### CPF na Receita Federal on-demand - Service: `SERVICE_RFB_PF_ON_DEMAND` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: CPF Receita Federal, PF - CPF na Receita Federal on-demand - Retorno principal: Retorna situação atualizada do CPF consultada sob demanda na Receita Federal, com nome, nascimento, status cadastral e protocolo. Response resumido: ```json { "result": { "cpf": "cpf", "name": "Nome completo", "birthDate": "yyyy-MM-dd", "registrationStatus": "REGULAR", "protocol": "protocolo" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Dados demográficos - Service: `SERVICE_DEMOGRAPHIC_DATA_CPF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `birthDate` - Termos de busca: CPF Receita Federal, PF - Dados demográficos - Retorno principal: Retorna dados demograficos associados ao CPF, com dados regionais, estimativas e indicadores retornados pela base consultada. Response resumido: ```json { "result": { "cpf": "cpf", "demographicData": [ { "indicator": "Faixa de renda", "value": "Media" } ], "totalIndicators": 1 }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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)" }' ``` ### Dados eleitorais de candidato - Service: `SERVICE_ELECTION_CANDIDATE_DATA_CPF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: CPF Receita Federal, PF - Dados eleitorais de candidato - Retorno principal: Retorna histórico de candidaturas eleitorais do CPF, incluindo cargo, partido, ano, unidade eleitoral, bens declarados e situação quando disponível. Response resumido: ```json { "result": { "cpf": "cpf", "candidacies": [ { "year": 2024, "role": "VEREADOR", "party": "PARTIDO", "status": "DEFERIDO" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Dados financeiros e endereços - Service: `SERVICE_PF_FINANCIAL_AND_ADDRESS` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `birthDate` - Termos de busca: PF - Dados financeiros e endereços - Retorno principal: Retorna dados financeiros e endereços do CPF em uma consulta combinada, incluindo renda estimada, indicadores financeiros e endereços encontrados. Response resumido: ```json { "result": { "cpf": "cpf", "estimatedIncome": "5000-10000", "addresses": [ { "city": "Sao Paulo", "state": "SP" } ], "financialIndicators": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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)" }' ``` ### Dados pelo telefone - Service: `SERVICE_CONFIRM_PHONE` - Endpoint: `POST /api/service-api` - Campos do request: `phone` - Termos de busca: PF - Dados pelo telefone, telefone celular validação contato - Retorno principal: Retorna dados associados ao telefone informado, como possível titular, documento relacionado, status de confirmacao e atributos disponíveis. Response resumido: ```json { "result": { "phone": "+5561123456789", "matched": true, "person": { "name": "Nome encontrado", "document": "cpf" } }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Dados PIS - Service: `SERVICE_PIS_CONSULTATION` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Dados PIS - Retorno principal: Retorna dados de PIS/NIS associados ao CPF, incluindo número encontrado, status, dados cadastrais relacionados e mensagens da consulta. Response resumido: ```json { "result": { "cpf": "cpf", "pis": "00000000000", "status": "FOUND" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Dados Restritivos - Service: `SERVICE_BOAVISTA_CREDIT_SCORE_PERSON` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Dados Restritivos, score risco crédito rating inadimplência - Retorno principal: Retorna dados restritivos de crédito de pessoa física pelo CPF informado, incluindo score, indicativo e quantidade de restrições encontradas. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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" }' ``` ### Dívida ativa - Service: `SERVICE_ACTIVE_DEBT_PF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Dívida ativa, dívida ativa débito cobrança inadimplência - Retorno principal: Retorna dívidas ativas vinculadas ao CPF, com origem do débito, valores, situação, órgão credor e status da consulta. Response resumido: ```json { "result": { "cpf": "cpf", "totalDebts": 2, "totalValue": "1234.56", "debts": [ { "source": "PGFN", "value": "1234.56", "status": "ACTIVE" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Doações eleitorais - Service: `SERVICE_ELECTORAL_DONORS_CPF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: CPF Receita Federal, PF - Doações eleitorais, dados eleitorais campanha doações candidato - Retorno principal: Retorna doações eleitorais realizadas pelo CPF, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas. Response resumido: ```json { "result": { "cpf": "cpf", "donations": [ { "year": 2024, "recipient": "Candidato", "amount": "500.00" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Documentoscopia digital - Service: `SERVICE_DIGITAL_DOCUMENTOSCOPY` - Endpoint: `POST /api/service-api` - Campos do request: `key`, `image1`, `image2`, `selfie1` - Termos de busca: PF - Documentoscopia digital, documentoscopia documento selfie validação - Retorno principal: Retorna status da documentoscopia, chave da consulta, dados extraídos do documento, validações de documento/selfie e resultado de aprovacao. Response resumido: ```json { "result": { "key": "{key}", "status": "APPROVED", "documentData": { "name": "Nome extraído", "cpf": "cpf" }, "validations": [ { "name": "faceMatch", "status": "APPROVED" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Domínios - Service: `SERVICE_DOMAINS_CPF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: CPF Receita Federal, PF - Domínios, domínios sites presença digital - Retorno principal: Retorna domínios, sites e sinais digitais associados ao CPF, incluindo quantidade e registros encontrados quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "totalDomains": 1, "domains": [ { "domain": "exemplo.com.br", "status": "ACTIVE" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### E-mails de Pessoas Relacionadas - Service: `SERVICE_RELATED_PEOPLE_EMAILS` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - E-mails de Pessoas Relacionadas, email validação contato - Retorno principal: Retorna e-mails associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada e-mail. Response resumido: ```json { "result": { "cpf": "cpf", "totalRelatedPeopleEmails": 2, "relatedPeopleEmailsList": "nome@email.com - NOME DA PESSOA - 00000000000 - CONJUGE", "relatedPeopleEmails": [ { "relatedCpf": "00000000000", "relatedName": "NOME DA PESSOA", "relationship": "CONJUGE", "type": "PESSOAL", "isMain": true, "isRecent": true, "isActive": true, "email": "nome@email.com", "domain": "email.com", "validationStatus": "VALID" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Endereços - Service: `SERVICE_ADDRESS` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Endereços - Retorno principal: Retorna endereços associados ao CPF, incluindo logradouro, número, bairro, cidade, UF, CEP, país, tipo e indicadores de atualidade quando disponíveis. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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" }' ``` ### Endereços de Pessoas Relacionadas - Service: `SERVICE_RELATED_PEOPLE_ADDRESSES` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PF - Endereços de Pessoas Relacionadas - Retorno principal: Retorna endereços associados a pessoas relacionadas ao CNPJ informado, com o relacionamento identificado e sinais de uso de cada endereço. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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" }' ``` ### Enriquecimento de dados - Service: `SERVICE_PERSON_DATA_ENRICHMENT` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Enriquecimento de dados - Retorno principal: Retorna dados cadastrais do CPF, incluindo nome, nascimento, situação cadastral, filiação, óbito, idade, gênero e atributos disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "name": "Nome completo", "birthDate": "yyyy-MM-dd", "registrationStatus": "REGULAR", "motherName": "Nome da mãe" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Envolvimento político - Service: `SERVICE_POLITICAL_INVOLVEMENT` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Envolvimento político - Retorno principal: Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos. Response resumido: ```json { "result": { "cpf": "cpf", "politicalInvolvement": [ { "type": "CANDIDACY", "year": 2024, "details": "Candidatura encontrada" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Envolvimento político PF - Service: `SERVICE_POLITICAL_INVOLVEMENT_CPF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: CPF Receita Federal, PF - Envolvimento político PF - Retorno principal: Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos. Response resumido: ```json { "result": { "cpf": "cpf", "politicalInvolvement": [ { "type": "DONATION", "year": 2024, "details": "Doacao encontrada" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Exposição e perfil na mídia - Service: `SERVICE_MEDIA_PROFILE_EXPOSURE_PF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Exposição e perfil na mídia - Retorno principal: Retorna exposição e perfil de mídia da pessoa, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados. Response resumido: ```json { "result": { "cpf": "cpf", "mediaMentions": [ { "title": "Noticia encontrada", "source": "Fonte", "sentiment": "NEUTRAL" } ], "exposureLevel": "LOW" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### FaceMatch - Service: `SERVICE_FACE_MATCH` - Endpoint: `POST /api/service-api` - Campos do request: `image1`, `image2` - Termos de busca: PF - FaceMatch, comparação facial biometria selfie rosto - Retorno principal: Retorna comparacao facial entre duas imagens, com score de similaridade, status do match e mensagem de aprovacao ou reprovacao. Response resumido: ```json { "result": { "match": true, "similarity": 98.2, "status": "APPROVED" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Flags Negativos - Service: `SERVICE_QUOD_CREDIT_RISK_PERSON` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Flags Negativos - Retorno principal: 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. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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" }' ``` ### Histórico de e-mails - Service: `SERVICE_EMAILS_EXTENDED` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `limit` - Termos de busca: PF - Histórico de e-mails, email validação contato - Retorno principal: Retorna e-mails associados ao CPF, incluindo prioridade, status de validação, origem, data de atualização e sinais de uso quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "emails": [ { "email": "email@exemplo.com", "priority": 1, "isValid": true, "lastUpdate": "yyyy-MM-dd" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Histórico de telefones - Service: `SERVICE_PHONE_HISTORY` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `birthDate`, `limit` - Termos de busca: PF - Histórico de telefones, telefone celular validação contato - Retorno principal: Retorna histórico de telefones associados ao CPF, incluindo número, tipo de linha, operadora, prioridade, status e recência quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "phones": [ { "phone": "11900000000", "lineType": "MOBILE", "priority": 1, "lastUpdate": "yyyy-MM-dd" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Histórico familiar político - Service: `SERVICE_FAMILY_POLITICAL_HISTORY_CPF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: CPF Receita Federal, PF - Histórico familiar político - Retorno principal: Retorna histórico político familiar do CPF, incluindo familiares com candidaturas, doações, cargos, partidos e vínculos eleitorais quando encontrados. Response resumido: ```json { "result": { "cpf": "cpf", "familyPoliticalHistory": [ { "relativeName": "Nome relacionado", "relationship": "PARENTE", "role": "Candidato" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Histórico profissional - Service: `SERVICE_PROFESSIONAL_HISTORY` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Histórico profissional - Retorno principal: Retorna histórico profissional do CPF, incluindo empresas, cargos, datas, vínculos empregaticios ou societários e indicadores profissionais. Response resumido: ```json { "result": { "cpf": "cpf", "professionalHistory": [ { "companyName": "Empresa Exemplo", "role": "Analista", "startDate": "yyyy-MM-dd" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Histórico profissional do titular - Service: `SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `birthDate` - Termos de busca: PF - Histórico profissional do titular - Retorno principal: Retorna histórico profissional em que a pessoa aparece como titular, sócio ou proprietario, com empresas, cargos e datas de vinculo. Response resumido: ```json { "result": { "cpf": "cpf", "ownerHistory": [ { "companyName": "Empresa Exemplo", "cnpj": "cnpj", "qualification": "SOCIO" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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)" }' ``` ### Indicadores de atividades - Service: `SERVICE_ACTIVITIES_INDICATORS` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Indicadores de atividades - Retorno principal: Retorna indicadores de atividades vinculadas ao CPF, como sinais profissionais, segmentos, ocupacoes e registros disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "activityIndicators": [ { "type": "PROFESSIONAL", "description": "Indicador encontrado" } ], "hasActivityIndicators": true }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Informações financeiras - Service: `SERVICE_FINANCIAL_INFORMATION` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Informações financeiras - Retorno principal: Retorna informações financeiras estimadas do CPF, como renda presumida, poder aquisitivo, classe econômica e indicadores financeiros disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "estimatedIncome": "5000-10000", "purchasingPower": "MEDIUM", "financialIndicators": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### KYC e compliance - Service: `SERVICE_PERSON_KYC` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `birthDate` - Termos de busca: PF - KYC e compliance, compliance KYC sanções PEP mídia - Retorno principal: Retorna checagem de KYC da pessoa, incluindo PEP, sanções, mídia, processos, alertas de compliance e sinais de risco. Response resumido: ```json { "result": { "cpf": "cpf", "isPep": false, "sanctions": [], "mediaExposure": [], "riskAlerts": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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)" }' ``` ### Mandado de prisão - Service: `SERVICE_ARREST_WARRANT` - Endpoint: `POST /api/service-api` - Campos do request: `nome`, `motherName`, `fatherName`, `birthDate`, `cpf` - Termos de busca: PF - Mandado de prisão - Retorno principal: Retorna indicativos de mandado de prisão para os dados informados, com situação, órgão, processo e detalhes encontrados quando houver ocorrência. Response resumido: ```json { "result": { "cpf": "cpf", "hasArrestWarrant": false, "warrants": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Modelagem de dados - Service: `SERVICE_PERSON_DATA_MODELING` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Modelagem de dados - Retorno principal: Retorna modelagem consolidada da pessoa, reunindo dados cadastrais, contatos, endereços, vínculos, indicadores e resumos derivados. Response resumido: ```json { "result": { "cpf": "cpf", "profileSummary": "Resumo consolidado", "contacts": [], "addresses": [], "relationships": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### OCR de comprovante de endereço - Service: `SERVICE_OCR_PROOF_OF_ADDRESS` - Endpoint: `POST /api/service-api` - Campos do request: `image1` - Termos de busca: OCR documento imagem base64 leitura extração, PF - OCR de comprovante de endereço, comprovante de endereço conta fatura endereço - Retorno principal: 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. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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" }' ``` ### OCR de emancipação - Service: `SERVICE_OCR_EMANCIPATION` - Endpoint: `POST /api/service-api` - Campos do request: `image1` - Termos de busca: OCR documento imagem base64 leitura extração, PF - OCR de emancipação, documento emancipação cartório certidão declaração - Retorno principal: Retorna texto OCR do documento de emancipacao e dados objetivos extraídos quando existirem, sem reprovar pela ausencia de campos variaveis. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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" }' ``` ### OCR React - Service: `SERVICE_OCR` - Endpoint: `POST /api/service-api` - Campos do request: `documentType`, `image1`, `image2` - Termos de busca: OCR documento imagem base64 leitura extração, PF - OCR React - Retorno principal: Retorna dados extraídos de documentos de identificação enviados por imagem, como RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identificação automatica. Response resumido: ```json { "result": { "cpf": "cpf", "docType": "CNH", "name": "Nome extraído", "birthDate": "yyyy-MM-dd", "cnhCategory": "B", "cnhNumber": "00000000000" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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)" }' ``` ### Pessoa politicamente exposta - Service: `SERVICE_PEP` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Pessoa politicamente exposta - Retorno principal: 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. Response resumido: ```json { "result": { "cpf": "cpf", "isPep": false, "positions": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Pessoas relacionadas - Service: `SERVICE_RELATED_PEOPLE` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `birthDate` - Termos de busca: PF - Pessoas relacionadas - Retorno principal: Retorna pessoas relacionadas ao CPF, com nome, documento mascarado, tipo de relação, nível de proximidade e origem do vinculo. Response resumido: ```json { "result": { "cpf": "cpf", "relatedPeople": [ { "name": "Pessoa relacionada", "relationshipType": "FAMILIAR", "confidence": "HIGH" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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)" }' ``` ### Prêmios e certificações - Service: `SERVICE_AWARDS_AND_CERTIFICATIONS_CPF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: CPF Receita Federal, PF - Prêmios e certificações - Retorno principal: Retorna a quantidade e os registros de premios e certificacoes encontrados para o CPF, quando a base consultada possuir dados. Response resumido: ```json { "result": { "cpf": "cpf", "totalAwards": 0, "totalCertifications": 0, "awards": [], "certifications": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Prestadores de serviço eleitorais - Service: `SERVICE_ELECTORAL_PROVIDERS_CPF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: CPF Receita Federal, PF - Prestadores de serviço eleitorais, dados eleitorais campanha doações candidato - Retorno principal: Retorna prestações de serviço eleitorais vinculadas ao CPF, com campanha, candidato/partido, valor, ano e natureza do serviço. Response resumido: ```json { "result": { "cpf": "cpf", "campos": [ { "year": 2024, "campaign": "Campanha", "amount": "800.00", "serviceType": "Servico" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Processos jurídicos e administrativos - Service: `SERVICE_JURIDICAL_PROCESSES` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Processos jurídicos e administrativos, processos judiciais jurídicos tribunal certidão - Retorno principal: Retorna processos jurídicos e administrativos vinculados ao CPF, com tribunal, classe, assunto, partes, status e datas quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "totalProcesses": 1, "processes": [ { "court": "TJSP", "processNumber": "0000000-00.0000.0.00.0000", "status": "ACTIVE" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Prompt de IA para pessoa - Service: `SERVICE_PERSON_AI_PROMPT` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Prompt de IA para pessoa - Retorno principal: Retorna uma resposta textual consolidada por IA a partir dos dados da pessoa, com resumo, pontos de atenção e leitura operacional. Response resumido: ```json { "result": { "cpf": "cpf", "answer": "Resumo analitico gerado pela IA", "highlights": [ "ponto relevante" ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Propensão a apostas online - Service: `SEVICE_ONLINE_BETTING_PROPENSITY` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Propensão a apostas online, apostas bets compliance bet - Retorno principal: Retorna propensão do CPF a apostas online, com score, faixa de propensão, indicadores comportamentais e sinais associados quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "propensityScore": 78, "propensityLevel": "HIGH", "indicators": [ "sinal encontrado" ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Relacionamentos econômicos - Service: `SERVICE_ECONOMIC_RELATIONSHIP` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Relacionamentos econômicos - Retorno principal: Retorna vínculos econômicos associados ao CPF, como empresas relacionadas, participações, relações profissionais e indicadores de relacionamento. Response resumido: ```json { "result": { "cpf": "cpf", "relationships": [ { "type": "OWNER", "relatedDocument": "cnpj", "relatedName": "Empresa relacionada" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Resultado da documentoscopia digital - Service: `SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT` - Endpoint: `POST /api/service-api` - Campos do request: `key` - Termos de busca: PF - Resultado da documentoscopia digital, documentoscopia documento selfie validação - Retorno principal: Retorna o resultado ja processado da documentoscopia pela chave informada, com status, campos extraídos, regras avaliadas e evidencias. Response resumido: ```json { "result": { "key": "{key}", "status": "APPROVED", "fields": [ { "name": "cpf", "value": "cpf" } ], "rules": [ { "name": "document", "status": "APPROVED" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Risco financeiro - Service: `SERVICE_FINANCIAL_RISK_SCORE` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `birthDate` - Termos de busca: PF - Risco financeiro, score risco crédito rating inadimplência - Retorno principal: Retorna score de risco financeiro do CPF, faixa de risco, recomendação resumida e fatores que influenciam a avaliação. Response resumido: ```json { "result": { "cpf": "cpf", "score": 681, "riskLevel": "MEDIUM", "recommendation": "REVIEW" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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)" }' ``` ### Score biométrico - Service: `SERVICE_DATAVALID_CNH` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `image1` - Termos de busca: PF - Score biométrico, score risco crédito rating inadimplência - Retorno principal: Retorna validação validação documental da CNH, incluindo score biométrico, similaridade facial, status de validação e campos conferidos. Response resumido: ```json { "result": { "cpf": "cpf", "biometricScore": 0.98, "validated": true, "validationStatus": "APPROVED" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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}" }' ``` ### Score de crédito - Service: `SERVICE_CREDIT_SCORE` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Score de crédito, score risco crédito rating inadimplência - Retorno principal: Retorna score de crédito associado ao CPF, com pontuação, faixa de risco e mensagem da consulta quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "score": 750, "riskLevel": "LOW", "message": "Score calculado com sucesso" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Score de Crédito - Service: `SERVICE_QUOD_CREDIT_SCORE_PERSON` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Score de Crédito, score risco crédito rating inadimplência - Retorno principal: 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. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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" }' ``` ### Score de Crédito Multidados - Service: `SERVICE_BOAVISTA_ONE_SCORE_PERSON` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Score de Crédito Multidados, score risco crédito rating inadimplência - Retorno principal: 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. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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" }' ``` ### Score de inadimplência - Service: `SERVICE_DEFAULT_RISK_SCORE` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Score de inadimplência, score risco crédito rating inadimplência - Retorno principal: Retorna score de risco de inadimplência para CPF, com pontuação, faixa de risco e probabilidade estimada quando disponível. Response resumido: ```json { "result": { "cpf": "cpf", "score": 690, "riskLevel": "MEDIUM", "defaultProbability": "8%" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Score de risco de fraude - Service: `SERVICE_FRAUD_RISK_SCORE` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `factor` - Termos de busca: PF - Score de risco de fraude, score risco crédito rating inadimplência - Retorno principal: Retorna score de risco de fraude do CPF, fator analisado, nível de risco, score numérico e sinais que suportam a decisão. Response resumido: ```json { "result": { "cpf": "cpf", "factor": "minRisk", "score": 720, "riskLevel": "LOW", "indicators": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Servidores públicos - Service: `SERVICE_PUBLIC_SERVANTS` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Servidores públicos - Retorno principal: Retorna registros de servidor publico associados ao CPF, incluindo órgão, cargo, vinculo, remuneracao/faixa e período quando disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "publicServantRecords": [ { "agency": "Orgao publico", "role": "Cargo", "status": "ACTIVE" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Status do CPF na Receita Federal - Service: `SERVICE_RFB_PF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `dataDeNascimento` - Termos de busca: CPF Receita Federal, PF - Status do CPF na Receita Federal - Retorno principal: Retorna situação do CPF na Receita Federal, incluindo nome, nascimento, status cadastral, comprovante/protocolo e dados fiscais disponíveis. Response resumido: ```json { "result": { "cpf": "cpf", "name": "Nome completo", "birthDate": "yyyy-MM-dd", "registrationStatus": "REGULAR", "protocol": "protocolo" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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)" }' ``` ### Telefones de Pessoas Relacionadas - Service: `SERVICE_RELATED_PEOPLE_PHONES` - Endpoint: `POST /api/service-api` - Campos do request: `cpf` - Termos de busca: PF - Telefones de Pessoas Relacionadas, telefone celular validação contato - Retorno principal: Retorna telefones associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada telefone. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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" }' ``` ### TSE - Local de votação - Service: `SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `birthDate`, `motherName` - Termos de busca: CPF Receita Federal, PF - TSE - Local de votação - Retorno principal: Retorna local de votação, situação eleitoral e biometria atual da pessoa no TSE, a partir do CPF informado. Response resumido: ```json { "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}" } ``` Curl de homologação: ```bash 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)" }' ``` ### Validação de CPF com endereço - Service: `SERVICE_CPF_ADDRESS_VALIDATION` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `zipcode`, `numberAddress` - Termos de busca: CPF Receita Federal, PF - Validação de CPF com endereço - Retorno principal: 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. Response resumido: ```json { "result": { "cpf": "cpf", "zipcode": "01001000", "match": true, "confidence": "HIGH", "normalizedAddress": "Rua Exemplo, 100" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Validação de CPF com telefone - Service: `SERVICE_CPF_PHONE_VALIDATION` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `phone` - Termos de busca: CPF Receita Federal, PF - Validação de CPF com telefone, telefone celular validação contato - Retorno principal: Retorna validação da associação entre CPF e telefone, com status de match, mensagem da consulta e dados retornados na consulta. Response resumido: ```json { "result": { "cpf": "cpf", "phone": "11900000000", "match": true, "statusMessage": "Telefone associado ao documento" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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" }' ``` ### Validação de e-mail - Service: `SERVICE_EMAIL_VALIDATION` - Endpoint: `POST /api/service-api` - Campos do request: `email` - Termos de busca: PF - Validação de e-mail, email validação contato - Retorno principal: Retorna validação do e-mail informado, incluindo formato, existencia provável, domínio, entregabilidade e indicadores de risco. Response resumido: ```json { "result": { "email": "email@email.com", "validFormat": true, "deliverable": true, "domain": "email.com", "riskLevel": "LOW" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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@email.com" }' ``` ### Validação do E-Social - Service: `SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION` - Endpoint: `POST /api/service-api` - Campos do request: `cpf`, `nit` - Termos de busca: PF - Validação do E-Social - Retorno principal: Retorna qualificação cadastral no eSocial, com status de consistencia entre CPF, NIT/PIS e dados cadastrais informados. Response resumido: ```json { "result": { "cpf": "cpf", "nit": "nit", "qualified": true, "inconsistencies": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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)" }' ``` ## Pessoa Jurídica ### Ações Trabalhistas - Service: `SERVICE_LABOR_LAWSUITS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Ações Trabalhistas, processos judiciais jurídicos tribunal certidão - Retorno principal: Retorna certidão on-demand informando se há processos trabalhistas tramitando relacionados à empresa consultada, físicos ou eletrônicos. Response resumido: ```json { "result": { "cnpj": "cnpj", "laborLawsuitsStatus": "NADA CONSTA", "laborLawsuitsProtocol": "2026000000000", "laborLawsuitsCertificateNumber": "00000000/2026", "laborLawsuitsIssuedDate": "2026-08-01", "laborLawsuitsContent": "Certifica-se que nada consta em nome da empresa quanto a ações trabalhistas", "laborLawsuitsProcessesCount": 0, "laborLawsuitsSummary": "Nada consta de ações trabalhistas", "laborLawsuitsProcesses": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_LABOR_LAWSUITS", "cnpj": "cnpj" }' ``` ### Acordos Sindicais - Service: `SERVICE_SYNDICATE_AGREEMENTS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Acordos Sindicais - Retorno principal: Retorna os acordos sindicais firmados entre a empresa e os sindicatos que representam seus funcionários, com totais e detalhamento. Response resumido: ```json { "result": { "cnpj": "cnpj", "syndicateAgreementsTotal": 1, "syndicateAgreementsTotalActive": 1, "syndicateAgreementsSummary": "Empresa com 1 acordo sindical ativo", "syndicateAgreementsStats": [], "syndicateAgreements": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_SYNDICATE_AGREEMENTS", "cnpj": "cnpj" }' ``` ### Anúncios Online - Service: `SERVICE_ONLINE_ADS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Anúncios Online - Retorno principal: Retorna anúncios online vinculados à empresa, identificando perfis de vendedor em portais de classificados e marketplaces peer-to-peer por telefone. Response resumido: ```json { "result": { "cnpj": "cnpj", "onlineAdsTotalPhones": 0, "onlineAdsSummary": "Nenhum anúncio online encontrado", "onlineAds": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_ONLINE_ADS", "cnpj": "cnpj" }' ``` ### Arrecadação Simples Nacional - MEI - Service: `SERVICE_PGMEI` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Arrecadação Simples Nacional - MEI - Retorno principal: Retorna o Documento de Arrecadação do Simples Nacional (DAS) para Microempreendedores Individuais (MEI), com situação, ano de referência, guias pendentes e histórico mensal de arrecadação. Response resumido: ```json { "result": { "cnpj": "cnpj", "pgmeiStatus": "Optante", "pgmeiReferenceYear": "2026", "pgmeiPendingGuides": 0, "pgmeiSummary": "MEI optante e regular no ano de referência", "pgmeiGuides": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_PGMEI", "cnpj": "cnpj" }' ``` ### Avaliações e Reputação - Service: `SERVICE_REPUTATIONS_AND_REVIEWS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Avaliações e Reputação - Retorno principal: Retorna a reputação da empresa em diferentes plataformas de avaliação de serviços, com visão consolidada, detalhamento por fonte e histórico de evolução. Response resumido: ```json { "result": { "cnpj": "cnpj", "totalReputationSources": 2, "reputationSummary": "Empresa possui avaliações em 2 plataformas", "reputationAndReviews": [], "reputationSummaryDetails": {}, "reputationSummaryByDataSources": {} }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_REPUTATIONS_AND_REVIEWS", "cnpj": "cnpj" }' ``` ### Beneficiários Finais - Service: `SERVICE_ULTIMATE_BENEFICIAL_OWNERS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Beneficiários Finais - Retorno principal: Retorna os beneficiários finais da empresa pelo CNPJ informado, com percentual de participação acumulado, inclusive por cadeias indiretas, conforme limiar legal de 25%. Response resumido: ```json { "result": { "cnpj": "cnpj", "uboSummary": "Consulta realizada", "uboTotalCompaniesInGroup": 3, "uboTotalPeopleInGroup": 5, "uboNumberOfOwners": 2, "uboBeneficialOwners": [ { "name": "NOME DO BENEFICIARIO", "document": "00000000000", "accumulatedPercentage": 45.5 } ], "uboParticipations": [ { "ownerDocument": "00000000000", "ownerName": "NOME DO BENEFICIARIO", "ownedDocument": "cnpj", "percentage": 45.5, "level": 1 } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_ULTIMATE_BENEFICIAL_OWNERS", "cnpj": "cnpj" }' ``` ### Categoria Comercial - Service: `SERVICE_MERCHANT_CATEGORY_DATA` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Categoria Comercial - Retorno principal: Retorna a categorização da empresa de acordo com o MCC (Merchant Category Code), por associação direta com a Abecs ou inferido pelo CNAE. Response resumido: ```json { "result": { "cnpj": "cnpj", "merchantCategoryHasDirectAssociation": "false", "merchantCategoryHasMultipleCodes": "false", "merchantCategorySummary": "Categoria comercial inferida pelo CNAE", "merchantCategoryCategories": [], "merchantCategoryCnaeCategories": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_MERCHANT_CATEGORY_DATA", "cnpj": "cnpj" }' ``` ### Certidão Negativa CNJ - Service: `SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Certidão Negativa CNJ - Retorno principal: Retorna a certidão negativa do CNJ pelo CNPJ informado, cobrindo condenações cíveis por improbidade administrativa e inelegibilidade. Response resumido: ```json { "result": { "cnpj": "cnpj", "cnjSummary": "Consulta realizada", "cnjBaseStatus": "NEGATIVA", "cnjClearance": "Sim", "cnjIssueDate": "2026-08-01", "cnjCertificateUrl": "https://example.com/certidão-cnj.pdf" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY", "cnpj": "cnpj" }' ``` ### Certidão Negativa Correcional CGU - Service: `SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Certidão Negativa Correcional CGU - Retorno principal: Retorna a certidão negativa correcional da CGU pelo CNPJ informado, cobrindo punições vigentes em CEIS, CNEP e CEPIM. Response resumido: ```json { "result": { "cnpj": "cnpj", "cguSummary": "Consulta realizada", "cguBaseStatus": "NEGATIVA", "cguClearance": "Sim", "cguValidUntil": "2027-08-01", "cguIssueDate": "2026-08-01", "cguCertificateUrl": "https://example.com/certidão-cgu.pdf" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY", "cnpj": "cnpj" }' ``` ### Certidão Negativa de Débitos Estaduais - Service: `SERVICE_STATE_DEBT_CERTIFICATE_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Certidão Negativa de Débitos Estaduais, dívida ativa débito cobrança inadimplência - Retorno principal: Retorna a certidão negativa de débitos estaduais pelo CNPJ informado, disponível para todos os estados. Response resumido: ```json { "result": { "cnpj": "cnpj", "stateDebtSummary": "Consulta realizada", "stateDebtBaseStatus": "NEGATIVA", "stateDebtClearance": "Sim", "stateDebtState": "SP", "stateDebtRegistration": "000.000.000.000", "stateDebtValidUntil": "2027-08-01", "stateDebtCertificateUrl": "https://example.com/certidão-débitos-estaduais.pdf" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_STATE_DEBT_CERTIFICATE_COMPANY", "cnpj": "cnpj" }' ``` ### Certidão negativa de protesto - Service: `SERVICE_PROTEST_PJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Certidão negativa de protesto - Retorno principal: Retorna certidão/consulta de protestos para CNPJ, com status, cartórios consultados, protestos, valores e datas. Response resumido: ```json { "result": { "cnpj": "cnpj", "hasProtests": false, "notaryOffices": [], "protests": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_PROTEST_PJ", "cnpj": "cnpj" }' ``` ### CNPJ na Receita Federal on-demand - Service: `SERVICE_RFB_PJ_ON_DEMAND` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CNPJ Receita Federal, CPF Receita Federal, PJ - CNPJ na Receita Federal on-demand - Retorno principal: Retorna situação atualizada do CNPJ consultada sob demanda na Receita Federal, com razão social, status cadastral, CNAEs e endereço. Response resumido: ```json { "result": { "cnpj": "cnpj", "officialName": "EMPRESA EXEMPLO LTDA", "status": "ATIVA", "openingDate": "yyyy-MM-dd", "mainActivity": "CNAE principal" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_RFB_PJ_ON_DEMAND", "cnpj": "cnpj" }' ``` ### Compliance de casas de apostas - Service: `SERVICE_COMPLIANCE_BET_PJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Compliance de casas de apostas, apostas bets compliance bet - Retorno principal: Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas. Response resumido: ```json { "result": { "cnpj": "cnpj", "hasBettingExposure": true, "indicators": [ "atividade relacionada" ], "riskLevel": "MEDIUM" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_COMPLIANCE_BET_PJ", "cnpj": "cnpj" }' ``` ### Compliance de casas de apostas (alias curto) - Service: `SERVICE_COMPLIANCE_BET` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Compliance de casas de apostas (alias curto), apostas bets compliance bet - Retorno principal: Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas. Response resumido: ```json { "result": { "cnpj": "cnpj", "hasBettingExposure": true, "indicators": [ "atividade relacionada" ], "riskLevel": "MEDIUM" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_COMPLIANCE_BET", "cnpj": "cnpj" }' ``` ### Cota de PCD - Service: `SERVICE_PCD_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Cota de PCD - Retorno principal: Retorna a certidão de cumprimento da cota legal de contratação de pessoas com deficiência e beneficiários reabilitados, pelo CNPJ informado. Response resumido: ```json { "result": { "cnpj": "cnpj", "pcdSummary": "Consulta realizada", "pcdBaseStatus": "EM CONFORMIDADE", "pcdExpeditionDate": "2026-08-01", "pcdCertificateUrl": "https://example.com/certidão-pcd.pdf", "pcdContent": "Texto integral da certidão de cota de PCD" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_PCD_COMPANY", "cnpj": "cnpj" }' ``` ### Dados cadastrais de CNPJ - Service: `SERVICE_REGISTRATION_DATA_CNPJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CNPJ Receita Federal, PJ - Dados cadastrais de CNPJ - Retorno principal: Retorna dados cadastrais do CNPJ, incluindo razão social, nome fantasia, situação, abertura, CNAEs, natureza jurídica e endereço quando disponíveis. Response resumido: ```json { "result": { "cnpj": "cnpj", "officialName": "EMPRESA EXEMPLO LTDA", "tradeName": "EMPRESA EXEMPLO", "status": "ATIVA", "openingDate": "yyyy-MM-dd" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_REGISTRATION_DATA_CNPJ", "cnpj": "cnpj" }' ``` ### Dados de Fundos de Investimento - Service: `SERVICE_INVESTMENT_FUND_DATA` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Dados de Fundos de Investimento - Retorno principal: Retorna informações cadastrais e operacionais de fundos de investimento associados ao CNPJ, conforme registros da CVM. Response resumido: ```json { "result": { "cnpj": "cnpj", "totalMovimentations": 0, "investmentFundDataSummary": "Nenhuma movimentação de fundo de investimento encontrada", "investmentFundData": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_INVESTMENT_FUND_DATA", "cnpj": "cnpj" }' ``` ### Dados Restritivos PJ - Service: `SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Dados Restritivos PJ, score risco crédito rating inadimplência - Retorno principal: Retorna dados restritivos de crédito de pessoa jurídica pelo CNPJ informado, incluindo score, indicativo e quantidade de restrições encontradas. Response resumido: ```json { "result": { "cnpj": "cnpj", "score": 720, "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}" } ``` Curl de homologação: ```bash 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_COMPANY", "cnpj": "cnpj" }' ``` ### DAS MEI na Receita - Service: `SERVICE_DAS_MEI` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CPF Receita Federal, PJ - DAS MEI na Receita - Retorno principal: Retorna informações de DAS MEI e situação fiscal relacionada ao CNPJ, incluindo períodos, pagamentos, pendências e status quando disponíveis. Response resumido: ```json { "result": { "cnpj": "cnpj", "meiStatus": "ACTIVE", "periods": [ { "period": "2026-01", "paid": true } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_DAS_MEI", "cnpj": "cnpj" }' ``` ### Débitos ativos - Service: `SERVICE_ACTIVE_DEBT_PJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Débitos ativos, dívida ativa débito cobrança inadimplência - Retorno principal: Retorna dívidas ativas vinculadas ao CNPJ, com origem do débito, valores, situação, órgão credor e status da consulta. Response resumido: ```json { "result": { "cnpj": "cnpj", "totalDebts": 1, "totalValue": "9800.00", "debts": [ { "source": "PGFN", "value": "9800.00", "status": "ACTIVE" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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_PJ", "cnpj": "cnpj" }' ``` ### Débitos com a PGFN - Service: `SERVICE_PGFN_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Débitos com a PGFN, dívida ativa débito cobrança inadimplência - Retorno principal: Retorna a certidão de débitos relativos a créditos tributários federais e à dívida ativa da união junto à PGFN, pelo CNPJ informado. Response resumido: ```json { "result": { "cnpj": "cnpj", "pgfnSummary": "Consulta realizada", "pgfnBaseStatus": "NEGATIVA", "pgfnClearance": "Sim", "pgfnEmissionDate": "2026-08-01", "pgfnCertificateUrl": "https://example.com/certidão-pgfn.pdf" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_PGFN_COMPANY", "cnpj": "cnpj" }' ``` ### Distribuição de Processos dos Sócios - Service: `SERVICE_OWNERS_LAWSUITS_DISTRIBUTION` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Distribuição de Processos dos Sócios, processos judiciais jurídicos tribunal certidão - Retorno principal: Retorna dados agregados sobre a distribuição de processos judiciais nos quais os sócios da empresa consultada estão envolvidos, com estatísticas por período e papel na ação. Response resumido: ```json { "result": { "cnpj": "cnpj", "companyOwnersLawsuitsTotalOwners": 2, "companyOwnersLawsuitsMaxPerOwner": 3, "companyOwnersLawsuitsAvgPerOwner": 1.5, "companyOwnersLawsuitsMinPerOwner": 0, "companyOwnersLawsuitsAsAuthor": 1, "companyOwnersLawsuitsAsDefendant": 2, "companyOwnersLawsuitsAsOther": 0, "companyOwnersLawsuitsTotal": 3, "companyOwnersLawsuitsRelatedToLawyers": false, "companyOwnersLawsuitsRelatedToJudges": false, "companyOwnersLawsuitsFirstDate": "2015-01-01", "companyOwnersLawsuitsLastDate": "2026-01-01", "companyOwnersLawsuitsLast30Days": 0, "companyOwnersLawsuitsLast90Days": 0, "companyOwnersLawsuitsLast180Days": 0, "companyOwnersLawsuitsLast365Days": 1, "companyOwnersLawsuitsSummary": "Sócios com 3 processos judiciais encontrados", "companyOwnersLawsuitsDistribution": {} }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_OWNERS_LAWSUITS_DISTRIBUTION", "cnpj": "cnpj" }' ``` ### Distribuição de Processos Judiciais - Service: `SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Distribuição de Processos Judiciais, processos judiciais jurídicos tribunal certidão - Retorno principal: Retorna dados agregados sobre a distribuição de processos judiciais nos quais a empresa consultada está envolvida, com estatísticas por período. Response resumido: ```json { "result": { "cnpj": "cnpj", "companyLawsuitsTotal": 5, "companyLawsuitsFirstDate": "2016-03-10", "companyLawsuitsLastDate": "2026-02-20", "companyLawsuitsLast30Days": 0, "companyLawsuitsLast90Days": 1, "companyLawsuitsLast180Days": 1, "companyLawsuitsLast365Days": 2, "companyLawsuitsSummary": "Empresa com 5 processos judiciais encontrados", "companyLawsuitsDistribution": {} }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY", "cnpj": "cnpj" }' ``` ### Doações eleitorais - Service: `SERVICE_ELECTORAL_DONORS_CNPJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CNPJ Receita Federal, PJ - Doações eleitorais, dados eleitorais campanha doações candidato - Retorno principal: Retorna doações eleitorais realizadas pela empresa, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas. Response resumido: ```json { "result": { "cnpj": "cnpj", "donations": [ { "year": 2024, "recipient": "Candidato", "amount": "1000.00" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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_CNPJ", "cnpj": "cnpj" }' ``` ### Doações eleitorais dos sócios - Service: `SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CNPJ Receita Federal, PJ - Doações eleitorais dos sócios, dados eleitorais campanha doações candidato - Retorno principal: Retorna doações eleitorais feitas pelos sócios da empresa, com sócio relacionado, ano, candidato/partido, valor e detalhes eleitorais. Response resumido: ```json { "result": { "cnpj": "cnpj", "ownersDonations": [ { "ownerName": "Nome do sócio", "year": 2024, "recipient": "Candidato", "amount": "300.00" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ", "cnpj": "cnpj" }' ``` ### Domínios CNPJ - Service: `SERVICE_DOMAINS_CNPJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CNPJ Receita Federal, PJ - Domínios CNPJ, domínios sites presença digital - Retorno principal: Retorna domínios, sites e sinais digitais associados ao CNPJ, incluindo quantidade e registros encontrados quando disponíveis. Response resumido: ```json { "result": { "cnpj": "cnpj", "totalDomains": 1, "domains": [ { "domain": "empresa.com.br", "status": "ACTIVE" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_DOMAINS_CNPJ", "cnpj": "cnpj" }' ``` ### Endereços estendidos - Service: `SERVICE_ADDRESSES_EXTENDED_CNPJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CNPJ Receita Federal, PJ - Endereços estendidos - Retorno principal: Retorna a lista completa de endereços do CNPJ em result.addresses (logradouro, número, complemento, bairro, cidade, UF, país, CEP, tipo, se está ativo e se é o principal), além de um resumo agregado em result.addressesExtendedTotal* com totais e datas da primeira/última passagem confirmada. Response resumido: ```json { "result": { "cnpj": "cnpj", "addresses": [ { "address": "Av Exemplo", "number": "1000", "complement": "Sala 10", "neighborhood": "Centro", "city": "Sao Paulo", "state": "SP", "country": "Brasil", "zipcode": "01001000", "addressType": "COMMERCIAL", "isActive": "true", "isMainForEntity": "true", "priority": "1", "lastValidationDate": "2026-05-12" } ], "addressesExtendedTotal": 1, "addressesExtendedTotalActive": 1, "addressesExtendedTotalWork": 1, "addressesExtendedTotalPersonal": 0, "addressesExtendedTotalUnique": 1, "addressesExtendedTotalPassages": 7, "addressesExtendedTotalBadPassages": 0, "addressesExtendedOldestPassageDate": "2018-02-10", "addressesExtendedNewestPassageDate": "2026-05-12" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_ADDRESSES_EXTENDED_CNPJ", "cnpj": "cnpj" }' ``` ### Enriquecimento de dados - Service: `SERVICE_CORPORATE_DATA_ENRICHMENT` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CNPJ Receita Federal, PJ - Enriquecimento de dados - Retorno principal: Retorna cadastro completo da empresa, incluindo razão social, nome fantasia, situação cadastral, CNAEs, natureza jurídica, porte, capital e endereço. Response resumido: ```json { "result": { "cnpj": "cnpj", "officialName": "EMPRESA EXEMPLO LTDA", "tradeName": "EMPRESA EXEMPLO", "status": "ATIVA", "mainActivity": "CNAE principal" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_CORPORATE_DATA_ENRICHMENT", "cnpj": "cnpj" }' ``` ### Evolução da Empresa - Service: `SERVICE_COMPANY_EVOLUTION` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Evolução da Empresa - Retorno principal: Retorna a evolução temporal de capital, quantidade de funcionários, filiais e sócios da empresa, com tendência de crescimento. Response resumido: ```json { "result": { "cnpj": "cnpj", "companyEvolutionSummary": "Empresa com tendência de crescimento estável", "companyEvolutionStats": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_COMPANY_EVOLUTION", "cnpj": "cnpj" }' ``` ### Exposição e perfil na mídia dos sócios - Service: `SERVICE_MEDIA_PROFILE_EXPOSURE_PJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Exposição e perfil na mídia dos sócios - Retorno principal: Retorna exposição e perfil de mídia da empresa e sócios, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados. Response resumido: ```json { "result": { "cnpj": "cnpj", "mediaMentions": [ { "title": "Noticia encontrada", "source": "Fonte", "sentiment": "NEUTRAL" } ], "exposureLevel": "LOW" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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_PJ", "cnpj": "cnpj" }' ``` ### FGTS - Service: `SERVICE_FGTS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - FGTS - Retorno principal: Retorna a certidão de regularidade do empregador perante o FGTS, com status, número e validade da certidão e conteúdo textual emitido. Response resumido: ```json { "result": { "cnpj": "cnpj", "fgtsStatus": "REGULAR", "fgtsCertificateNumber": "2026000000000000", "fgtsCertificateValidity": "01/08/2026 a 29/08/2026", "fgtsCertificateText": "Certificado que a empresa encontra-se em situação regular perante o FGTS", "fgtsSummary": "Empresa regular perante o FGTS", "fgtsDetails": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_FGTS", "cnpj": "cnpj" }' ``` ### Flags Negativos PJ - Service: `SERVICE_QUOD_CREDIT_RISK_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Flags Negativos PJ - Retorno principal: Retorna flags negativos de crédito de pessoa jurídica pelo CNPJ informado, com nível e classificação de risco, indicativo de restrições e quantidade de flags negativos. Response resumido: ```json { "result": { "cnpj": "cnpj", "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}" } ``` Curl de homologação: ```bash 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_COMPANY", "cnpj": "cnpj" }' ``` ### Fornecedores eleitorais - Service: `SERVICE_ELECTORAL_PROVIDERS_CNPJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CNPJ Receita Federal, PJ - Fornecedores eleitorais, dados eleitorais campanha doações candidato - Retorno principal: Retorna prestações de serviço eleitorais vinculadas ao CNPJ, com campanha, candidato/partido, valor, ano e natureza do serviço. Response resumido: ```json { "result": { "cnpj": "cnpj", "campos": [ { "year": 2024, "campaign": "Campanha", "amount": "2500.00", "serviceType": "Servico" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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_CNPJ", "cnpj": "cnpj" }' ``` ### Histórico de Dados Básicos - Service: `SERVICE_HISTORY_BASIC_DATA` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Histórico de Dados Básicos - Retorno principal: Retorna o histórico de alterações cadastrais básicas do CNPJ: nome, regime tributário, situação cadastral, CNAE e capital social. Response resumido: ```json { "result": { "cnpj": "cnpj", "historyBasicDataCurrentName": "EMPRESA EXEMPLO LTDA", "historyBasicDataAge": 6, "historyBasicDataTotalChanges": 2, "historyBasicDataSummary": "Empresa com 2 alterações cadastrais encontradas", "historyBasicDataStats": [], "historyBasicDataNameHistory": [], "historyBasicDataTaxRegimeHistory": [], "historyBasicDataTaxIdStatusHistory": [], "historyBasicDataCnaeHistory": [], "historyBasicDataCapitalHistory": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_HISTORY_BASIC_DATA", "cnpj": "cnpj" }' ``` ### Influência do Quadro Societário - Service: `SERVICE_OWNERS_INFLUENCE` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Influência do Quadro Societário - Retorno principal: Retorna o nível de influência inferido do quadro societário da empresa, considerando exposição na mídia, envolvimento político e histórico de processos dos sócios. Response resumido: ```json { "result": { "cnpj": "cnpj", "influenceScore": 0, "ownersInfluenceSummary": "Baixa influência do quadro societário", "ownersInfluence": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_OWNERS_INFLUENCE", "cnpj": "cnpj" }' ``` ### KYC e Compliance do Grupo Econômico - Service: `SERVICE_ECONOMIC_GROUP_KYC_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - KYC e Compliance do Grupo Econômico, compliance KYC sanções PEP mídia - Retorno principal: Retorna indicadores agregados de KYC e compliance regulatório do grupo econômico completo do CNPJ informado, incluindo exposição política (PEP) e sanções. Response resumido: ```json { "result": { "cnpj": "cnpj", "economicGroupKycSummary": "Consulta realizada", "economicGroupTotalCurrentPep": "0", "economicGroupTotalHistoricalPep": "1", "economicGroupTotalCurrentSanctioned": "0", "economicGroupTotalHistoricalSanctioned": "0", "economicGroupAverageSanctions": "0" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_ECONOMIC_GROUP_KYC_COMPANY", "cnpj": "cnpj" }' ``` ### KYC e Compliance dos Funcionários - Service: `SERVICE_EMPLOYEES_KYC` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - KYC e Compliance dos Funcionários, compliance KYC sanções PEP mídia - Retorno principal: Retorna indicadores de KYC e compliance regulatório dos funcionários vinculados à empresa, incluindo classificações de PEP e sanções nacionais e internacionais. Response resumido: ```json { "result": { "cnpj": "cnpj", "employeesKycTotalEmployees": 5, "employeesKycCurrentlyPepCount": 0, "employeesKycCurrentlySanctionedCount": 0, "employeesKycPreviouslySanctionedCount": 0, "employeesKycFlaggedCount": 0, "employeesKycSummary": "Nenhum funcionário sinalizado como PEP ou sancionado", "employeesKycFlagged": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_EMPLOYEES_KYC", "cnpj": "cnpj" }' ``` ### KYC e compliance dos sócios - Service: `SERVICE_COMPANY_KYC_OWNERS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - KYC e compliance dos sócios, compliance KYC sanções PEP sancionado interpol ofac - Retorno principal: Retorna um resumo agregado de KYC/compliance da empresa (totalCurrentPep, totalCurrentSanctioned, averageSanctionsPerOwner, pepPercentage) e o detalhamento individual de cada sócio em result.kycOwners/companyOwners/peopleOwners, incluindo sanctionsHistory (histórico completo), highConfidenceSanctionsHistory (apenas sanções com matchRate acima de 90) e pepHistories. Response resumido: ```json { "result": { "cnpj": "cnpj", "totalCurrentPep": 1, "totalHistoricallyPEP": 1, "totalCurrentSanctioned": 1, "totalHistoricallySanctioned": 1, "averageSanctionsPerOwner": 1, "averageSanctionsPerOwnerExact": 0.5, "pepPercentage": 50, "ownerMaxSanctions": 1, "ownerMinSanctions": 0, "activeOwners": [ "11122233344", "55566677788" ], "inactiveOwners": [], "kycOwners": [ { "cpf": "11122233344", "isPep": true, "isCurrentlySanctioned": true, "wasPreviouslySanctioned": true, "firstSanctionDate": "2021-03-15", "lastSanctionDate": "2024-08-02", "firstPepOccurrenceDate": "2019-01-10", "lastPepOccurrenceDate": "2024-08-02", "sanctionsHistory": [ { "source": "interpol", "type": "RED_NOTICE", "standardizedSanctionType": "INTERNATIONAL_ALERT", "matchRate": 96, "details": { "Charge": "Fraud", "IssuingCountry": "Brazil" }, "normalizedDetails": { "acusacao": "Fraude", "paisEmissor": "Brasil" }, "startDate": "2021-03-15", "endDate": null, "isCurrentlyPresentOnSource": true } ], "highConfidenceSanctionsHistory": [ { "source": "interpol", "type": "RED_NOTICE", "standardizedSanctionType": "INTERNATIONAL_ALERT", "matchRate": 96, "details": { "Charge": "Fraud", "IssuingCountry": "Brazil" }, "normalizedDetails": { "acusacao": "Fraude", "paisEmissor": "Brasil" }, "startDate": "2021-03-15", "endDate": null, "isCurrentlyPresentOnSource": true } ], "pepHistories": [ { "level": "FEDERAL", "jobTitle": "Secretario", "department": "Ministerio Exemplo", "startDate": "2019-01-10", "endDate": null } ], "isCurrentlyElectoralDonor": false, "isHistoricalElectoralDonor": true, "totalElectoralDonations": 2, "totalElectoralDonationAmount": 15000 }, { "cpf": "55566677788", "isPep": false, "isCurrentlySanctioned": false, "wasPreviouslySanctioned": false, "sanctionsHistory": [], "highConfidenceSanctionsHistory": [], "pepHistories": [] } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_COMPANY_KYC_OWNERS", "cnpj": "cnpj" }' ``` ### Marketplaces - Service: `SERVICE_MARKETPLACE_DATA` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Marketplaces - Retorno principal: Retorna a presença da empresa em marketplaces, incluindo lojas operadas, produtos listados, marketplace com mais produtos e melhor avaliação. Response resumido: ```json { "result": { "cnpj": "cnpj", "totalMarketplacesUsed": 1, "totalStoresOperated": 1, "marketplaceWithMostProducts": "Mercado Livre", "marketplaceWithBestRating": "Mercado Livre", "totalProductsListed": 0, "marketplaceSummary": "Empresa presente em 1 marketplace", "marketplaceDetails": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_MARKETPLACE_DATA", "cnpj": "cnpj" }' ``` ### Obras Civis - Service: `SERVICE_CIVIL_CONSTRUCTION` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Obras Civis - Retorno principal: Retorna obras civis vinculadas ao CNPJ informado, conforme o Cadastro Nacional de Obras (CNO). Response resumido: ```json { "result": { "cnpj": "cnpj", "totalCivilConstructionRecords": 2, "totalActiveCivilConstructionRecords": 1, "civilConstructionSummary": "Consulta realizada", "civilConstructionRecords": [ { "cno": "00000000000", "status": "ATIVA", "address": "RUA EXEMPLO, 100", "startDate": "2025-01-01" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_CIVIL_CONSTRUCTION", "cnpj": "cnpj" }' ``` ### OCR de cartão CNPJ - Service: `SERVICE_OCR_CNPJ_CARD` - Endpoint: `POST /api/service-api` - Campos do request: `image1` - Termos de busca: CNPJ Receita Federal, OCR cartão CNPJ comprovante inscrição empresa, OCR documento imagem base64 leitura extração, PJ - OCR de cartão CNPJ - Retorno principal: Retorna dados extraídos do cartão CNPJ enviado por imagem, incluindo CNPJ, tipo do documento e texto OCR quando disponível. Response resumido: ```json { "result": { "cnpj": "cnpj", "docType": "CNPJ_CARD", "genericOcr": "texto extraído do cartão CNPJ" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_OCR_CNPJ_CARD", "image1": "base64" }' ``` ### Optante pelo Simples Nacional - Service: `SERVICE_SIMPLES_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Optante pelo Simples Nacional - Retorno principal: Retorna a situação da empresa como optante pelo Simples Nacional e pelo SIMEI, pelo CNPJ informado. Response resumido: ```json { "result": { "cnpj": "cnpj", "simplesSummary": "Consulta realizada", "simplesOfficialName": "NOME OFICIAL DA EMPRESA", "simplesNationalStatus": "OPTANTE", "simplesMeiStatus": "NAO OPTANTE", "simplesCertificateUrl": "https://example.com/comprovante-simples.pdf" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_SIMPLES_COMPANY", "cnpj": "cnpj" }' ``` ### Percentual de Participação Societária - Service: `SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Percentual de Participação Societária - Retorno principal: Retorna o percentual de participação societária de cada sócio da empresa pelo CNPJ informado. Response resumido: ```json { "result": { "cnpj": "cnpj", "numberOfOwners": 2, "numberOfPeopleAsOwners": 1, "numberOfCompaniesAsOwners": 1, "hasMajorityStakeHolder": true, "averageParticipationPercentage": 50, "maxParticipationPercentage": 70, "minParticipationPercentage": 30, "firstOwnerEntryDate": "2015-03-01", "lastOwnerEntryDate": "2022-06-15", "ownerParticipationSummary": "Consulta realizada", "ownerParticipations": [ { "ownerDocument": "00000000000", "ownerName": "NOME DO SOCIO", "percentage": 70 } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY", "cnpj": "cnpj" }' ``` ### Processos jurídicos - Service: `SERVICE_JURIDICAL_PROCESSES_PJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Processos jurídicos, processos judiciais jurídicos tribunal certidão - Retorno principal: Retorna processos jurídicos vinculados ao CNPJ, com tribunal, classe, assunto, partes, status, número do processo e datas quando disponíveis. Response resumido: ```json { "result": { "cnpj": "cnpj", "totalProcesses": 1, "processes": [ { "court": "TJSP", "processNumber": "0000000-00.0000.0.00.0000", "status": "ACTIVE" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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_PJ", "cnpj": "cnpj" }' ``` ### Processos jurídicos dos sócios - Service: `SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Processos jurídicos dos sócios, processos judiciais jurídicos tribunal certidão - Retorno principal: Retorna processos jurídicos associados aos sócios da empresa, com sócio relacionado, tribunal, classe, assunto, status e datas. Response resumido: ```json { "result": { "cnpj": "cnpj", "ownersProcesses": [ { "ownerName": "Nome do sócio", "totalProcesses": 1, "processes": [] } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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_PJ_OWNERS", "cnpj": "cnpj" }' ``` ### Projetos Públicos - Service: `SERVICE_PUBLIC_PROJECTS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Projetos Públicos - Retorno principal: Retorna projetos com financiamento de órgãos públicos associados à empresa pelo CNPJ informado, com fonte, modalidade e valores contratado e desembolsado. Response resumido: ```json { "result": { "cnpj": "cnpj", "totalPublicProjects": 1, "publicProjectsSummary": "Consulta realizada", "publicProjects": [ { "source": "BNDES", "modality": "FINANCIAMENTO", "contractedValue": 500000, "disbursedValue": 250000, "contractDate": "2025-01-10" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_PUBLIC_PROJECTS", "cnpj": "cnpj" }' ``` ### Receita Federal - QSA - Service: `SERVICE_RF_QSA` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CPF Receita Federal, PJ - Receita Federal - QSA - Retorno principal: Retorna o quadro societário-administrativo (QSA) do CNPJ informado, com dados cadastrais da matriz (porte, capital, CNAE, natureza jurídica, situação cadastral) e a lista de sócios e administradores. Response resumido: ```json { "result": { "cnpj": "cnpj", "qsaCompanyType": "MATRIZ", "qsaCompanySize": "DEMAIS", "qsaCapital": "DEZ MIL REAIS", "qsaCapitalValue": "10000.00", "qsaCnae": "62.09-1-00", "qsaMainEconomicActivity": "SUPORTE TECNICO, MANUTENCAO E OUTROS SERVICOS EM TECNOLOGIA DA INFORMACAO", "qsaSecondaryActivity": "DESENVOLVIMENTO DE PROGRAMAS DE COMPUTADOR SOB ENCOMENDA", "qsaLegalNatureCode": "2062", "qsaLegalNature": "SOCIEDADE EMPRESARIA LIMITADA", "qsaIrsStatus": "ATIVA", "qsaIsActive": "true", "qsaStatusDate": "2018-04-04", "qsaPartnersCount": 1, "qsaSummary": "Empresa ativa com 1 sócio encontrado no QSA", "qsaPartners": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_RF_QSA", "cnpj": "cnpj" }' ``` ### Relacionamentos da empresa - Service: `SERVICE_COMPANY_RELATIONSHIP` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Relacionamentos da empresa - Retorno principal: Retorna relacionamentos da empresa, como sócios, proprietários, empresas relacionadas, participações e vínculos societários identificados. Response resumido: ```json { "result": { "cnpj": "cnpj", "owners": [ { "name": "Nome do sócio", "document": "cpf", "share": "50%" } ], "relatedCompanies": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_COMPANY_RELATIONSHIP", "cnpj": "cnpj" }' ``` ### Relacionamentos do Grupo Econômico - Service: `SERVICE_ECONOMIC_GROUP_RELATIONSHIPS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Relacionamentos do Grupo Econômico - Retorno principal: Retorna as entidades (pessoas e empresas) que integram o mesmo grupo econômico do CNPJ consultado, com relacionamentos atuais, históricos e estatísticas agregadas. Response resumido: ```json { "result": { "cnpj": "cnpj", "totalEconomicGroupRelationships": 3, "economicGroupRelationshipsSummary": "Empresa possui 3 relacionamentos de grupo econômico", "economicGroupRelationships": [], "economicGroupCurrentRelationships": [], "economicGroupHistoricalRelationships": [], "economicGroupRelationshipsStats": {} }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_ECONOMIC_GROUP_RELATIONSHIPS", "cnpj": "cnpj" }' ``` ### Risco de crédito - Service: `SERVICE_CREDIT_RISK_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Risco de crédito, score risco crédito rating inadimplência - Retorno principal: Retorna dados de risco de crédito PJ, com score, rating, risco esperado e sinais jurídicos quando disponíveis. Response resumido: ```json { "result": { "cnpj": "cnpj", "creditRisk": { "status": "APPROVED", "score": "720", "rating": "B", "expectedDefault": "MEDIUM", "legalProcess": false } }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_CREDIT_RISK_COMPANY", "cnpj": "cnpj" }' ``` ### Score de Crédito Multidados PJ - Service: `SERVICE_BOAVISTA_ONE_SCORE_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Score de Crédito Multidados PJ, score risco crédito rating inadimplência - Retorno principal: Retorna score de crédito multidados de pessoa jurídica pelo CNPJ informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta. Response resumido: ```json { "result": { "cnpj": "cnpj", "score": 700, "riskLevel": "BAIXO", "riskClassification": "A", "reasonCodes": [ "Bom histórico de pagamentos" ], "creditBureauSummary": "Score de crédito multidados acima da média do setor", "creditBureauDetails": {}, "origin": "Boa Vista", "queryDate": "2026-08-01" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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_COMPANY", "cnpj": "cnpj" }' ``` ### Score de Crédito PJ - Service: `SERVICE_QUOD_CREDIT_SCORE_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Score de Crédito PJ, score risco crédito rating inadimplência - Retorno principal: Retorna score de crédito de pessoa jurídica pelo CNPJ informado, com nível de risco, classificação de risco, motivos do score e resumo textual da consulta. Response resumido: ```json { "result": { "cnpj": "cnpj", "score": 650, "riskLevel": "MEDIO", "riskClassification": "B", "reasonCodes": [ "Tempo de mercado", "Capital social baixo" ], "creditBureauSummary": "Score de crédito dentro da média do setor", "creditBureauDetails": {}, "origin": "Quod", "queryDate": "2026-08-01" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash 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_COMPANY", "cnpj": "cnpj" }' ``` ### Score de Crédito Quantum PJ - Service: `SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Score de Crédito Quantum PJ, score risco crédito rating inadimplência - Retorno principal: Retorna score de crédito Quantum de pessoa jurídica pelo CNPJ informado, com resumo textual e dados estruturados de bureau de crédito. Response resumido: ```json { "result": { "cnpj": "cnpj", "score": 690, "creditBureauSummary": "Score de crédito dentro da média do setor", "creditBureauDetails": {}, "origin": "Quantum", "queryDate": "2026-08-01" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY", "cnpj": "cnpj" }' ``` ### SINTEGRA - Service: `SERVICE_SINTEGRA_CONSULTATION` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj`, `uf` - Termos de busca: PJ - SINTEGRA - Retorno principal: Retorna dados do SINTEGRA, incluindo inscrição estadual, UF, situação, regime, atividades, endereço e mensagens da consulta. Response resumido: ```json { "result": { "cnpj": "cnpj", "stateRegistration": "000000000", "state": "SP", "status": "HABILITADO", "regime": "NORMAL" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_SINTEGRA_CONSULTATION", "cnpj": "cnpj", "uf": "uf (opcional)" }' ``` ### Sócios de primeiro nível - Service: `SERVICE_FIRST_LEVEL_PARTNER` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Sócios de primeiro nível - Retorno principal: Retorna sócios de primeiro nível da empresa, com nome, documento, participação, qualificação e vínculos diretos ao CNPJ. Response resumido: ```json { "result": { "cnpj": "cnpj", "partners": [ { "name": "Nome do sócio", "document": "cpf", "level": 1, "qualification": "SOCIO" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_FIRST_LEVEL_PARTNER", "cnpj": "cnpj" }' ``` ### Sócios na Receita Federal - Service: `SERVICE_COMPANY_RFB_OWNERS` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CPF Receita Federal, PJ - Sócios na Receita Federal - Retorno principal: Retorna o quadro societario na Receita Federal, com nome dos sócios, documentos mascarados, qualificação, participação e data de entrada quando disponível. Response resumido: ```json { "result": { "cnpj": "cnpj", "owners": [ { "name": "Nome do sócio", "qualification": "SOCIO-ADMINISTRADOR", "entryDate": "yyyy-MM-dd" } ] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_COMPANY_RFB_OWNERS", "cnpj": "cnpj" }' ``` ### Status do CNPJ na Receita Federal - Service: `SERVICE_RFB_PJ` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: CNPJ Receita Federal, CPF Receita Federal, PJ - Status do CNPJ na Receita Federal - Retorno principal: Retorna situação do CNPJ na Receita Federal, incluindo razão social, nome fantasia, situação cadastral, abertura, CNAEs e endereço. Response resumido: ```json { "result": { "cnpj": "cnpj", "officialName": "EMPRESA EXEMPLO LTDA", "status": "ATIVA", "openingDate": "yyyy-MM-dd", "mainActivity": "CNAE principal" }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_RFB_PJ", "cnpj": "cnpj" }' ``` ### Telefones - Service: `SERVICE_PHONES_EXTENDED_COMPANY` - Endpoint: `POST /api/service-api` - Campos do request: `cnpj` - Termos de busca: PJ - Telefones, telefone celular validação contato - Retorno principal: Retorna os telefones associados à empresa, com indicadores de validade, prioridade e origem. Response resumido: ```json { "result": { "cnpj": "cnpj", "phonesExtendedCompanyTotal": 2, "phonesExtendedCompanyTotalActive": 1, "phonesExtendedCompanySummary": "Empresa com 2 telefones encontrados, 1 ativo", "phonesExtendedCompanyStats": [], "phonesExtendedCompany": [] }, "status": { "code": 200, "message": "Success" }, "externalId": "{externalId}" } ``` Curl de homologação: ```bash curl --location 'https://backoffice-hml.idcerberus.com/api/service-api' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {jwt_token}' \ --data '{ "service": "SERVICE_PHONES_EXTENDED_COMPANY", "cnpj": "cnpj" }' ```