Skip to content
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/lens/getResearch
- 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]

Consultar um caso​

GET
/api/v1/lens/{workspaceId}/research/{id}

O caso inteiro: o relato, as contagens de filhos, a raia do quadro e — o que mais importa para quem integra — o andamento das duas rotas assíncronas.

  • documents é o envio dos documentos: o status, o progresso de 0 a 100, o resultado de cada arquivo (saved, read, read_failed ou left_out, com o motivo) e a montagem do caso (documents.assembly), em que a reconciliação transforma as leituras em envolvidos e preenche o relato.
  • analysis é a análise: o status, o código do erro quando falhou e o result, com um campo por dimensão (dimdocumental, dimchronology, …).

Caso sem envio tem documents com a mesma forma, vazia; caso sem análise tem analysis.status vazio e result nulo. Nenhuma lista sai null.

Authorizations​

BearerAuth

Token Bearer JWT obtido em POST /api/v1/authentication. O workspace do token precisa ser o mesmo do caminho.

Type
HTTP (bearer)

Parameters​

Path Parameters

workspaceId*

O workspace dono do caso. Tem de ser o workspace do token.

Type
string
Required
Example"3f1a2b4c-5d6e-4f70-8a91-b2c3d4e5f607"
Format
"uuid"
id*

O id do caso.

Type
string
Required
Example"7d2f8e10-4c3b-4a5d-9e8f-1a2b3c4d5e6f"
Format
"uuid"

Responses​

O caso, com o envio dos documentos e a análise.

application/json
JSON
{
  
"id": "string",
  
"workspaceId": "string",
  
"userId": "string",
  
"domain": "auto",
  
"objective": "sinistro",
  
"reportAddress": "string",
  
"reportText": "string",
  
"doubts": [
  
  
"string"
  
],
  
"status": "CREATED",
  
"incidentType": "colisao",
  
"bot": {
  
  
"additionalProperties": "string"
  
},
  
"kanbanId": "string",
  
"createdAt": "string",
  
"updatedAt": "string",
  
"reportTime": "2026-11-03 23:48",
  
"vehicleCount": 1,
  
"entityCount": 2,
  
"documentCount": 7,
  
"documents": {
  
  
"status": "DONE",
  
  
"total": 7,
  
  
"progress": 100,
  
  
"errorCode": "",
  
  
"results": [
  
  
  
{
  
  
  
  
"index": 0,
  
  
  
  
"fileName": "bo.pdf",
  
  
  
  
"declaredType": "",
  
  
  
  
"type": "BOLETIM_OCORRENCIA",
  
  
  
  
"documentId": "b41c9f27-8d3e-4a16-9c5b-2e7f80a1d3c4",
  
  
  
  
"target": "BOLETIM_OCORRENCIA",
  
  
  
  
"position": "",
  
  
  
  
"outcome": "read",
  
  
  
  
"reason": ""
  
  
  
}
  
  
],
  
  
"assembly": {
  
  
  
"status": "DONE",
  
  
  
"errorCode": "",
  
  
  
"reason": "",
  
  
  
"documents": [
  
  
  
  
{
  
  
  
  
  
"documentId": "string",
  
  
  
  
  
"outcome": "used",
  
  
  
  
  
"reason": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"entities": [
  
  
  
  
{
  
  
  
  
  
"key": "VEHICLE:TST1A23",
  
  
  
  
  
"type": "PERSON",
  
  
  
  
  
"value": "TST1A23",
  
  
  
  
  
"name": "FIAT ARGO DRIVE 1.0",
  
  
  
  
  
"roles": [
  
  
  
  
  
  
"SEGURADO"
  
  
  
  
  
],
  
  
  
  
  
"entityId": "5e9a3c71-2b4d-4e8f-a9c0-6d1b7f2e8a35",
  
  
  
  
  
"outcome": "created",
  
  
  
  
  
"reason": ""
  
  
  
  
}
  
  
  
],
  
  
  
"institutional": 2,
  
  
  
"fields": [
  
  
  
  
[
  
  
  
  
  
"incidentType",
  
  
  
  
  
"reportAddress",
  
  
  
  
  
"reportTime"
  
  
  
  
]
  
  
  
],
  
  
  
"notes": [
  
  
  
  
"string"
  
  
  
]
  
  
}
  
},
  
"analysis": {
  
  
"status": "DONE",
  
  
"errorCode": "",
  
  
"startedAt": "string",
  
  
"finishedAt": "string",
  
  
"result": {
  
  
  
"dimdocumental": {
  
  
  
  
"status": "apurado",
  
  
  
  
"verdict": "atencao",
  
  
  
  
"reason": "",
  
  
  
  
"alerts": [
  
  
  
  
  
{
  
  
  
  
  
  
"code": "DOC_OWNER_MISMATCH",
  
  
  
  
  
  
"level": "atencao",
  
  
  
  
  
  
"entities": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"PERSON:11144477735"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"documents": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"evidence": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"CRLV: MARIA DA SILVA",
  
  
  
  
  
  
  
  
"Apólice: JOÃO DA SILVA"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"message": "O titular do CRLV não é o segurado da apólice."
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"summary": "Os documentos fecham entre si, com uma divergência de titularidade a esclarecer."
  
  
  
},
  
  
  
"dimchronology": {
  
  
  
  
"status": "apurado",
  
  
  
  
"verdict": "atencao",
  
  
  
  
"reason": "",
  
  
  
  
"alerts": [
  
  
  
  
  
{
  
  
  
  
  
  
"code": "DOC_OWNER_MISMATCH",
  
  
  
  
  
  
"level": "atencao",
  
  
  
  
  
  
"entities": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"PERSON:11144477735"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"documents": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"evidence": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"CRLV: MARIA DA SILVA",
  
  
  
  
  
  
  
  
"Apólice: JOÃO DA SILVA"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"message": "O titular do CRLV não é o segurado da apólice."
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"summary": "Os documentos fecham entre si, com uma divergência de titularidade a esclarecer."
  
  
  
},
  
  
  
"dimcoverage": {
  
  
  
  
"status": "apurado",
  
  
  
  
"verdict": "atencao",
  
  
  
  
"reason": "",
  
  
  
  
"alerts": [
  
  
  
  
  
{
  
  
  
  
  
  
"code": "DOC_OWNER_MISMATCH",
  
  
  
  
  
  
"level": "atencao",
  
  
  
  
  
  
"entities": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"PERSON:11144477735"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"documents": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"evidence": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"CRLV: MARIA DA SILVA",
  
  
  
  
  
  
  
  
"Apólice: JOÃO DA SILVA"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"message": "O titular do CRLV não é o segurado da apólice."
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"summary": "Os documentos fecham entre si, com uma divergência de titularidade a esclarecer."
  
  
  
},
  
  
  
"dimpossession": {
  
  
  
  
"status": "apurado",
  
  
  
  
"verdict": "atencao",
  
  
  
  
"reason": "",
  
  
  
  
"alerts": [
  
  
  
  
  
{
  
  
  
  
  
  
"code": "DOC_OWNER_MISMATCH",
  
  
  
  
  
  
"level": "atencao",
  
  
  
  
  
  
"entities": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"PERSON:11144477735"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"documents": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"evidence": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"CRLV: MARIA DA SILVA",
  
  
  
  
  
  
  
  
"Apólice: JOÃO DA SILVA"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"message": "O titular do CRLV não é o segurado da apólice."
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"summary": "Os documentos fecham entre si, com uma divergência de titularidade a esclarecer."
  
  
  
},
  
  
  
"dimimagery": {
  
  
  
  
"status": "apurado",
  
  
  
  
"verdict": "atencao",
  
  
  
  
"reason": "",
  
  
  
  
"alerts": [
  
  
  
  
  
{
  
  
  
  
  
  
"code": "DOC_OWNER_MISMATCH",
  
  
  
  
  
  
"level": "atencao",
  
  
  
  
  
  
"entities": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"PERSON:11144477735"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"documents": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"evidence": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"CRLV: MARIA DA SILVA",
  
  
  
  
  
  
  
  
"Apólice: JOÃO DA SILVA"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"message": "O titular do CRLV não é o segurado da apólice."
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"summary": "Os documentos fecham entre si, com uma divergência de titularidade a esclarecer."
  
  
  
},
  
  
  
"dimterritory": {
  
  
  
  
"status": "apurado",
  
  
  
  
"verdict": "atencao",
  
  
  
  
"reason": "",
  
  
  
  
"alerts": [
  
  
  
  
  
{
  
  
  
  
  
  
"code": "DOC_OWNER_MISMATCH",
  
  
  
  
  
  
"level": "atencao",
  
  
  
  
  
  
"entities": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"PERSON:11144477735"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"documents": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"evidence": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"CRLV: MARIA DA SILVA",
  
  
  
  
  
  
  
  
"Apólice: JOÃO DA SILVA"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"message": "O titular do CRLV não é o segurado da apólice."
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"summary": "Os documentos fecham entre si, com uma divergência de titularidade a esclarecer."
  
  
  
},
  
  
  
"dimeconomic": {
  
  
  
  
"status": "apurado",
  
  
  
  
"verdict": "atencao",
  
  
  
  
"reason": "",
  
  
  
  
"alerts": [
  
  
  
  
  
{
  
  
  
  
  
  
"code": "DOC_OWNER_MISMATCH",
  
  
  
  
  
  
"level": "atencao",
  
  
  
  
  
  
"entities": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"PERSON:11144477735"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"documents": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"evidence": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"CRLV: MARIA DA SILVA",
  
  
  
  
  
  
  
  
"Apólice: JOÃO DA SILVA"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"message": "O titular do CRLV não é o segurado da apólice."
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"summary": "Os documentos fecham entre si, com uma divergência de titularidade a esclarecer."
  
  
  
},
  
  
  
"dimnetwork": {
  
  
  
  
"status": "apurado",
  
  
  
  
"verdict": "atencao",
  
  
  
  
"reason": "",
  
  
  
  
"alerts": [
  
  
  
  
  
{
  
  
  
  
  
  
"code": "DOC_OWNER_MISMATCH",
  
  
  
  
  
  
"level": "atencao",
  
  
  
  
  
  
"entities": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"PERSON:11144477735"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"documents": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"evidence": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"CRLV: MARIA DA SILVA",
  
  
  
  
  
  
  
  
"Apólice: JOÃO DA SILVA"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"message": "O titular do CRLV não é o segurado da apólice."
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"summary": "Os documentos fecham entre si, com uma divergência de titularidade a esclarecer."
  
  
  
},
  
  
  
"dimphysical": {
  
  
  
  
"status": "apurado",
  
  
  
  
"verdict": "atencao",
  
  
  
  
"reason": "",
  
  
  
  
"alerts": [
  
  
  
  
  
{
  
  
  
  
  
  
"code": "DOC_OWNER_MISMATCH",
  
  
  
  
  
  
"level": "atencao",
  
  
  
  
  
  
"entities": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"PERSON:11144477735"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"documents": [
  
  
  
  
  
  
  
"string"
  
  
  
  
  
  
],
  
  
  
  
  
  
"evidence": [
  
  
  
  
  
  
  
[
  
  
  
  
  
  
  
  
"CRLV: MARIA DA SILVA",
  
  
  
  
  
  
  
  
"Apólice: JOÃO DA SILVA"
  
  
  
  
  
  
  
]
  
  
  
  
  
  
],
  
  
  
  
  
  
"message": "O titular do CRLV não é o segurado da apólice."
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"summary": "Os documentos fecham entre si, com uma divergência de titularidade a esclarecer."
  
  
  
}
  
  
}
  
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI