{ "generatedBy": "scripts/generate-llms.mjs", "artifactVersion": "2026-06", "totalServices": 125, "services": [ { "service": "SERVICE_CRIMINAL_RECORD_CIVIL", "documentedAlias": "SERVICE_CRIMINAL_RECORD_CIVIL", "name": "Antecedentes criminais civis", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "rg", "uf" ], "requestExample": "service: SERVICE_CRIMINAL_RECORD_CIVIL\ncpf: cpf\nrg: rg\nuf: uf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CRIMINAL_RECORD_CIVIL", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Antecedentes criminais civis", "searchTerms": [ "Antecedentes criminais civis", "PF - Antecedentes criminais civis", "SERVICE_CRIMINAL_RECORD_CIVIL" ], "responseSummary": "Retorna resultado de antecedentes criminais civis, com status da certidão, ocorrências encontradas, UF, RG e mensagens da consulta.", "callingAlias": "SERVICE_CRIMINAL_RECORD_CIVIL", "services": [], "requiredFields": [ "cpf", "rg", "uf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CRIMINAL_RECORD_CIVIL", "cpf": "cpf", "rg": "rg", "uf": "uf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "juridico", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_CRIMINAL_RECORD_FEDERAL", "documentedAlias": "SERVICE_CRIMINAL_RECORD_FEDERAL", "name": "Antecedentes criminais federais", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_CRIMINAL_RECORD_FEDERAL\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CRIMINAL_RECORD_FEDERAL", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Antecedentes criminais federais", "searchTerms": [ "Antecedentes criminais federais", "PF - Antecedentes criminais federais", "SERVICE_CRIMINAL_RECORD_FEDERAL" ], "responseSummary": "Retorna resultado de antecedentes criminais federais, com status da certidão, ocorrências encontradas e mensagens da consulta.", "callingAlias": "SERVICE_CRIMINAL_RECORD_FEDERAL", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CRIMINAL_RECORD_FEDERAL", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_SOCIAL_ASSISTANCE_EXTENDED", "documentedAlias": "SERVICE_SOCIAL_ASSISTANCE_EXTENDED", "name": "Benefícios sociais estendidos", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_SOCIAL_ASSISTANCE_EXTENDED\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_SOCIAL_ASSISTANCE_EXTENDED", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Benefícios sociais estendidos", "searchTerms": [ "Benefícios sociais estendidos", "PF - Benefícios sociais estendidos", "SERVICE_SOCIAL_ASSISTANCE_EXTENDED" ], "responseSummary": "Retorna benefícios sociais estendidos vinculados ao CPF, com programas, indicadores, situação e detalhes encontrados quando disponíveis.", "callingAlias": "SERVICE_SOCIAL_ASSISTANCE_EXTENDED", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_SOCIAL_ASSISTANCE_EXTENDED", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "beneficios-sociais", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_FAMILY_SOCIAL_BENEFITS", "documentedAlias": "SERVICE_FAMILY_SOCIAL_BENEFITS", "name": "Benefícios sociais familiares", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_FAMILY_SOCIAL_BENEFITS\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FAMILY_SOCIAL_BENEFITS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Benefícios sociais familiares", "searchTerms": [ "Benefícios sociais familiares", "PF - Benefícios sociais familiares", "SERVICE_FAMILY_SOCIAL_BENEFITS" ], "responseSummary": "Retorna benefícios sociais familiares vinculados ao CPF, com programas, situação, quantidade e registros encontrados quando disponíveis.", "callingAlias": "SERVICE_FAMILY_SOCIAL_BENEFITS", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_FAMILY_SOCIAL_BENEFITS", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "beneficios-sociais", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_FACE_INDEX", "documentedAlias": "SERVICE_FACE_INDEX", "name": "Busca de face na base", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "image1" ], "requestExample": "service: SERVICE_FACE_INDEX\nimage1: base64", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FACE_INDEX", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Busca de face na base", "searchTerms": [ "Busca de face na base", "PF - Busca de face na base", "SERVICE_FACE_INDEX", "comparação facial biometria selfie rosto", "face index busca facial selfie CPF base de faces" ], "responseSummary": "Busca uma selfie na base de faces indexadas e retorna se encontrou face, CPF associado e similaridade quando disponíveis.", "callingAlias": "SERVICE_FACE_INDEX", "services": [], "requiredFields": [ "image1" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_FACE_INDEX", "image1": "base64" }, "successResponseExample": { "result": { "faceFound": true, "similarity": 99.9, "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 400, "message": "Face nao encontrada na base", "cause": "Selfie nao teve correspondencia na base de faces ou nao foi possivel detectar rosto.", "action": "Usar selfie real, frontal e nítida. Não usar foto de documento." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-face-index.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": false, "needsSelfie": true, "needsCpf": false, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Use selfie real, frontal e nítida. Não use foto de RG, CNH ou print de documento.", "Face Index busca correspondência na base de faces; isso não é validação definitiva de identidade." ] }, "tags": [ "cpf", "face", "imagem" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-face-index.hml.curl" }, { "service": "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF", "documentedAlias": "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF", "name": "Cartão SUS", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Cartão SUS", "searchTerms": [ "CPF Receita Federal", "Cartão SUS", "PF - Cartão SUS", "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF" ], "responseSummary": "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.", "callingAlias": "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_NOTHING_RECORD_LAWSUITS", "documentedAlias": "SERVICE_NOTHING_RECORD_LAWSUITS", "name": "Certidão de Nada Consta", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "court", "uf", "sphere" ], "requestExample": "service: SERVICE_NOTHING_RECORD_LAWSUITS\ncpf: cpf\ncourt: TRF1\nuf: uf\nsphere: CIVIL", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_NOTHING_RECORD_LAWSUITS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Certidão de Nada Consta", "searchTerms": [ "Certidão de Nada Consta", "PF - Certidão de Nada Consta", "SERVICE_NOTHING_RECORD_LAWSUITS", "processos judiciais jurídicos tribunal certidão" ], "responseSummary": "Retorna certidão de nada consta para a esfera/tribunal informado, com status, mensagem, ocorrências e dados usados na consulta.", "callingAlias": "SERVICE_NOTHING_RECORD_LAWSUITS", "services": [], "requiredFields": [ "cpf", "court", "uf", "sphere" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_NOTHING_RECORD_LAWSUITS", "cpf": "cpf", "court": "TRF1", "uf": "uf", "sphere": "CIVIL" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE", "documentedAlias": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE", "name": "Certidão negativa de protesto", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_PROTEST_CLEARANCE_CERTIFICATE\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PROTEST_CLEARANCE_CERTIFICATE", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Certidão negativa de protesto", "searchTerms": [ "Certidão negativa de protesto", "PF - Certidão negativa de protesto", "SERVICE_PROTEST_CLEARANCE_CERTIFICATE" ], "responseSummary": "Retorna certidão/consulta de protestos para CPF, com status de nada consta ou lista de protestos, cartório, valor e datas.", "callingAlias": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE", "services": [ "SERVICE_PROTEST_PF" ], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_PROTEST_PF", "documentedAlias": "SERVICE_PROTEST_PF", "name": "Certidão negativa de protesto PF", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_PROTEST_PF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PROTEST_PF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Certidão negativa de protesto PF", "searchTerms": [ "Certidão negativa de protesto PF", "PF - Certidão negativa de protesto PF", "SERVICE_PROTEST_PF" ], "responseSummary": "Retorna certidão/consulta de protestos para CPF, com status, cartórios consultados, protestos e mensagens.", "callingAlias": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE", "services": [ "SERVICE_PROTEST_CLEARANCE_CERTIFICATE" ], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PROTEST_PF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_MEI", "documentedAlias": "SERVICE_MEI", "name": "Consulta de MEI", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_MEI\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_MEI", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Consulta de MEI", "searchTerms": [ "Consulta de MEI", "PF - Consulta de MEI", "SERVICE_MEI" ], "responseSummary": "Retorna empresas MEI associadas ao CPF, incluindo CNPJ, razão social, situação, atividades, endereço e datas cadastrais quando disponíveis.", "callingAlias": "SERVICE_MEI", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_MEI", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000", "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "beneficios-sociais", "cadastral", "cnpj", "comprovante-endereco", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_RFB_PF_ON_DEMAND", "documentedAlias": "SERVICE_RFB_PF_ON_DEMAND", "name": "CPF na Receita Federal on-demand", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_RFB_PF_ON_DEMAND\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RFB_PF_ON_DEMAND", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - CPF na Receita Federal on-demand", "searchTerms": [ "CPF Receita Federal", "CPF na Receita Federal on-demand", "PF - CPF na Receita Federal on-demand", "SERVICE_RFB_PF_ON_DEMAND" ], "responseSummary": "Retorna situação atualizada do CPF consultada sob demanda na Receita Federal, com nome, nascimento, status cadastral e protocolo.", "callingAlias": "SERVICE_RFB_PF_ON_DEMAND", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_RFB_PF_ON_DEMAND", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_DEMOGRAPHIC_DATA_CPF", "documentedAlias": "SERVICE_DEMOGRAPHIC_DATA_CPF", "name": "Dados demográficos", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "birthDate" ], "requestExample": "service: SERVICE_DEMOGRAPHIC_DATA_CPF\ncpf: cpf\nbirthDate: yyyy-MM-dd (opcional)", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DEMOGRAPHIC_DATA_CPF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Dados demográficos", "searchTerms": [ "CPF Receita Federal", "Dados demográficos", "PF - Dados demográficos", "SERVICE_DEMOGRAPHIC_DATA_CPF" ], "responseSummary": "Retorna dados demograficos associados ao CPF, com dados regionais, estimativas e indicadores retornados pela base consultada.", "callingAlias": "SERVICE_DEMOGRAPHIC_DATA_CPF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [ "birthDate" ], "payloadExample": { "service": "SERVICE_DEMOGRAPHIC_DATA_CPF", "cpf": "cpf", "birthDate": "yyyy-MM-dd (opcional)" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF", "documentedAlias": "SERVICE_ELECTION_CANDIDATE_DATA_CPF", "name": "Dados eleitorais de candidato", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_ELECTION_CANDIDATE_DATA_CPF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ELECTION_CANDIDATE_DATA_CPF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Dados eleitorais de candidato", "searchTerms": [ "CPF Receita Federal", "Dados eleitorais de candidato", "PF - Dados eleitorais de candidato", "SERVICE_ELECTION_CANDIDATE_DATA_CPF" ], "responseSummary": "Retorna histórico de candidaturas eleitorais do CPF, incluindo cargo, partido, ano, unidade eleitoral, bens declarados e situação quando disponível.", "callingAlias": "SERVICE_ELECTION_CANDIDATE_DATA_CPF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS", "documentedAlias": "SERVICE_PF_FINANCIAL_AND_ADDRESS", "name": "Dados financeiros e endereços", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "birthDate" ], "requestExample": "service: SERVICE_PF_FINANCIAL_AND_ADDRESS\ncpf: cpf\nbirthDate: yyyy-MM-dd (opcional)", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PF_FINANCIAL_AND_ADDRESS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Dados financeiros e endereços", "searchTerms": [ "Dados financeiros e endereços", "PF - Dados financeiros e endereços", "SERVICE_PF_FINANCIAL_AND_ADDRESS" ], "responseSummary": "Retorna dados financeiros e endereços do CPF em uma consulta combinada, incluindo renda estimada, indicadores financeiros e endereços encontrados.", "callingAlias": "SERVICE_PF_FINANCIAL_AND_ADDRESS", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [ "birthDate" ], "payloadExample": { "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS", "cpf": "cpf", "birthDate": "yyyy-MM-dd (opcional)" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "comprovante-endereco", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_CONFIRM_PHONE", "documentedAlias": "SERVICE_CONFIRM_PHONE", "name": "Dados pelo telefone", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "phone" ], "requestExample": "service: SERVICE_CONFIRM_PHONE\nphone: \"+5561123456789\"", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CONFIRM_PHONE", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Dados pelo telefone", "searchTerms": [ "Dados pelo telefone", "PF - Dados pelo telefone", "SERVICE_CONFIRM_PHONE", "telefone celular validação contato" ], "responseSummary": "Retorna dados associados ao telefone informado, como possível titular, documento relacionado, status de confirmacao e atributos disponíveis.", "callingAlias": "SERVICE_CONFIRM_PHONE", "services": [], "requiredFields": [ "phone" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CONFIRM_PHONE", "phone": "+5561123456789" }, "successResponseExample": { "result": { "message": "Retorna dados associados ao telefone informado, como possível titular, documento relacionado, status de confirmacao e atributos disponíveis." }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "llms-api-reference.txt" ], "useCurlExample": false, "needsImage": true, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "contato", "imagem" ] }, { "service": "SERVICE_PIS_CONSULTATION", "documentedAlias": "SERVICE_PIS_CONSULTATION", "name": "Dados PIS", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_PIS_CONSULTATION\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PIS_CONSULTATION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Dados PIS", "searchTerms": [ "Dados PIS", "PF - Dados PIS", "SERVICE_PIS_CONSULTATION" ], "responseSummary": "Retorna dados de PIS/NIS associados ao CPF, incluindo número encontrado, status, dados cadastrais relacionados e mensagens da consulta.", "callingAlias": "SERVICE_PIS_CONSULTATION", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PIS_CONSULTATION", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_BOAVISTA_CREDIT_SCORE_PERSON", "documentedAlias": "SERVICE_BOAVISTA_CREDIT_SCORE_PERSON", "name": "Dados Restritivos", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_BOAVISTA_CREDIT_SCORE_PERSON\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_BOAVISTA_CREDIT_SCORE_PERSON", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Dados Restritivos", "searchTerms": [ "Dados Restritivos", "PF - Dados Restritivos", "SERVICE_BOAVISTA_CREDIT_SCORE_PERSON", "score risco crédito rating inadimplência" ], "responseSummary": "Retorna dados restritivos de crédito de pessoa física pelo CPF informado, incluindo score, indicativo e quantidade de restrições encontradas.", "callingAlias": "SERVICE_BOAVISTA_CREDIT_SCORE_PERSON", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_BOAVISTA_CREDIT_SCORE_PERSON", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cpf", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_ACTIVE_DEBT_PF", "documentedAlias": "SERVICE_ACTIVE_DEBT_PF", "name": "Dívida ativa", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_ACTIVE_DEBT_PF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ACTIVE_DEBT_PF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Dívida ativa", "searchTerms": [ "Dívida ativa", "PF - Dívida ativa", "SERVICE_ACTIVE_DEBT_PF", "dívida ativa débito cobrança inadimplência" ], "responseSummary": "Retorna dívidas ativas vinculadas ao CPF, com origem do débito, valores, situação, órgão credor e status da consulta.", "callingAlias": "SERVICE_ACTIVE_DEBT_PF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ACTIVE_DEBT_PF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cpf", "rg", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_ELECTORAL_DONORS_CPF", "documentedAlias": "SERVICE_ELECTORAL_DONORS_CPF", "name": "Doações eleitorais", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_ELECTORAL_DONORS_CPF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ELECTORAL_DONORS_CPF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Doações eleitorais", "searchTerms": [ "CPF Receita Federal", "Doações eleitorais", "PF - Doações eleitorais", "SERVICE_ELECTORAL_DONORS_CPF", "dados eleitorais campanha doações candidato" ], "responseSummary": "Retorna doações eleitorais realizadas pelo CPF, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.", "callingAlias": "SERVICE_ELECTORAL_DONORS_CPF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ELECTORAL_DONORS_CPF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY", "documentedAlias": "SERVICE_DIGITAL_DOCUMENTOSCOPY", "name": "Documentoscopia digital", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "key", "image1", "image2", "selfie1" ], "requestExample": "service: SERVICE_DIGITAL_DOCUMENTOSCOPY\nkey: 84bfcd2e-2336-4e30-bcab-15348b7890b5\nimage1: base64\nimage2: base64\nselfie1: base64", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DIGITAL_DOCUMENTOSCOPY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Documentoscopia digital", "searchTerms": [ "Documentoscopia digital", "PF - Documentoscopia digital", "SERVICE_DIGITAL_DOCUMENTOSCOPY", "documentoscopia documento selfie validação" ], "responseSummary": "Retorna status da documentoscopia, chave da consulta, dados extraídos do documento, validações de documento/selfie e resultado de aprovacao.", "callingAlias": "SERVICE_DOCUMENTOSCOPY", "services": [ "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT" ], "requiredFields": [ "key", "image1", "image2", "selfie1" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY", "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5", "image1": "base64", "image2": "base64", "selfie1": "base64" }, "successResponseExample": { "result": { "message": "Retorna status da documentoscopia, chave da consulta, dados extraídos do documento, validações de documento/selfie e resultado de aprovacao." }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 400, "message": "Face nao encontrada na base", "cause": "Selfie nao teve correspondencia na base de faces ou nao foi possivel detectar rosto.", "action": "Usar selfie real, frontal e nítida. Não usar foto de documento." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "llms-api-reference.txt" ], "useCurlExample": false, "needsImage": true, "needsRealDocument": false, "needsSelfie": true, "needsCpf": false, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Use selfie real, frontal e nítida. Não use foto de RG, CNH ou print de documento.", "Face Index busca correspondência na base de faces; isso não é validação definitiva de identidade." ] }, "tags": [ "face", "imagem" ] }, { "service": "SERVICE_DOMAINS_CPF", "documentedAlias": "SERVICE_DOMAINS_CPF", "name": "Domínios", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_DOMAINS_CPF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DOMAINS_CPF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Domínios", "searchTerms": [ "CPF Receita Federal", "Domínios", "PF - Domínios", "SERVICE_DOMAINS_CPF", "domínios sites presença digital" ], "responseSummary": "Retorna domínios, sites e sinais digitais associados ao CPF, incluindo quantidade e registros encontrados quando disponíveis.", "callingAlias": "SERVICE_DOMAINS_CPF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_DOMAINS_CPF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf", "dominios" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_RELATED_PEOPLE_EMAILS", "documentedAlias": "SERVICE_RELATED_PEOPLE_EMAILS", "name": "E-mails de Pessoas Relacionadas", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_RELATED_PEOPLE_EMAILS\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RELATED_PEOPLE_EMAILS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - E-mails de Pessoas Relacionadas", "searchTerms": [ "E-mails de Pessoas Relacionadas", "PF - E-mails de Pessoas Relacionadas", "SERVICE_RELATED_PEOPLE_EMAILS", "email validação contato" ], "responseSummary": "Retorna e-mails associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada e-mail.", "callingAlias": "SERVICE_RELATED_PEOPLE_EMAILS", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_RELATED_PEOPLE_EMAILS", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "contato", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_ADDRESS", "documentedAlias": "SERVICE_ADDRESS", "name": "Endereços", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_ADDRESS\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ADDRESS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Endereços", "searchTerms": [ "Endereços", "PF - Endereços", "SERVICE_ADDRESS" ], "responseSummary": "Retorna endereços associados ao CPF, incluindo logradouro, número, bairro, cidade, UF, CEP, país, tipo e indicadores de atualidade quando disponíveis.", "callingAlias": "SERVICE_ADDRESS", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ADDRESS", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "comprovante-endereco", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_RELATED_PEOPLE_ADDRESSES", "documentedAlias": "SERVICE_RELATED_PEOPLE_ADDRESSES", "name": "Endereços de Pessoas Relacionadas", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_RELATED_PEOPLE_ADDRESSES\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RELATED_PEOPLE_ADDRESSES", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Endereços de Pessoas Relacionadas", "searchTerms": [ "Endereços de Pessoas Relacionadas", "PF - Endereços de Pessoas Relacionadas", "SERVICE_RELATED_PEOPLE_ADDRESSES" ], "responseSummary": "Retorna endereços associados a pessoas relacionadas ao CNPJ informado, com o relacionamento identificado e sinais de uso de cada endereço.", "callingAlias": "SERVICE_RELATED_PEOPLE_ADDRESSES", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_RELATED_PEOPLE_ADDRESSES", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "comprovante-endereco" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_PERSON_DATA_ENRICHMENT", "documentedAlias": "SERVICE_PERSON_DATA_ENRICHMENT", "name": "Enriquecimento de dados", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_PERSON_DATA_ENRICHMENT\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PERSON_DATA_ENRICHMENT", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Enriquecimento de dados", "searchTerms": [ "Enriquecimento de dados", "PF - Enriquecimento de dados", "SERVICE_PERSON_DATA_ENRICHMENT" ], "responseSummary": "Retorna dados cadastrais do CPF, incluindo nome, nascimento, situação cadastral, filiação, óbito, idade, gênero e atributos disponíveis.", "callingAlias": "SERVICE_PERSON_DATA_ENRICHMENT", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PERSON_DATA_ENRICHMENT", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_POLITICAL_INVOLVEMENT", "documentedAlias": "SERVICE_POLITICAL_INVOLVEMENT", "name": "Envolvimento político", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_POLITICAL_INVOLVEMENT\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_POLITICAL_INVOLVEMENT", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Envolvimento político", "searchTerms": [ "Envolvimento político", "PF - Envolvimento político", "SERVICE_POLITICAL_INVOLVEMENT" ], "responseSummary": "Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.", "callingAlias": "SERVICE_POLITICAL_INVOLVEMENT", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_POLITICAL_INVOLVEMENT", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_POLITICAL_INVOLVEMENT_CPF", "documentedAlias": "SERVICE_POLITICAL_INVOLVEMENT_CPF", "name": "Envolvimento político PF", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_POLITICAL_INVOLVEMENT_CPF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_POLITICAL_INVOLVEMENT_CPF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Envolvimento político PF", "searchTerms": [ "CPF Receita Federal", "Envolvimento político PF", "PF - Envolvimento político PF", "SERVICE_POLITICAL_INVOLVEMENT_CPF" ], "responseSummary": "Retorna envolvimento político do CPF, incluindo candidaturas, cargos, doações, prestações de serviço, partidos e vínculos políticos.", "callingAlias": "SERVICE_POLITICAL_INVOLVEMENT_CPF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_POLITICAL_INVOLVEMENT_CPF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF", "documentedAlias": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF", "name": "Exposição e perfil na mídia", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_MEDIA_PROFILE_EXPOSURE_PF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_MEDIA_PROFILE_EXPOSURE_PF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Exposição e perfil na mídia", "searchTerms": [ "Exposição e perfil na mídia", "PF - Exposição e perfil na mídia", "SERVICE_MEDIA_PROFILE_EXPOSURE_PF" ], "responseSummary": "Retorna exposição e perfil de mídia da pessoa, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.", "callingAlias": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_FACE_MATCH", "documentedAlias": "SERVICE_FACE_MATCH", "name": "FaceMatch", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "image1", "image2" ], "requestExample": "service: SERVICE_FACE_MATCH\nimage1: base64\nimage2: base64", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FACE_MATCH", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - FaceMatch", "searchTerms": [ "FaceMatch", "PF - FaceMatch", "SERVICE_FACE_MATCH", "comparação facial biometria selfie rosto" ], "responseSummary": "Retorna comparacao facial entre duas imagens, com score de similaridade, status do match e mensagem de aprovacao ou reprovacao.", "callingAlias": "SERVICE_FACE_MATCH", "services": [], "requiredFields": [ "image1", "image2" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_FACE_MATCH", "image1": "base64", "image2": "base64" }, "successResponseExample": { "result": { "message": "Retorna comparacao facial entre duas imagens, com score de similaridade, status do match e mensagem de aprovacao ou reprovacao." }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 400, "message": "Face nao encontrada na base", "cause": "Selfie nao teve correspondencia na base de faces ou nao foi possivel detectar rosto.", "action": "Usar selfie real, frontal e nítida. Não usar foto de documento." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "llms-api-reference.txt" ], "useCurlExample": false, "needsImage": true, "needsRealDocument": false, "needsSelfie": true, "needsCpf": false, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Use selfie real, frontal e nítida. Não use foto de RG, CNH ou print de documento.", "Face Index busca correspondência na base de faces; isso não é validação definitiva de identidade.", "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "face", "imagem", "risco-credito" ] }, { "service": "SERVICE_QUOD_CREDIT_RISK_PERSON", "documentedAlias": "SERVICE_QUOD_CREDIT_RISK_PERSON", "name": "Flags Negativos", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_QUOD_CREDIT_RISK_PERSON\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_QUOD_CREDIT_RISK_PERSON", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Flags Negativos", "searchTerms": [ "Flags Negativos", "PF - Flags Negativos", "SERVICE_QUOD_CREDIT_RISK_PERSON" ], "responseSummary": "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.", "callingAlias": "SERVICE_QUOD_CREDIT_RISK_PERSON", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_QUOD_CREDIT_RISK_PERSON", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cpf", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_EMAILS_EXTENDED", "documentedAlias": "SERVICE_EMAILS_EXTENDED", "name": "Histórico de e-mails", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "limit" ], "requestExample": "service: SERVICE_EMAILS_EXTENDED\ncpf: cpf\nlimit: 10", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_EMAILS_EXTENDED", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Histórico de e-mails", "searchTerms": [ "Histórico de e-mails", "PF - Histórico de e-mails", "SERVICE_EMAILS_EXTENDED", "email validação contato" ], "responseSummary": "Retorna e-mails associados ao CPF, incluindo prioridade, status de validação, origem, data de atualização e sinais de uso quando disponíveis.", "callingAlias": "SERVICE_EMAILS_EXTENDED", "services": [], "requiredFields": [ "cpf", "limit" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_EMAILS_EXTENDED", "cpf": "cpf", "limit": "10" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "contato", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_PHONE_HISTORY", "documentedAlias": "SERVICE_PHONE_HISTORY", "name": "Histórico de telefones", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "birthDate", "limit" ], "requestExample": "service: SERVICE_PHONE_HISTORY\ncpf: cpf\nbirthDate: yyyy-MM-dd (opcional)\nlimit: 10", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PHONE_HISTORY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Histórico de telefones", "searchTerms": [ "Histórico de telefones", "PF - Histórico de telefones", "SERVICE_PHONE_HISTORY", "telefone celular validação contato" ], "responseSummary": "Retorna histórico de telefones associados ao CPF, incluindo número, tipo de linha, operadora, prioridade, status e recência quando disponíveis.", "callingAlias": "SERVICE_PHONE_HISTORY", "services": [], "requiredFields": [ "cpf", "limit" ], "optionalFields": [ "birthDate" ], "payloadExample": { "service": "SERVICE_PHONE_HISTORY", "cpf": "cpf", "birthDate": "yyyy-MM-dd (opcional)", "limit": "10" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "contato", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF", "documentedAlias": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF", "name": "Histórico familiar político", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_FAMILY_POLITICAL_HISTORY_CPF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FAMILY_POLITICAL_HISTORY_CPF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Histórico familiar político", "searchTerms": [ "CPF Receita Federal", "Histórico familiar político", "PF - Histórico familiar político", "SERVICE_FAMILY_POLITICAL_HISTORY_CPF" ], "responseSummary": "Retorna histórico político familiar do CPF, incluindo familiares com candidaturas, doações, cargos, partidos e vínculos eleitorais quando encontrados.", "callingAlias": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_PROFESSIONAL_HISTORY", "documentedAlias": "SERVICE_PROFESSIONAL_HISTORY", "name": "Histórico profissional", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_PROFESSIONAL_HISTORY\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PROFESSIONAL_HISTORY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Histórico profissional", "searchTerms": [ "Histórico profissional", "PF - Histórico profissional", "SERVICE_PROFESSIONAL_HISTORY" ], "responseSummary": "Retorna histórico profissional do CPF, incluindo empresas, cargos, datas, vínculos empregaticios ou societários e indicadores profissionais.", "callingAlias": "SERVICE_PROFESSIONAL_HISTORY", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PROFESSIONAL_HISTORY", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY", "documentedAlias": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY", "name": "Histórico profissional do titular", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "birthDate" ], "requestExample": "service: SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY\ncpf: cpf\nbirthDate: yyyy-MM-dd (opcional)", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Histórico profissional do titular", "searchTerms": [ "Histórico profissional do titular", "PF - Histórico profissional do titular", "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY" ], "responseSummary": "Retorna histórico profissional em que a pessoa aparece como titular, sócio ou proprietario, com empresas, cargos e datas de vinculo.", "callingAlias": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [ "birthDate" ], "payloadExample": { "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY", "cpf": "cpf", "birthDate": "yyyy-MM-dd (opcional)" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_ACTIVITIES_INDICATORS", "documentedAlias": "SERVICE_ACTIVITIES_INDICATORS", "name": "Indicadores de atividades", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_ACTIVITIES_INDICATORS\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ACTIVITIES_INDICATORS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Indicadores de atividades", "searchTerms": [ "Indicadores de atividades", "PF - Indicadores de atividades", "SERVICE_ACTIVITIES_INDICATORS" ], "responseSummary": "Retorna indicadores de atividades vinculadas ao CPF, como sinais profissionais, segmentos, ocupacoes e registros disponíveis.", "callingAlias": "SERVICE_ACTIVITIES_INDICATORS", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ACTIVITIES_INDICATORS", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_FINANCIAL_INFORMATION", "documentedAlias": "SERVICE_FINANCIAL_INFORMATION", "name": "Informações financeiras", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_FINANCIAL_INFORMATION\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FINANCIAL_INFORMATION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Informações financeiras", "searchTerms": [ "Informações financeiras", "PF - Informações financeiras", "SERVICE_FINANCIAL_INFORMATION" ], "responseSummary": "Retorna informações financeiras estimadas do CPF, como renda presumida, poder aquisitivo, classe econômica e indicadores financeiros disponíveis.", "callingAlias": "SERVICE_FINANCIAL_INFORMATION", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_FINANCIAL_INFORMATION", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_PERSON_KYC", "documentedAlias": "SERVICE_PERSON_KYC", "name": "KYC e compliance", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "birthDate" ], "requestExample": "service: SERVICE_PERSON_KYC\ncpf: cpf\nbirthDate: yyyy-MM-dd (opcional)", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PERSON_KYC", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - KYC e compliance", "searchTerms": [ "KYC e compliance", "PF - KYC e compliance", "SERVICE_PERSON_KYC", "compliance KYC sanções PEP mídia" ], "responseSummary": "Retorna checagem de KYC da pessoa, incluindo PEP, sanções, mídia, processos, alertas de compliance e sinais de risco.", "callingAlias": "SERVICE_PERSON_KYC", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [ "birthDate" ], "payloadExample": { "service": "SERVICE_PERSON_KYC", "cpf": "cpf", "birthDate": "yyyy-MM-dd (opcional)" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "compliance", "cpf", "juridico", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_ARREST_WARRANT", "documentedAlias": "SERVICE_ARREST_WARRANT", "name": "Mandado de prisão", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "nome", "motherName", "fatherName", "birthDate", "cpf" ], "requestExample": "service: SERVICE_ARREST_WARRANT\nnome: nome\nmotherName: nome da mãe\nfatherName: nome do pai\nbirthDate: dd/MM/yyyy\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ARREST_WARRANT", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Mandado de prisão", "searchTerms": [ "Mandado de prisão", "PF - Mandado de prisão", "SERVICE_ARREST_WARRANT" ], "responseSummary": "Retorna indicativos de mandado de prisão para os dados informados, com situação, órgão, processo e detalhes encontrados quando houver ocorrência.", "callingAlias": "SERVICE_ARREST_WARRANT", "services": [], "requiredFields": [ "nome", "motherName", "fatherName", "birthDate", "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ARREST_WARRANT", "nome": "nome", "motherName": "nome da mãe", "fatherName": "nome do pai", "birthDate": "dd/MM/yyyy", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_PERSON_DATA_MODELING", "documentedAlias": "SERVICE_PERSON_DATA_MODELING", "name": "Modelagem de dados", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_PERSON_DATA_MODELING\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PERSON_DATA_MODELING", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Modelagem de dados", "searchTerms": [ "Modelagem de dados", "PF - Modelagem de dados", "SERVICE_PERSON_DATA_MODELING" ], "responseSummary": "Retorna modelagem consolidada da pessoa, reunindo dados cadastrais, contatos, endereços, vínculos, indicadores e resumos derivados.", "callingAlias": "SERVICE_PERSON_DATA_MODELING", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PERSON_DATA_MODELING", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "comprovante-endereco", "contato", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_OCR_PROOF_OF_ADDRESS", "documentedAlias": "SERVICE_OCR_PROOF_OF_ADDRESS", "name": "OCR de comprovante de endereço", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "image1" ], "requestExample": "service: SERVICE_OCR_PROOF_OF_ADDRESS\nimage1: base64", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_OCR_PROOF_OF_ADDRESS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - OCR de comprovante de endereço", "searchTerms": [ "OCR de comprovante de endereço", "OCR documento imagem base64 leitura extração", "PF - OCR de comprovante de endereço", "SERVICE_OCR_PROOF_OF_ADDRESS", "comprovante de endereço conta fatura endereço" ], "responseSummary": "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.", "callingAlias": "SERVICE_OCR_PROOF_OF_ADDRESS", "services": [], "requiredFields": [ "image1" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_OCR_PROOF_OF_ADDRESS", "image1": "base64" }, "successResponseExample": { "result": { "docType": "COMPROVANTE_ENDERECO", "fullAddress": "Endereço extraído do comprovante", "genericOcr": "texto extraído do comprovante" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 400, "message": "Não foi possível ler o documento", "cause": "Imagem ilegível, documento errado ou campo principal não encontrado no OCR.", "action": "Testar imagem nítida, documento correto e payload mínimo indicado na documentação." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-ocr-proof-of-address.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": true, "needsSelfie": false, "needsCpf": false, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Use imagem real e legível do documento. Base64 deve ser puro, sem prefixo data:image.", "Se o OCR não extrair um campo, explique que o retorno depende da leitura da imagem e não invente valor." ] }, "tags": [ "comprovante-endereco", "imagem", "ocr" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-ocr-proof-of-address.hml.curl" }, { "service": "SERVICE_OCR_EMANCIPATION", "documentedAlias": "SERVICE_OCR_EMANCIPATION", "name": "OCR de emancipação", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "image1" ], "requestExample": "service: SERVICE_OCR_EMANCIPATION\nimage1: base64", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_OCR_EMANCIPATION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - OCR de emancipação", "searchTerms": [ "OCR de emancipação", "OCR documento imagem base64 leitura extração", "PF - OCR de emancipação", "SERVICE_OCR_EMANCIPATION", "documento emancipação cartório certidão declaração" ], "responseSummary": "Retorna texto OCR do documento de emancipacao e dados objetivos extraídos quando existirem, sem reprovar pela ausencia de campos variaveis.", "callingAlias": "SERVICE_OCR_EMANCIPATION", "services": [], "requiredFields": [ "image1" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_OCR_EMANCIPATION", "image1": "base64" }, "successResponseExample": { "result": { "docType": "EMANCIPATION_DOCUMENT", "genericOcr": "texto extraído do documento" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 400, "message": "Não foi possível ler o documento", "cause": "Imagem ilegível, documento errado ou campo principal não encontrado no OCR.", "action": "Testar imagem nítida, documento correto e payload mínimo indicado na documentação." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "llms-api-reference.txt" ], "useCurlExample": false, "needsImage": true, "needsRealDocument": true, "needsSelfie": false, "needsCpf": false, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Use imagem real e legível do documento. Base64 deve ser puro, sem prefixo data:image.", "Se o OCR não extrair um campo, explique que o retorno depende da leitura da imagem e não invente valor." ] }, "tags": [ "imagem", "ocr" ] }, { "service": "SERVICE_OCR", "documentedAlias": "SERVICE_OCR", "name": "OCR React", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "documentType", "image1", "image2" ], "requestExample": "service: SERVICE_OCR\ndocumentType: IDENTIFICATION_DOCUMENT\nimage1: base64\nimage2: base64 (opcional)", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_OCR", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - OCR React", "searchTerms": [ "OCR React", "OCR documento imagem base64 leitura extração", "PF - OCR React", "SERVICE_OCR" ], "responseSummary": "Retorna dados extraídos de documentos de identificação enviados por imagem, como RG/CIN, CNH, OAB, RNE/CRNM, passaporte ou identificação automatica.", "callingAlias": "SERVICE_OCR", "services": [], "requiredFields": [ "documentType", "image1" ], "optionalFields": [ "image2" ], "payloadExample": { "service": "SERVICE_OCR", "documentType": "IDENTIFICATION_DOCUMENT", "image1": "base64", "image2": "base64 (opcional)" }, "successResponseExample": { "result": { "docType": "CNH", "cpf": "00000000000", "name": "NOME DO CLIENTE" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 400, "message": "Não foi possível ler o documento", "cause": "Imagem ilegível, documento errado ou campo principal não encontrado no OCR.", "action": "Testar imagem nítida, documento correto e payload mínimo indicado na documentação." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-ocr-cnh.hml.curl", "https://api-docs.idcerberus.com/examples/service-api-ocr-rg.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": true, "needsSelfie": false, "needsCpf": false, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Use imagem real e legível do documento. Base64 deve ser puro, sem prefixo data:image.", "Se o OCR não extrair um campo, explique que o retorno depende da leitura da imagem e não invente valor." ] }, "tags": [ "cnh", "imagem", "ocr", "react", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-ocr-cnh.hml.curl" }, { "service": "SERVICE_PEP", "documentedAlias": "SERVICE_PEP", "name": "Pessoa politicamente exposta", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_PEP\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PEP", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Pessoa politicamente exposta", "searchTerms": [ "PF - Pessoa politicamente exposta", "Pessoa politicamente exposta", "SERVICE_PEP" ], "responseSummary": "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.", "callingAlias": "SERVICE_PEP", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PEP", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_RELATED_PEOPLE", "documentedAlias": "SERVICE_RELATED_PEOPLE", "name": "Pessoas relacionadas", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "birthDate" ], "requestExample": "service: SERVICE_RELATED_PEOPLE\ncpf: cpf\nbirthDate: yyyy-MM-dd (opcional)", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RELATED_PEOPLE", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Pessoas relacionadas", "searchTerms": [ "PF - Pessoas relacionadas", "Pessoas relacionadas", "SERVICE_RELATED_PEOPLE" ], "responseSummary": "Retorna pessoas relacionadas ao CPF, com nome, documento mascarado, tipo de relação, nível de proximidade e origem do vinculo.", "callingAlias": "SERVICE_RELATED_PEOPLE", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [ "birthDate" ], "payloadExample": { "service": "SERVICE_RELATED_PEOPLE", "cpf": "cpf", "birthDate": "yyyy-MM-dd (opcional)" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "imagem" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF", "documentedAlias": "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF", "name": "Prêmios e certificações", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_AWARDS_AND_CERTIFICATIONS_CPF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_AWARDS_AND_CERTIFICATIONS_CPF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Prêmios e certificações", "searchTerms": [ "CPF Receita Federal", "PF - Prêmios e certificações", "Prêmios e certificações", "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF" ], "responseSummary": "Retorna a quantidade e os registros de premios e certificacoes encontrados para o CPF, quando a base consultada possuir dados.", "callingAlias": "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_ELECTORAL_PROVIDERS_CPF", "documentedAlias": "SERVICE_ELECTORAL_PROVIDERS_CPF", "name": "Prestadores de serviço eleitorais", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_ELECTORAL_PROVIDERS_CPF\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ELECTORAL_PROVIDERS_CPF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Prestadores de serviço eleitorais", "searchTerms": [ "CPF Receita Federal", "PF - Prestadores de serviço eleitorais", "Prestadores de serviço eleitorais", "SERVICE_ELECTORAL_PROVIDERS_CPF", "dados eleitorais campanha doações candidato" ], "responseSummary": "Retorna prestações de serviço eleitorais vinculadas ao CPF, com campanha, candidato/partido, valor, ano e natureza do serviço.", "callingAlias": "SERVICE_ELECTORAL_PROVIDERS_CPF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ELECTORAL_PROVIDERS_CPF", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_JURIDICAL_PROCESSES", "documentedAlias": "SERVICE_JURIDICAL_PROCESSES", "name": "Processos jurídicos e administrativos", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_JURIDICAL_PROCESSES\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_JURIDICAL_PROCESSES", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Processos jurídicos e administrativos", "searchTerms": [ "PF - Processos jurídicos e administrativos", "Processos jurídicos e administrativos", "SERVICE_JURIDICAL_PROCESSES", "processos judiciais jurídicos tribunal certidão" ], "responseSummary": "Retorna processos jurídicos e administrativos vinculados ao CPF, com tribunal, classe, assunto, partes, status e datas quando disponíveis.", "callingAlias": "SERVICE_JURIDICAL_PROCESSES", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_JURIDICAL_PROCESSES", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_PERSON_AI_PROMPT", "documentedAlias": "SERVICE_PERSON_AI_PROMPT", "name": "Prompt de IA para pessoa", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_PERSON_AI_PROMPT\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PERSON_AI_PROMPT", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Prompt de IA para pessoa", "searchTerms": [ "PF - Prompt de IA para pessoa", "Prompt de IA para pessoa", "SERVICE_PERSON_AI_PROMPT" ], "responseSummary": "Retorna uma resposta textual consolidada por IA a partir dos dados da pessoa, com resumo, pontos de atenção e leitura operacional.", "callingAlias": "SERVICE_PERSON_AI_PROMPT", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PERSON_AI_PROMPT", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SEVICE_ONLINE_BETTING_PROPENSITY", "documentedAlias": "SEVICE_ONLINE_BETTING_PROPENSITY", "name": "Propensão a apostas online", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SEVICE_ONLINE_BETTING_PROPENSITY\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SEVICE_ONLINE_BETTING_PROPENSITY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Propensão a apostas online", "searchTerms": [ "PF - Propensão a apostas online", "Propensão a apostas online", "SEVICE_ONLINE_BETTING_PROPENSITY", "apostas bets compliance bet" ], "responseSummary": "Retorna propensão do CPF a apostas online, com score, faixa de propensão, indicadores comportamentais e sinais associados quando disponíveis.", "callingAlias": "SEVICE_ONLINE_BETTING_PROPENSITY", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SEVICE_ONLINE_BETTING_PROPENSITY", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "compliance", "cpf", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_ECONOMIC_RELATIONSHIP", "documentedAlias": "SERVICE_ECONOMIC_RELATIONSHIP", "name": "Relacionamentos econômicos", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_ECONOMIC_RELATIONSHIP\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ECONOMIC_RELATIONSHIP", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Relacionamentos econômicos", "searchTerms": [ "PF - Relacionamentos econômicos", "Relacionamentos econômicos", "SERVICE_ECONOMIC_RELATIONSHIP" ], "responseSummary": "Retorna vínculos econômicos associados ao CPF, como empresas relacionadas, participações, relações profissionais e indicadores de relacionamento.", "callingAlias": "economic_relationships", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ECONOMIC_RELATIONSHIP", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT", "documentedAlias": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT", "name": "Resultado da documentoscopia digital", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "key" ], "requestExample": "service: SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT\nkey: de0cd562-5962-40bd-8f94-5a7184ecde0e", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Resultado da documentoscopia digital", "searchTerms": [ "PF - Resultado da documentoscopia digital", "Resultado da documentoscopia digital", "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT", "documentoscopia documento selfie validação" ], "responseSummary": "Retorna o resultado ja processado da documentoscopia pela chave informada, com status, campos extraídos, regras avaliadas e evidencias.", "callingAlias": "SERVICE_DIGITAL_DOCUMENTOSCOPY", "services": [], "requiredFields": [ "key" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT", "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e" }, "successResponseExample": { "result": { "message": "Retorna o resultado ja processado da documentoscopia pela chave informada, com status, campos extraídos, regras avaliadas e evidencias." }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 400, "message": "Face nao encontrada na base", "cause": "Selfie nao teve correspondencia na base de faces ou nao foi possivel detectar rosto.", "action": "Usar selfie real, frontal e nítida. Não usar foto de documento." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "llms-api-reference.txt" ], "useCurlExample": false, "needsImage": true, "needsRealDocument": false, "needsSelfie": true, "needsCpf": false, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Use selfie real, frontal e nítida. Não use foto de RG, CNH ou print de documento.", "Face Index busca correspondência na base de faces; isso não é validação definitiva de identidade." ] }, "tags": [ "face", "imagem" ] }, { "service": "SERVICE_FINANCIAL_RISK_SCORE", "documentedAlias": "SERVICE_FINANCIAL_RISK_SCORE", "name": "Risco financeiro", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "birthDate" ], "requestExample": "service: SERVICE_FINANCIAL_RISK_SCORE\ncpf: cpf\nbirthDate: yyyy-MM-dd (opcional)", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FINANCIAL_RISK_SCORE", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Risco financeiro", "searchTerms": [ "PF - Risco financeiro", "Risco financeiro", "SERVICE_FINANCIAL_RISK_SCORE", "score risco crédito rating inadimplência" ], "responseSummary": "Retorna score de risco financeiro do CPF, faixa de risco, recomendação resumida e fatores que influenciam a avaliação.", "callingAlias": "SERVICE_FINANCIAL_RISK_SCORE", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [ "birthDate" ], "payloadExample": { "service": "SERVICE_FINANCIAL_RISK_SCORE", "cpf": "cpf", "birthDate": "yyyy-MM-dd (opcional)" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cpf", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_DATAVALID_CNH", "documentedAlias": "SERVICE_DATAVALID_CNH", "name": "Score biométrico", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "image1" ], "requestExample": "service: SERVICE_DATAVALID_CNH\ncpf: cpf\nimage1: \"{base64Image}\"", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DATAVALID_CNH", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Score biométrico", "searchTerms": [ "PF - Score biométrico", "SERVICE_DATAVALID_CNH", "Score biométrico", "score risco crédito rating inadimplência" ], "responseSummary": "Retorna validação validação documental da CNH, incluindo score biométrico, similaridade facial, status de validação e campos conferidos.", "callingAlias": "SERVICE_DATAVALID_CNH", "services": [], "requiredFields": [ "cpf", "image1" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_DATAVALID_CNH", "cpf": "cpf", "image1": "{base64Image}" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cnh", "cpf", "imagem", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_CREDIT_SCORE", "documentedAlias": "SERVICE_CREDIT_SCORE", "name": "Score de crédito", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_CREDIT_SCORE\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CREDIT_SCORE", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Score de crédito", "searchTerms": [ "PF - Score de crédito", "SERVICE_CREDIT_SCORE", "Score de crédito", "score risco crédito rating inadimplência" ], "responseSummary": "Retorna score de crédito associado ao CPF, com pontuação, faixa de risco e mensagem da consulta quando disponíveis.", "callingAlias": "SERVICE_CREDIT_SCORE", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CREDIT_SCORE", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000", "score": "000", "riskLevel": "BAIXO" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-credit-score.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cpf", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-credit-score.hml.curl" }, { "service": "SERVICE_QUOD_CREDIT_SCORE_PERSON", "documentedAlias": "SERVICE_QUOD_CREDIT_SCORE_PERSON", "name": "Score de Crédito", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_QUOD_CREDIT_SCORE_PERSON\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_QUOD_CREDIT_SCORE_PERSON", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Score de Crédito", "searchTerms": [ "PF - Score de Crédito", "SERVICE_QUOD_CREDIT_SCORE_PERSON", "Score de Crédito", "score risco crédito rating inadimplência" ], "responseSummary": "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.", "callingAlias": "SERVICE_QUOD_CREDIT_SCORE_PERSON", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_QUOD_CREDIT_SCORE_PERSON", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cpf", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_BOAVISTA_ONE_SCORE_PERSON", "documentedAlias": "SERVICE_BOAVISTA_ONE_SCORE_PERSON", "name": "Score de Crédito Multidados", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_BOAVISTA_ONE_SCORE_PERSON\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_BOAVISTA_ONE_SCORE_PERSON", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Score de Crédito Multidados", "searchTerms": [ "PF - Score de Crédito Multidados", "SERVICE_BOAVISTA_ONE_SCORE_PERSON", "Score de Crédito Multidados", "score risco crédito rating inadimplência" ], "responseSummary": "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.", "callingAlias": "SERVICE_BOAVISTA_ONE_SCORE_PERSON", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_BOAVISTA_ONE_SCORE_PERSON", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cpf", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_DEFAULT_RISK_SCORE", "documentedAlias": "SERVICE_DEFAULT_RISK_SCORE", "name": "Score de inadimplência", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_DEFAULT_RISK_SCORE\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_DEFAULT_RISK_SCORE", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Score de inadimplência", "searchTerms": [ "PF - Score de inadimplência", "SERVICE_DEFAULT_RISK_SCORE", "Score de inadimplência", "score risco crédito rating inadimplência" ], "responseSummary": "Retorna score de risco de inadimplência para CPF, com pontuação, faixa de risco e probabilidade estimada quando disponível.", "callingAlias": "SERVICE_DEFAULT_RISK_SCORE", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_DEFAULT_RISK_SCORE", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cpf", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_FRAUD_RISK_SCORE", "documentedAlias": "SERVICE_FRAUD_RISK_SCORE", "name": "Score de risco de fraude", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "factor" ], "requestExample": "service: SERVICE_FRAUD_RISK_SCORE\ncpf: cpf\nfactor: minRisk or minattrition", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_FRAUD_RISK_SCORE", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Score de risco de fraude", "searchTerms": [ "PF - Score de risco de fraude", "SERVICE_FRAUD_RISK_SCORE", "Score de risco de fraude", "score risco crédito rating inadimplência" ], "responseSummary": "Retorna score de risco de fraude do CPF, fator analisado, nível de risco, score numérico e sinais que suportam a decisão.", "callingAlias": "SERVICE_FRAUD_RISK_SCORE", "services": [], "requiredFields": [ "cpf", "factor" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_FRAUD_RISK_SCORE", "cpf": "cpf", "factor": "minRisk or minattrition" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cpf", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_PUBLIC_SERVANTS", "documentedAlias": "SERVICE_PUBLIC_SERVANTS", "name": "Servidores públicos", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_PUBLIC_SERVANTS\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_PUBLIC_SERVANTS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Servidores públicos", "searchTerms": [ "PF - Servidores públicos", "SERVICE_PUBLIC_SERVANTS", "Servidores públicos" ], "responseSummary": "Retorna registros de servidor publico associados ao CPF, incluindo órgão, cargo, vinculo, remuneracao/faixa e período quando disponíveis.", "callingAlias": "SERVICE_PUBLIC_SERVANTS", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PUBLIC_SERVANTS", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cpf", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_RFB_PF", "documentedAlias": "SERVICE_RFB_PF", "name": "Status do CPF na Receita Federal", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "dataDeNascimento" ], "requestExample": "service: SERVICE_RFB_PF\ncpf: cpf\ndataDeNascimento: yyyy-MM-dd (opcional)", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RFB_PF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Status do CPF na Receita Federal", "searchTerms": [ "CPF Receita Federal", "PF - Status do CPF na Receita Federal", "SERVICE_RFB_PF", "Status do CPF na Receita Federal" ], "responseSummary": "Retorna situação do CPF na Receita Federal, incluindo nome, nascimento, status cadastral, comprovante/protocolo e dados fiscais disponíveis.", "callingAlias": "SERVICE_RFB_PF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [ "dataDeNascimento" ], "payloadExample": { "service": "SERVICE_RFB_PF", "cpf": "cpf", "dataDeNascimento": "yyyy-MM-dd (opcional)" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "comprovante-endereco", "cpf", "imagem" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_RELATED_PEOPLE_PHONES", "documentedAlias": "SERVICE_RELATED_PEOPLE_PHONES", "name": "Telefones de Pessoas Relacionadas", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf" ], "requestExample": "service: SERVICE_RELATED_PEOPLE_PHONES\ncpf: cpf", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_RELATED_PEOPLE_PHONES", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Telefones de Pessoas Relacionadas", "searchTerms": [ "PF - Telefones de Pessoas Relacionadas", "SERVICE_RELATED_PEOPLE_PHONES", "Telefones de Pessoas Relacionadas", "telefone celular validação contato" ], "responseSummary": "Retorna telefones associados a pessoas relacionadas ao CPF informado, com o relacionamento identificado e sinais de uso de cada telefone.", "callingAlias": "SERVICE_RELATED_PEOPLE_PHONES", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_RELATED_PEOPLE_PHONES", "cpf": "cpf" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "contato", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF", "documentedAlias": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF", "name": "TSE - Local de votação", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "birthDate", "motherName" ], "requestExample": "service: SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF\ncpf: cpf\nbirthDate: yyyy-MM-dd (opcional)\nmotherName: nome da mãe (opcional)", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - TSE - Local de votação", "searchTerms": [ "CPF Receita Federal", "PF - TSE - Local de votação", "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF", "TSE - Local de votação" ], "responseSummary": "Retorna local de votação, situação eleitoral e biometria atual da pessoa no TSE, a partir do CPF informado.", "callingAlias": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [ "birthDate", "motherName" ], "payloadExample": { "service": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF", "cpf": "cpf", "birthDate": "yyyy-MM-dd (opcional)", "motherName": "nome da mãe (opcional)" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 400, "message": "Face nao encontrada na base", "cause": "Selfie nao teve correspondencia na base de faces ou nao foi possivel detectar rosto.", "action": "Usar selfie real, frontal e nítida. Não usar foto de documento." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": false, "needsSelfie": true, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Use selfie real, frontal e nítida. Não use foto de RG, CNH ou print de documento.", "Face Index busca correspondência na base de faces; isso não é validação definitiva de identidade." ] }, "tags": [ "cadastral", "cpf", "face" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_CPF_ADDRESS_VALIDATION", "documentedAlias": "SERVICE_CPF_ADDRESS_VALIDATION", "name": "Validação de CPF com endereço", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "zipcode", "numberAddress" ], "requestExample": "service: SERVICE_CPF_ADDRESS_VALIDATION\ncpf: cpf\nzipcode: 00000-000\nnumberAddress: 13", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CPF_ADDRESS_VALIDATION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Validação de CPF com endereço", "searchTerms": [ "CPF Receita Federal", "PF - Validação de CPF com endereço", "SERVICE_CPF_ADDRESS_VALIDATION", "Validação de CPF com endereço" ], "responseSummary": "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.", "callingAlias": "SERVICE_CPF_ADDRESS_VALIDATION", "services": [], "requiredFields": [ "cpf", "zipcode", "numberAddress" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CPF_ADDRESS_VALIDATION", "cpf": "cpf", "zipcode": "00000-000", "numberAddress": "13" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "comprovante-endereco", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_CPF_PHONE_VALIDATION", "documentedAlias": "SERVICE_CPF_PHONE_VALIDATION", "name": "Validação de CPF com telefone", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "phone" ], "requestExample": "service: SERVICE_CPF_PHONE_VALIDATION\ncpf: cpf\nphone: \"11900000000\"", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_CPF_PHONE_VALIDATION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Validação de CPF com telefone", "searchTerms": [ "CPF Receita Federal", "PF - Validação de CPF com telefone", "SERVICE_CPF_PHONE_VALIDATION", "Validação de CPF com telefone", "telefone celular validação contato" ], "responseSummary": "Retorna validação da associação entre CPF e telefone, com status de match, mensagem da consulta e dados retornados na consulta.", "callingAlias": "SERVICE_CPF_PHONE_VALIDATION", "services": [], "requiredFields": [ "cpf", "phone" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CPF_PHONE_VALIDATION", "cpf": "cpf", "phone": "11900000000" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "contato", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_EMAIL_VALIDATION", "documentedAlias": "SERVICE_EMAIL_VALIDATION", "name": "Validação de e-mail", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "email" ], "requestExample": "service: SERVICE_EMAIL_VALIDATION\nemail: email@email.com", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_EMAIL_VALIDATION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Validação de e-mail", "searchTerms": [ "PF - Validação de e-mail", "SERVICE_EMAIL_VALIDATION", "Validação de e-mail", "email validação contato" ], "responseSummary": "Retorna validação do e-mail informado, incluindo formato, existencia provável, domínio, entregabilidade e indicadores de risco.", "callingAlias": "SERVICE_EMAIL_VALIDATION1", "services": [], "requiredFields": [ "email" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_EMAIL_VALIDATION", "email": "email@email.com" }, "successResponseExample": { "result": { "message": "Retorna validação do e-mail informado, incluindo formato, existencia provável, domínio, entregabilidade e indicadores de risco." }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "llms-api-reference.txt" ], "useCurlExample": false, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "contato", "risco-credito" ] }, { "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION", "documentedAlias": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION", "name": "Validação do E-Social", "category": "Pessoa Física", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cpf", "nit" ], "requestExample": "service: SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION\ncpf: cpf\nnit: \"(opcional)\"", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-fisica#SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-fisica", "apiReferenceSection": "PF - Validação do E-Social", "searchTerms": [ "PF - Validação do E-Social", "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION", "Validação do E-Social" ], "responseSummary": "Retorna qualificação cadastral no eSocial, com status de consistencia entre CPF, NIT/PIS e dados cadastrais informados.", "callingAlias": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION", "services": [], "requiredFields": [ "cpf" ], "optionalFields": [ "nit" ], "payloadExample": { "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION", "cpf": "cpf", "nit": "(opcional)" }, "successResponseExample": { "result": { "cpf": "00000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": true, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "beneficios-sociais", "cadastral", "cpf" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cpf.hml.curl" }, { "service": "SERVICE_LABOR_LAWSUITS", "documentedAlias": "SERVICE_LABOR_LAWSUITS", "name": "Ações Trabalhistas", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_LABOR_LAWSUITS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_LABOR_LAWSUITS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Ações Trabalhistas", "searchTerms": [ "Ações Trabalhistas", "PJ - Ações Trabalhistas", "SERVICE_LABOR_LAWSUITS", "processos judiciais jurídicos tribunal certidão" ], "responseSummary": "Retorna certidão on-demand informando se há processos trabalhistas tramitando relacionados à empresa consultada, físicos ou eletrônicos.", "callingAlias": "SERVICE_LABOR_LAWSUITS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_LABOR_LAWSUITS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_SYNDICATE_AGREEMENTS", "documentedAlias": "SERVICE_SYNDICATE_AGREEMENTS", "name": "Acordos Sindicais", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_SYNDICATE_AGREEMENTS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_SYNDICATE_AGREEMENTS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Acordos Sindicais", "searchTerms": [ "Acordos Sindicais", "PJ - Acordos Sindicais", "SERVICE_SYNDICATE_AGREEMENTS" ], "responseSummary": "Retorna os acordos sindicais firmados entre a empresa e os sindicatos que representam seus funcionários, com totais e detalhamento.", "callingAlias": "SERVICE_SYNDICATE_AGREEMENTS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_SYNDICATE_AGREEMENTS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_ONLINE_ADS", "documentedAlias": "SERVICE_ONLINE_ADS", "name": "Anúncios Online", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_ONLINE_ADS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ONLINE_ADS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Anúncios Online", "searchTerms": [ "Anúncios Online", "PJ - Anúncios Online", "SERVICE_ONLINE_ADS" ], "responseSummary": "Retorna anúncios online vinculados à empresa, identificando perfis de vendedor em portais de classificados e marketplaces peer-to-peer por telefone.", "callingAlias": "SERVICE_ONLINE_ADS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ONLINE_ADS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "contato", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_PGMEI", "documentedAlias": "SERVICE_PGMEI", "name": "Arrecadação Simples Nacional - MEI", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_PGMEI\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PGMEI", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Arrecadação Simples Nacional - MEI", "searchTerms": [ "Arrecadação Simples Nacional - MEI", "PJ - Arrecadação Simples Nacional - MEI", "SERVICE_PGMEI" ], "responseSummary": "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.", "callingAlias": "SERVICE_PGMEI", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PGMEI", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "imagem", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_REPUTATIONS_AND_REVIEWS", "documentedAlias": "SERVICE_REPUTATIONS_AND_REVIEWS", "name": "Avaliações e Reputação", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_REPUTATIONS_AND_REVIEWS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_REPUTATIONS_AND_REVIEWS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Avaliações e Reputação", "searchTerms": [ "Avaliações e Reputação", "PJ - Avaliações e Reputação", "SERVICE_REPUTATIONS_AND_REVIEWS" ], "responseSummary": "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.", "callingAlias": "SERVICE_REPUTATIONS_AND_REVIEWS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_REPUTATIONS_AND_REVIEWS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_ULTIMATE_BENEFICIAL_OWNERS", "documentedAlias": "SERVICE_ULTIMATE_BENEFICIAL_OWNERS", "name": "Beneficiários Finais", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_ULTIMATE_BENEFICIAL_OWNERS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ULTIMATE_BENEFICIAL_OWNERS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Beneficiários Finais", "searchTerms": [ "Beneficiários Finais", "PJ - Beneficiários Finais", "SERVICE_ULTIMATE_BENEFICIAL_OWNERS" ], "responseSummary": "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%.", "callingAlias": "SERVICE_ULTIMATE_BENEFICIAL_OWNERS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ULTIMATE_BENEFICIAL_OWNERS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_MERCHANT_CATEGORY_DATA", "documentedAlias": "SERVICE_MERCHANT_CATEGORY_DATA", "name": "Categoria Comercial", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_MERCHANT_CATEGORY_DATA\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_MERCHANT_CATEGORY_DATA", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Categoria Comercial", "searchTerms": [ "Categoria Comercial", "PJ - Categoria Comercial", "SERVICE_MERCHANT_CATEGORY_DATA" ], "responseSummary": "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.", "callingAlias": "SERVICE_MERCHANT_CATEGORY_DATA", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_MERCHANT_CATEGORY_DATA", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY", "documentedAlias": "SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY", "name": "Certidão Negativa CNJ", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Certidão Negativa CNJ", "searchTerms": [ "Certidão Negativa CNJ", "PJ - Certidão Negativa CNJ", "SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY" ], "responseSummary": "Retorna a certidão negativa do CNJ pelo CNPJ informado, cobrindo condenações cíveis por improbidade administrativa e inelegibilidade.", "callingAlias": "SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CNJ_NEGATIVE_CERTIFICATE_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY", "documentedAlias": "SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY", "name": "Certidão Negativa Correcional CGU", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Certidão Negativa Correcional CGU", "searchTerms": [ "Certidão Negativa Correcional CGU", "PJ - Certidão Negativa Correcional CGU", "SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY" ], "responseSummary": "Retorna a certidão negativa correcional da CGU pelo CNPJ informado, cobrindo punições vigentes em CEIS, CNEP e CEPIM.", "callingAlias": "SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CGU_NEGATIVE_CERTIFICATE_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_STATE_DEBT_CERTIFICATE_COMPANY", "documentedAlias": "SERVICE_STATE_DEBT_CERTIFICATE_COMPANY", "name": "Certidão Negativa de Débitos Estaduais", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_STATE_DEBT_CERTIFICATE_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_STATE_DEBT_CERTIFICATE_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Certidão Negativa de Débitos Estaduais", "searchTerms": [ "Certidão Negativa de Débitos Estaduais", "PJ - Certidão Negativa de Débitos Estaduais", "SERVICE_STATE_DEBT_CERTIFICATE_COMPANY", "dívida ativa débito cobrança inadimplência" ], "responseSummary": "Retorna a certidão negativa de débitos estaduais pelo CNPJ informado, disponível para todos os estados.", "callingAlias": "SERVICE_STATE_DEBT_CERTIFICATE_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_STATE_DEBT_CERTIFICATE_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cnpj", "juridico", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_PROTEST_PJ", "documentedAlias": "SERVICE_PROTEST_PJ", "name": "Certidão negativa de protesto", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_PROTEST_PJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PROTEST_PJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Certidão negativa de protesto", "searchTerms": [ "Certidão negativa de protesto", "PJ - Certidão negativa de protesto", "SERVICE_PROTEST_PJ" ], "responseSummary": "Retorna certidão/consulta de protestos para CNPJ, com status, cartórios consultados, protestos, valores e datas.", "callingAlias": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE_PJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PROTEST_PJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_RFB_PJ_ON_DEMAND", "documentedAlias": "SERVICE_RFB_PJ_ON_DEMAND", "name": "CNPJ na Receita Federal on-demand", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_RFB_PJ_ON_DEMAND\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_RFB_PJ_ON_DEMAND", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - CNPJ na Receita Federal on-demand", "searchTerms": [ "CNPJ Receita Federal", "CNPJ na Receita Federal on-demand", "CPF Receita Federal", "PJ - CNPJ na Receita Federal on-demand", "SERVICE_RFB_PJ_ON_DEMAND" ], "responseSummary": "Retorna situação atualizada do CNPJ consultada sob demanda na Receita Federal, com razão social, status cadastral, CNAEs e endereço.", "callingAlias": "SERVICE_RFB_PJ_ON_DEMAND", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_RFB_PJ_ON_DEMAND", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cpf": "00000000000", "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "beneficios-sociais", "cadastral", "cnpj", "comprovante-endereco", "cpf", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_COMPLIANCE_BET_PJ", "documentedAlias": "SERVICE_COMPLIANCE_BET_PJ", "name": "Compliance de casas de apostas", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_COMPLIANCE_BET_PJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPLIANCE_BET_PJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Compliance de casas de apostas", "searchTerms": [ "Compliance de casas de apostas", "PJ - Compliance de casas de apostas", "SERVICE_COMPLIANCE_BET_PJ", "apostas bets compliance bet" ], "responseSummary": "Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas.", "callingAlias": "SERVICE_COMPLIANCE_BET_PJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_COMPLIANCE_BET_PJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "compliance", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_COMPLIANCE_BET", "documentedAlias": "SERVICE_COMPLIANCE_BET", "name": "Compliance de casas de apostas (alias curto)", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_COMPLIANCE_BET\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPLIANCE_BET", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Compliance de casas de apostas (alias curto)", "searchTerms": [ "Compliance de casas de apostas (alias curto)", "PJ - Compliance de casas de apostas (alias curto)", "SERVICE_COMPLIANCE_BET", "apostas bets compliance bet" ], "responseSummary": "Retorna indicadores de exposição da empresa a apostas, bets e compliance regulatório, incluindo sinais de operação, domínio, atividade e alertas.", "callingAlias": "SERVICE_COMPLIANCE_BET", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_COMPLIANCE_BET", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "compliance", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_PCD_COMPANY", "documentedAlias": "SERVICE_PCD_COMPANY", "name": "Cota de PCD", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_PCD_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PCD_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Cota de PCD", "searchTerms": [ "Cota de PCD", "PJ - Cota de PCD", "SERVICE_PCD_COMPANY" ], "responseSummary": "Retorna a certidão de cumprimento da cota legal de contratação de pessoas com deficiência e beneficiários reabilitados, pelo CNPJ informado.", "callingAlias": "SERVICE_PCD_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PCD_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_REGISTRATION_DATA_CNPJ", "documentedAlias": "SERVICE_REGISTRATION_DATA_CNPJ", "name": "Dados cadastrais de CNPJ", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_REGISTRATION_DATA_CNPJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_REGISTRATION_DATA_CNPJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Dados cadastrais de CNPJ", "searchTerms": [ "CNPJ Receita Federal", "Dados cadastrais de CNPJ", "PJ - Dados cadastrais de CNPJ", "SERVICE_REGISTRATION_DATA_CNPJ" ], "responseSummary": "Retorna dados cadastrais do CNPJ, incluindo razão social, nome fantasia, situação, abertura, CNAEs, natureza jurídica e endereço quando disponíveis.", "callingAlias": "SERVICE_REGISTRATION_DATA_CNPJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_REGISTRATION_DATA_CNPJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "beneficios-sociais", "cadastral", "cnpj", "comprovante-endereco", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_INVESTMENT_FUND_DATA", "documentedAlias": "SERVICE_INVESTMENT_FUND_DATA", "name": "Dados de Fundos de Investimento", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_INVESTMENT_FUND_DATA\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_INVESTMENT_FUND_DATA", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Dados de Fundos de Investimento", "searchTerms": [ "Dados de Fundos de Investimento", "PJ - Dados de Fundos de Investimento", "SERVICE_INVESTMENT_FUND_DATA" ], "responseSummary": "Retorna informações cadastrais e operacionais de fundos de investimento associados ao CNPJ, conforme registros da CVM.", "callingAlias": "SERVICE_INVESTMENT_FUND_DATA", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_INVESTMENT_FUND_DATA", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY", "documentedAlias": "SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY", "name": "Dados Restritivos PJ", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Dados Restritivos PJ", "searchTerms": [ "Dados Restritivos PJ", "PJ - Dados Restritivos PJ", "SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY", "score risco crédito rating inadimplência" ], "responseSummary": "Retorna dados restritivos de crédito de pessoa jurídica pelo CNPJ informado, incluindo score, indicativo e quantidade de restrições encontradas.", "callingAlias": "SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_BOAVISTA_CREDIT_SCORE_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cnpj", "juridico", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_DAS_MEI", "documentedAlias": "SERVICE_DAS_MEI", "name": "DAS MEI na Receita", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_DAS_MEI\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_DAS_MEI", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - DAS MEI na Receita", "searchTerms": [ "CPF Receita Federal", "DAS MEI na Receita", "PJ - DAS MEI na Receita", "SERVICE_DAS_MEI" ], "responseSummary": "Retorna informações de DAS MEI e situação fiscal relacionada ao CNPJ, incluindo períodos, pagamentos, pendências e status quando disponíveis.", "callingAlias": "SERVICE_DAS_MEI", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_DAS_MEI", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cpf": "00000000000", "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cnpj", "cpf", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_ACTIVE_DEBT_PJ", "documentedAlias": "SERVICE_ACTIVE_DEBT_PJ", "name": "Débitos ativos", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_ACTIVE_DEBT_PJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ACTIVE_DEBT_PJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Débitos ativos", "searchTerms": [ "Débitos ativos", "PJ - Débitos ativos", "SERVICE_ACTIVE_DEBT_PJ", "dívida ativa débito cobrança inadimplência" ], "responseSummary": "Retorna dívidas ativas vinculadas ao CNPJ, com origem do débito, valores, situação, órgão credor e status da consulta.", "callingAlias": "SERVICE_ACTIVE_DEBT_PJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ACTIVE_DEBT_PJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cnpj", "juridico", "rg", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_PGFN_COMPANY", "documentedAlias": "SERVICE_PGFN_COMPANY", "name": "Débitos com a PGFN", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_PGFN_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PGFN_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Débitos com a PGFN", "searchTerms": [ "Débitos com a PGFN", "PJ - Débitos com a PGFN", "SERVICE_PGFN_COMPANY", "dívida ativa débito cobrança inadimplência" ], "responseSummary": "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.", "callingAlias": "SERVICE_PGFN_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PGFN_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cnpj", "juridico", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_OWNERS_LAWSUITS_DISTRIBUTION", "documentedAlias": "SERVICE_OWNERS_LAWSUITS_DISTRIBUTION", "name": "Distribuição de Processos dos Sócios", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_OWNERS_LAWSUITS_DISTRIBUTION\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_OWNERS_LAWSUITS_DISTRIBUTION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Distribuição de Processos dos Sócios", "searchTerms": [ "Distribuição de Processos dos Sócios", "PJ - Distribuição de Processos dos Sócios", "SERVICE_OWNERS_LAWSUITS_DISTRIBUTION", "processos judiciais jurídicos tribunal certidão" ], "responseSummary": "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.", "callingAlias": "SERVICE_OWNERS_LAWSUITS_DISTRIBUTION", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_OWNERS_LAWSUITS_DISTRIBUTION", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY", "documentedAlias": "SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY", "name": "Distribuição de Processos Judiciais", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Distribuição de Processos Judiciais", "searchTerms": [ "Distribuição de Processos Judiciais", "PJ - Distribuição de Processos Judiciais", "SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY", "processos judiciais jurídicos tribunal certidão" ], "responseSummary": "Retorna dados agregados sobre a distribuição de processos judiciais nos quais a empresa consultada está envolvida, com estatísticas por período.", "callingAlias": "SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_ELECTORAL_DONORS_CNPJ", "documentedAlias": "SERVICE_ELECTORAL_DONORS_CNPJ", "name": "Doações eleitorais", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_ELECTORAL_DONORS_CNPJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ELECTORAL_DONORS_CNPJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Doações eleitorais", "searchTerms": [ "CNPJ Receita Federal", "Doações eleitorais", "PJ - Doações eleitorais", "SERVICE_ELECTORAL_DONORS_CNPJ", "dados eleitorais campanha doações candidato" ], "responseSummary": "Retorna doações eleitorais realizadas pela empresa, com ano, candidato/partido, valor, cargo, UF e detalhes da prestacao de contas.", "callingAlias": "SERVICE_ELECTORAL_DONORS_CNPJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ELECTORAL_DONORS_CNPJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cnpj", "juridico", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ", "documentedAlias": "SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ", "name": "Doações eleitorais dos sócios", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Doações eleitorais dos sócios", "searchTerms": [ "CNPJ Receita Federal", "Doações eleitorais dos sócios", "PJ - Doações eleitorais dos sócios", "SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ", "dados eleitorais campanha doações candidato" ], "responseSummary": "Retorna doações eleitorais feitas pelos sócios da empresa, com sócio relacionado, ano, candidato/partido, valor e detalhes eleitorais.", "callingAlias": "SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_OWNERS_ELECTORAL_DONORS_CNPJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_DOMAINS_CNPJ", "documentedAlias": "SERVICE_DOMAINS_CNPJ", "name": "Domínios CNPJ", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_DOMAINS_CNPJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_DOMAINS_CNPJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Domínios CNPJ", "searchTerms": [ "CNPJ Receita Federal", "Domínios CNPJ", "PJ - Domínios CNPJ", "SERVICE_DOMAINS_CNPJ", "domínios sites presença digital" ], "responseSummary": "Retorna domínios, sites e sinais digitais associados ao CNPJ, incluindo quantidade e registros encontrados quando disponíveis.", "callingAlias": "SERVICE_DOMAINS_CNPJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_DOMAINS_CNPJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cnpj", "dominios", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_ADDRESSES_EXTENDED_CNPJ", "documentedAlias": "SERVICE_ADDRESSES_EXTENDED_CNPJ", "name": "Endereços estendidos", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_ADDRESSES_EXTENDED_CNPJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ADDRESSES_EXTENDED_CNPJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Endereços estendidos", "searchTerms": [ "CNPJ Receita Federal", "Endereços estendidos", "PJ - Endereços estendidos", "SERVICE_ADDRESSES_EXTENDED_CNPJ" ], "responseSummary": "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.", "callingAlias": "SERVICE_ADDRESSES_EXTENDED_CNPJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ADDRESSES_EXTENDED_CNPJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cnpj", "comprovante-endereco", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_CORPORATE_DATA_ENRICHMENT", "documentedAlias": "SERVICE_CORPORATE_DATA_ENRICHMENT", "name": "Enriquecimento de dados", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_CORPORATE_DATA_ENRICHMENT\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CORPORATE_DATA_ENRICHMENT", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Enriquecimento de dados", "searchTerms": [ "CNPJ Receita Federal", "Enriquecimento de dados", "PJ - Enriquecimento de dados", "SERVICE_CORPORATE_DATA_ENRICHMENT" ], "responseSummary": "Retorna cadastro completo da empresa, incluindo razão social, nome fantasia, situação cadastral, CNAEs, natureza jurídica, porte, capital e endereço.", "callingAlias": "SERVICE_CORPORATE_DATA_ENRICHMENT", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CORPORATE_DATA_ENRICHMENT", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "beneficios-sociais", "cadastral", "cnpj", "comprovante-endereco", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_COMPANY_EVOLUTION", "documentedAlias": "SERVICE_COMPANY_EVOLUTION", "name": "Evolução da Empresa", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_COMPANY_EVOLUTION\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPANY_EVOLUTION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Evolução da Empresa", "searchTerms": [ "Evolução da Empresa", "PJ - Evolução da Empresa", "SERVICE_COMPANY_EVOLUTION" ], "responseSummary": "Retorna a evolução temporal de capital, quantidade de funcionários, filiais e sócios da empresa, com tendência de crescimento.", "callingAlias": "SERVICE_COMPANY_EVOLUTION", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_COMPANY_EVOLUTION", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PJ", "documentedAlias": "SERVICE_MEDIA_PROFILE_EXPOSURE_PJ", "name": "Exposição e perfil na mídia dos sócios", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_MEDIA_PROFILE_EXPOSURE_PJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_MEDIA_PROFILE_EXPOSURE_PJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Exposição e perfil na mídia dos sócios", "searchTerms": [ "Exposição e perfil na mídia dos sócios", "PJ - Exposição e perfil na mídia dos sócios", "SERVICE_MEDIA_PROFILE_EXPOSURE_PJ" ], "responseSummary": "Retorna exposição e perfil de mídia da empresa e sócios, com notícias, fontes, categorias, sentimento, relevância e alertas encontrados.", "callingAlias": "SERVICE_MEDIA_PROFILE_EXPOSURE_PJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_FGTS", "documentedAlias": "SERVICE_FGTS", "name": "FGTS", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_FGTS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_FGTS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - FGTS", "searchTerms": [ "FGTS", "PJ - FGTS", "SERVICE_FGTS" ], "responseSummary": "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.", "callingAlias": "SERVICE_FGTS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_FGTS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_QUOD_CREDIT_RISK_COMPANY", "documentedAlias": "SERVICE_QUOD_CREDIT_RISK_COMPANY", "name": "Flags Negativos PJ", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_QUOD_CREDIT_RISK_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_QUOD_CREDIT_RISK_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Flags Negativos PJ", "searchTerms": [ "Flags Negativos PJ", "PJ - Flags Negativos PJ", "SERVICE_QUOD_CREDIT_RISK_COMPANY" ], "responseSummary": "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.", "callingAlias": "SERVICE_QUOD_CREDIT_RISK_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_QUOD_CREDIT_RISK_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cnpj", "juridico", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_ELECTORAL_PROVIDERS_CNPJ", "documentedAlias": "SERVICE_ELECTORAL_PROVIDERS_CNPJ", "name": "Fornecedores eleitorais", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_ELECTORAL_PROVIDERS_CNPJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ELECTORAL_PROVIDERS_CNPJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Fornecedores eleitorais", "searchTerms": [ "CNPJ Receita Federal", "Fornecedores eleitorais", "PJ - Fornecedores eleitorais", "SERVICE_ELECTORAL_PROVIDERS_CNPJ", "dados eleitorais campanha doações candidato" ], "responseSummary": "Retorna prestações de serviço eleitorais vinculadas ao CNPJ, com campanha, candidato/partido, valor, ano e natureza do serviço.", "callingAlias": "SERVICE_ELECTORAL_PROVIDERS_CNPJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ELECTORAL_PROVIDERS_CNPJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_HISTORY_BASIC_DATA", "documentedAlias": "SERVICE_HISTORY_BASIC_DATA", "name": "Histórico de Dados Básicos", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_HISTORY_BASIC_DATA\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_HISTORY_BASIC_DATA", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Histórico de Dados Básicos", "searchTerms": [ "Histórico de Dados Básicos", "PJ - Histórico de Dados Básicos", "SERVICE_HISTORY_BASIC_DATA" ], "responseSummary": "Retorna o histórico de alterações cadastrais básicas do CNPJ: nome, regime tributário, situação cadastral, CNAE e capital social.", "callingAlias": "SERVICE_HISTORY_BASIC_DATA", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_HISTORY_BASIC_DATA", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "beneficios-sociais", "cadastral", "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_OWNERS_INFLUENCE", "documentedAlias": "SERVICE_OWNERS_INFLUENCE", "name": "Influência do Quadro Societário", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_OWNERS_INFLUENCE\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_OWNERS_INFLUENCE", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Influência do Quadro Societário", "searchTerms": [ "Influência do Quadro Societário", "PJ - Influência do Quadro Societário", "SERVICE_OWNERS_INFLUENCE" ], "responseSummary": "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.", "callingAlias": "SERVICE_OWNERS_INFLUENCE", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_OWNERS_INFLUENCE", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_ECONOMIC_GROUP_KYC_COMPANY", "documentedAlias": "SERVICE_ECONOMIC_GROUP_KYC_COMPANY", "name": "KYC e Compliance do Grupo Econômico", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_ECONOMIC_GROUP_KYC_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ECONOMIC_GROUP_KYC_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - KYC e Compliance do Grupo Econômico", "searchTerms": [ "KYC e Compliance do Grupo Econômico", "PJ - KYC e Compliance do Grupo Econômico", "SERVICE_ECONOMIC_GROUP_KYC_COMPANY", "compliance KYC sanções PEP mídia" ], "responseSummary": "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.", "callingAlias": "SERVICE_ECONOMIC_GROUP_KYC_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ECONOMIC_GROUP_KYC_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "compliance", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_EMPLOYEES_KYC", "documentedAlias": "SERVICE_EMPLOYEES_KYC", "name": "KYC e Compliance dos Funcionários", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_EMPLOYEES_KYC\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_EMPLOYEES_KYC", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - KYC e Compliance dos Funcionários", "searchTerms": [ "KYC e Compliance dos Funcionários", "PJ - KYC e Compliance dos Funcionários", "SERVICE_EMPLOYEES_KYC", "compliance KYC sanções PEP mídia" ], "responseSummary": "Retorna indicadores de KYC e compliance regulatório dos funcionários vinculados à empresa, incluindo classificações de PEP e sanções nacionais e internacionais.", "callingAlias": "SERVICE_EMPLOYEES_KYC", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_EMPLOYEES_KYC", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "compliance", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_COMPANY_KYC_OWNERS", "documentedAlias": "SERVICE_COMPANY_KYC_OWNERS", "name": "KYC e compliance dos sócios", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_COMPANY_KYC_OWNERS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPANY_KYC_OWNERS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - KYC e compliance dos sócios", "searchTerms": [ "KYC e compliance dos sócios", "PJ - KYC e compliance dos sócios", "SERVICE_COMPANY_KYC_OWNERS", "compliance KYC sanções PEP sancionado interpol ofac" ], "responseSummary": "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.", "callingAlias": "SERVICE_COMPANY_KYC_OWNERS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_COMPANY_KYC_OWNERS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "compliance", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_MARKETPLACE_DATA", "documentedAlias": "SERVICE_MARKETPLACE_DATA", "name": "Marketplaces", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_MARKETPLACE_DATA\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_MARKETPLACE_DATA", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Marketplaces", "searchTerms": [ "Marketplaces", "PJ - Marketplaces", "SERVICE_MARKETPLACE_DATA" ], "responseSummary": "Retorna a presença da empresa em marketplaces, incluindo lojas operadas, produtos listados, marketplace com mais produtos e melhor avaliação.", "callingAlias": "SERVICE_MARKETPLACE_DATA", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_MARKETPLACE_DATA", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_CIVIL_CONSTRUCTION", "documentedAlias": "SERVICE_CIVIL_CONSTRUCTION", "name": "Obras Civis", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_CIVIL_CONSTRUCTION\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CIVIL_CONSTRUCTION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Obras Civis", "searchTerms": [ "Obras Civis", "PJ - Obras Civis", "SERVICE_CIVIL_CONSTRUCTION" ], "responseSummary": "Retorna obras civis vinculadas ao CNPJ informado, conforme o Cadastro Nacional de Obras (CNO).", "callingAlias": "SERVICE_CIVIL_CONSTRUCTION", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CIVIL_CONSTRUCTION", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_OCR_CNPJ_CARD", "documentedAlias": "SERVICE_OCR_CNPJ_CARD", "name": "OCR de cartão CNPJ", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "image1" ], "requestExample": "service: SERVICE_OCR_CNPJ_CARD\nimage1: base64", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_OCR_CNPJ_CARD", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - OCR de cartão CNPJ", "searchTerms": [ "CNPJ Receita Federal", "OCR cartão CNPJ comprovante inscrição empresa", "OCR de cartão CNPJ", "OCR documento imagem base64 leitura extração", "PJ - OCR de cartão CNPJ", "SERVICE_OCR_CNPJ_CARD" ], "responseSummary": "Retorna dados extraídos do cartão CNPJ enviado por imagem, incluindo CNPJ, tipo do documento e texto OCR quando disponível.", "callingAlias": "SERVICE_OCR_CNPJ_CARD", "services": [], "requiredFields": [ "image1" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_OCR_CNPJ_CARD", "image1": "base64" }, "successResponseExample": { "result": { "cnpj": "00000000000000", "docType": "CNPJ_CARD", "genericOcr": "texto extraído do cartão CNPJ" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 400, "message": "Não foi possível ler o documento", "cause": "Imagem ilegível, documento errado ou campo principal não encontrado no OCR.", "action": "Testar imagem nítida, documento correto e payload mínimo indicado na documentação." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-ocr-cnpj-card.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": true, "needsSelfie": false, "needsCpf": false, "needsCnpj": false, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Use imagem real e legível do documento. Base64 deve ser puro, sem prefixo data:image.", "Se o OCR não extrair um campo, explique que o retorno depende da leitura da imagem e não invente valor." ] }, "tags": [ "cadastral", "cartao-cnpj", "cnpj", "comprovante-endereco", "imagem", "juridico", "ocr" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-ocr-cnpj-card.hml.curl" }, { "service": "SERVICE_SIMPLES_COMPANY", "documentedAlias": "SERVICE_SIMPLES_COMPANY", "name": "Optante pelo Simples Nacional", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_SIMPLES_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_SIMPLES_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Optante pelo Simples Nacional", "searchTerms": [ "Optante pelo Simples Nacional", "PJ - Optante pelo Simples Nacional", "SERVICE_SIMPLES_COMPANY" ], "responseSummary": "Retorna a situação da empresa como optante pelo Simples Nacional e pelo SIMEI, pelo CNPJ informado.", "callingAlias": "SERVICE_SIMPLES_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_SIMPLES_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY", "documentedAlias": "SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY", "name": "Percentual de Participação Societária", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Percentual de Participação Societária", "searchTerms": [ "PJ - Percentual de Participação Societária", "Percentual de Participação Societária", "SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY" ], "responseSummary": "Retorna o percentual de participação societária de cada sócio da empresa pelo CNPJ informado.", "callingAlias": "SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_BOAVISTA_OWNER_PARTICIPATION_DATA_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_JURIDICAL_PROCESSES_PJ", "documentedAlias": "SERVICE_JURIDICAL_PROCESSES_PJ", "name": "Processos jurídicos", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_JURIDICAL_PROCESSES_PJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_JURIDICAL_PROCESSES_PJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Processos jurídicos", "searchTerms": [ "PJ - Processos jurídicos", "Processos jurídicos", "SERVICE_JURIDICAL_PROCESSES_PJ", "processos judiciais jurídicos tribunal certidão" ], "responseSummary": "Retorna processos jurídicos vinculados ao CNPJ, com tribunal, classe, assunto, partes, status, número do processo e datas quando disponíveis.", "callingAlias": "SERVICE_JURIDICAL_PROCESSES_PJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_JURIDICAL_PROCESSES_PJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS", "documentedAlias": "SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS", "name": "Processos jurídicos dos sócios", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Processos jurídicos dos sócios", "searchTerms": [ "PJ - Processos jurídicos dos sócios", "Processos jurídicos dos sócios", "SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS", "processos judiciais jurídicos tribunal certidão" ], "responseSummary": "Retorna processos jurídicos associados aos sócios da empresa, com sócio relacionado, tribunal, classe, assunto, status e datas.", "callingAlias": "SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_PUBLIC_PROJECTS", "documentedAlias": "SERVICE_PUBLIC_PROJECTS", "name": "Projetos Públicos", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_PUBLIC_PROJECTS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PUBLIC_PROJECTS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Projetos Públicos", "searchTerms": [ "PJ - Projetos Públicos", "Projetos Públicos", "SERVICE_PUBLIC_PROJECTS" ], "responseSummary": "Retorna projetos com financiamento de órgãos públicos associados à empresa pelo CNPJ informado, com fonte, modalidade e valores contratado e desembolsado.", "callingAlias": "SERVICE_PUBLIC_PROJECTS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PUBLIC_PROJECTS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico", "rg" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_RF_QSA", "documentedAlias": "SERVICE_RF_QSA", "name": "Receita Federal - QSA", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_RF_QSA\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_RF_QSA", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Receita Federal - QSA", "searchTerms": [ "CPF Receita Federal", "PJ - Receita Federal - QSA", "Receita Federal - QSA", "SERVICE_RF_QSA" ], "responseSummary": "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.", "callingAlias": "SERVICE_RF_QSA", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_RF_QSA", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cpf": "00000000000", "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cnpj", "cpf", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_COMPANY_RELATIONSHIP", "documentedAlias": "SERVICE_COMPANY_RELATIONSHIP", "name": "Relacionamentos da empresa", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_COMPANY_RELATIONSHIP\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPANY_RELATIONSHIP", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Relacionamentos da empresa", "searchTerms": [ "PJ - Relacionamentos da empresa", "Relacionamentos da empresa", "SERVICE_COMPANY_RELATIONSHIP" ], "responseSummary": "Retorna relacionamentos da empresa, como sócios, proprietários, empresas relacionadas, participações e vínculos societários identificados.", "callingAlias": "SERVICE_COMPANY_RELATIONSHIP", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_COMPANY_RELATIONSHIP", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_ECONOMIC_GROUP_RELATIONSHIPS", "documentedAlias": "SERVICE_ECONOMIC_GROUP_RELATIONSHIPS", "name": "Relacionamentos do Grupo Econômico", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_ECONOMIC_GROUP_RELATIONSHIPS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_ECONOMIC_GROUP_RELATIONSHIPS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Relacionamentos do Grupo Econômico", "searchTerms": [ "PJ - Relacionamentos do Grupo Econômico", "Relacionamentos do Grupo Econômico", "SERVICE_ECONOMIC_GROUP_RELATIONSHIPS" ], "responseSummary": "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.", "callingAlias": "SERVICE_ECONOMIC_GROUP_RELATIONSHIPS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_ECONOMIC_GROUP_RELATIONSHIPS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_CREDIT_RISK_COMPANY", "documentedAlias": "SERVICE_CREDIT_RISK_COMPANY", "name": "Risco de crédito", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_CREDIT_RISK_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_CREDIT_RISK_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Risco de crédito", "searchTerms": [ "PJ - Risco de crédito", "Risco de crédito", "SERVICE_CREDIT_RISK_COMPANY", "score risco crédito rating inadimplência" ], "responseSummary": "Retorna dados de risco de crédito PJ, com score, rating, risco esperado e sinais jurídicos quando disponíveis.", "callingAlias": "SERVICE_CREDIT_RISK_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_CREDIT_RISK_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000", "creditRisk": { "score": "000", "rating": "A", "expectedDefault": "0.00", "legalProcess": false } }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-credit-risk-company.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cnpj", "juridico", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-credit-risk-company.hml.curl" }, { "service": "SERVICE_BOAVISTA_ONE_SCORE_COMPANY", "documentedAlias": "SERVICE_BOAVISTA_ONE_SCORE_COMPANY", "name": "Score de Crédito Multidados PJ", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_BOAVISTA_ONE_SCORE_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_BOAVISTA_ONE_SCORE_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Score de Crédito Multidados PJ", "searchTerms": [ "PJ - Score de Crédito Multidados PJ", "SERVICE_BOAVISTA_ONE_SCORE_COMPANY", "Score de Crédito Multidados PJ", "score risco crédito rating inadimplência" ], "responseSummary": "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.", "callingAlias": "SERVICE_BOAVISTA_ONE_SCORE_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_BOAVISTA_ONE_SCORE_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cnpj", "juridico", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_QUOD_CREDIT_SCORE_COMPANY", "documentedAlias": "SERVICE_QUOD_CREDIT_SCORE_COMPANY", "name": "Score de Crédito PJ", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_QUOD_CREDIT_SCORE_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_QUOD_CREDIT_SCORE_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Score de Crédito PJ", "searchTerms": [ "PJ - Score de Crédito PJ", "SERVICE_QUOD_CREDIT_SCORE_COMPANY", "Score de Crédito PJ", "score risco crédito rating inadimplência" ], "responseSummary": "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.", "callingAlias": "SERVICE_QUOD_CREDIT_SCORE_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_QUOD_CREDIT_SCORE_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cnpj", "juridico", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY", "documentedAlias": "SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY", "name": "Score de Crédito Quantum PJ", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Score de Crédito Quantum PJ", "searchTerms": [ "PJ - Score de Crédito Quantum PJ", "SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY", "Score de Crédito Quantum PJ", "score risco crédito rating inadimplência" ], "responseSummary": "Retorna score de crédito Quantum de pessoa jurídica pelo CNPJ informado, com resumo textual e dados estruturados de bureau de crédito.", "callingAlias": "SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_QUANTUM_CUSTOM_SCORE_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [ "Explique score, rating e risco apenas quando esses campos aparecerem no result." ] }, "tags": [ "cnpj", "juridico", "quantum", "risco-credito" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_SINTEGRA_CONSULTATION", "documentedAlias": "SERVICE_SINTEGRA_CONSULTATION", "name": "SINTEGRA", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj", "uf" ], "requestExample": "service: SERVICE_SINTEGRA_CONSULTATION\ncnpj: cnpj\nuf: uf (opcional)", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_SINTEGRA_CONSULTATION", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - SINTEGRA", "searchTerms": [ "PJ - SINTEGRA", "SERVICE_SINTEGRA_CONSULTATION", "SINTEGRA" ], "responseSummary": "Retorna dados do SINTEGRA, incluindo inscrição estadual, UF, situação, regime, atividades, endereço e mensagens da consulta.", "callingAlias": "SERVICE_SINTEGRA_CONSULTATION", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [ "uf" ], "payloadExample": { "service": "SERVICE_SINTEGRA_CONSULTATION", "cnpj": "cnpj", "uf": "uf (opcional)" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "comprovante-endereco", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_FIRST_LEVEL_PARTNER", "documentedAlias": "SERVICE_FIRST_LEVEL_PARTNER", "name": "Sócios de primeiro nível", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_FIRST_LEVEL_PARTNER\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_FIRST_LEVEL_PARTNER", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Sócios de primeiro nível", "searchTerms": [ "PJ - Sócios de primeiro nível", "SERVICE_FIRST_LEVEL_PARTNER", "Sócios de primeiro nível" ], "responseSummary": "Retorna sócios de primeiro nível da empresa, com nome, documento, participação, qualificação e vínculos diretos ao CNPJ.", "callingAlias": "SERVICE_FIRST_LEVEL_PARTNER", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_FIRST_LEVEL_PARTNER", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "imagem", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_COMPANY_RFB_OWNERS", "documentedAlias": "SERVICE_COMPANY_RFB_OWNERS", "name": "Sócios na Receita Federal", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_COMPANY_RFB_OWNERS\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_COMPANY_RFB_OWNERS", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Sócios na Receita Federal", "searchTerms": [ "CPF Receita Federal", "PJ - Sócios na Receita Federal", "SERVICE_COMPANY_RFB_OWNERS", "Sócios na Receita Federal" ], "responseSummary": "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.", "callingAlias": "SERVICE_COMPANY_RFB_OWNERS", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_COMPANY_RFB_OWNERS", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cpf": "00000000000", "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 400, "message": "Imagem obrigatória não encontrada", "cause": "Payload sem `image1`, `image2`, `selfie1`, URL ou `key` esperado pelo service.", "action": "Enviar base64 puro, URL válida ou key existente conforme o guia do service." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": true, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cadastral", "cnpj", "cpf", "imagem", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_RFB_PJ", "documentedAlias": "SERVICE_RFB_PJ", "name": "Status do CNPJ na Receita Federal", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_RFB_PJ\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_RFB_PJ", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Status do CNPJ na Receita Federal", "searchTerms": [ "CNPJ Receita Federal", "CPF Receita Federal", "PJ - Status do CNPJ na Receita Federal", "SERVICE_RFB_PJ", "Status do CNPJ na Receita Federal" ], "responseSummary": "Retorna situação do CNPJ na Receita Federal, incluindo razão social, nome fantasia, situação cadastral, abertura, CNAEs e endereço.", "callingAlias": "SERVICE_RFB_PJ", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_RFB_PJ", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cpf": "00000000000", "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "beneficios-sociais", "cadastral", "cnpj", "comprovante-endereco", "cpf", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" }, { "service": "SERVICE_PHONES_EXTENDED_COMPANY", "documentedAlias": "SERVICE_PHONES_EXTENDED_COMPANY", "name": "Telefones", "category": "Pessoa Jurídica", "documented": true, "endpoint": "POST /api/service-api", "method": "POST", "requiresAuth": true, "environments": { "homologation": "https://backoffice-hml.idcerberus.com", "production": "https://backoffice.idcerberus.com" }, "requestFields": [ "cnpj" ], "requestExample": "service: SERVICE_PHONES_EXTENDED_COMPANY\ncnpj: cnpj", "documentationUrl": "https://api-docs.idcerberus.com/api-reference/services-pessoa-juridica#SERVICE_PHONES_EXTENDED_COMPANY", "guideUrl": "https://api-docs.idcerberus.com/guides/servicos-pessoa-juridica", "apiReferenceSection": "PJ - Telefones", "searchTerms": [ "PJ - Telefones", "SERVICE_PHONES_EXTENDED_COMPANY", "Telefones", "telefone celular validação contato" ], "responseSummary": "Retorna os telefones associados à empresa, com indicadores de validade, prioridade e origem.", "callingAlias": "SERVICE_PHONES_EXTENDED_COMPANY", "services": [], "requiredFields": [ "cnpj" ], "optionalFields": [], "payloadExample": { "service": "SERVICE_PHONES_EXTENDED_COMPANY", "cnpj": "cnpj" }, "successResponseExample": { "result": { "cnpj": "00000000000000" }, "status": { "code": 200, "message": "Consulta realizada com sucesso" }, "onboardingStatus": "APPROVED", "externalId": "{externalId}" }, "commonErrors": [ { "statusCode": 400, "message": "Don't have access to the service", "cause": "Produto sem service ativo/API habilitada ou alias de chamada incorreto.", "action": "Conferir produto, alias configurado e flag de API antes de testar de novo." }, { "statusCode": 500, "message": "Falha ao realizar consulta", "cause": "Falha técnica no processamento ou storage.", "action": "Investigar com `externalId`, horario, ambiente e service chamado." } ], "curlExampleUrls": [ "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" ], "mcpHints": { "bestContext": "llms-api-reference.txt", "readBeforeAnswering": [ "services-catalog.json", "examples/*.curl", "llms-api-reference.txt" ], "useCurlExample": true, "needsImage": false, "needsRealDocument": false, "needsSelfie": false, "needsCpf": false, "needsCnpj": true, "publicResponseField": "result", "avoidFields": [ "fieldsOutput", "required", "enabled", "valid", "callService", "nextStep", "services" ], "doNotDo": [ "Não inventar payload, retorno ou service fora do catálogo.", "Não solicitar token, client, secret, CPF, CNPJ ou imagem real.", "Não chamar HML ou produção; usar apenas a documentação como fonte." ], "notes": [] }, "tags": [ "cnpj", "contato", "juridico" ], "curlExampleUrl": "https://api-docs.idcerberus.com/examples/service-api-cnpj.hml.curl" } ] }