Developers

Aparência

Vai integrar a API REST da Zarv com ajuda de IA? Copie a instrução que aponta o modelo para esta documentação.
Ver a instrução
Você vai integrar a API REST da Zarv. Use a documentação oficial como fonte da verdade.

- Página desta integração: https://developers.zarv.com/api/id-v3/datasets/person-financeAdvanced-2-0
- Autenticação Bearer JWT e hosts: https://developers.zarv.com/setup
- Índice das APIs: https://developers.zarv.com/api
- Índice da documentação em markdown: https://developers.zarv.com/llms.txt
- Documentação completa em um arquivo: https://developers.zarv.com/llms-full.txt

Os specs OpenAPI publicados são a fonte da verdade para rotas e schemas — use o spec da API que você escolher antes de escrever qualquer request.

Antes de escrever qualquer código, leia a página desta integração. Siga exatamente os nomes de campos, endpoints, callbacks e formatos que estiverem documentados — não invente parâmetros nem endpoints, e não deduza comportamento a partir de outras APIs que você conhece. Se algo de que você precisa não estiver na documentação, diga que não está em vez de supor.

Minha tarefa: [ex.: escolher a API certa e fazer a primeira chamada autenticada]

financeAdvanced 2.0 · Pessoa ​

Registro negativo de credito de uma pessoa: dividas vencidas, protestos em cartorio, cheques devolvidos, acoes e execucoes judiciais e falencia, com a situacao do CPF na Receita Federal.

EntidadePessoa (CPF, entity: pf)
MódulofinanceAdvanced
Versão2.0 (mais recente)
Datasetperson-financeAdvanced-2.0
ExecuçãoAdd-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, 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 ​

CampoTipoObservação
datasetstringsempre person-financeAdvanced-2.0
modulestringsempre financeAdvanced
financeAdvancedobjectos dados do módulo (abaixo)

Dados ​

overdueDebts ​

CampoTipoObservação
financeAdvanced.overdueDebts.countinteger
financeAdvanced.overdueDebts.balanceBrlnumber
financeAdvanced.overdueDebts.firstAtstringdate
financeAdvanced.overdueDebts.lastAtstringdate
financeAdvanced.overdueDebts.itemsarray<object>
financeAdvanced.overdueDebts.items[].amountBrlnumber
financeAdvanced.overdueDebts.items[].citystring
financeAdvanced.overdueDebts.items[].contractIdstring
financeAdvanced.overdueDebts.items[].courtstring
financeAdvanced.overdueDebts.items[].creditorstring
financeAdvanced.overdueDebts.items[].disputedboolean
financeAdvanced.overdueDebts.items[].dueAtstringdate
financeAdvanced.overdueDebts.items[].naturestring
financeAdvanced.overdueDebts.items[].notaryOfficestring
financeAdvanced.overdueDebts.items[].occurredAtstringdate
financeAdvanced.overdueDebts.items[].recordedAtstringdate
financeAdvanced.overdueDebts.items[].statestring
financeAdvanced.overdueDebts.truncatedboolean

protests ​

CampoTipoObservação
financeAdvanced.protests.countinteger
financeAdvanced.protests.balanceBrlnumber
financeAdvanced.protests.firstAtstringdate
financeAdvanced.protests.lastAtstringdate
financeAdvanced.protests.itemsarray<object>
financeAdvanced.protests.items[].amountBrlnumber
financeAdvanced.protests.items[].citystring
financeAdvanced.protests.items[].contractIdstring
financeAdvanced.protests.items[].courtstring
financeAdvanced.protests.items[].creditorstring
financeAdvanced.protests.items[].disputedboolean
financeAdvanced.protests.items[].dueAtstringdate
financeAdvanced.protests.items[].naturestring
financeAdvanced.protests.items[].notaryOfficestring
financeAdvanced.protests.items[].occurredAtstringdate
financeAdvanced.protests.items[].recordedAtstringdate
financeAdvanced.protests.items[].statestring
financeAdvanced.protests.truncatedboolean

badChecks ​

CampoTipoObservação
financeAdvanced.badChecks.countinteger

judgementFilings ​

CampoTipoObservação
financeAdvanced.judgementFilings.countinteger
financeAdvanced.judgementFilings.balanceBrlnumber
financeAdvanced.judgementFilings.firstAtstringdate
financeAdvanced.judgementFilings.lastAtstringdate
financeAdvanced.judgementFilings.itemsarray<object>
financeAdvanced.judgementFilings.items[].amountBrlnumber
financeAdvanced.judgementFilings.items[].citystring
financeAdvanced.judgementFilings.items[].contractIdstring
financeAdvanced.judgementFilings.items[].courtstring
financeAdvanced.judgementFilings.items[].creditorstring
financeAdvanced.judgementFilings.items[].disputedboolean
financeAdvanced.judgementFilings.items[].dueAtstringdate
financeAdvanced.judgementFilings.items[].naturestring
financeAdvanced.judgementFilings.items[].notaryOfficestring
financeAdvanced.judgementFilings.items[].occurredAtstringdate
financeAdvanced.judgementFilings.items[].recordedAtstringdate
financeAdvanced.judgementFilings.items[].statestring
financeAdvanced.judgementFilings.truncatedboolean

bankruptcy ​

CampoTipoObservação
financeAdvanced.bankruptcy.countinteger
financeAdvanced.bankruptcy.balanceBrlnumber
financeAdvanced.bankruptcy.lastAtstringdate

history ​

CampoTipoObservação
financeAdvanced.history.oldestAtstringdate
financeAdvanced.history.daysFromCutoffinteger
financeAdvanced.history.atEdgeboolean

registration ​

CampoTipoObservação
financeAdvanced.registration.statusstring
financeAdvanced.registration.statusAtstringdate

timeline ​

CampoTipoObservação
financeAdvanced.timelinearray<object>
financeAdvanced.timeline[].amountBrlnumber
financeAdvanced.timeline[].basisstring
financeAdvanced.timeline[].datestring
financeAdvanced.timeline[].detailstring
financeAdvanced.timeline[].eventstring
financeAdvanced.timeline[].precisionstring
financeAdvanced.timeline[].refstring
financeAdvanced.timeline[].sourcestring