--- url: https://developers.zarv.com/api/id-v3/datasets/person-financeAdvanced-3-0.md description: >- Zarv ID v3: formato do módulo financeAdvanced do dataset person-financeAdvanced-3.0. Registro negativo de crédito de uma pessoa, reunido de mais de uma… --- # financeAdvanced 3.0 · Pessoa Registro negativo de crédito de uma pessoa, reunido de mais de uma fonte numa resposta só: dívidas vencidas, protestos em cartório, cheques devolvidos, cobranças, ações judiciais, falência, documento roubado e a situação do CPF na Receita Federal. | | | | -------- | ----------------------------------------------------------------------------------------- | | Entidade | Pessoa (CPF, `entity: pf`) | | Módulo | `financeAdvanced` | | Versão | `3.0` (mais recente) | | Dataset | `person-financeAdvanced-3.0` | | Execução | Add-on: só roda quando pedido em `options.modules.financeAdvanced` e habilitado no perfil | Este é o formato do corpo de [`GET /api/v3/enrichments/{id}/modules/financeAdvanced`](/api/id-v3/getEnrichmentModule), a rota que a `url` do módulo, na raiz do enriquecimento, aponta. Os campos são publicados como o dataset os entrega: um campo ausente significa que o dado não foi obtido, não que o valor é falso ou zero. Os caminhos abaixo são relativos ao corpo da resposta. ## Envelope | Campo | Tipo | Observação | | ----------------- | -------- | ----------------------------------- | | `dataset` | `string` | sempre `person-financeAdvanced-3.0` | | `module` | `string` | sempre `financeAdvanced` | | `financeAdvanced` | `object` | os dados do módulo (abaixo) | ## Dados ### `overdueDebts` | Campo | Tipo | Observação | | ------------------------------------------------------- | --------------- | ---------- | | `financeAdvanced.overdueDebts.count` | `integer` | | | `financeAdvanced.overdueDebts.countUpperBound` | `integer` | | | `financeAdvanced.overdueDebts.balanceBrl` | `number` | | | `financeAdvanced.overdueDebts.balanceBrlUpperBound` | `number` | | | `financeAdvanced.overdueDebts.firstAt` | `string` | date | | `financeAdvanced.overdueDebts.lastAt` | `string` | date | | `financeAdvanced.overdueDebts.items` | `array` | | | `financeAdvanced.overdueDebts.items[].amountBrl` | `number` | | | `financeAdvanced.overdueDebts.items[].bank` | `string` | | | `financeAdvanced.overdueDebts.items[].bankBranch` | `string` | | | `financeAdvanced.overdueDebts.items[].bankCode` | `string` | | | `financeAdvanced.overdueDebts.items[].checkNumber` | `string` | | | `financeAdvanced.overdueDebts.items[].city` | `string` | | | `financeAdvanced.overdueDebts.items[].contractId` | `string` | | | `financeAdvanced.overdueDebts.items[].court` | `string` | | | `financeAdvanced.overdueDebts.items[].creditor` | `string` | | | `financeAdvanced.overdueDebts.items[].creditorDocument` | `string` | | | `financeAdvanced.overdueDebts.items[].disputed` | `boolean` | | | `financeAdvanced.overdueDebts.items[].distributor` | `string` | | | `financeAdvanced.overdueDebts.items[].dueAt` | `string` | date | | `financeAdvanced.overdueDebts.items[].nature` | `string` | | | `financeAdvanced.overdueDebts.items[].notaryOffice` | `string` | | | `financeAdvanced.overdueDebts.items[].occurredAt` | `string` | date | | `financeAdvanced.overdueDebts.items[].principalDebtor` | `boolean` | | | `financeAdvanced.overdueDebts.items[].recordedAt` | `string` | date | | `financeAdvanced.overdueDebts.items[].returnCode` | `integer` | | | `financeAdvanced.overdueDebts.items[].state` | `string` | | | `financeAdvanced.overdueDebts.truncated` | `boolean` | | ### `protests` | Campo | Tipo | Observação | | --------------------------------------------------- | --------------- | ---------- | | `financeAdvanced.protests.count` | `integer` | | | `financeAdvanced.protests.countUpperBound` | `integer` | | | `financeAdvanced.protests.balanceBrl` | `number` | | | `financeAdvanced.protests.balanceBrlUpperBound` | `number` | | | `financeAdvanced.protests.firstAt` | `string` | date | | `financeAdvanced.protests.lastAt` | `string` | date | | `financeAdvanced.protests.items` | `array` | | | `financeAdvanced.protests.items[].amountBrl` | `number` | | | `financeAdvanced.protests.items[].bank` | `string` | | | `financeAdvanced.protests.items[].bankBranch` | `string` | | | `financeAdvanced.protests.items[].bankCode` | `string` | | | `financeAdvanced.protests.items[].checkNumber` | `string` | | | `financeAdvanced.protests.items[].city` | `string` | | | `financeAdvanced.protests.items[].contractId` | `string` | | | `financeAdvanced.protests.items[].court` | `string` | | | `financeAdvanced.protests.items[].creditor` | `string` | | | `financeAdvanced.protests.items[].creditorDocument` | `string` | | | `financeAdvanced.protests.items[].disputed` | `boolean` | | | `financeAdvanced.protests.items[].distributor` | `string` | | | `financeAdvanced.protests.items[].dueAt` | `string` | date | | `financeAdvanced.protests.items[].nature` | `string` | | | `financeAdvanced.protests.items[].notaryOffice` | `string` | | | `financeAdvanced.protests.items[].occurredAt` | `string` | date | | `financeAdvanced.protests.items[].principalDebtor` | `boolean` | | | `financeAdvanced.protests.items[].recordedAt` | `string` | date | | `financeAdvanced.protests.items[].returnCode` | `integer` | | | `financeAdvanced.protests.items[].state` | `string` | | | `financeAdvanced.protests.truncated` | `boolean` | | ### `badChecks` | Campo | Tipo | Observação | | ---------------------------------------------------- | --------------- | ---------- | | `financeAdvanced.badChecks.count` | `integer` | | | `financeAdvanced.badChecks.countUpperBound` | `integer` | | | `financeAdvanced.badChecks.firstAt` | `string` | date | | `financeAdvanced.badChecks.lastAt` | `string` | date | | `financeAdvanced.badChecks.items` | `array` | | | `financeAdvanced.badChecks.items[].amountBrl` | `number` | | | `financeAdvanced.badChecks.items[].bank` | `string` | | | `financeAdvanced.badChecks.items[].bankBranch` | `string` | | | `financeAdvanced.badChecks.items[].bankCode` | `string` | | | `financeAdvanced.badChecks.items[].checkNumber` | `string` | | | `financeAdvanced.badChecks.items[].city` | `string` | | | `financeAdvanced.badChecks.items[].contractId` | `string` | | | `financeAdvanced.badChecks.items[].court` | `string` | | | `financeAdvanced.badChecks.items[].creditor` | `string` | | | `financeAdvanced.badChecks.items[].creditorDocument` | `string` | | | `financeAdvanced.badChecks.items[].disputed` | `boolean` | | | `financeAdvanced.badChecks.items[].distributor` | `string` | | | `financeAdvanced.badChecks.items[].dueAt` | `string` | date | | `financeAdvanced.badChecks.items[].nature` | `string` | | | `financeAdvanced.badChecks.items[].notaryOffice` | `string` | | | `financeAdvanced.badChecks.items[].occurredAt` | `string` | date | | `financeAdvanced.badChecks.items[].principalDebtor` | `boolean` | | | `financeAdvanced.badChecks.items[].recordedAt` | `string` | date | | `financeAdvanced.badChecks.items[].returnCode` | `integer` | | | `financeAdvanced.badChecks.items[].state` | `string` | | | `financeAdvanced.badChecks.truncated` | `boolean` | | ### `collectionRecords` | Campo | Tipo | Observação | | ------------------------------------------------------------ | --------------- | ---------- | | `financeAdvanced.collectionRecords.count` | `integer` | | | `financeAdvanced.collectionRecords.countUpperBound` | `integer` | | | `financeAdvanced.collectionRecords.balanceBrl` | `number` | | | `financeAdvanced.collectionRecords.balanceBrlUpperBound` | `number` | | | `financeAdvanced.collectionRecords.firstAt` | `string` | date | | `financeAdvanced.collectionRecords.lastAt` | `string` | date | | `financeAdvanced.collectionRecords.items` | `array` | | | `financeAdvanced.collectionRecords.items[].amountBrl` | `number` | | | `financeAdvanced.collectionRecords.items[].bank` | `string` | | | `financeAdvanced.collectionRecords.items[].bankBranch` | `string` | | | `financeAdvanced.collectionRecords.items[].bankCode` | `string` | | | `financeAdvanced.collectionRecords.items[].checkNumber` | `string` | | | `financeAdvanced.collectionRecords.items[].city` | `string` | | | `financeAdvanced.collectionRecords.items[].contractId` | `string` | | | `financeAdvanced.collectionRecords.items[].court` | `string` | | | `financeAdvanced.collectionRecords.items[].creditor` | `string` | | | `financeAdvanced.collectionRecords.items[].creditorDocument` | `string` | | | `financeAdvanced.collectionRecords.items[].disputed` | `boolean` | | | `financeAdvanced.collectionRecords.items[].distributor` | `string` | | | `financeAdvanced.collectionRecords.items[].dueAt` | `string` | date | | `financeAdvanced.collectionRecords.items[].nature` | `string` | | | `financeAdvanced.collectionRecords.items[].notaryOffice` | `string` | | | `financeAdvanced.collectionRecords.items[].occurredAt` | `string` | date | | `financeAdvanced.collectionRecords.items[].principalDebtor` | `boolean` | | | `financeAdvanced.collectionRecords.items[].recordedAt` | `string` | date | | `financeAdvanced.collectionRecords.items[].returnCode` | `integer` | | | `financeAdvanced.collectionRecords.items[].state` | `string` | | | `financeAdvanced.collectionRecords.truncated` | `boolean` | | ### `judgementFilings` | Campo | Tipo | Observação | | ----------------------------------------------------------- | --------------- | ---------- | | `financeAdvanced.judgementFilings.count` | `integer` | | | `financeAdvanced.judgementFilings.countUpperBound` | `integer` | | | `financeAdvanced.judgementFilings.balanceBrl` | `number` | | | `financeAdvanced.judgementFilings.balanceBrlUpperBound` | `number` | | | `financeAdvanced.judgementFilings.firstAt` | `string` | date | | `financeAdvanced.judgementFilings.lastAt` | `string` | date | | `financeAdvanced.judgementFilings.items` | `array` | | | `financeAdvanced.judgementFilings.items[].amountBrl` | `number` | | | `financeAdvanced.judgementFilings.items[].bank` | `string` | | | `financeAdvanced.judgementFilings.items[].bankBranch` | `string` | | | `financeAdvanced.judgementFilings.items[].bankCode` | `string` | | | `financeAdvanced.judgementFilings.items[].checkNumber` | `string` | | | `financeAdvanced.judgementFilings.items[].city` | `string` | | | `financeAdvanced.judgementFilings.items[].contractId` | `string` | | | `financeAdvanced.judgementFilings.items[].court` | `string` | | | `financeAdvanced.judgementFilings.items[].creditor` | `string` | | | `financeAdvanced.judgementFilings.items[].creditorDocument` | `string` | | | `financeAdvanced.judgementFilings.items[].disputed` | `boolean` | | | `financeAdvanced.judgementFilings.items[].distributor` | `string` | | | `financeAdvanced.judgementFilings.items[].dueAt` | `string` | date | | `financeAdvanced.judgementFilings.items[].nature` | `string` | | | `financeAdvanced.judgementFilings.items[].notaryOffice` | `string` | | | `financeAdvanced.judgementFilings.items[].occurredAt` | `string` | date | | `financeAdvanced.judgementFilings.items[].principalDebtor` | `boolean` | | | `financeAdvanced.judgementFilings.items[].recordedAt` | `string` | date | | `financeAdvanced.judgementFilings.items[].returnCode` | `integer` | | | `financeAdvanced.judgementFilings.items[].state` | `string` | | | `financeAdvanced.judgementFilings.truncated` | `boolean` | | ### `bankruptcy` | Campo | Tipo | Observação | | ------------------------------------------------- | --------- | ---------- | | `financeAdvanced.bankruptcy.count` | `integer` | | | `financeAdvanced.bankruptcy.countUpperBound` | `integer` | | | `financeAdvanced.bankruptcy.balanceBrl` | `number` | | | `financeAdvanced.bankruptcy.balanceBrlUpperBound` | `number` | | | `financeAdvanced.bankruptcy.firstAt` | `string` | date | | `financeAdvanced.bankruptcy.lastAt` | `string` | date | ### `stolenDocuments` | Campo | Tipo | Observação | | ------------------------------------------------------ | --------- | ---------- | | `financeAdvanced.stolenDocuments.count` | `integer` | | | `financeAdvanced.stolenDocuments.countUpperBound` | `integer` | | | `financeAdvanced.stolenDocuments.balanceBrl` | `number` | | | `financeAdvanced.stolenDocuments.balanceBrlUpperBound` | `number` | | | `financeAdvanced.stolenDocuments.firstAt` | `string` | date | | `financeAdvanced.stolenDocuments.lastAt` | `string` | date | ### `history` | Campo | Tipo | Observação | | ---------------------------------------- | --------- | ---------- | | `financeAdvanced.history.oldestAt` | `string` | date | | `financeAdvanced.history.daysFromCutoff` | `integer` | | | `financeAdvanced.history.atEdge` | `boolean` | | ### `registration` | Campo | Tipo | Observação | | --------------------------------------- | -------- | ---------- | | `financeAdvanced.registration.status` | `string` | | | `financeAdvanced.registration.statusAt` | `string` | date | ### `timeline` | Campo | Tipo | Observação | | -------------------------------------- | --------------- | ---------- | | `financeAdvanced.timeline` | `array` | | | `financeAdvanced.timeline[].amountBrl` | `number` | | | `financeAdvanced.timeline[].basis` | `string` | | | `financeAdvanced.timeline[].date` | `string` | | | `financeAdvanced.timeline[].detail` | `string` | | | `financeAdvanced.timeline[].event` | `string` | | | `financeAdvanced.timeline[].precision` | `string` | | | `financeAdvanced.timeline[].ref` | `string` | | | `financeAdvanced.timeline[].source` | `string` | |