Consultar os dados de um módulo
GET
/api/v3/enrichments/{id}/modules/{module}
Os dados de um módulo concluído, no formato publicado pelo dataset. Os módulos que um enriquecimento roda são os do perfil usado na criação: consulte GET /api/v3/profiles/{id} (ou GET /api/v3/profiles) para ver cada módulo do perfil e o dataset dele. Na raiz do enriquecimento (GET /api/v3/enrichments/{id}), modules lista os módulos deste enriquecimento e o status de cada um. O formato de cada dataset está em Datasets.
Módulo ({module}) |
Pessoa (CPF) | Empresa (CNPJ) | O que traz |
|---|---|---|---|
finance |
1.0, 1.1 | 1.0 | Renda estimada, faixa de patrimônio e histórico de declaração do imposto de renda. |
financeAdvanced |
2.0 | 2.0 | Registro negativo de crédito: dívidas vencidas e protestos. |
lawsuits |
1.0, 2.0, 3.0 | 1.0, 2.0, 3.0 | Processos judiciais do documento, classificados na taxonomia do CNJ, com contadores, indicadores de risco e a lista de processos. |
ownersLawsuits |
— | 1.0 | Processos judiciais dos sócios do quadro societário de um CNPJ. |
profile |
1.0, 2.0 | 1.0, 2.0 | Cadastro base do documento na Receita Federal e os contatos conhecidos (telefones, e-mails e endereços). |
related |
1.0, 1.1, 2.0 | 1.0, 2.0 | Vínculos do documento com pessoas e empresas: parentesco, sociedade, representação e emprego. |
Authorizations
bearerAuth
Token de acesso obtido em POST /api/v1/authentication. Veja Autenticação.
Type
HTTP (bearer)
Responses
Os dados do módulo.
application/json
JSON "dataset": "person-finance-1.0", "finance": { "assets": "string", "assistance": { "active": 0, "amountReceived": 0, "installments": 0, "items": [ { "active": true, "amount": 0, "city": "string", "context": "string", "endDate": "string", "installments": 0, "name": "string", "payments": { "count": 0, "duplicateReferenceDates": 0, "first": 0, "items": [ { "month": "string" } ], "last": 0, "sum": 0, "values": [ { "count": 0, "value": 0 } ] }, "startDate": "string", "state": "string", "totalAmount": 0 } ], "receiving": true, "total": 0 }, "debts": { "consecutiveMonths": 0, "current": true, "firstAt": "string", "last180Days": 0, "last30Days": 0, "last365Days": 0, "last90Days": 0, "lastAt": "string", "maxConsecutiveMonths": 0, "months": 0, "occurrences": 0, "origins": 0 }, "income": { "band": "string", "basis": "string", "monthlyBRL": 0 }, "taxReturns": { "filed": 0, "items": [ { "bank": "string", "filed": true, "status": "string", "updatedAt": "string", "year": "string" } ], "latest": "string", "years": 0 }, "timeline": [ { "amountBrl": 0, "basis": "string", "date": "string", "detail": "string", "event": "string", "precision": "string", "ref": "string", "source": "string" } ] }, "module": "finance"
{
}