Listar documentos da apólice

Esse método retorna uma lista paginada com todos os documentos de uma apólice.

POST {{api_url}}/api/v1/list-policies-documents

Headers

Name
Type
Description

Authorization*

String

Código de acesso

Query params

Name
Type
Description

policy

String

Protocolo de identificação da apólice

id

Number

Identificador único da apólice

page

Number

Página a ser buscada

Response Body

Name
Type
Description

totalCount

String

Quantidade total de itens

hasNextPage

Number

Indica se há mais uma página a ser buscada

files.id

Number

Identificador único do documento

files.code_policy

String

Número da apólice

files.effective_date

Date

Início da vigência

files.expiry_date

Date

Final da vigência

Response Examples



{
    "totalCount": 1,
    "hasNextPage": false,
    "files": [
        {
            "id": 282,
            "code_policy": "7700020240103123456789",
            "effective_date": "2024-03-13 02:31",
            "expiry_date": "2024-04-13 02:31"
        }
    ]
}

Last updated