Sinistro

Criar sinistro

POST {{url_ambiente}}v1/claim

Request

{
    "registerNumber":"100000"
    "description":"descricao para o sinistro",
    "policyNumber":"046692022100101710000820",
    "notificationEmail":"email@gmail.com",
    "files":[]
}

💡 Explicando o JSON de request

Field: registerNumber Type: string ❗Campo obrigatório.

Campo usado para definir o susep.

Field: description Type: string ❗Campo obrigatório. ❗Minimo de 20 caracteres.

Campo usado para definir a descrição do sinistro.


Field: policyNumber Type: string ❗Campo obrigatório.

Campo usado para definir o vinculo entre apolice e sinistro.


Field: notificationEmail Type: string ❗Campo obrigatório.

Campo usado para definir o email que recebera uma notificação.


Field: files Type: array<string>

Campo usado para enviar um array de arquivos no formato de base64.


Response

💡 Explicando o JSON de response

Field: protocol Type: string

Numero de protocolo gerado vinculado ao sinistro.


Consultar Sinistro

Endpoint

GET {{url_ambiente}}/v1/{registerNumber}/{policyNumber}

Chamada GET, para consultar o sinistro, passando como route parameter o numero da apolice e susep.

Path Parameters

Name
Type
Description

policyNumber*

Número da apólice

registerNumber*

String

Número Susep

Query Parameters

Name
Type
Description

page

String

Possível passar número da pagina.

protocol

String

Possível passar número do protocolo.



Response

💡 Explicando o JSON de response

Field: list.updatedAt Type: date

Data de atualização do sinistro.


Field: list.createdAt Type: date

Data de criação do sinistro.


Field: list.description Type: string

Descrição do sinistro.


Field: list.protocol Type: string

Protocolo do sinistro.


Field: list.notificationEmail Type: string

Email que recebeu a notificação do sinistro.


Field: list.notificationEmail Type: string

Email que recebeu a notificação do sinistro.


Field: list.files Type: array

Array contendo os arquivos vinculados ao sinistro.


Field: list.files[].url Type: string

Link do arquivo.

Last updated