openapi: 3.0.0
info:
title: API Quote Patrimonial - Open Insurance Brasil
description: |
API de Cotação Patrimonial do Open Insurance Brasil - Fase 3.\
Recebe informações da solicitação de cotação e contratação vindas das instituições iniciadoras.\
Possui um conjunto de endpoints por ramo de produto e um conjunto específico de endpoints para ramos classificados como LEAD OPIN.\
Requer consentimento do cliente para todos os 'endpoints'.
# Orientações
A `Role` do diretório de participantes relacionada à presente API é a `ICS`.\
Para todos os `endpoints` desta API é previsto o envio de um `token` através do header `Authorization`.\
Os dados serão entregues pela iniciadora na seguradora desde que o `consentId` relacionado corresponda a um consentimento válido e com o status `AUTHORISED`.\
Relacionamos a seguir as `permissions` necessárias para o envio de dados em cada `endpoint` da presente API.
## Permissions necessárias para a API Quote Patrimonial
Para cada um dos `paths` desta API, além dos escopos (`scopes`) indicados existem `permissions` que deverão ser observadas:
### `/lead/request`
- permissions:
- POST: **QUOTE_PATRIMONIAL_LEAD_CREATE**
### `/lead/request/{consentId}`
- permissions:
- PATCH: **QUOTE_PATRIMONIAL_LEAD_UPDATE**
### `/home/request/{consentId}/quote-status`
- permissions:
- GET: **QUOTE_PATRIMONIAL_HOME_READ**
### `/home/request`
- permissions:
- POST: **QUOTE_PATRIMONIAL_HOME_CREATE**
### `/home/request/{consentId}`
- permissions:
- PATCH: **QUOTE_PATRIMONIAL_HOME_UPDATE**
### `/condominium/request/{consentId}/quote-status`
- permissions:
- GET: **QUOTE_PATRIMONIAL_CONDOMINIUM_READ**
### `/condominium/request`
- permissions:
- POST: **QUOTE_PATRIMONIAL_CONDOMINIUM_CREATE**
### `/condominium/request/{consentId}`
- permissions:
- PATCH: **QUOTE_PATRIMONIAL_CONDOMINIUM_UPDATE**
### `/business/request/{consentId}/quote-status`
- permissions:
- GET: **QUOTE_PATRIMONIAL_BUSINESS_READ**
### `/business/request`
- permissions:
- POST: **QUOTE_PATRIMONIAL_BUSINESS_CREATE**
### `/business/request/{consentId}`
- permissions:
- PATCH: **QUOTE_PATRIMONIAL_BUSINESS_UPDATE**
### `/diverse-risks/request/{consentId}/quote-status`
- permissions:
- GET: **QUOTE_PATRIMONIAL_DIVERSE_RISKS_READ**
### `/diverse-risks/request`
- permissions:
- POST: **QUOTE_PATRIMONIAL_DIVERSE_RISKS_CREATE**
### `/diverse-risks/request/{consentId}`
- permissions:
- PATCH: **QUOTE_PATRIMONIAL_DIVERSE_RISKS_UPDATE**
## Válidações Semanticas - Entidade não processável - 422
- 1 - `Idempotência:` Valida se há divergência entre chave de idempotência e informações enviadas (ERRO_IDEMPOTENCIA);
- 2 - `Não Informado:` Valida itens não explicitamente informados pelo servidor - (NAO_INFORMADO).
version: 1.11.0
contact:
name: Governança do Open Insurance Brasil
url: 'https://www.gov.br/susep'
servers:
- url: 'https://api.organizacao.com.br/open-insurance/quote-patrimonial/v1'
description: Servidor de Produção
- url: 'https://api.organizacao.com.br/open-insurance/quote-patrimonial/v1'
description: Servidor de Homologação
tags:
- name: PatrimonialLead
description: Iniciação de serviços de seguro Cotação Patrimonial (PatrimonialLead)
- name: PatrimonialHome
description: Iniciação de serviços de seguro Cotação Patrimonial (PatrimonialHome)
- name: PatrimonialCondominium
description: Iniciação de serviços de seguro Cotação Patrimonial (PatrimonialCondominium)
- name: PatrimonialBusiness
description: Iniciação de serviços de seguro Cotação Patrimonial (PatrimonialBusiness)
- name: PatrimonialDiverseRisks
description: Iniciação de serviços de seguro Cotação Patrimonial (PatrimonialDiverseRisks)
paths:
/lead/request:
post:
tags:
- PatrimonialLead
summary: Envia dados de cotação e contratação de PatrimonialLead
description: "Método para criação de solicitação de cotação e contratação de PatrimonialLead"
operationId: "postQuotePatrimonialLead"
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: '#/components/parameters/xIdempotencyKey'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QuoteRequestPatrimonialLead'
responses:
'201':
$ref: '#/components/responses/OKResponseQuoteRequestPatrimonialLead'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntityQuote'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-lead
/lead/request/{consentId}:
patch:
tags:
- PatrimonialLead
summary: Atualiza dados de cotação e contratação de PatrimonialLead identificado por consentId
description: "Método para atualização de solicitação de cotação e contratação de PatrimonialLead"
operationId: "patchQuotePatrimonialLead"
parameters:
- $ref: "#/components/parameters/consentId"
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RevokePatchPayload'
description: Payload para postagem da atualização de proposta de cotação.
required: true
responses:
'200':
$ref: '#/components/responses/200UpdatedQuotePatrimonialLead'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-lead
/home/request:
post:
tags:
- PatrimonialHome
summary: Envia dados de cotação e contratação de PatrimonialHome
description: "Método para criação de solicitação de cotação e contratação de PatrimonialHome"
operationId: "postQuotePatrimonialHome"
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: '#/components/parameters/xIdempotencyKey'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QuoteRequestPatrimonialHome'
responses:
'201':
$ref: '#/components/responses/OKResponseQuoteRequestPatrimonialHome'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntityQuote'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-home
/home/request/{consentId}/quote-status:
get:
tags:
- PatrimonialHome
summary: Obtém os dados de cotação e contratação de PatrimonialHome identificado por consentId
description: "Método para consulta dos dados de solicitação de cotação e contratação de PatrimonialHome"
operationId: "getQuotePatrimonialHome"
parameters:
- $ref: "#/components/parameters/consentId"
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/pageSize"
responses:
'200':
$ref: '#/components/responses/200QuoteStatusPatrimonialHome'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-home
/home/request/{consentId}:
patch:
tags:
- PatrimonialHome
summary: Atualiza dados de cotação e contratação de PatrimonialHome identificado por consentId
description: "Método para atualização de solicitação de cotação e contratação de PatrimonialHome"
operationId: "patchQuotePatrimonialHome"
parameters:
- $ref: "#/components/parameters/consentId"
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchPayload'
description: Payload para postagem da atualização de proposta de cotação.
required: true
responses:
'200':
$ref: '#/components/responses/200UpdatedQuotePatrimonialHome'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-home
/condominium/request:
post:
tags:
- PatrimonialCondominium
summary: Envia dados de cotação e contratação de PatrimonialCondominium
description: "Método para criação de solicitação de cotação e contratação de PatrimonialCondominium"
operationId: "postQuotePatrimonialCondominium"
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: '#/components/parameters/xIdempotencyKey'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QuoteRequestPatrimonialCondominium'
responses:
'201':
$ref: '#/components/responses/OKResponseQuoteRequestPatrimonialCondominium'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntityQuote'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-condominium
/condominium/request/{consentId}/quote-status:
get:
tags:
- PatrimonialCondominium
summary: Obtém os dados de cotação e contratação de PatrimonialCondominium identificado por consentId
description: "Método para consulta dos dados de solicitação de cotação e contratação de PatrimonialCondominium"
operationId: "getQuotePatrimonialCondominium"
parameters:
- $ref: "#/components/parameters/consentId"
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/pageSize"
responses:
'200':
$ref: '#/components/responses/200QuoteStatusPatrimonialCondominium'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-condominium
/condominium/request/{consentId}:
patch:
tags:
- PatrimonialCondominium
summary: Atualiza dados de cotação e contratação de PatrimonialCondominium identificado por consentId
description: "Método para atualização de solicitação de cotação e contratação de PatrimonialCondominium"
operationId: "patchQuotePatrimonialCondominium"
parameters:
- $ref: "#/components/parameters/consentId"
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchPayload'
description: Payload para postagem da atualização de proposta de cotação.
required: true
responses:
'200':
$ref: '#/components/responses/200UpdatedQuotePatrimonialCondominium'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-condominium
/business/request:
post:
tags:
- PatrimonialBusiness
summary: Envia dados de cotação e contratação de PatrimonialBusiness
description: "Método para criação de solicitação de cotação e contratação de PatrimonialBusiness"
operationId: "postQuotePatrimonialBusiness"
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: '#/components/parameters/xIdempotencyKey'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QuoteRequestPatrimonialBusiness'
responses:
'201':
$ref: '#/components/responses/OKResponseQuoteRequestPatrimonialBusiness'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntityQuote'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-business
/business/request/{consentId}/quote-status:
get:
tags:
- PatrimonialBusiness
summary: Obtém os dados de cotação e contratação de PatrimonialBusiness identificado por consentId
description: "Método para consulta dos dados de solicitação de cotação e contratação de PatrimonialBusiness"
operationId: "getQuotePatrimonialBusiness"
parameters:
- $ref: "#/components/parameters/consentId"
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/pageSize"
responses:
'200':
$ref: '#/components/responses/200QuoteStatusPatrimonialBusiness'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-business
/business/request/{consentId}:
patch:
tags:
- PatrimonialBusiness
summary: Atualiza dados de cotação e contratação de PatrimonialBusiness identificado por consentId
description: "Método para atualização de solicitação de cotação e contratação de PatrimonialBusiness"
operationId: "patchQuotePatrimonialBusiness"
parameters:
- $ref: "#/components/parameters/consentId"
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchPayload'
description: Payload para postagem da atualização de proposta de cotação.
required: true
responses:
'200':
$ref: '#/components/responses/200UpdatedQuotePatrimonialBusiness'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-business
/diverse-risks/request:
post:
tags:
- PatrimonialDiverseRisks
summary: Envia dados de cotação e contratação de PatrimonialDiverseRisks
description: "Método para criação de solicitação de cotação e contratação de PatrimonialDiverseRisks"
operationId: "postQuotePatrimonialDiverseRisks"
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: '#/components/parameters/xIdempotencyKey'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/QuoteRequestPatrimonialDiverseRisks'
responses:
'201':
$ref: '#/components/responses/OKResponseQuoteRequestPatrimonialDiverseRisks'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntityQuote'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-diverse-risks
/diverse-risks/request/{consentId}/quote-status:
get:
tags:
- PatrimonialDiverseRisks
summary: Obtém os dados de cotação e contratação de PatrimonialDiverseRisks identificado por consentId
description: "Método para consulta dos dados de solicitação de cotação e contratação de PatrimonialDiverseRisks"
operationId: "getQuotePatrimonialDiverseRisks"
parameters:
- $ref: "#/components/parameters/consentId"
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/pageSize"
responses:
'200':
$ref: '#/components/responses/200QuoteStatusPatrimonialDiverseRisks'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-diverse-risks
/diverse-risks/request/{consentId}:
patch:
tags:
- PatrimonialDiverseRisks
summary: Atualiza dados de cotação e contratação de PatrimonialDiverseRisks identificado por consentId
description: "Método para atualização de solicitação de cotação e contratação de PatrimonialDiverseRisks"
operationId: "patchQuotePatrimonialDiverseRisks"
parameters:
- $ref: "#/components/parameters/consentId"
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/xFapiAuthDate'
- $ref: '#/components/parameters/xFapiCustomerIpAddress'
- $ref: '#/components/parameters/xFapiInteractionId'
- $ref: '#/components/parameters/xCustomerUserAgent'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchPayload'
description: Payload para postagem da atualização de proposta de cotação.
required: true
responses:
'200':
$ref: '#/components/responses/200UpdatedQuotePatrimonialDiverseRisks'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'405':
$ref: '#/components/responses/MethodNotAllowed'
'406':
$ref: '#/components/responses/NotAcceptable'
'422':
$ref: '#/components/responses/UnprocessableEntity'
'429':
$ref: '#/components/responses/TooManyRequests'
'500':
$ref: '#/components/responses/InternalServerError'
default:
description: Erro inesperado.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
security:
- OAuth2Security:
- quote-patrimonial-diverse-risks
components:
schemas:
PolicyDataPatrimonialLead:
$ref: '#/components/schemas/PolicyDataPatrimonial'
PolicyDataPatrimonial: ## schema dados transacionais de fase 2 - atualização pendente
type: array
description: Lista que agrupa os dados das apólices históricos em categorias.
items:
type: object
properties:
policyInfo:
$ref: '#/components/schemas/InsurancePatrimonialPolicyInfo'
premium:
$ref: '#/components/schemas/InsurancePatrimonialPremium'
claim:
$ref: '#/components/schemas/InsurancePatrimonialClaim'
InsurancePatrimonialPolicyInfo:
type: object
description: Objeto que agrupa dados de ápolice.
required:
- documentType
- policyId
- issuanceType
- issuanceDate
- termStartDate
- termEndDate
- maxLMG
- proposalId
- insureds
- insuredObjects
properties:
documentType:
description: Tipo de Documento Emitido
type: string
enum: [APOLICE_INDIVIDUAL,
BILHETE,
CERTIFICADO,
APOLICE_INDIVIDUAL_AUTOMOVEL,
APOLICE_FROTA_AUTOMOVEL,
CERTIFICADO_AUTOMOVEL]
example: APOLICE_INDIVIDUAL
policyId:
description: Identificador da apólice ou bilhete
type: string
maxLength: 60
example: "111111"
susepProcessNumber:
description: Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
type: string
maxLength: 60
groupCertificateId:
description: "Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)"
type: string
maxLength: 60
issuanceType:
description: "Tipo de Emissão"
type: string
enum: [EMISSAO_PROPRIA,
COSSEGURO_ACEITO]
example: EMISSAO_PROPRIA
issuanceDate:
description: Data de emissão do documento
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
termStartDate:
description: Data de início de vigência do documento
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
termEndDate:
description: Data de fim de vigência do documento
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
leadInsurerCode:
description: "Código da seguradora líder para contratos com arranjo de cosseguro"
type: string
maxLength: 1024
leadInsurerPolicyId:
description: "Identificador da apólice seguradora líder para apólice de cosseguro aceito"
type: string
maxLength: 1024
maxLMG:
description: Valor Limite máximo de garantia (LMG)
allOf:
- $ref: '#/components/schemas/AmountDetails'
proposalId:
description: Identificador da Proposta
type: string
maxLength: 60
insureds:
type: array
description: Lista que agrupa os dados dos segurados.
items:
$ref: '#/components/schemas/PersonalInfo'
beneficiaries:
type: array
description: Lista que agrupa os dados dos beneficiários.
items:
$ref: '#/components/schemas/BeneficiaryInfo'
principals:
type: array
description: Lista que agrupa os dados dos tomadores/garantidos.
items:
$ref: '#/components/schemas/PrincipalInfo'
intermediaries:
type: array
description: Lista que agrupa os dados de intermediários.
items:
$ref: '#/components/schemas/Intermediary'
insuredObjects:
type: array
description: Lista que agrupa os dados de objetos segurados.
items:
$ref: '#/components/schemas/InsurancePatrimonialInsuredObject'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/InsurancePatrimonialCoverage'
coinsuranceRetainedPercentage:
description: "Percentual Retido em Cosseguro (Quando há cosseguro)"
type: string
pattern: ^100\.0{1,9}$|^\d{1,2}\.\d{1,9}$
example: '10.00'
coinsurers:
type: array
description: Lista que agrupa os dados dos cosseguros.
items:
$ref: '#/components/schemas/Coinsurer'
branchInfo:
$ref: '#/components/schemas/InsurancePatrimonialSpecificPolicyInfo'
PrincipalInfo:
type: object
required:
- identification
- identificationType
- name
- postCode
- city
- state
- country
- address
properties:
identification:
description: Documento de Identificação do Tomador/Garantidor
type: string
maxLength: 60
example: "12345678900"
identificationType:
description: Tipo de Documento do Tomador/Garantidor
type: string
enum: [
CPF,
CNPJ,
OUTROS
]
example: CPF
identificationTypeOthers:
description: Campo de detalhamento para quando a opcao do tipo de documento do Tomador/Garantidor for OUTROS
type: string
maxLength: 100
example: RNE
name:
description: Nome ou Razão Social do Tomador/Garantidor
type: string
maxLength: 60
example: Nome Sobrenome
postCode:
description: Código Postal do Tomador/Garantidor
type: string
maxLength: 60
example: "10000000"
email:
description: E-mail do Tomador/Garantidor (caso possua)
type: string
pattern: ^\S+@\S+\.\S+$
maxLength: 256
city:
description: Cidade do Tomador/Garantidor (por extenso)
type: string
maxLength: 60
state:
description: Estado do Tomador/Garantidor (por extenso)
type: string
example: AC
enum: ['AC', 'AL', 'AP', 'AM', 'BA', 'CE', 'DF', 'ES', 'GO', 'MA', 'MT', 'MS', 'MG', 'PA', 'PB', 'PR', 'PE', 'PI', 'RJ', 'RN', 'RS', 'RO', 'RR', 'SC', 'SP', 'SE', 'TO', 'BR', 'XX']
country:
description: País do Tomador/Garantidor (de acordo com o código "alpha3" do ISO-3166)
type: string
enum: [AFG,ALA,ALB,DZA,ASM,AND,AGO,AIA,ATA,ATG,ARG,ARM,ABW,AUS,AUT,AZE,BHS,BHR,BGD,BRB,BLR,BEL,BLZ,BEN,BMU,BTN,BOL,BES,BIH,BWA,BVT,BRA,IOT,BRN,BGR,BFA,BDI,CPV,KHM,CMR,CAN,CYM,CAF,TCD,CHL,CHN,CXR,CCK,COL,COM,COG,COD,COK,CRI,CIV,HRV,CUB,CUW,CYP,CZE,DNK,DJI,DMA,DOM,ECU,EGY,SLV,GNQ,ERI,EST,SWZ,ETH,FLK,FRO,FJI,FIN,FRA,GUF,PYF,ATF,GAB,GMB,GEO,DEU,GHA,GIB,GRC,GRL,GRD,GLP,GUM,GTM,GGY,GIN,GNB,GUY,HTI,HMD,VAT,HND,HKG,HUN,ISL,IND,IDN,IRN,IRQ,IRL,IMN,ISR,ITA,JAM,JPN,JEY,JOR,KAZ,KEN,KIR,PRK,KOR,KWT,KGZ,LAO,LVA,LBN,LSO,LBR,LBY,LIE,LTU,LUX,MAC,MDG,MWI,MYS,MDV,MLI,MLT,MHL,MTQ,MRT,MUS,MYT,MEX,FSM,MDA,MCO,MNG,MNE,MSR,MAR,MOZ,MMR,NAM,NRU,NPL,NLD,NCL,NZL,NIC,NER,NGA,NIU,NFK,MKD,MNP,NOR,OMN,PAK,PLW,PSE,PAN,PNG,PRY,PER,PHL,PCN,POL,PRT,PRI,QAT,REU,ROU,RUS,RWA,BLM,SHN,KNA,LCA,MAF,SPM,VCT,WSM,SMR,STP,SAU,SEN,SRB,SYC,SLE,SGP,SXM,SVK,SVN,SLB,SOM,ZAF,SGS,SSD,ESP,LKA,SDN,SUR,SJM,SWE,CHE,SYR,TWN,TJK,TZA,THA,TLS,TGO,TKL,TON,TTO,TUN,TUR,TKM,TCA,TUV,UGA,UKR,ARE,GBR,USA,UMI,URY,UZB,VUT,VEN,VNM,VGB,VIR,WLF,ESH,YEM,ZMB,ZWE]
example: BRA
address:
description: Endereço do Tomador/Garantidor (restante do endereço, excluindo cidade, estado e país)
type: string
maxLength: 60
addressAdditionalInfo:
description: Complemento do endereço do Tomador/Garantidor.
type: string
maxLength: 30
example: Fundos
PersonalInfo:
type: object
required:
- identification
- identificationType
- name
- postCode
- birthDate
- city
- state
- country
- address
properties:
identification:
description: Documento de Identificação do segurado
type: string
maxLength: 60
example: "12345678900"
identificationType:
description: Tipo de Documento do segurado
type: string
enum: [
CPF,
CNPJ,
OUTROS
]
example: CPF
identificationTypeOthers:
description: Campo de detalhamento para quando a opcao do tipo de documento do segurado for OUTROS
type: string
maxLength: 100
example: RNE
name:
description: Nome ou Razão Social do segurado
type: string
maxLength: 60
example: Nome Sobrenome
birthDate:
description: Data de nascimento do segurado
type: string
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '1999-06-12'
postCode:
description: Código Postal do Segurado
type: string
maxLength: 60
example: "10000000"
email:
description: E-mail da segurado (caso possua)
type: string
pattern: ^\S+@\S+\.\S+$
maxLength: 256
city:
description: Cidade o segurado(por extenso)
type: string
maxLength: 60
state:
description: Estado do segurado
type: string
example: AC
enum: ['AC', 'AL', 'AP', 'AM', 'BA', 'CE', 'DF', 'ES', 'GO', 'MA', 'MT', 'MS', 'MG', 'PA', 'PB', 'PR', 'PE', 'PI', 'RJ', 'RN', 'RS', 'RO', 'RR', 'SC', 'SP', 'SE', 'TO', 'BR', 'XX']
country:
description: País do segurado (de acordo com o código "alpha3" do ISO-3166)
type: string
example: BRA
enum: [AFG,ALA,ALB,DZA,ASM,AND,AGO,AIA,ATA,ATG,ARG,ARM,ABW,AUS,AUT,AZE,BHS,BHR,BGD,BRB,BLR,BEL,BLZ,BEN,BMU,BTN,BOL,BES,BIH,BWA,BVT,BRA,IOT,BRN,BGR,BFA,BDI,CPV,KHM,CMR,CAN,CYM,CAF,TCD,CHL,CHN,CXR,CCK,COL,COM,COG,COD,COK,CRI,CIV,HRV,CUB,CUW,CYP,CZE,DNK,DJI,DMA,DOM,ECU,EGY,SLV,GNQ,ERI,EST,SWZ,ETH,FLK,FRO,FJI,FIN,FRA,GUF,PYF,ATF,GAB,GMB,GEO,DEU,GHA,GIB,GRC,GRL,GRD,GLP,GUM,GTM,GGY,GIN,GNB,GUY,HTI,HMD,VAT,HND,HKG,HUN,ISL,IND,IDN,IRN,IRQ,IRL,IMN,ISR,ITA,JAM,JPN,JEY,JOR,KAZ,KEN,KIR,PRK,KOR,KWT,KGZ,LAO,LVA,LBN,LSO,LBR,LBY,LIE,LTU,LUX,MAC,MDG,MWI,MYS,MDV,MLI,MLT,MHL,MTQ,MRT,MUS,MYT,MEX,FSM,MDA,MCO,MNG,MNE,MSR,MAR,MOZ,MMR,NAM,NRU,NPL,NLD,NCL,NZL,NIC,NER,NGA,NIU,NFK,MKD,MNP,NOR,OMN,PAK,PLW,PSE,PAN,PNG,PRY,PER,PHL,PCN,POL,PRT,PRI,QAT,REU,ROU,RUS,RWA,BLM,SHN,KNA,LCA,MAF,SPM,VCT,WSM,SMR,STP,SAU,SEN,SRB,SYC,SLE,SGP,SXM,SVK,SVN,SLB,SOM,ZAF,SGS,SSD,ESP,LKA,SDN,SUR,SJM,SWE,CHE,SYR,TWN,TJK,TZA,THA,TLS,TGO,TKL,TON,TTO,TUN,TUR,TKM,TCA,TUV,UGA,UKR,ARE,GBR,USA,UMI,URY,UZB,VUT,VEN,VNM,VGB,VIR,WLF,ESH,YEM,ZMB,ZWE]
address:
description: Endereço da Pessoa (restante do endereço, excluindo cidade, estado e país)
type: string
maxLength: 60
addressAdditionalInfo:
type: string
maxLength: 100
description: Informações adicionais do endereço do segurado
PersonalQuoteCustomer:
type: object
description: Objeto de informações de pessoa física.
properties:
identification:
$ref: '#/components/schemas/PersonalIdentificationData'
qualification:
$ref: '#/components/schemas/PersonalQualificationData'
complimentaryInfo:
$ref: '#/components/schemas/PersonalComplimentaryInformationData'
BusinessQuoteCustomer:
type: object
description: Objeto de informações de pessoa jurídica.
properties:
identification:
$ref: '#/components/schemas/BusinessIdentificationData'
qualification:
$ref: '#/components/schemas/BusinessQualificationData'
complimentaryInfo:
$ref: '#/components/schemas/BusinessComplimentaryInformationData'
BeneficiaryInfo:
type: object
required:
- identification
- identificationType
- name
properties:
identification:
description: Documento de Identificação do beneficiário
type: string
maxLength: 60
example: "12345678900"
identificationType:
description: Tipo de Documento do beneficiário
type: string
enum: [
CPF,
CNPJ,
OUTROS
]
example: CPF
identificationTypeOthers:
description: Campo de detalhamento para quando a opcao do tipo de documento do beneficiário for OUTROS
type: string
maxLength: 100
example: RNE
name:
description: Nome ou Razão Social do beneficiário
type: string
maxLength: 60
example: Nome Sobrenome
Intermediary:
type: object
required:
- type
- name
properties:
type:
description: Tipo do Intermediador
type: string
enum: [
CORRETOR,
REPRESENTANTE,
ESTIPULANTE_AVERBADOR_INSTITUIDOR,
CORRESPONDENTE,
AGENTE_DE_MICROSSEGUROS,
OUTROS
]
example: REPRESENTANTE
typeOthers:
description: Descricao do Tipo do Intermediador quando for informada a opcao OUTROS
type: string
maxLength: 100
identification:
description: Documento de Identificação do Intermediador(a) (Caso Tipo de Intermediador não seja CORRETOR ou quando for CORRETOR, porém o identificador do intermediador não seja informado)
type: string
maxLength: 60
pattern: ^[a-zA-Z0-9]{1,60}$
example: "12345678900"
brokerId:
description: Identificador do intermediador da apólice - código Susep do corretor(a) (Caso Tipo de Intermediador for CORRETOR)
type: string
pattern: ^\d{9}$
identificationType:
description: Tipo de Documento do Intermediador(a) (Caso Tipo de Intermediador não seja CORRETOR ou quando for CORRETOR, porém o identificador do intermediador não seja informado)
type: string
enum: [
CPF,
CNPJ,
OUTROS
]
example: CPF
identificationTypeOthers:
description: Campo de detalhamento para quando a opcao do tipo de documento do intermediador(a) for OUTROS
type: string
maxLength: 100
example: RNE
name:
description: Nome ou Razão Social da Intermediador
type: string
maxLength: 60
example: Nome Sobrenome
postCode:
description: Código Postal da Intermediador (Caso Tipo de Intermediador for ESTIPULANTE)
type: string
maxLength: 60
example: "10000000"
city:
description: Cidade da Intermediador (por extenso; Caso Tipo de Intermediador for ESTIPULANTE)
type: string
maxLength: 60
state:
description: Estado da Intermediador (por extenso; Caso Tipo de Intermediador for ESTIPULANTE)
type: string
maxLength: 60
country:
description: País da Intermediador (de acordo com o código "alpha3" do ISO-3166; Caso Tipo de Intermediador for ESTIPULANTE)
type: string
example: BRA
enum: [AFG,ALA,ALB,DZA,ASM,AND,AGO,AIA,ATA,ATG,ARG,ARM,ABW,AUS,AUT,AZE,BHS,BHR,BGD,BRB,BLR,BEL,BLZ,BEN,BMU,BTN,BOL,BES,BIH,BWA,BVT,BRA,IOT,BRN,BGR,BFA,BDI,CPV,KHM,CMR,CAN,CYM,CAF,TCD,CHL,CHN,CXR,CCK,COL,COM,COG,COD,COK,CRI,CIV,HRV,CUB,CUW,CYP,CZE,DNK,DJI,DMA,DOM,ECU,EGY,SLV,GNQ,ERI,EST,SWZ,ETH,FLK,FRO,FJI,FIN,FRA,GUF,PYF,ATF,GAB,GMB,GEO,DEU,GHA,GIB,GRC,GRL,GRD,GLP,GUM,GTM,GGY,GIN,GNB,GUY,HTI,HMD,VAT,HND,HKG,HUN,ISL,IND,IDN,IRN,IRQ,IRL,IMN,ISR,ITA,JAM,JPN,JEY,JOR,KAZ,KEN,KIR,PRK,KOR,KWT,KGZ,LAO,LVA,LBN,LSO,LBR,LBY,LIE,LTU,LUX,MAC,MDG,MWI,MYS,MDV,MLI,MLT,MHL,MTQ,MRT,MUS,MYT,MEX,FSM,MDA,MCO,MNG,MNE,MSR,MAR,MOZ,MMR,NAM,NRU,NPL,NLD,NCL,NZL,NIC,NER,NGA,NIU,NFK,MKD,MNP,NOR,OMN,PAK,PLW,PSE,PAN,PNG,PRY,PER,PHL,PCN,POL,PRT,PRI,QAT,REU,ROU,RUS,RWA,BLM,SHN,KNA,LCA,MAF,SPM,VCT,WSM,SMR,STP,SAU,SEN,SRB,SYC,SLE,SGP,SXM,SVK,SVN,SLB,SOM,ZAF,SGS,SSD,ESP,LKA,SDN,SUR,SJM,SWE,CHE,SYR,TWN,TJK,TZA,THA,TLS,TGO,TKL,TON,TTO,TUN,TUR,TKM,TCA,TUV,UGA,UKR,ARE,GBR,USA,UMI,URY,UZB,VUT,VEN,VNM,VGB,VIR,WLF,ESH,YEM,ZMB,ZWE]
address:
description: Endereço da Intermediador (restante do do endereço, excluindo cidade, estado e país; Caso Tipo de Intermediador for ESTIPULANTE)
type: string
maxLength: 60
InsurancePatrimonialInsuredObject:
type: object
required:
- type
- description
- coverages
properties:
identification:
type: string
maxLength: 100
description: "Identificador do objeto segurado (Quando o Tipo de Objeto Segurado for diferente de PESSOA). Obs.: Para Fiança Locatícia, é a identificação do Contrato de Locação."
type:
type: string
description: Tipo do objeto segurado
example: CONTRATO
enum: [CONTRATO,
PROCESSO_ADMINISTRATIVO,
PROCESSO_JUDICIAL,
AUTOMOVEL,
CONDUTOR,
FROTA,
PESSOA,
OUTROS]
typeAdditionalInfo:
type: string
maxLength: 100
description: "Descrição do tipo do objeto segurado(caso tipo de objeto segurado for outros)."
description:
type: string
maxLength: 1024
description: Descrição do objeto segurado
amount:
$ref: '#/components/schemas/AmountDetails'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/InsurancePatrimonialInsuredObjectCoverage'
InsurancePatrimonialInsuredObjectCoverage:
type: object
required:
- branch
- code
- susepProcessNumber
- LMI
- termStartDate
- termEndDate
- feature
- type
- premiumPeriodicity
properties:
branch:
type: string
maxLength: 4
example: '0111'
description: Grupo e Ramo da Cobertura (Conforme regulamentação Susep vigente)
code:
$ref: '#/components/schemas/InsurancePatrimonialCoverageCode'
description:
type: string
maxLength: 500
description: "Descrição / Nome da Cobertura (Obrigatório quando o campo 'Codigo' for preenchido com 'Outras')"
internalCode:
type: string
maxLength: 500
description: "Código interno da cobertura da seguradora(obrigatório se houver)"
susepProcessNumber:
type: string
maxLength: 50
LMI:
description: Valor de Limite Máximo de Indenização (LMI) solicitado
allOf:
- $ref: '#/components/schemas/AmountDetails'
isLMISublimit:
type: boolean
description: Limite máximo de indenização (LMI) é sublimite (Caso aplicável)
termStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
description: "Data de início de vigência da cobertura"
termEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
description: "Data de fim de vigência da cobertura"
isMainCoverage:
type: boolean
description: "Cobertura Principal"
feature:
type: string
description: "Característica da cobertura"
example: MASSIFICADOS
enum: [MASSIFICADOS,
MASSIFICADOS_MICROSEGUROS,
GRANDES_RISCOS]
type:
type: string
description: "Tipo de cobertura"
example: PARAMETRICO
enum: [PARAMETRICO,
INTERMITENTE,
REGULAR_COMUM,
CAPITAL_GLOBAL,
PARAMETRICO_E_INTERMITENTE]
gracePeriod:
type: integer
maxLength: 5
description: "Período de carência. OBS: Obrigatório, se houver"
gracePeriodicity:
type: string
description: "Periodicidade da carência. OBS: Obrigatório, se houver"
example: DIA
enum: [DIA,
MES,
ANO]
gracePeriodCountingMethod:
type: string
description: "Indicador de dias úteis ou corridos da carência. OBS: Obrigatório, se houver"
example: DIAS_UTEIS
enum: [DIAS_UTEIS,
DIAS_CORRIDOS]
gracePeriodStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
description: "Data de início da carência. OBS: Obrigatório, se houver"
gracePeriodEndDate:
type: string
format: date
maxLength: 10
example: '2022-12-31'
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
description: "Data de fim da carência. OBS: Obrigatório, se houver"
premiumPeriodicity:
description: Periodicidade de pagamento do premio
type: string
enum: [MENSAL,
BIMESTRAL,
TRIMESTRAL,
QUADRIMESTRAL,
SEMESTRAL,
ANUAL,
ESPORADICA,
PAGAMENTO_UNICO,
OUTROS]
premiumPeriodicityOthers:
description: Descricao da Periodicidade de pagamento do premio quando for informada a opcao OUTROS
type: string
maxLength: 100
InsurancePatrimonialCoverage:
type: object
required:
- branch
- code
minProperties: 3
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: '0111'
code:
$ref: '#/components/schemas/InsurancePatrimonialCoverageCode'
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
deductible:
$ref: '#/components/schemas/Deductible'
POS:
$ref: '#/components/schemas/POS'
Deductible:
type: object
description: Informações de franquia
required:
- type
- amount
- period
- periodicity
- periodStartDate
- periodEndDate
- description
properties:
type:
description: Tipo de Franquia
type: string
enum: [
REDUZIDA,
NORMAL,
MAJORADA,
DEDUTIVEL,
OUTROS
]
example: DEDUTIVEL
typeAdditionalInfo:
description: Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
type: string
maxLength: 500
amount:
description: Valor da franquia
allOf:
- $ref: '#/components/schemas/AmountDetails'
period:
description: Prazo da Franquia
type: integer
maxLength: 5
example: 10
periodicity:
description: Periodicidade da Franquia
type: string
enum: [
DIA,
MES,
ANO
]
example: DIA
periodCountingMethod:
description: Indicador de Dias Úteis ou Corridos (Caso aplicável)
type: string
enum: [
DIAS_UTEIS,
DIAS_CORRIDOS
]
example: DIAS_UTEIS
periodStartDate:
description: Data de Início da Franquia
type: string
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-05-16'
periodEndDate:
description: Data de Fim da Franquia
type: string
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-05-17'
description:
description: Descrição da Franquia
type: string
maxLength: 60
example: Franquia de exemplo
POS:
type: object
description: Objeto que agrupa os dados de Participação Obrigatória do Segurado.
required:
- applicationType
- description
properties:
applicationType:
description: Forma de Aplicação do POS
type: string
enum: [
VALOR,
PERCENTUAL,
OUTROS
]
example: VALOR
description:
description: Descrição do POS
type: string
maxLength: 60
example: "Descrição de exemplo"
minValue:
$ref: '#/components/schemas/AmountDetails'
maxValue:
$ref: '#/components/schemas/AmountDetails'
percentage:
description: Percentual POS
type: string
pattern: ^100\.0{1,9}$|^\d{1,2}\.\d{1,9}$
example: '10.00'
valueOthers:
$ref: '#/components/schemas/AmountDetails'
Coinsurer:
type: object
required:
- identification
- cededPercentage
properties:
identification:
description: "Identificação da congênere, cessionário do cosseguro. Obs: Obrigatório quando há cosseguro"
type: string
maxLength: 60
cededPercentage:
description: "Percentual cedido para a congênere para contratos de cosseguro cedido. Obs: Obrigatório quando há cosseguro"
type: string
pattern: ^100\.0{1,9}$|^\d{1,2}\.\d{1,9}$
example: '10.00'
InsurancePatrimonialPremium:
type: object
description: Objeto que agrupa dados de prêmio.
required:
- amount
- paymentsQuantity
- coverages
- payments
properties:
paymentsQuantity:
description: Quantidade de parcelas do prêmio do contrato
type: integer
maxLength: 3
example: 4
amount:
$ref: '#/components/schemas/AmountDetails'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/InsurancePatrimonialPremiumCoverage'
payments:
type: array
description: Lista que agrupa os dados de pagamentos.
items:
$ref: '#/components/schemas/Payment'
InsurancePatrimonialPremiumCoverage:
type: object
required:
- branch
- code
- premiumAmount
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: '0111'
code:
$ref: '#/components/schemas/InsurancePatrimonialCoverageCode'
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
premiumAmount:
description: Valor de Prêmio da Cobertura
allOf:
- $ref: '#/components/schemas/AmountDetails'
Payment:
type: object
required:
- movementDate
- movementType
- movementPaymentsNumber
- amount
- maturityDate
properties:
movementDate:
description: Data do movimento de prêmio
type: string
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
movementType:
description: Tipo do Movimento
type: string
enum: [LIQUIDACAO_DE_PREMIO,
LIQUIDACAO_DE_RESTITUICAO_DE_PREMIO,
LIQUIDACAO_DE_CUSTO_DE_AQUISICAO,
LIQUIDACAO_DE_RESTITUICAO_DE_CUSTO_DE_AQUISICAO,
COMPENSACAO_FINANCEIRA,
ESTORNO_DE_PREMIO,
ESTORNO_DE_RESTITUICAO_DE_PREMIO,
ESTORNO_DE_CUSTO_DE_AQUISICAO,
EMISSAO_DE_PREMIO,
CANCELAMENTO_DE_PARCELA,
EMISSAO_DE_RESTITUICAO_DE_PREMIO,
REABERTURA_DE_PARCELA,
BAIXA_POR_PERDA,
CANCELAMENTO_DE_PREMIO_E_PARCELA]
example: LIQUIDACAO_DE_PREMIO
movementOrigin:
description: "Origem do Movimento. Obs: Obrigatório caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO e ESTORNO_DE_PREMIO"
type: string
enum: [EMISSAO_DIRETA,
EMISSAO_ACEITA_DE_COSSEGURO,
EMISSAO_CEDIDA_DE_COSSEGURO]
example: EMISSAO_DIRETA
movementPaymentsNumber:
description: Identificador da parcela do movimento
type: string
maxLength: 3
amount:
$ref: '#/components/schemas/AmountDetails'
maturityDate:
description: Data de Vencimento da Parcela
type: string
format: date
pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$
example: '2022-12-31'
tellerId:
description: "Documento do Pagador/Recebedor Obs: Obrigatório caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO e LIQUIDACAO_DE_CUSTO_DE_AQUISICAO"
type: string
maxLength: 1024
tellerIdType:
description: "Tipo do Documento do Pagador/Recebedor Obs: Obrigatório caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO e LIQUIDACAO_DE_CUSTO_DE_AQUISICAO"
type: string
enum: [CPF,
CNPJ,
OUTROS]
example: CPF
tellerIdTypeOthers:
description: "Campo para descrever o tipo do documento quando for OUTROS"
type: string
maxLength: 100
tellerName:
description: "Nome ou Razão Social do Pagador/Recebedor Obs: Obrigatório caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO e LIQUIDACAO_DE_CUSTO_DE_AQUISICAO"
type: string
maxLength: 100
financialInstitutionCode:
description: "Código da Instituição Financeiro do Pagamento Obs: Obrigatório caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO e LIQUIDACAO_DE_CUSTO_DE_AQUISICAO"
type: string
maxLength: 100
paymentType:
description: "Meio de Pagamento Obs: Obrigatório caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO e LIQUIDACAO_DE_CUSTO_DE_AQUISICAO"
type: string
enum: [BOLETO,
TED,
TEF,
CARTAO,
DOC,
CHEQUE,
DESCONTO_EM_FOLHA,
PIX,
DINHEIRO_EM_ESPECIE,
COMUNICABILIDADE,
OUTROS]
example: BOLETO
InsurancePatrimonialClaim:
type: object
description: Objeto que agrupa dados de sinistro.
required:
- identification
- status
- statusAlterationDate
- occurrenceDate
- warningDate
- amount
- coverages
properties:
identification:
description: Identificador do processo de sinistro
type: string
maxLength: 50
documentationDeliveryDate:
description: Data de entrega da documentação completa (Caso tenha ocorrido toda a entrega)
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
status:
description: Status do sinistro
type: string
example: ABERTO
enum: [ABERTO,
ENCERRADO_COM_INDENIZACAO,
ENCERRADO_SEM_INDENIZACAO,
REABERTO,
CANCELADO_POR_ERRO_OPERACIONAL,
AVALIACAO_INICIAL]
statusAlterationDate:
description: Data de alteração do status do sinistro
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
occurrenceDate:
description: Data de ocorrência do sinistro
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
warningDate:
description: Data de aviso do sinistro
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
thirdPartyClaimDate:
description: Data de reclamação do terceiro
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
amount:
$ref: '#/components/schemas/AmountDetails'
denialJustification:
description: "Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')"
type: string
example: RISCO_EXCLUIDO
enum: [RISCO_EXCLUIDO,
RISCO_AGRAVADO,
SEM_DOCUMENTACAO,
DOCUMENTACAO_INCOMPLETA,
PRESCRICAO,
FORA_COBERTURA,
OUTROS]
denialJustificationDescription:
description: "Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')"
type: string
maxLength: 100
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/InsurancePatrimonialClaimCoverage'
InsurancePatrimonialClaimCoverage:
type: object
required:
- branch
- code
properties:
insuredObjectId:
description: Identificador do Objeto Segurado (Caso aplicável)
type: string
maxLength: 100
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: '0111'
code:
$ref: '#/components/schemas/InsurancePatrimonialCoverageCode'
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
warningDate:
description: Data de Aviso do Sinistro por Cobertura (Caso aplicável)
type: string
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
thirdPartyClaimDate:
description: Data de Reclamação do Terceiro por Cobertura (Caso aplicável)
type: string
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-12-31'
InsurancePatrimonialSpecificPolicyInfo:
type: object
description: Informações do Anexo Específico
properties:
basicCoverageIndex:
description: Indicador de Cobertura Básica. Caso contrato de Compreensivo Condomínio
type: string
enum: [SIMPLES,
AMPLA]
example: SIMPLES
insuredObjects:
type: array
description: Lista que agrupa os dados de objetos segurados.
items:
$ref: '#/components/schemas/InsurancePatrimonialSpecificInsuredObject'
InsurancePatrimonialSpecificInsuredObject:
type: object
required:
- identification
properties:
identification:
type: string
maxLength: 100
description: Identificador do objeto segurado
propertyType:
description: Tipo do imóvel ou condomínio segurado. Caso contrato de Compreensivo Residencial e Compreensivo Condomínio
type: string
enum: [CASA,
APARTAMENTO,
CONDOMINIO_RESIDENCIAL,
CONDOMINIO_COMERCIAL,
CONDOMINIO_MISTOS]
example: CASA
structuringType:
description: Tipo de estruturação para Compreensivo Condomínio. Caso contrato de Compreensivo Condomínio
type: string
enum: [CONDOMINIO_VERTICAL,
CONDOMINIO_HORIZONTAL,
MISTO]
example: CONDOMINIO_VERTICAL
postCode:
description: Código postal do imóvel, condomínio ou unidade empresarial/planta. Caso aplicável
type: string
maxLength: 60
example: "10000000"
businessActivity:
description: Código nacional de atividade econômica do IBGE. Caso aplicável
type: string
maxLength: 7
pattern: '^\d{7}$'
example: "1234567"
InsurancePatrimonialCoverageCode:
type: string
description: Código da cobertura, conforme Anexo II do Manual de Escopo de Dados
enum: [
IMOVEL_BASICA,
IMOVEL_AMPLA,
DANOS_ELETRICOS,
DANOS_POR_AGUA,
ALAGAMENTO,
RESPONSABILIDADE_CIVIL_FAMILIAR,
RESPONSABILIDADE_CIVIL_DANOS_MORAIS,
ROUBO_SUBTRACAO_BENS,
ROUBO_SUBTRACAO_BENS_FORA_LOCAL_SEGURADO,
TACOS_GOLFE_HOLE_ONE,
PEQUENAS_REFORMAS_OBRAS,
GREVES_TUMULTOS_LOCKOUT,
MICROEMPREENDEDOR,
ESCRITORIO_RESIDENCIA,
DANOS_EQUIPAMENTOS_ELETRONICOS,
QUEBRA_VIDROS,
IMPACTO_VEICULOS,
VENDAVAL,
PERDA_PAGAMENTO_ALUGUEL,
BICICLETA,
RESPONSABILIDADE_CIVIL_BICICLETA,
RC_EMPREGADOR,
DESMORONAMENTO,
DESPESAS_EXTRAORDINARIAS,
JOIAS_OBRAS_ARTE,
TERREMOTO,
IMPACTO_AERONAVES,
PAISAGISMO,
INCENDIO,
QUEDA_RAIO,
EXPLOSAO,
COBERTURA_BASICA_AMPLA_COBERTURAS_PARA_QUAISQUER_EVENTOS_QUE_POSSAM_CAUSAR_DANOS_FISICOS_AO_IMOVEL_SEGURADO_EXCETO_OS_EXPRESSAMENTE_EXCLUIDOS,
COBERTURA_BASICA_SIMPLES_COBERTURAS_DE_INCENDIO_QUEDA_DE_RAIO_DENTRO_DO_TERRENO_SEGURADO_E_EXPLOSAO_DE_QUALQUER_NATUREZA,
ANUNCIOS_LUMINOSOS,
DANOS_AO_JARDIM,
DESPESAS_COM_ALUGUEL,
EQUIPAMENTOS,
FIDELIDADE_DE_EMPREGADOS,
IMPACTO_DE_VEICULOS,
VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
LUCROS_CESSANTES,
QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RESPONSABILIDADE_CIVIL,
ROUBO,
VALORES,
TUMULTO,
INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
VENDAVAL_ATE_FUMACA,
ALAGAMENTO_E_INUNDACAO,
TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
ROUBO_E_FURTO_QUALIFICADO,
RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
DERRAME,
VAZAMENTO,
QUEBRA_DE_MAQUINAS,
LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
PERDA_OU_PAGAMENTO_DE_ALUGUEL,
PEQUENAS_OBRAS_DE_ENGENHARIA,
DANOS_DE_CAUSA_EXTERNA,
DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
LUCRO_BRUTO,
LUCRO_LIQUIDO,
DESPESAS_FIXAS,
PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
AFRETAMENTOS_DE_AERONAVES,
ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
DANOS_MORAIS,
DESPESAS_COM_DESENTULHO_DO_LOCAL,
DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
EQUIPAMENTOS_MOVEIS_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
HONORARIOS_DE_PERITO,
INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_30_DIAS_EXCETO_PARA_REFORMAS_AMPLIACOES,
MANUTENCAO_AMPLA_ATE_24_MESES,
MANUTENCAO_SIMPLES_ATE_24_MESES,
OBRAS_CONCLUIDAS,
OBRAS_TEMPORARIAS,
OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
PROPRIEDADES_CIRCUNVIZINHAS,
RECOMPOSICAO_DE_DOCUMENTOS,
RESPONSABILIDADE_CIVIL_EMPREGADOR,
FUNDACAO,
STANDS_DE_VENDA,
TRANSPORTE_TERRESTRE,
TUMULTOS_GREVES_E_LOCKOUT,
DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
INFIDELIDADE_DE_FUNCIONARIOS,
VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
ALAGAMENTO_INUNDACAO,
ALUGUEL_PERDA_OU_PAGAMENTO,
BAGAGEM,
BASICA_INCENDIO_RAIO_EXPLOSAO,
BASICA_DANOS_MATERIAIS,
BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
DANOS_NA_FABRICACAO,
DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS,
DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
DESPESAS_FIXA,
DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES,
FRIGORIFICADOS,
EQUIPAMENTOS_ARRENDADOS,
EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
EQUIPAMENTOS_ELETRONICOS,
EQUIPAMENTOS_ESTACIONARIOS,
EQUIPAMENTOS_MOVEIS,
EQUIPAMENTOS_PORTATEIS,
HONORARIOS_DE_PERITOS,
IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
IMPACTO_DE_VEICULOS_TERRESTRES,
LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
PATIOS,
ROUBO_DE_BENS_DE_HOSPEDES,
ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
TERRORISMO_E_SABOTAGEM,
VAZAMENTO_DE_TUBULACOES_E_TANQUES,
VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
QuoteResultAssistance:
type: object
required:
- type
- service
- description
- assistancePremiumAmount
properties:
type:
description: Tipo de prestação de serviços
type: string
example: ASSISTENCIA_AUTO
enum: [
ASSISTENCIA_AUTO,
ASSISTENCIA_RE,
ASSISTENCIA_VIDA,
BENEFICIOS,
DESPACHANTE,
LOCACAO_DE_VEICULOS,
REPAROS_AUTOMOTIVOS,
REPAROS_EMERGENCIAIS,
SERVICO_DE_MANUTENCAO,
SERVICO_EM_CASO_DE_SINISTRO,
TRANSPORTE_DO_EMERGENCIAL,
OUTROS
]
service:
description: Nome do serviço prestado
type: string
example: AMPARO_DE_CRIANCAS
enum: [
ACIONAMENTO_E_OU_AGENDAMENTO_DE_LEVA_E_TRAZ,
AMPARO_DE_CRIANCAS,
APLICACAO_DE_VACINAS_EM_DOMICILIO,
AQUECEDORES,
ASSISTENCIA_A_ELETRODOMESTICOS,
ASSISTENCIA_AUTO_E_OU_MOTO,
ASSISTENCIA_BIKE,
ASSISTENCIA_EM_VIAGEM,
ASSISTENCIA_ESCOLAR,
ASSISTENCIA_FUNERAL,
ASSISTENCIA_FUNERAL_PET,
ASSISTENCIA_INFORMATICA,
ASSISTENCIA_NUTRICIONAL,
ASSISTENCIA_PET,
ASSISTENCIA_RESIDENCIAL,
ASSISTENCIA_SUSTENTAVEL,
ASSISTENCIA_VETERINARIA_EMERGENCIAL,
ASSISTENCIAS_SAUDE_E_BEM_ESTAR,
BABY_SITTER,
CACAMBA,
CARRO_RESERVA,
CESTA_BASICA,
CESTA_DE_ALIMENTOS,
CESTA_NATALIDADE,
CHAVEIRO,
CHECK_UP,
COBERTURA_PROVISORIA_DE_TELHADO,
CONCIERGE,
CONSERTO_DE_AR_CONDICIONADO,
CONSERTO_DE_ELETRODOMESTICOS_LINHA_BRANCA,
CONSERTO_DE_ELETROELETRONICO_LINHA_MARROM,
CONSERTO_DE_PORTA_ONDULADA,
CONSULTAS_VETERINARIAS,
CONSULTORIA_ORCAMENTARIA,
CONVENIENCIA_EM_VIAGEM,
DEDETIZACAO,
DESATOLAMENTO,
DESCARTE_RESPONSAVEL,
DESCONTOS_EM_CONSULTAS_E_EXAMES,
DESCONTOS_EM_MEDICAMENTOS,
DESENTUPIMENTO,
DESINSETIZACAO_E_DESRATIZACAO,
DESPACHANTE,
DESPESAS_FARMACEUTICAS,
DESPESAS_MEDICAS_CIRURGICAS_E_DE_HOSPITALIZACAO,
DESPESAS_ODONTOLOGICAS,
ELETRICISTA,
EMERGENCIAS,
ENCANADOR,
ENVIO_DE_ACOMPANHANTE_EM_CASO_DE_ACIDENTE,
ENVIO_DE_FAMILIAR_PARA_ACOMPANHAMENTO_DE_MENORES_DE_CATORZE_ANOS,
ENVIO_DE_RACAO,
ESCRITORIO_VIRTUAL,
GUARDA_DE_ANIMAIS,
GUARDA_DO_VEICULO,
GUINCHO,
HELP_DESK,
HIDRAULICA,
HOSPEDAGEM,
HOSPEDAGEM_DE_ANIMAIS,
INDICACAO_DE_BANHO_E_TOSA,
INDICACAO_DE_PROFISSIONAIS,
INFORMACAO_SOBRE_RACAS_DE_CAES,
INFORMACAO_SOBRE_VENDA_DE_FILHOTES,
INFORMACOES_SOBRE_VACINAS,
INFORMACOES_VETERINARIAS_UTEIS,
INSTALACAO_RESIDENCIA,
INSTALACAO_DE_CHUVEIRO_ELETRICO_E_OU_TROCA_DE_RESISTENCIA,
INSTALACAO_DE_SUPORTE_TV_ATE_SETENTA,
LIMPEZA,
LIMPEZA_DE_AR_CONDICIONADO,
LIMPEZA_DE_CAIXA_D_AGUA,
LIMPEZA_DE_CALHAS,
LIMPEZA_DE_RALOS_E_SIFOES,
LOCACAO_DE_ELETRODOMESTICOS,
LOCACAO_DE_VEICULOS,
LOCALIZACAO_DE_BAGAGEM,
MANUTENCAO,
MARTELINHO_E_REPARO_RAPIDO,
MECANICO,
MEIO_DE_TRANSPORTE,
MONITORACAO_MEDICA,
MOTO,
MOTORISTA_AMIGO,
MOTORISTA_SUBSTITUTO,
MTA_MEIO_DE_TRANSPORTE_ALTERNATIVO,
MUDANCA_E_GUARDA_DE_MOVEIS,
ORGANIZACAO,
ORIENTACAO_EM_CASO_DE_PERDA_DE_DOCUMENTOS,
ORIENTACAO_MEDICA,
ORIENTACAO_PSICOLOGICA,
PERSONAL_FITNESS,
REBOQUE,
REBOQUE_BIKE,
RECUPERACAO_DO_VEICULO,
REGRESSO_ANTECIPADO_EM_CASO_DE_FALECIMENTO_DE_PARENTES,
REGRESSO_DO_USUARIO_APOS_ALTA_HOSPITALAR,
REINSTALACAO_E_REPARO_DO_VENTILADOR_DE_TETO,
REMANEJAMENTO_DE_MOVEIS,
REMOCAO_HOSPITALAR,
REMOCAO_MEDICA,
REMOCAO_MEDICA_INTER_HOSPITALAR,
REPARACAO_AUTOMOTIVA,
REPARO_DE_TELEFONIA,
REPARO_EM_PORTOES_AUTOMATICOS,
REPARO_FIXACAO_DE_ANTENAS,
REPAROS_ELETRICOS,
RETORNO_ANTECIPADO_AO_DOMICILIO,
REVERSAO_DE_FOGAO,
REVISAO_DE_INSTALACAO_ELETRICA,
SEGUNDA_OPINIAO_MEDICA_INTERNACIONAL,
SEGURANCA,
SERRALHEIRO,
SERVICO_DE_INDICACAO_MEDICA,
SERVICO_DE_LIMPEZA,
SERVICOS_AUTO,
SERVICOS_ESPECIAIS_FIXACAO_DE_OBJETOS,
SERVICOS_GERAIS,
SUBSTITUICAO_DE_PNEUS,
SUBSTITUICAO_DE_TELHAS,
TAXI,
TELEMEDICINA,
TRANSMISSAO_DE_MENSAGENS_URGENTES,
TRANSPORTE_E_ENVIO_DE_FAMILIAR,
TRANSPORTE_E_GUARDA_MOVEIS,
TRANSPORTE_ESCOLAR_PESSOAS,
TRANSPORTE_VETERINARIO_EMERGENCIAL,
TRASLADO_DE_CORPO,
TROCA_DE_BATERIA,
TROCA_DE_PNEUS,
VERIFICACAO_DE_POSSIVEIS_VAZAMENTOS,
VIDROS_E_ACESSORIOS,
VIGILANCIA_E_SEGURANCA,
OUTROS
]
description:
description: Descrição do serviço prestado
type: string
maxLength: 5000
assistancePremiumAmount:
description: Valor de Prêmio da Assistência
allOf:
- $ref: '#/components/schemas/AmountDetails'
QuoteResultPremium:
type: object
description: Objeto que agrupa dados de prêmio.
required:
- totalPremiumAmount
- totalNetAmount
- IOF
- paymentsQuantity
- coverages
- payments
properties:
paymentsQuantity:
description: Quantidade de parcelas do prêmio do contrato
type: integer
maxLength: 3
example: 4
totalPremiumAmount:
description: Valor total do prêmio do contrato
allOf:
- $ref: '#/components/schemas/AmountDetails'
totalNetAmount:
description: Valor de prêmio líquido total
allOf:
- $ref: '#/components/schemas/AmountDetails'
IOF:
description: Valor do IOF
allOf:
- $ref: '#/components/schemas/AmountDetails'
interestRateOverPayments:
description: Taxa de juros sobre o parcelamento do prêmio
type: string
pattern: ^\d{1,3}\.\d{1,9}$
example: "10.00"
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/QuoteResultPremiumCoverage'
payments:
type: array
description: Lista que agrupa os dados de pagamentos.
items:
$ref: '#/components/schemas/QuoteResultPayment'
ClaimNotification:
type: object
description: Valores de sinistros (nos últimos 12 meses)
required:
- claimAmount
- claimDescription
properties:
claimAmount:
description: "Valor do sinistro De acordo com ISO-4217."
allOf:
- $ref: '#/components/schemas/AmountDetails'
claimDescription:
description: Descrição do sinistro
type: string
maxLength: 100
additionalProperties: false
PolicyDataPatrimonialCondominium:
$ref: '#/components/schemas/PolicyDataPatrimonial'
QuoteDataPatrimonialCondominium:
type: object
required:
- coverages
- mainActivity
- isLegallyConstituted
- condominiumType
description: Objeto que agrupa dados específicos do ramo de cotação.
properties:
mainActivity:
description: "Principal atividade do local de risco"
type: string
example: COMERCIO
enum: [COMERCIO,
INDUSTRIA,
SERVICO]
isLegallyConstituted:
description: O condomínio está legalmente constituído?
type: boolean
registryStarted:
description: O registro na receita federal foi iniciado? Condicional ao campo "isLegallyConstituted" ser false
type: boolean
timeRegistry:
description: O registro na receita federal possui mais de 12 meses? Condicional ao campo "registryStarted" ser true
type: boolean
condominiumType:
description: |
"Trata-se de condomínio do tipo:
1. Condomínio Polo Industrial
2. Condomínio Logístico / Galpão
3. Condomínio Armazém/Depósito
4. Condomínio Garagem de veículos
5. Condomínio Shopping center"
Caso se encaixe em algum dos itens acima, a cotação será classificada como Lead.
type: boolean
termStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de vigência dentro de 24 horas"
termEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim de vigência até as 24 horas"
insuranceTermStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Não permite retroagir vigência permite - vigência posterior"
insuranceType:
type: string
description: Tipo de Seguro
example: NOVO
enum: [NOVO,
RENOVACAO]
policyId:
description: Número para identificar a apólice atual
type: string
maxLength: 100
example: "111111"
insurerId:
description: Nome para identifcar a congênere de renovação
type: string
maxLength: 100
currency:
description: Moeda de emissão do contrato de acordo com ISO-4217.
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
basicCoverageIndex:
description: "Indicador de Modalidade de Cobertura Básica (Caso contrato de Compreensivo Condomínio)"
type: string
example: SIMPLES
enum: [SIMPLES,
AMPLA]
maxLMG:
description: Valor Limite máximo de garantia (LMG)
allOf:
- $ref: '#/components/schemas/AmountDetails'
includesAssistanceServices:
description: Deseja contratação de serviços de assistência?
type: boolean
claimAmount:
description: "Valor do sinistro De acordo com ISO-4217."
allOf:
- $ref: '#/components/schemas/AmountDetails'
claimDescription:
description: Descrição do sinistro
type: string
maxLength: 100
insuredObject:
$ref: '#/components/schemas/QuotePatrimonialCondominiumInsuredObject'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/QuotePatrimonialCondominiumCoverage'
QuotePatrimonialCondominiumInsuredObject:
type: object
description: Objeto que agrupa os dados de objeto segurado.
properties:
identification:
type: string
maxLength: 100
description: "Identificador do objeto segurado. Obs.: Para Fiança Locatícia, é a identificação do Contrato de Locação."
structuringType:
description: "Indica o tipo de estruturação"
type: string
example: CONDOMINIO_VERTICAL
enum: [
CONDOMINIO_VERTICAL,
CONDOMINIO_HORIZONTAL,
MISTO]
propertyType:
description: Tipo docondomínio segurado
type: string
example: CONDOMINIO_EXCLUSIVAMENTE_RESIDENCIAL
enum: [
CONDOMINIO_RESIDENCIAL_COM_COMERCIO_NO_TERREO,
CONDOMINIO_DE_ESCRITORIOS_CONSULTORIOS,
CONDOMINIO_RESIDENCIAL_COM_ESCRITORIO_E_COMERCIO,
CONDOMINIO_DE_ESCRITORIOS_CONSULTORIOS_COM_COMERCIO_NO_TERREO,
CONDOMINIO_FLAT_APART_HOTEL,
CONDOMINIO_FLAT_APART_HOTEL_COM_COMERCIO,
CONDOMINIO_EXCLUSIVAMENTE_COMERCIAL,
CONDOMINIO_EXCLUSIVAMENTE_RESIDENCIAL
]
hasElevator:
description: O Condomínio Possui Elevador?
type: boolean
isFullyOrPartiallyListed:
description: O Condomínio é total ou parcialmente tombado pelo patrimônio histórico?
type: boolean
numberOfBlocks:
description: Qual a quantidade de blocos?
type: string
maxLength: 100
example: "3"
condominiumAge:
description: Qual a idade, em anos, do Condomínio?
type: string
maxLength: 100
example: "20"
hasReuseOfWater:
description: Participa de algum programa de reuso ou reaproveitamento de água?
type: boolean
securityProtection:
description: Quais itens de segurança dispõe o condomínio?
type: array
items:
type: string
example: PORTEIRO_ELETRONICO
enum: [
CAMERA_CFTV,
PORTARIA_VINTE_E_QUATRO_HORAS,
ALARME_DISPOSITIVO_ANTI_FURTO,
VIGILANCIA_TERCEIRIZADA,
CONDOMINIO_FECHADO,
CERCA_ELETRICA,
GRADES_EM_JANELAS_E_PORTAS,
PORTEIRO_ELETRONICO,
CATRACA_ELETRONICA_DE_ACESSO,
NAO_POSSUI]
riskLocationInfo:
$ref: '#/components/schemas/QuotePatrimonialCondominiumRiskLocation'
indenizationWithoutDepreciation:
description: "Contratar seguro com a indenização sem aplicação de depreciação dos bens segurados (valor de novo)"
type: boolean
wasThereAClaim:
description: Houve sinistro no local nos últimos 12 meses?
type: boolean
claimNotifications:
description: Lista de sinistros e valores
type: array
items:
$ref: '#/components/schemas/ClaimNotification'
QuotePatrimonialCondominiumCoverage:
type: object
description: Objeto que agrupa os dados de objeto segurado.
required:
- branch
- code
- isSeparateContractingAllowed
- maxLMI
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: "0111"
code:
type: string
description: Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
example: RESIDENCIAL_IMOVEL_BASICA
enum: [
RESIDENCIAL_IMOVEL_BASICA,
RESIDENCIAL_IMOVEL_AMPLA,
RESIDENCIAL_INCENDIO,
RESIDENCIAL_QUEDA_DE_RAIO,
RESIDENCIAL_EXPLOSAO,
RESIDENCIAL_IMPACTO_DE_AERONAVES,
RESIDENCIAL_ALAGAMENTO,
RESIDENCIAL_DANOS_ELETRICOS,
RESIDENCIAL_DANOS_POR_AGUA,
RESIDENCIAL_RESPONSABILIDADE_CIVIL_FAMILIAR,
RESIDENCIAL_VENDAVAL,
RESIDENCIAL_DANOS_A_EQUIPAMENTOS_ELETRONICOS,
RESIDENCIAL_TERREMOTO,
RESIDENCIAL_PERDA_E_PAGAMENTO_DE_ALUGUEL,
RESIDENCIAL_ROUBO_E_SUBTRACAO_DE_BENS,
RESIDENCIAL_QUEBRA_DE_VIDROS,
RESIDENCIAL_IMPACTO_DE_VEICULOS,
RESIDENCIAL_DESMORONAMENTO,
RESIDENCIAL_TUMULTOS_GREVES_E_LOCKOUTS,
RESIDENCIAL_DESPESAS_EXTRAORDINARIAS,
RESIDENCIAL_JOIAS_E_OBRAS_DE_ARTE,
CONDOMINIAL_COBERTURA_BASICA_SIMPLES,
CONDOMINIAL_COBERTURA_BASICA_AMPLA,
CONDOMINIAL_ANUNCIOS_LUMINOSOS,
CONDOMINIAL_DANOS_AO_JARDIM,
CONDOMINIAL_DANOS_ELETRICOS,
CONDOMINIAL_DESMORONAMENTO,
CONDOMINIAL_DESPESAS_COM_ALUGUEL,
CONDOMINIAL_EQUIPAMENTOS,
CONDOMINIAL_FIDELIDADE_DE_EMPREGADOS,
CONDOMINIAL_IMPACTO_DE_VEICULOS,
CONDOMINIAL_VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
CONDOMINIAL_LUCROS_CESSANTES,
CONDOMINIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
CONDOMINIAL_RESPONSABILIDADE_CIVIL,
CONDOMINIAL_ROUBO,
CONDOMINIAL_VALORES,
CONDOMINIAL_VAZAMENTO,
CONDOMINIAL_VENDAVAL,
CONDOMINIAL_ALAGAMENTO,
CONDOMINIAL_TUMULTO,
EMPRESARIAL_INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
EMPRESARIAL_DANOS_ELETRICOS,
EMPRESARIAL_VENDAVAL_ATE_FUMACA,
EMPRESARIAL_DESMORONAMENTO,
EMPRESARIAL_ALAGAMENTO_E_INUNDACAO,
EMPRESARIAL_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
EMPRESARIAL_ROUBO_E_FURTO_QUALIFICADO,
EMPRESARIAL_VALORES,
EMPRESARIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
EMPRESARIAL_ANUNCIOS_LUMINOSOS,
EMPRESARIAL_FIDELIDADE_DE_EMPREGADOS,
EMPRESARIAL_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
EMPRESARIAL_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
EMPRESARIAL_DERRAME,
EMPRESARIAL_VAZAMENTO,
EMPRESARIAL_EQUIPAMENTOS,
EMPRESARIAL_QUEBRA_DE_MAQUINAS,
EMPRESARIAL_RESPONSABILIDADE_CIVIL,
EMPRESARIAL_DESPESAS_EXTRAORDINARIAS,
EMPRESARIAL_LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
EMPRESARIAL_PERDA_OU_PAGAMENTO_DE_ALUGUEL,
EMPRESARIAL_PEQUENAS_OBRAS_DE_ENGENHARIA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
DIVERSOS_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
CESSANTES_LUCRO_BRUTO_LUCRO_LIQUIDO_E_DESPESAS_FIXAS,
CESSANTES_LUCRO_LIQUIDO,
CESSANTES_DESPESAS_FIXAS,
CESSANTES_PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
ENGENHARIA_OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
ENGENHARIA_AFRETAMENTOS_DE_AERONAVES,
ENGENHARIA_ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
ENGENHARIA_DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
ENGENHARIA_DANOS_MORAIS,
ENGENHARIA_DESPESAS_COM_DESENTULHO_DO_LOCAL,
ENGENHARIA_DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
ENGENHARIA_DESPESAS_EXTRAORDINARIAS,
ENGENHARIA_EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
ENGENHARIA_EQUIPAMENTOS_MOVEIS_OU_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
ENGENHARIA_FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
ENGENHARIA_HONORARIOS_DE_PERITO,
ENGENHARIA_INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_TRINTA_DIAS_EXCETO_PARA_REFORMAS_OU_AMPLIACOES,
ENGENHARIA_LUCROS_CESSANTES,
ENGENHARIA_MANUTENCAO_AMPLA_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_MANUTENCAO_SIMPLES_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_OBRAS_CONCLUIDAS,
ENGENHARIA_OBRAS_TEMPORARIAS,
ENGENHARIA_OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
ENGENHARIA_PROPRIEDADES_CIRCUNVIZINHAS,
ENGENHARIA_RECOMPOSICAO_DE_DOCUMENTOS,
ENGENHARIA_RESPONSABILIDADE_CIVIL_EMPREGADOR,
ENGENHARIA_FUNDACAO,
ENGENHARIA_STANDS_DE_VENDA,
ENGENHARIA_TRANSPORTE_TERRESTRE,
ENGENHARIA_TUMULTOS_GREVES_E_LOCKOUT,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
BANCOS_INFIDELIDADE_DE_FUNCIONARIOS,
BANCOS_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
BANCOS_VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
BANCOS_VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
RNO_ALAGAMENTO_INUNDACAO,
RNO_ALUGUEL_PERDA_OU_PAGAMENTO,
RNO_ANUNCIOS_LUMINOSOS,
RNO_BAGAGEM,
RNO_BASICA_INCENDIO_RAIO_EXPLOSAO,
RNO_BASICA_DANOS_MATERIAIS,
RNO_BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
RNO_BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
RNO_CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
RNO_DANOS_ELETRICOS,
RNO_DANOS_NA_FABRICACAO,
RNO_DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS_SPRINKLERS,
RNO_DESMORONAMENTO,
RNO_DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
RNO_DESPESAS_EXTRAORDINARIAS,
RNO_DESPESAS_FIXA,
RNO_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
RNO_EQUIPAMENTOS_ARRENDADOS,
RNO_EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
RNO_EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
RNO_EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
RNO_EQUIPAMENTOS_ELETRONICOS,
RNO_EQUIPAMENTOS_ESTACIONARIOS,
RNO_EQUIPAMENTOS_MOVEIS,
RNO_EQUIPAMENTOS_PORTATEIS,
RNO_FIDELIDADE_DE_EMPREGADOS,
RNO_HONORARIOS_DE_PERITOS,
RNO_IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
RNO_IMPACTO_DE_VEICULOS_TERRESTRES,
RNO_LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
RNO_LUCROS_CESSANTES,
RNO_MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
RNO_PATIOS,
RNO_QUEBRA_DE_MAQUINAS,
RNO_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RNO_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
RNO_ROUBO_DE_BENS_DE_HOSPEDES,
RNO_ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
RNO_ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
RNO_ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
RNO_TERRORISMO_E_SABOTAGEM,
RNO_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
RNO_VAZAMENTO_DE_TUBULACOES_E_TANQUES,
RNO_VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
RNO_VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
isSeparateContractingAllowed:
description: Permissão para Contratação Separada
type: boolean
maxLMI:
description: Valor de Limite Máximo de Indenização (LMI) solicitado
allOf:
- $ref: '#/components/schemas/AmountDetails'
internalCode:
description: "Código interno da cobertura da seguradora"
type: string
maxLength: 500
QuotePatrimonialCondominiumRiskLocation:
type: object
description: Objeto que agrupa dados de local de risco.
properties:
address:
type: string
maxLength: 100
description: Logradouro do Local de Risco
example: "Avenida Paulista, 2000"
additionalInfo:
type: string
maxLength: 100
description: Complemento *
example: "Apartamento 1304"
districtName:
type: string
maxLength: 100
description: Bairro *
example: "Cerqueira César"
townName:
type: string
maxLength: 100
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
description: Município
example: "São Paulo"
countrySubDivision:
type: string
description: Sigla da Unidade da Federação
example: AC
enum: [AC,
AL,
AP,
AM,
BA,
CE,
DF,
ES,
GO,
MA,
MT,
MS,
MG,
PA,
PB,
PR,
PE,
PI,
RJ,
RN,
RS,
RO,
RR,
SC,
SP,
SE,
TO]
postCode:
type: string
maxLength: 8
description: CEP
example: "1310200"
QuoteStatusPatrimonialCondominium:
type: object
required:
- quoteCustomer
- quoteData
- quotes
properties:
quoteCustomer:
description: Objeto que agrupa as categorias de dados cadastrais do cliente.
oneOf:
- $ref: '#/components/schemas/PersonalQuoteCustomer'
- $ref: '#/components/schemas/BusinessQuoteCustomer'
quoteData:
$ref: '#/components/schemas/ResultQuotePatrimonialCondominium'
quotes:
type: array
minItems: 1
description: Lista de cotações enviadas pela seguradora.
items:
required:
- premiumInfo
- coverages
- quoteDateTime
- insurerQuoteId
type: object
description: Informações da cotação enviada pela seguradora
properties:
insurerQuoteId:
type: string
description: |
Id da proposta da segurada
quoteDateTime:
type: string
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: "2023-05-21T08:30:00Z"
description: Data e hora da cotação
susepProcessNumbers:
description: "Número do Processo Susep das Coberturas"
type: array
items:
type: string
maxLength: 50
updatingIndex:
description: Índice de atualização dos valores do contrato
type: string
example: IPCA
enum: [
IPCA,
IGP_M,
INPC,
OUTROS,
NAO_SE_APLICA
]
updatingIndexOthers:
description: Campo para descrever o indice de atualização quando for outros
type: string
maxLength: 100
updatingPeriodicity:
description: Periodicidade de atualização
type: string
example: ANUAL
enum: [
ANUAL,
OUTROS
]
updatingPeriodicityOthers:
description: Campo para descrever a periodicidade do indice de atualização quando for outros
type: string
maxLength: 100
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/ResultQuotePatrimonialCondominiumCoverage'
assistances:
type: array
description: Lista que agrupa dados de assistências.
items:
$ref: '#/components/schemas/QuoteResultAssistance'
premiumInfo:
$ref: '#/components/schemas/QuoteResultPremium'
quoteCustomData:
$ref: '#/components/schemas/QuoteCustomData'
ResultQuotePatrimonialCondominiumCoverage:
type: object
required:
- branch
- code
- isSeparateContractingAllowed
- maxLMI
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: "0111"
code:
type: string
description: Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
example: RESIDENCIAL_IMOVEL_BASICA
enum: [
RESIDENCIAL_IMOVEL_BASICA,
RESIDENCIAL_IMOVEL_AMPLA,
RESIDENCIAL_INCENDIO,
RESIDENCIAL_QUEDA_DE_RAIO,
RESIDENCIAL_EXPLOSAO,
RESIDENCIAL_IMPACTO_DE_AERONAVES,
RESIDENCIAL_ALAGAMENTO,
RESIDENCIAL_DANOS_ELETRICOS,
RESIDENCIAL_DANOS_POR_AGUA,
RESIDENCIAL_RESPONSABILIDADE_CIVIL_FAMILIAR,
RESIDENCIAL_VENDAVAL,
RESIDENCIAL_DANOS_A_EQUIPAMENTOS_ELETRONICOS,
RESIDENCIAL_TERREMOTO,
RESIDENCIAL_PERDA_E_PAGAMENTO_DE_ALUGUEL,
RESIDENCIAL_ROUBO_E_SUBTRACAO_DE_BENS,
RESIDENCIAL_QUEBRA_DE_VIDROS,
RESIDENCIAL_IMPACTO_DE_VEICULOS,
RESIDENCIAL_DESMORONAMENTO,
RESIDENCIAL_TUMULTOS_GREVES_E_LOCKOUTS,
RESIDENCIAL_DESPESAS_EXTRAORDINARIAS,
RESIDENCIAL_JOIAS_E_OBRAS_DE_ARTE,
CONDOMINIAL_COBERTURA_BASICA_SIMPLES,
CONDOMINIAL_COBERTURA_BASICA_AMPLA,
CONDOMINIAL_ANUNCIOS_LUMINOSOS,
CONDOMINIAL_DANOS_AO_JARDIM,
CONDOMINIAL_DANOS_ELETRICOS,
CONDOMINIAL_DESMORONAMENTO,
CONDOMINIAL_DESPESAS_COM_ALUGUEL,
CONDOMINIAL_EQUIPAMENTOS,
CONDOMINIAL_FIDELIDADE_DE_EMPREGADOS,
CONDOMINIAL_IMPACTO_DE_VEICULOS,
CONDOMINIAL_VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
CONDOMINIAL_LUCROS_CESSANTES,
CONDOMINIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
CONDOMINIAL_RESPONSABILIDADE_CIVIL,
CONDOMINIAL_ROUBO,
CONDOMINIAL_VALORES,
CONDOMINIAL_VAZAMENTO,
CONDOMINIAL_VENDAVAL,
CONDOMINIAL_ALAGAMENTO,
CONDOMINIAL_TUMULTO,
EMPRESARIAL_INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
EMPRESARIAL_DANOS_ELETRICOS,
EMPRESARIAL_VENDAVAL_ATE_FUMACA,
EMPRESARIAL_DESMORONAMENTO,
EMPRESARIAL_ALAGAMENTO_E_INUNDACAO,
EMPRESARIAL_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
EMPRESARIAL_ROUBO_E_FURTO_QUALIFICADO,
EMPRESARIAL_VALORES,
EMPRESARIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
EMPRESARIAL_ANUNCIOS_LUMINOSOS,
EMPRESARIAL_FIDELIDADE_DE_EMPREGADOS,
EMPRESARIAL_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
EMPRESARIAL_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
EMPRESARIAL_DERRAME,
EMPRESARIAL_VAZAMENTO,
EMPRESARIAL_EQUIPAMENTOS,
EMPRESARIAL_QUEBRA_DE_MAQUINAS,
EMPRESARIAL_RESPONSABILIDADE_CIVIL,
EMPRESARIAL_DESPESAS_EXTRAORDINARIAS,
EMPRESARIAL_LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
EMPRESARIAL_PERDA_OU_PAGAMENTO_DE_ALUGUEL,
EMPRESARIAL_PEQUENAS_OBRAS_DE_ENGENHARIA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
DIVERSOS_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
CESSANTES_LUCRO_BRUTO_LUCRO_LIQUIDO_E_DESPESAS_FIXAS,
CESSANTES_LUCRO_LIQUIDO,
CESSANTES_DESPESAS_FIXAS,
CESSANTES_PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
ENGENHARIA_OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
ENGENHARIA_AFRETAMENTOS_DE_AERONAVES,
ENGENHARIA_ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
ENGENHARIA_DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
ENGENHARIA_DANOS_MORAIS,
ENGENHARIA_DESPESAS_COM_DESENTULHO_DO_LOCAL,
ENGENHARIA_DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
ENGENHARIA_DESPESAS_EXTRAORDINARIAS,
ENGENHARIA_EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
ENGENHARIA_EQUIPAMENTOS_MOVEIS_OU_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
ENGENHARIA_FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
ENGENHARIA_HONORARIOS_DE_PERITO,
ENGENHARIA_INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_TRINTA_DIAS_EXCETO_PARA_REFORMAS_OU_AMPLIACOES,
ENGENHARIA_LUCROS_CESSANTES,
ENGENHARIA_MANUTENCAO_AMPLA_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_MANUTENCAO_SIMPLES_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_OBRAS_CONCLUIDAS,
ENGENHARIA_OBRAS_TEMPORARIAS,
ENGENHARIA_OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
ENGENHARIA_PROPRIEDADES_CIRCUNVIZINHAS,
ENGENHARIA_RECOMPOSICAO_DE_DOCUMENTOS,
ENGENHARIA_RESPONSABILIDADE_CIVIL_EMPREGADOR,
ENGENHARIA_FUNDACAO,
ENGENHARIA_STANDS_DE_VENDA,
ENGENHARIA_TRANSPORTE_TERRESTRE,
ENGENHARIA_TUMULTOS_GREVES_E_LOCKOUT,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
BANCOS_INFIDELIDADE_DE_FUNCIONARIOS,
BANCOS_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
BANCOS_VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
BANCOS_VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
RNO_ALAGAMENTO_INUNDACAO,
RNO_ALUGUEL_PERDA_OU_PAGAMENTO,
RNO_ANUNCIOS_LUMINOSOS,
RNO_BAGAGEM,
RNO_BASICA_INCENDIO_RAIO_EXPLOSAO,
RNO_BASICA_DANOS_MATERIAIS,
RNO_BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
RNO_BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
RNO_CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
RNO_DANOS_ELETRICOS,
RNO_DANOS_NA_FABRICACAO,
RNO_DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS_SPRINKLERS,
RNO_DESMORONAMENTO,
RNO_DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
RNO_DESPESAS_EXTRAORDINARIAS,
RNO_DESPESAS_FIXA,
RNO_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
RNO_EQUIPAMENTOS_ARRENDADOS,
RNO_EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
RNO_EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
RNO_EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
RNO_EQUIPAMENTOS_ELETRONICOS,
RNO_EQUIPAMENTOS_ESTACIONARIOS,
RNO_EQUIPAMENTOS_MOVEIS,
RNO_EQUIPAMENTOS_PORTATEIS,
RNO_FIDELIDADE_DE_EMPREGADOS,
RNO_HONORARIOS_DE_PERITOS,
RNO_IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
RNO_IMPACTO_DE_VEICULOS_TERRESTRES,
RNO_LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
RNO_LUCROS_CESSANTES,
RNO_MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
RNO_PATIOS,
RNO_QUEBRA_DE_MAQUINAS,
RNO_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RNO_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
RNO_ROUBO_DE_BENS_DE_HOSPEDES,
RNO_ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
RNO_ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
RNO_ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
RNO_TERRORISMO_E_SABOTAGEM,
RNO_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
RNO_VAZAMENTO_DE_TUBULACOES_E_TANQUES,
RNO_VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
RNO_VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
isSeparateContractingAllowed:
description: Permissão para Contratação Separada
type: boolean
maxLMI:
description: Valor de Limite Máximo de Indenização (LMI) solicitado
allOf:
- $ref: '#/components/schemas/AmountDetails'
deductible:
description: Informações de franquia
allOf:
- $ref: '#/components/schemas/Deductible'
POS:
description: Informações de POS
allOf:
- $ref: '#/components/schemas/POS'
internalCode:
description: "Código interno da cobertura da seguradora"
type: string
maxLength: 500
gracePeriod:
type: integer
maxLength: 5
description: "Período de carência. OBS: Obrigatório, se houver"
gracePeriodicity:
type: string
description: "Periodicidade da carência. OBS: Obrigatório, se houver"
example: DIA
enum: [DIA,
MES,
ANO]
gracePeriodCountingMethod:
type: string
description: "Indicador de dias úteis ou corridos da carência. OBS: Obrigatório, se houver"
example: DIAS_UTEIS
enum: [DIAS_UTEIS,
DIAS_CORRIDOS]
gracePeriodStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de início da carência. OBS: Obrigatório, se houver"
gracePeriodEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim da carência. OBS: Obrigatório, se houver"
ResultQuotePatrimonialCondominium:
type: object
description: Objeto que agrupa dados específicos do ramo de cotação.
required:
- coverages
- mainActivity
- isLegallyConstituted
- condominiumType
properties:
mainActivity:
description: "Principal atividade do local de risco"
type: string
example: COMERCIO
enum: [COMERCIO,
INDUSTRIA,
SERVICO]
isLegallyConstituted:
description: O condomínio está legalmente constituído?
type: boolean
registryStarted:
description: O registro na receita federal foi iniciado? Condicional ao campo "isLegallyConstituted" ser false
type: boolean
timeRegistry:
description: O registro na receita federal possui mais de 12 meses? Condicional ao campo "registryStarted" ser true
type: boolean
condominiumType:
description: |
"Trata-se de condomínio do tipo:
1. Condomínio Polo Industrial
2. Condomínio Logístico / Galpão
3. Condomínio Armazém/Depósito
4. Condomínio Garagem de veículos
5. Condomínio Shopping center"
Caso se encaixe em algum dos itens acima, a cotação será classificada como Lead.
type: boolean
termStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de vigência dentro de 24 horas"
termEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim de vigência até as 24 horas"
insuranceTermStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Não permite retroagir vigência permite - vigência posterior"
insuranceType:
type: string
description: Tipo de Seguro
example: NOVO
enum: [NOVO,
RENOVACAO]
policyId:
description: Número para identificar a apólice atual
type: string
maxLength: 100
example: "111111"
insurerId:
description: Nome para identifcar a congênere de renovação
type: string
maxLength: 100
currency:
description: Moeda de emissão do contrato de acordo com ISO-4217.
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
basicCoverageIndex:
description: "Indicador de Modalidade de Cobertura Básica (Caso contrato de Compreensivo Condomínio)"
type: string
example: SIMPLES
enum: [SIMPLES,
AMPLA]
maxLMG:
description: Valor Limite máximo de garantia (LMG)
allOf:
- $ref: '#/components/schemas/AmountDetails'
includesAssistanceServices:
description: Deseja contratação de serviços de assistência?
type: boolean
claimAmount:
description: "Valor do sinistro De acordo com ISO-4217."
allOf:
- $ref: '#/components/schemas/AmountDetails'
claimDescription:
description: Descrição do sinistro
type: string
maxLength: 100
insuredObject:
$ref: '#/components/schemas/QuotePatrimonialCondominiumResultInsuredObject'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/QuotePatrimonialCondominiumCoverage'
QuotePatrimonialCondominiumResultInsuredObject:
type: object
description: Objeto que agrupa os dados de objeto segurado.
required:
- identification
properties:
identification:
type: string
maxLength: 100
description: "Identificador do objeto segurado. Obs.: Para Fiança Locatícia, é a identificação do Contrato de Locação."
structuringType:
description: "Indica o tipo de estruturação"
type: string
example: CONDOMINIO_VERTICAL
enum: [
CONDOMINIO_VERTICAL,
CONDOMINIO_HORIZONTAL,
MISTO]
propertyType:
description: Tipo docondomínio segurado
type: string
example: CONDOMINIO_EXCLUSIVAMENTE_RESIDENCIAL
enum: [
CONDOMINIO_RESIDENCIAL_COM_COMERCIO_NO_TERREO,
CONDOMINIO_DE_ESCRITORIOS_CONSULTORIOS,
CONDOMINIO_RESIDENCIAL_COM_ESCRITORIO_E_COMERCIO,
CONDOMINIO_DE_ESCRITORIOS_CONSULTORIOS_COM_COMERCIO_NO_TERREO,
CONDOMINIO_FLAT_APART_HOTEL,
CONDOMINIO_FLAT_APART_HOTEL_COM_COMERCIO,
CONDOMINIO_EXCLUSIVAMENTE_COMERCIAL,
CONDOMINIO_EXCLUSIVAMENTE_RESIDENCIAL
]
hasElevator:
description: O Condomínio Possui Elevador?
type: boolean
isFullyOrPartiallyListed:
description: O Condomínio é total ou parcialmente tombado pelo patrimônio histórico?
type: boolean
numberOfBlocks:
description: Qual a quantidade de blocos?
type: string
maxLength: 100
example: "3"
condominiumAge:
description: Qual a idade, em anos, do Condomínio?
type: string
maxLength: 100
example: "20"
hasReuseOfWater:
description: Participa de algum programa de reuso ou reaproveitamento de água?
type: boolean
securityProtection:
description: Quais itens de segurança dispõe o condomínio?
type: array
items:
type: string
example: PORTEIRO_ELETRONICO
enum: [
CAMERA_CFTV,
PORTARIA_VINTE_E_QUATRO_HORAS,
ALARME_DISPOSITIVO_ANTI_FURTO,
VIGILANCIA_TERCEIRIZADA,
CONDOMINIO_FECHADO,
CERCA_ELETRICA,
GRADES_EM_JANELAS_E_PORTAS,
PORTEIRO_ELETRONICO,
CATRACA_ELETRONICA_DE_ACESSO,
NAO_POSSUI]
riskLocationInfo:
$ref: '#/components/schemas/QuotePatrimonialCondominiumRiskLocation'
indenizationWithoutDepreciation:
description: "Contratar seguro com a indenização sem aplicação de depreciação dos bens segurados (valor de novo)"
type: boolean
wasThereAClaim:
description: Houve sinistro no local nos últimos 12 meses?
type: boolean
claimNotifications:
description: Lista de sinistros e valores
type: array
items:
$ref: '#/components/schemas/ClaimNotification'
QuoteResultPayment:
type: object
required:
- amount
- paymentType
properties:
amount:
description: Valor da parcela
allOf:
- $ref: '#/components/schemas/AmountDetails'
paymentType:
description: "Meio de Pagamento Obs: Obrigatório caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO e LIQUIDACAO_DE_CUSTO_DE_AQUISICAO"
type: string
example: BOLETO
enum: [BOLETO,
TED,
TEF,
CARTAO,
DOC,
CHEQUE,
DESCONTO_EM_FOLHA,
PIX,
DINHEIRO_EM_ESPECIE,
OUTROS]
QuoteResultPremiumCoverage:
type: object
required:
- branch
- code
- premiumAmount
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: "0111"
code:
type: string
description: Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
example: RESIDENCIAL_IMOVEL_BASICA
enum: [
RESIDENCIAL_IMOVEL_BASICA,
RESIDENCIAL_IMOVEL_AMPLA,
RESIDENCIAL_INCENDIO,
RESIDENCIAL_QUEDA_DE_RAIO,
RESIDENCIAL_EXPLOSAO,
RESIDENCIAL_IMPACTO_DE_AERONAVES,
RESIDENCIAL_ALAGAMENTO,
RESIDENCIAL_DANOS_ELETRICOS,
RESIDENCIAL_DANOS_POR_AGUA,
RESIDENCIAL_RESPONSABILIDADE_CIVIL_FAMILIAR,
RESIDENCIAL_VENDAVAL,
RESIDENCIAL_DANOS_A_EQUIPAMENTOS_ELETRONICOS,
RESIDENCIAL_TERREMOTO,
RESIDENCIAL_PERDA_E_PAGAMENTO_DE_ALUGUEL,
RESIDENCIAL_ROUBO_E_SUBTRACAO_DE_BENS,
RESIDENCIAL_QUEBRA_DE_VIDROS,
RESIDENCIAL_IMPACTO_DE_VEICULOS,
RESIDENCIAL_DESMORONAMENTO,
RESIDENCIAL_TUMULTOS_GREVES_E_LOCKOUTS,
RESIDENCIAL_DESPESAS_EXTRAORDINARIAS,
RESIDENCIAL_JOIAS_E_OBRAS_DE_ARTE,
CONDOMINIAL_COBERTURA_BASICA_SIMPLES,
CONDOMINIAL_COBERTURA_BASICA_AMPLA,
CONDOMINIAL_ANUNCIOS_LUMINOSOS,
CONDOMINIAL_DANOS_AO_JARDIM,
CONDOMINIAL_DANOS_ELETRICOS,
CONDOMINIAL_DESMORONAMENTO,
CONDOMINIAL_DESPESAS_COM_ALUGUEL,
CONDOMINIAL_EQUIPAMENTOS,
CONDOMINIAL_FIDELIDADE_DE_EMPREGADOS,
CONDOMINIAL_IMPACTO_DE_VEICULOS,
CONDOMINIAL_VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
CONDOMINIAL_LUCROS_CESSANTES,
CONDOMINIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
CONDOMINIAL_RESPONSABILIDADE_CIVIL,
CONDOMINIAL_ROUBO,
CONDOMINIAL_VALORES,
CONDOMINIAL_VAZAMENTO,
CONDOMINIAL_VENDAVAL,
CONDOMINIAL_ALAGAMENTO,
CONDOMINIAL_TUMULTO,
EMPRESARIAL_INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
EMPRESARIAL_DANOS_ELETRICOS,
EMPRESARIAL_VENDAVAL_ATE_FUMACA,
EMPRESARIAL_DESMORONAMENTO,
EMPRESARIAL_ALAGAMENTO_E_INUNDACAO,
EMPRESARIAL_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
EMPRESARIAL_ROUBO_E_FURTO_QUALIFICADO,
EMPRESARIAL_VALORES,
EMPRESARIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
EMPRESARIAL_ANUNCIOS_LUMINOSOS,
EMPRESARIAL_FIDELIDADE_DE_EMPREGADOS,
EMPRESARIAL_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
EMPRESARIAL_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
EMPRESARIAL_DERRAME,
EMPRESARIAL_VAZAMENTO,
EMPRESARIAL_EQUIPAMENTOS,
EMPRESARIAL_QUEBRA_DE_MAQUINAS,
EMPRESARIAL_RESPONSABILIDADE_CIVIL,
EMPRESARIAL_DESPESAS_EXTRAORDINARIAS,
EMPRESARIAL_LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
EMPRESARIAL_PERDA_OU_PAGAMENTO_DE_ALUGUEL,
EMPRESARIAL_PEQUENAS_OBRAS_DE_ENGENHARIA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
DIVERSOS_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
CESSANTES_LUCRO_BRUTO_LUCRO_LIQUIDO_E_DESPESAS_FIXAS,
CESSANTES_LUCRO_LIQUIDO,
CESSANTES_DESPESAS_FIXAS,
CESSANTES_PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
ENGENHARIA_OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
ENGENHARIA_AFRETAMENTOS_DE_AERONAVES,
ENGENHARIA_ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
ENGENHARIA_DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
ENGENHARIA_DANOS_MORAIS,
ENGENHARIA_DESPESAS_COM_DESENTULHO_DO_LOCAL,
ENGENHARIA_DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
ENGENHARIA_DESPESAS_EXTRAORDINARIAS,
ENGENHARIA_EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
ENGENHARIA_EQUIPAMENTOS_MOVEIS_OU_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
ENGENHARIA_FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
ENGENHARIA_HONORARIOS_DE_PERITO,
ENGENHARIA_INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_TRINTA_DIAS_EXCETO_PARA_REFORMAS_OU_AMPLIACOES,
ENGENHARIA_LUCROS_CESSANTES,
ENGENHARIA_MANUTENCAO_AMPLA_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_MANUTENCAO_SIMPLES_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_OBRAS_CONCLUIDAS,
ENGENHARIA_OBRAS_TEMPORARIAS,
ENGENHARIA_OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
ENGENHARIA_PROPRIEDADES_CIRCUNVIZINHAS,
ENGENHARIA_RECOMPOSICAO_DE_DOCUMENTOS,
ENGENHARIA_RESPONSABILIDADE_CIVIL_EMPREGADOR,
ENGENHARIA_FUNDACAO,
ENGENHARIA_STANDS_DE_VENDA,
ENGENHARIA_TRANSPORTE_TERRESTRE,
ENGENHARIA_TUMULTOS_GREVES_E_LOCKOUT,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
BANCOS_INFIDELIDADE_DE_FUNCIONARIOS,
BANCOS_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
BANCOS_VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
BANCOS_VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
RNO_ALAGAMENTO_INUNDACAO,
RNO_ALUGUEL_PERDA_OU_PAGAMENTO,
RNO_ANUNCIOS_LUMINOSOS,
RNO_BAGAGEM,
RNO_BASICA_INCENDIO_RAIO_EXPLOSAO,
RNO_BASICA_DANOS_MATERIAIS,
RNO_BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
RNO_BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
RNO_CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
RNO_DANOS_ELETRICOS,
RNO_DANOS_NA_FABRICACAO,
RNO_DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS_SPRINKLERS,
RNO_DESMORONAMENTO,
RNO_DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
RNO_DESPESAS_EXTRAORDINARIAS,
RNO_DESPESAS_FIXA,
RNO_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
RNO_EQUIPAMENTOS_ARRENDADOS,
RNO_EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
RNO_EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
RNO_EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
RNO_EQUIPAMENTOS_ELETRONICOS,
RNO_EQUIPAMENTOS_ESTACIONARIOS,
RNO_EQUIPAMENTOS_MOVEIS,
RNO_EQUIPAMENTOS_PORTATEIS,
RNO_FIDELIDADE_DE_EMPREGADOS,
RNO_HONORARIOS_DE_PERITOS,
RNO_IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
RNO_IMPACTO_DE_VEICULOS_TERRESTRES,
RNO_LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
RNO_LUCROS_CESSANTES,
RNO_MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
RNO_PATIOS,
RNO_QUEBRA_DE_MAQUINAS,
RNO_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RNO_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
RNO_ROUBO_DE_BENS_DE_HOSPEDES,
RNO_ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
RNO_ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
RNO_ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
RNO_TERRORISMO_E_SABOTAGEM,
RNO_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
RNO_VAZAMENTO_DE_TUBULACOES_E_TANQUES,
RNO_VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
RNO_VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
internalCode:
description: "Código interno da cobertura da seguradora"
type: string
maxLength: 500
premiumAmount:
description: Valor de Prêmio da Cobertura
allOf:
- $ref: '#/components/schemas/AmountDetails'
PolicyDataPatrimonialHome:
$ref: '#/components/schemas/PolicyDataPatrimonial'
QuoteDataPatrimonialHome:
type: object
description: Objeto que agrupa dados específicos do ramo de cotação.
required:
- coverages
- hasCommercialActivity
- isCollectiveStipulated
- hasOneRiskLocation
properties:
hasCommercialActivity:
description: "Existe algum objeto segurado que possui atividade comercial de produção, manufatura, atendimento presencial na Residência?"
type: boolean
isCollectiveStipulated:
description: "Apólice é coletiva ou por estipulação?"
type: boolean
hasOneRiskLocation:
description: "Trata-se uma apólice com apenas um local de risco?"
type: boolean
termStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de vigência dentro de 24 horas"
termEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim de vigência até as 24 horas"
insuranceType:
type: string
description: Tipo de Seguro
example: NOVO
enum: [NOVO,
RENOVACAO]
policyId:
description: Número para identificar a apólice atual
type: string
maxLength: 100
example: "111111"
insurerId:
description: Nome para identifcar a congênere de renovação
type: string
maxLength: 100
currency:
description: Moeda de emissão do contrato de acordo com ISO-4217.
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
maxLMG:
description: Valor Limite máximo de garantia (LMG)
allOf:
- $ref: '#/components/schemas/AmountDetails'
includesAssistanceServices:
description: Deseja contratação de serviços de assistência
type: boolean
insuredObject:
$ref: '#/components/schemas/QuotePatrimonialHomeInsuredObject'
beneficiaries:
type: array
description: Lista de dados de beneficiários.
items:
$ref: '#/components/schemas/QuotePatrimonialHomeBeneficiary'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/QuotePatrimonialHomeCoverage'
QuotePatrimonialHomeInsuredObject:
type: object
description: Objeto que agrupa os dados de objeto segurado.
properties:
identification:
type: string
maxLength: 100
description: "Identificador do objeto segurado. Obs.: Para Fiança Locatícia, é a identificação do Contrato de Locação."
propertyType:
description: Indica o tipo do imóvel ou condomínio segurado
type: string
example: CASA
enum: [
CASA,
APARTAMENTO,
CASA_EM_CONDOMINIO
]
geographicRegion:
description: Descrição da região geográfica
type: string
example: ZONA_URBANA
enum: [
ZONA_URBANA,
ZONA_RURAL
]
propertiesForCoverage:
description: "Deseja cobertura para:"
type: string
example: PREDIO_E_CONTEUDO
enum: [
PREDIO_E_CONTEUDO,
APENAS_PARA_PREDIO,
APENAS_CONTEUDO
]
indenizationWithoutDepreciation:
description: Contratar Valor de novo? (sem depreciação)
type: boolean
riskLocationInfo:
$ref: '#/components/schemas/QuotePatrimonialHomeRiskLocation'
wasThereAClaim:
description: Houve sinistro no local nos últimos 12 meses?
type: boolean
QuotePatrimonialHomeBeneficiary:
type: object
properties:
identification:
description: Documento de Identificação do Beneficiário
type: string
maxLength: 60
example: "12345678900"
identificationType:
description: Tipo de Documento do Beneficiário
type: string
example: CPF
enum: [
CPF,
CNPJ,
OUTROS
]
identificationTypeOthers:
description: Descrição para quando o tipo de documento do beneficiários for outros.
type: string
example: PASSAPORTE
name:
description: Nome ou Razão Social do Beneficiário
type: string
maxLength: 60
example: "Nome Sobrenome"
QuotePatrimonialHomeCoverage:
type: object
required:
- branch
- code
- isSeparateContractingAllowed
- maxLMI
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: "0111"
code:
type: string
description: Código da cobertura, conforme Anexo II do Manual de Escopo de Dados
example: RESIDENCIAL_IMOVEL_BASICA
enum: [
RESIDENCIAL_IMOVEL_BASICA,
RESIDENCIAL_IMOVEL_AMPLA,
RESIDENCIAL_INCENDIO,
RESIDENCIAL_QUEDA_DE_RAIO,
RESIDENCIAL_EXPLOSAO,
RESIDENCIAL_IMPACTO_DE_AERONAVES,
RESIDENCIAL_ALAGAMENTO,
RESIDENCIAL_DANOS_ELETRICOS,
RESIDENCIAL_DANOS_POR_AGUA,
RESIDENCIAL_RESPONSABILIDADE_CIVIL_FAMILIAR,
RESIDENCIAL_VENDAVAL,
RESIDENCIAL_DANOS_A_EQUIPAMENTOS_ELETRONICOS,
RESIDENCIAL_TERREMOTO,
RESIDENCIAL_PERDA_E_PAGAMENTO_DE_ALUGUEL,
RESIDENCIAL_ROUBO_E_SUBTRACAO_DE_BENS,
RESIDENCIAL_QUEBRA_DE_VIDROS,
RESIDENCIAL_IMPACTO_DE_VEICULOS,
RESIDENCIAL_DESMORONAMENTO,
RESIDENCIAL_TUMULTOS_GREVES_E_LOCKOUTS,
RESIDENCIAL_DESPESAS_EXTRAORDINARIAS,
RESIDENCIAL_JOIAS_E_OBRAS_DE_ARTE,
CONDOMINIAL_COBERTURA_BASICA_SIMPLES,
CONDOMINIAL_COBERTURA_BASICA_AMPLA,
CONDOMINIAL_ANUNCIOS_LUMINOSOS,
CONDOMINIAL_DANOS_AO_JARDIM,
CONDOMINIAL_DANOS_ELETRICOS,
CONDOMINIAL_DESMORONAMENTO,
CONDOMINIAL_DESPESAS_COM_ALUGUEL,
CONDOMINIAL_EQUIPAMENTOS,
CONDOMINIAL_FIDELIDADE_DE_EMPREGADOS,
CONDOMINIAL_IMPACTO_DE_VEICULOS,
CONDOMINIAL_VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
CONDOMINIAL_LUCROS_CESSANTES,
CONDOMINIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
CONDOMINIAL_RESPONSABILIDADE_CIVIL,
CONDOMINIAL_ROUBO,
CONDOMINIAL_VALORES,
CONDOMINIAL_VAZAMENTO,
CONDOMINIAL_VENDAVAL,
CONDOMINIAL_ALAGAMENTO,
CONDOMINIAL_TUMULTO,
EMPRESARIAL_INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
EMPRESARIAL_DANOS_ELETRICOS,
EMPRESARIAL_VENDAVAL_ATE_FUMACA,
EMPRESARIAL_DESMORONAMENTO,
EMPRESARIAL_ALAGAMENTO_E_INUNDACAO,
EMPRESARIAL_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
EMPRESARIAL_ROUBO_E_FURTO_QUALIFICADO,
EMPRESARIAL_VALORES,
EMPRESARIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
EMPRESARIAL_ANUNCIOS_LUMINOSOS,
EMPRESARIAL_FIDELIDADE_DE_EMPREGADOS,
EMPRESARIAL_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
EMPRESARIAL_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
EMPRESARIAL_DERRAME,
EMPRESARIAL_VAZAMENTO,
EMPRESARIAL_EQUIPAMENTOS,
EMPRESARIAL_QUEBRA_DE_MAQUINAS,
EMPRESARIAL_RESPONSABILIDADE_CIVIL,
EMPRESARIAL_DESPESAS_EXTRAORDINARIAS,
EMPRESARIAL_LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
EMPRESARIAL_PERDA_OU_PAGAMENTO_DE_ALUGUEL,
EMPRESARIAL_PEQUENAS_OBRAS_DE_ENGENHARIA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
DIVERSOS_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
CESSANTES_LUCRO_BRUTO_LUCRO_LIQUIDO_E_DESPESAS_FIXAS,
CESSANTES_LUCRO_LIQUIDO,
CESSANTES_DESPESAS_FIXAS,
CESSANTES_PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
ENGENHARIA_OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
ENGENHARIA_AFRETAMENTOS_DE_AERONAVES,
ENGENHARIA_ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
ENGENHARIA_DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
ENGENHARIA_DANOS_MORAIS,
ENGENHARIA_DESPESAS_COM_DESENTULHO_DO_LOCAL,
ENGENHARIA_DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
ENGENHARIA_DESPESAS_EXTRAORDINARIAS,
ENGENHARIA_EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
ENGENHARIA_EQUIPAMENTOS_MOVEIS_OU_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
ENGENHARIA_FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
ENGENHARIA_HONORARIOS_DE_PERITO,
ENGENHARIA_INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_TRINTA_DIAS_EXCETO_PARA_REFORMAS_OU_AMPLIACOES,
ENGENHARIA_LUCROS_CESSANTES,
ENGENHARIA_MANUTENCAO_AMPLA_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_MANUTENCAO_SIMPLES_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_OBRAS_CONCLUIDAS,
ENGENHARIA_OBRAS_TEMPORARIAS,
ENGENHARIA_OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
ENGENHARIA_PROPRIEDADES_CIRCUNVIZINHAS,
ENGENHARIA_RECOMPOSICAO_DE_DOCUMENTOS,
ENGENHARIA_RESPONSABILIDADE_CIVIL_EMPREGADOR,
ENGENHARIA_FUNDACAO,
ENGENHARIA_STANDS_DE_VENDA,
ENGENHARIA_TRANSPORTE_TERRESTRE,
ENGENHARIA_TUMULTOS_GREVES_E_LOCKOUT,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
BANCOS_INFIDELIDADE_DE_FUNCIONARIOS,
BANCOS_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
BANCOS_VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
BANCOS_VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
RNO_ALAGAMENTO_INUNDACAO,
RNO_ALUGUEL_PERDA_OU_PAGAMENTO,
RNO_ANUNCIOS_LUMINOSOS,
RNO_BAGAGEM,
RNO_BASICA_INCENDIO_RAIO_EXPLOSAO,
RNO_BASICA_DANOS_MATERIAIS,
RNO_BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
RNO_BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
RNO_CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
RNO_DANOS_ELETRICOS,
RNO_DANOS_NA_FABRICACAO,
RNO_DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS_SPRINKLERS,
RNO_DESMORONAMENTO,
RNO_DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
RNO_DESPESAS_EXTRAORDINARIAS,
RNO_DESPESAS_FIXA,
RNO_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
RNO_EQUIPAMENTOS_ARRENDADOS,
RNO_EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
RNO_EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
RNO_EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
RNO_EQUIPAMENTOS_ELETRONICOS,
RNO_EQUIPAMENTOS_ESTACIONARIOS,
RNO_EQUIPAMENTOS_MOVEIS,
RNO_EQUIPAMENTOS_PORTATEIS,
RNO_FIDELIDADE_DE_EMPREGADOS,
RNO_HONORARIOS_DE_PERITOS,
RNO_IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
RNO_IMPACTO_DE_VEICULOS_TERRESTRES,
RNO_LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
RNO_LUCROS_CESSANTES,
RNO_MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
RNO_PATIOS,
RNO_QUEBRA_DE_MAQUINAS,
RNO_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RNO_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
RNO_ROUBO_DE_BENS_DE_HOSPEDES,
RNO_ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
RNO_ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
RNO_ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
RNO_TERRORISMO_E_SABOTAGEM,
RNO_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
RNO_VAZAMENTO_DE_TUBULACOES_E_TANQUES,
RNO_VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
RNO_VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
isSeparateContractingAllowed:
description: Permissão para Contratação Separada
type: boolean
maxLMI:
description: Valor de Limite Máximo de Indenização (LMI) solicitado
allOf:
- $ref: '#/components/schemas/AmountDetails'
internalCode:
description: "Código interno da cobertura da seguradora"
type: string
maxLength: 500
QuotePatrimonialHomeRiskLocation:
type: object
description: Objeto que agrupa dados de local de risco.
properties:
isSameAsTheProponent:
type: boolean
description: Endereço do Local de Risco é o mesmo do proponente?
address:
type: string
maxLength: 100
description: Logradouro do Local de Risco
example: "Avenida Paulista, 2000"
additionalInfo:
type: string
maxLength: 100
description: Complemento *
example: "Apartamento 1304"
districtName:
type: string
maxLength: 100
description: Bairro *
example: "Cerqueira César"
townName:
type: string
maxLength: 100
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
description: Município
example: "São Paulo"
countrySubDivision:
type: string
description: Sigla da Unidade da Federação
example: AC
enum: [AC,
AL,
AP,
AM,
BA,
CE,
DF,
ES,
GO,
MA,
MT,
MS,
MG,
PA,
PB,
PR,
PE,
PI,
RJ,
RN,
RS,
RO,
RR,
SC,
SP,
SE,
TO]
postCode:
type: string
maxLength: 8
description: CEP
example: "1310200"
propertyUsageType:
description: Tipo de moradia
type: string
example: HABITUAL
enum: [
HABITUAL,
VERANEIO,
DESOCUPADO,
IMOVEL_COM_ATIVIDADE_COMERCIAL_REMUNERADA,
ALUGUEL_POR_TEMPORADA
]
propertyBuildType:
description: Tipo de construção
type: string
example: ALVENARIA
enum: [
ALVENARIA,
MADEIRA,
MISTA]
isListedDisappropriatedCondemned:
description: Imóvel tombado, desapropriado ou condenado por órgão público?
type: boolean
isUnderConstructionRenovation:
description: O imóvel está em construção ou reforma?
type: boolean
securityProtection:
description: O imóvel possui sistemas de protecionais de segurança?
type: array
items:
type: string
example: CAMERA_CFTV
enum: [
CAMERA_CFTV,
PORTARIA_HORAS,
ALARME_DISPOSITIVO_ANTI_FURTO,
VIGILANCIA_TERCEIRIZADA,
CONDOMINIO_FECHADO,
CERCA_ELETRICA,
GRADES_EM_JANELAS_E_PORTAS,
NAO_POSSUI]
fireProtection:
description: O imóvel possui sistemas de protecionais de incêndio?
type: array
items:
type: string
example: EXTINTOR
enum: [
EXTINTOR,
HIDRANTES,
SPRINKLER_CHUVEIROS_AUTOMATICOS,
DETECTOR_DE_FUMACA,
ALARME_DE_INCENDIO,
NAO_POSSUI]
propertyUseType:
description: Uso do imóvel
type: string
example: PROPRIO
enum: [
PROPRIO,
ALUGADO
]
QuoteStatusPatrimonialHome:
type: object
description: Objeto que agrupa todas as informações da cotação. Condicional ao pedido de cotação já ter sido aceita.
required:
- quoteCustomer
- quoteData
- quotes
properties:
quoteCustomer:
description: Objeto que agrupa as categorias de dados cadastrais do cliente.
oneOf:
- $ref: '#/components/schemas/PersonalQuoteCustomer'
- $ref: '#/components/schemas/BusinessQuoteCustomer'
quoteData:
$ref: '#/components/schemas/ResultQuotePatrimonialHome'
quotes:
type: array
minItems: 1
description: Lista de cotações enviadas pela seguradora.
items:
required:
- premiumInfo
- coverages
- quoteDateTime
- insurerQuoteId
type: object
description: Informações da cotação enviada pela seguradora
properties:
insurerQuoteId:
type: string
description: |
Id da proposta da segurada
quoteDateTime:
type: string
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2023-05-21T08:30:00Z'
description: Data e hora da cotação
susepProcessNumbers:
description: "Número do Processo Susep das Coberturas"
type: array
items:
type: string
maxLength: 50
updatingIndex:
description: Índice de atualização dos valores do contrato
type: string
example: IPCA
enum: [
IPCA,
IGP_M,
INPC,
OUTROS,
NAO_SE_APLICA
]
updatingIndexOthers:
description: Descrição para quando o tipo de índice de atualização for outros.
type: string
updatingPeriodicity:
description: Periodicidade de atualização
type: string
example: ANUAL
enum: [
ANUAL,
OUTROS
]
updatingPeriodicityOthers:
description: Descrição para quando a periodicidade de atualização for outros.
type: string
example: MENSAL
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/QuotePatrimonialHomeResultCoverage'
assistances:
type: array
description: Lista que agrupa dados de assistências.
items:
$ref: '#/components/schemas/QuoteResultAssistance'
premiumInfo:
$ref: '#/components/schemas/QuoteResultPremium'
quoteCustomData:
$ref: '#/components/schemas/QuoteCustomData'
ResultQuotePatrimonialHome:
type: object
description: Objeto que agrupa dados específicos do ramo de cotação.
required:
- coverages
- hasCommercialActivity
- isCollectiveStipulated
- hasOneRiskLocation
properties:
hasCommercialActivity:
description: "Existe algum objeto segurado que possui atividade comercial de produção, manufatura, atendimento presencial na Residência?"
type: boolean
isCollectiveStipulated:
description: "Apólice é coletiva ou por estipulação?"
type: boolean
hasOneRiskLocation:
description: "Trata-se uma apólice com apenas um local de risco?"
type: boolean
termStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de vigência dentro de 24 horas"
termEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim de vigência até as 24 horas"
insuranceType:
type: string
description: Tipo de Seguro
example: NOVO
enum: [NOVO,
RENOVACAO]
policyId:
description: Número para identificar a apólice atual
type: string
maxLength: 100
example: "111111"
insurerId:
description: Nome para identifcar a congênere de renovação
type: string
maxLength: 100
currency:
description: Moeda de emissão do contrato de acordo com ISO-4217.
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
maxLMG:
description: Valor Limite máximo de garantia (LMG)
allOf:
- $ref: '#/components/schemas/AmountDetails'
includesAssistanceServices:
description: Deseja contratação de serviços de assistência
type: boolean
insuredObject:
$ref: '#/components/schemas/QuotePatrimonialHomeResultInsuredObject'
beneficiaries:
type: array
description: Lista de dados de beneficiários.
items:
$ref: '#/components/schemas/QuotePatrimonialHomeBeneficiary'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/QuotePatrimonialHomeCoverage'
QuotePatrimonialHomeResultCoverage:
type: object
required:
- branch
- code
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: "0111"
code:
type: string
description: Código da cobertura, conforme Anexo II do Manual de Escopo de Dados
example: RESIDENCIAL_IMOVEL_BASICA
enum: [
RESIDENCIAL_IMOVEL_BASICA,
RESIDENCIAL_IMOVEL_AMPLA,
RESIDENCIAL_INCENDIO,
RESIDENCIAL_QUEDA_DE_RAIO,
RESIDENCIAL_EXPLOSAO,
RESIDENCIAL_IMPACTO_DE_AERONAVES,
RESIDENCIAL_ALAGAMENTO,
RESIDENCIAL_DANOS_ELETRICOS,
RESIDENCIAL_DANOS_POR_AGUA,
RESIDENCIAL_RESPONSABILIDADE_CIVIL_FAMILIAR,
RESIDENCIAL_VENDAVAL,
RESIDENCIAL_DANOS_A_EQUIPAMENTOS_ELETRONICOS,
RESIDENCIAL_TERREMOTO,
RESIDENCIAL_PERDA_E_PAGAMENTO_DE_ALUGUEL,
RESIDENCIAL_ROUBO_E_SUBTRACAO_DE_BENS,
RESIDENCIAL_QUEBRA_DE_VIDROS,
RESIDENCIAL_IMPACTO_DE_VEICULOS,
RESIDENCIAL_DESMORONAMENTO,
RESIDENCIAL_TUMULTOS_GREVES_E_LOCKOUTS,
RESIDENCIAL_DESPESAS_EXTRAORDINARIAS,
RESIDENCIAL_JOIAS_E_OBRAS_DE_ARTE,
CONDOMINIAL_COBERTURA_BASICA_SIMPLES,
CONDOMINIAL_COBERTURA_BASICA_AMPLA,
CONDOMINIAL_ANUNCIOS_LUMINOSOS,
CONDOMINIAL_DANOS_AO_JARDIM,
CONDOMINIAL_DANOS_ELETRICOS,
CONDOMINIAL_DESMORONAMENTO,
CONDOMINIAL_DESPESAS_COM_ALUGUEL,
CONDOMINIAL_EQUIPAMENTOS,
CONDOMINIAL_FIDELIDADE_DE_EMPREGADOS,
CONDOMINIAL_IMPACTO_DE_VEICULOS,
CONDOMINIAL_VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
CONDOMINIAL_LUCROS_CESSANTES,
CONDOMINIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
CONDOMINIAL_RESPONSABILIDADE_CIVIL,
CONDOMINIAL_ROUBO,
CONDOMINIAL_VALORES,
CONDOMINIAL_VAZAMENTO,
CONDOMINIAL_VENDAVAL,
CONDOMINIAL_ALAGAMENTO,
CONDOMINIAL_TUMULTO,
EMPRESARIAL_INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
EMPRESARIAL_DANOS_ELETRICOS,
EMPRESARIAL_VENDAVAL_ATE_FUMACA,
EMPRESARIAL_DESMORONAMENTO,
EMPRESARIAL_ALAGAMENTO_E_INUNDACAO,
EMPRESARIAL_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
EMPRESARIAL_ROUBO_E_FURTO_QUALIFICADO,
EMPRESARIAL_VALORES,
EMPRESARIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
EMPRESARIAL_ANUNCIOS_LUMINOSOS,
EMPRESARIAL_FIDELIDADE_DE_EMPREGADOS,
EMPRESARIAL_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
EMPRESARIAL_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
EMPRESARIAL_DERRAME,
EMPRESARIAL_VAZAMENTO,
EMPRESARIAL_EQUIPAMENTOS,
EMPRESARIAL_QUEBRA_DE_MAQUINAS,
EMPRESARIAL_RESPONSABILIDADE_CIVIL,
EMPRESARIAL_DESPESAS_EXTRAORDINARIAS,
EMPRESARIAL_LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
EMPRESARIAL_PERDA_OU_PAGAMENTO_DE_ALUGUEL,
EMPRESARIAL_PEQUENAS_OBRAS_DE_ENGENHARIA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
DIVERSOS_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
CESSANTES_LUCRO_BRUTO_LUCRO_LIQUIDO_E_DESPESAS_FIXAS,
CESSANTES_LUCRO_LIQUIDO,
CESSANTES_DESPESAS_FIXAS,
CESSANTES_PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
ENGENHARIA_OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
ENGENHARIA_AFRETAMENTOS_DE_AERONAVES,
ENGENHARIA_ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
ENGENHARIA_DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
ENGENHARIA_DANOS_MORAIS,
ENGENHARIA_DESPESAS_COM_DESENTULHO_DO_LOCAL,
ENGENHARIA_DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
ENGENHARIA_DESPESAS_EXTRAORDINARIAS,
ENGENHARIA_EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
ENGENHARIA_EQUIPAMENTOS_MOVEIS_OU_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
ENGENHARIA_FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
ENGENHARIA_HONORARIOS_DE_PERITO,
ENGENHARIA_INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_TRINTA_DIAS_EXCETO_PARA_REFORMAS_OU_AMPLIACOES,
ENGENHARIA_LUCROS_CESSANTES,
ENGENHARIA_MANUTENCAO_AMPLA_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_MANUTENCAO_SIMPLES_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_OBRAS_CONCLUIDAS,
ENGENHARIA_OBRAS_TEMPORARIAS,
ENGENHARIA_OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
ENGENHARIA_PROPRIEDADES_CIRCUNVIZINHAS,
ENGENHARIA_RECOMPOSICAO_DE_DOCUMENTOS,
ENGENHARIA_RESPONSABILIDADE_CIVIL_EMPREGADOR,
ENGENHARIA_FUNDACAO,
ENGENHARIA_STANDS_DE_VENDA,
ENGENHARIA_TRANSPORTE_TERRESTRE,
ENGENHARIA_TUMULTOS_GREVES_E_LOCKOUT,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
BANCOS_INFIDELIDADE_DE_FUNCIONARIOS,
BANCOS_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
BANCOS_VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
BANCOS_VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
RNO_ALAGAMENTO_INUNDACAO,
RNO_ALUGUEL_PERDA_OU_PAGAMENTO,
RNO_ANUNCIOS_LUMINOSOS,
RNO_BAGAGEM,
RNO_BASICA_INCENDIO_RAIO_EXPLOSAO,
RNO_BASICA_DANOS_MATERIAIS,
RNO_BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
RNO_BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
RNO_CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
RNO_DANOS_ELETRICOS,
RNO_DANOS_NA_FABRICACAO,
RNO_DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS_SPRINKLERS,
RNO_DESMORONAMENTO,
RNO_DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
RNO_DESPESAS_EXTRAORDINARIAS,
RNO_DESPESAS_FIXA,
RNO_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
RNO_EQUIPAMENTOS_ARRENDADOS,
RNO_EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
RNO_EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
RNO_EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
RNO_EQUIPAMENTOS_ELETRONICOS,
RNO_EQUIPAMENTOS_ESTACIONARIOS,
RNO_EQUIPAMENTOS_MOVEIS,
RNO_EQUIPAMENTOS_PORTATEIS,
RNO_FIDELIDADE_DE_EMPREGADOS,
RNO_HONORARIOS_DE_PERITOS,
RNO_IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
RNO_IMPACTO_DE_VEICULOS_TERRESTRES,
RNO_LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
RNO_LUCROS_CESSANTES,
RNO_MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
RNO_PATIOS,
RNO_QUEBRA_DE_MAQUINAS,
RNO_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RNO_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
RNO_ROUBO_DE_BENS_DE_HOSPEDES,
RNO_ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
RNO_ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
RNO_ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
RNO_TERRORISMO_E_SABOTAGEM,
RNO_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
RNO_VAZAMENTO_DE_TUBULACOES_E_TANQUES,
RNO_VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
RNO_VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
internalCode:
description: "Código interno da cobertura da seguradora"
type: string
maxLength: 500
isSeparateContractingAllowed:
description: Permissão para Contratação Separada
type: boolean
maxLMI:
description: Valor de Limite Máximo de Indenização (LMI) solicitado
allOf:
- $ref: '#/components/schemas/AmountDetails'
deductible:
description: Informações de franquia
allOf:
- $ref: '#/components/schemas/QuotePatrimonialHomeResultDeductible'
POS:
description: Informações de POS
allOf:
- $ref: '#/components/schemas/POS'
gracePeriod:
type: integer
maxLength: 5
description: "Período de carência. OBS: Obrigatório, se houver"
gracePeriodicity:
type: string
description: "Periodicidade da carência. OBS: Obrigatório, se houver"
example: DIA
enum: [DIA,
MES,
ANO]
gracePeriodCountingMethod:
type: string
description: "Indicador de dias úteis ou corridos da carência. OBS: Obrigatório, se houver"
example: DIAS_UTEIS
enum: [DIAS_UTEIS,
DIAS_CORRIDOS]
gracePeriodStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de início da carência. OBS: Obrigatório, se houver"
gracePeriodEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim da carência. OBS: Obrigatório, se houver"
QuotePatrimonialHomeResultInsuredObject:
type: object
description: Objeto que agrupa os dados de objeto segurado.
required:
- identification
properties:
identification:
type: string
maxLength: 100
description: "Identificador do objeto segurado. Obs.: Para Fiança Locatícia, é a identificação do Contrato de Locação."
propertyType:
description: Indica o tipo do imóvel ou condomínio segurado
type: string
example: CASA
enum: [
CASA,
APARTAMENTO,
CASA_EM_CONDOMINIO
]
geographicRegion:
description: Descrição da região geográfica
type: string
example: ZONA_URBANA
enum: [
ZONA_URBANA,
ZONA_RURAL
]
propertiesForCoverage:
description: "Deseja cobertura para:"
type: string
example: PREDIO_E_CONTEUDO
enum: [
PREDIO_E_CONTEUDO,
APENAS_PARA_PREDIO,
APENAS_CONTEUDO
]
indenizationWithoutDepreciation:
description: Contratar Valor de novo? (sem depreciação)
type: boolean
riskLocationInfo:
$ref: '#/components/schemas/QuotePatrimonialHomeRiskLocation'
wasThereAClaim:
description: Houve sinistro no local nos últimos 12 meses?
type: boolean
QuotePatrimonialHomeResultDeductible:
type: object
required:
- type
- amount
properties:
type:
description: Tipo de Franquia
type: string
enum: [
REDUZIDA,
NORMAL,
MAJORADA,
DEDUTIVEL,
OUTROS
]
typeAdditionalInfo:
description: Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
type: string
maxLength: 500
amount:
description: Valor da Franquia
allOf:
- $ref: '#/components/schemas/AmountDetails'
PolicyDataPatrimonialBusiness:
$ref: '#/components/schemas/PolicyDataPatrimonial'
QuoteDataPatrimonialBusiness:
type: object
description: Objeto que agrupa dados específicos do ramo de cotação.
required:
- coverages
- isCollectiveStipulated
- hasOneRiskLocation
properties:
isCollectiveStipulated:
description: "Apólice é coletiva ou por estipulação?"
type: boolean
hasOneRiskLocation:
description: "Trata-se uma apólice com apenas um local de risco?"
type: boolean
termStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de vigência dentro de 24 horas"
termEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim de vigência até as 24 horas"
insuranceType:
type: string
description: Tipo de Seguro
example: NOVO
enum: [NOVO,
RENOVACAO]
policyId:
description: Número para identificar a apólice atual
type: string
maxLength: 100
example: "111111"
insurerId:
description: Nome para identifcar a congênere de renovação
type: string
maxLength: 100
currency:
description: Moeda de emissão do contrato de acordo com ISO-4217.
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
maxLMG:
description: Valor Limite máximo de garantia (LMG)
allOf:
- $ref: '#/components/schemas/AmountDetails'
includesAssistanceServices:
description: Deseja contratação de serviços de assistência
type: boolean
claimAmount:
description: Valor do sinistro
allOf:
- $ref: '#/components/schemas/AmountDetails'
claimDescription:
description: Descrição do sinistro
type: string
maxLength: 1000
insuredObject:
$ref: '#/components/schemas/QuotePatrimonialBusinessInsuredObject'
beneficiaries:
type: array
description: Lista de dados de beneficiários.
items:
$ref: '#/components/schemas/QuotePatrimonialBusinessBeneficiary'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/QuotePatrimonialBusinessCoverage'
QuotePatrimonialBusinessBeneficiary:
type: object
properties:
identification:
description: Documento de Identificação do Beneficiário
type: string
maxLength: 60
example: "12345678900"
identificationType:
description: Tipo de Documento do Beneficiário
type: string
example: CPF
enum: [
CPF,
CNPJ,
OUTROS
]
identificationTypeOthers:
description: Descrição para quando o tipo de documento do beneficiário for outros.
type: string
example: PASSAPORTE
name:
description: Nome ou Razão Social do Beneficiário
type: string
maxLength: 60
example: Nome Sobrenome
QuotePatrimonialBusinessInsuredObject:
type: object
description: Objeto que agrupa os dados de objeto segurado.
properties:
identification:
type: string
maxLength: 100
description: "Identificador do objeto segurado. Obs.: Para Fiança Locatícia, é a identificação do Contrato de Locação."
riskAmount:
description: "Valor em Risco"
allOf:
- $ref: '#/components/schemas/AmountDetails'
mainActivity:
description: "Principal atividade do local de risco"
type: string
example: COMERCIO
enum: [COMERCIO,
INDUSTRIA,
SERVICO]
businessActivity:
description: Código CNAE da atividade principal (caso aplicável)
type: string
maxLength: 7
businessActivityDescription:
description: Descrição do código CNAE da atividade principal
type: string
maxLength: 100
professionalRegisterOrganization:
description: Conselho de registro da categoria (Para profissionais liberais que não possuam CNPJ)
type: string
maxLength: 100
example: OAB-PR
professionalRegisterNumber:
description: Número de registro no conselho
type: string
maxLength: 50
example: OAB-PR
selfEmployeeJobTitle:
description: Título para autônomos com contratação na pessoa física, que possuam registro na respectiva prefeitura do local de risco
type: string
example: ADMINISTRADORES
enum: [
ADMINISTRADORES,
ADVOGADOS,
AGROPECUARISTA,
AGRONOMOS,
ALFAIATE,
ARQUITETOS,
ARQUIVISTAS,
ARTESAO,
ARTISTAS,
ATORES,
ATUARIOS,
AUTORES_TEATRAIS,
BACHAREIS_EM_CIENCIAS_DA_COMPUTACAO,
BARBEIRO_CABELEIREIRO,
BARISTA,
BIBLIOTECARIO,
BIOMEDICOS,
BIOLOGOS,
CENOGRAFOS,
CHAVEIRO,
CINEASTA,
COMPOSITORES_ARTISTICOS_MUSICAIS_E_PLASTICOS,
CONFEITEIRO,
CONTADORES,
CORRETORES_DE_IMOVEIS,
COSTUREIRA,
CUIDADOR,
DESENHISTA,
DESIGNER,
ECONOMISTAS,
EDUCADORES_FISICOS,
ELETRICISTA,
ENCANADOR,
ENFERMEIROS,
ENGENHEIROS,
ENOLOGO,
ESCRITOR,
ESTATITICOS,
ESTETICISTA,
FARMACEUTICO,
FEIRANTE,
FISIOTERAPEUTAS,
FLORICULTOR,
FONOAUDIOLOGOS,
FOTOGRAFO,
GESSEIRO,
GEOLOGOS,
GRAFICO_TIPOGRAFO,
JOALHEIRO,
JORNALEIRO,
JORNALISTAS,
LEILOEIROS,
MARCENEIRO_CARPINTEIRO,
MECANICO_FUNILEIRO,
MESTRE_DE_CERIMONIA,
MODELO,
MUSEOLOGOS,
MEDICO,
MEDICOS_VETERINARIOS,
MUSICO,
NUTRICIONISTA,
OCEANOGRAFOS,
ODONTOLOGISTA,
OFTALMOLOGISTA,
ORTOPEDISTA,
PADEIRO,
PARTEIRAS,
PEDREIRO_MESTRE_DE_OBRAS,
PERFUMISTA,
PERSONAL_TRAINER,
PINTOR,
PODOLOGO,
PROFESSOR,
PROFESSORES_PARTICULARES,
PROFISSIONAL_DE_TECNOLOGIA_DA_INFORMACAO_TI,
PROJETISTA,
PROTETICO,
PROTETICOS_DENTARIOS,
PSICOLOGOS,
PUBLICITARIOS,
QUIMICOS,
RELACOES_PUBLICAS,
RELOJOEIRO,
SAPATEIRO,
SERRALHEIRO,
SOCIOLOGOS,
SOMMELIER,
TAPECEIRO,
TECNOLOGOS,
TERAPEUTAS_OCUPACIONAIS,
TIPOGRAFO,
TRADUTORES,
TECNICO_EM_INFORMATICA,
TECNICOS_AGRICOLAS,
TECNICOS_EM_CONTABILIDADE,
TECNICOS_EM_RADIOLOGIA,
TECNICOS_INDUSTRIAIS,
VETERINARIO,
VIDRACEIRO,
ZOOTECNISTAS,
OUTROS
]
selfEmployeeJobTitleOthers:
type: string
description: Descrição do título para autonomos com contratação na pessoa fisica quando o tipo for outros.
propertiesForCoverage:
description: "Deseja cobertura para:"
type: string
example: PREDIO_E_CONTEUDO
enum: [
PREDIO_E_CONTEUDO,
APENAS_PARA_PREDIO,
APENAS_CONTEUDO
]
riskLocationInfo:
$ref: '#/components/schemas/QuotePatrimonialBusinessRiskLocation'
wasThereAClaim:
description: Houve sinistro no local nos últimos 12 meses?
type: boolean
claimNotifications:
description: Lista de sinistros e valores
type: array
items:
$ref: '#/components/schemas/ClaimNotification'
QuotePatrimonialBusinessCoverage:
type: object
required:
- branch
- code
- isSeparateContractingAllowed
- maxLMI
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: "0111"
code:
type: string
description: Código da cobertura, conforme Anexo II do Manual de Escopo de Dados
example: RESIDENCIAL_IMOVEL_BASICA
enum: [
RESIDENCIAL_IMOVEL_BASICA,
RESIDENCIAL_IMOVEL_AMPLA,
RESIDENCIAL_INCENDIO,
RESIDENCIAL_QUEDA_DE_RAIO,
RESIDENCIAL_EXPLOSAO,
RESIDENCIAL_IMPACTO_DE_AERONAVES,
RESIDENCIAL_ALAGAMENTO,
RESIDENCIAL_DANOS_ELETRICOS,
RESIDENCIAL_DANOS_POR_AGUA,
RESIDENCIAL_RESPONSABILIDADE_CIVIL_FAMILIAR,
RESIDENCIAL_VENDAVAL,
RESIDENCIAL_DANOS_A_EQUIPAMENTOS_ELETRONICOS,
RESIDENCIAL_TERREMOTO,
RESIDENCIAL_PERDA_E_PAGAMENTO_DE_ALUGUEL,
RESIDENCIAL_ROUBO_E_SUBTRACAO_DE_BENS,
RESIDENCIAL_QUEBRA_DE_VIDROS,
RESIDENCIAL_IMPACTO_DE_VEICULOS,
RESIDENCIAL_DESMORONAMENTO,
RESIDENCIAL_TUMULTOS_GREVES_E_LOCKOUTS,
RESIDENCIAL_DESPESAS_EXTRAORDINARIAS,
RESIDENCIAL_JOIAS_E_OBRAS_DE_ARTE,
CONDOMINIAL_COBERTURA_BASICA_SIMPLES,
CONDOMINIAL_COBERTURA_BASICA_AMPLA,
CONDOMINIAL_ANUNCIOS_LUMINOSOS,
CONDOMINIAL_DANOS_AO_JARDIM,
CONDOMINIAL_DANOS_ELETRICOS,
CONDOMINIAL_DESMORONAMENTO,
CONDOMINIAL_DESPESAS_COM_ALUGUEL,
CONDOMINIAL_EQUIPAMENTOS,
CONDOMINIAL_FIDELIDADE_DE_EMPREGADOS,
CONDOMINIAL_IMPACTO_DE_VEICULOS,
CONDOMINIAL_VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
CONDOMINIAL_LUCROS_CESSANTES,
CONDOMINIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
CONDOMINIAL_RESPONSABILIDADE_CIVIL,
CONDOMINIAL_ROUBO,
CONDOMINIAL_VALORES,
CONDOMINIAL_VAZAMENTO,
CONDOMINIAL_VENDAVAL,
CONDOMINIAL_ALAGAMENTO,
CONDOMINIAL_TUMULTO,
EMPRESARIAL_INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
EMPRESARIAL_DANOS_ELETRICOS,
EMPRESARIAL_VENDAVAL_ATE_FUMACA,
EMPRESARIAL_DESMORONAMENTO,
EMPRESARIAL_ALAGAMENTO_E_INUNDACAO,
EMPRESARIAL_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
EMPRESARIAL_ROUBO_E_FURTO_QUALIFICADO,
EMPRESARIAL_VALORES,
EMPRESARIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
EMPRESARIAL_ANUNCIOS_LUMINOSOS,
EMPRESARIAL_FIDELIDADE_DE_EMPREGADOS,
EMPRESARIAL_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
EMPRESARIAL_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
EMPRESARIAL_DERRAME,
EMPRESARIAL_VAZAMENTO,
EMPRESARIAL_EQUIPAMENTOS,
EMPRESARIAL_QUEBRA_DE_MAQUINAS,
EMPRESARIAL_RESPONSABILIDADE_CIVIL,
EMPRESARIAL_DESPESAS_EXTRAORDINARIAS,
EMPRESARIAL_LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
EMPRESARIAL_PERDA_OU_PAGAMENTO_DE_ALUGUEL,
EMPRESARIAL_PEQUENAS_OBRAS_DE_ENGENHARIA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
DIVERSOS_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
CESSANTES_LUCRO_BRUTO_LUCRO_LIQUIDO_E_DESPESAS_FIXAS,
CESSANTES_LUCRO_LIQUIDO,
CESSANTES_DESPESAS_FIXAS,
CESSANTES_PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
ENGENHARIA_OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
ENGENHARIA_AFRETAMENTOS_DE_AERONAVES,
ENGENHARIA_ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
ENGENHARIA_DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
ENGENHARIA_DANOS_MORAIS,
ENGENHARIA_DESPESAS_COM_DESENTULHO_DO_LOCAL,
ENGENHARIA_DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
ENGENHARIA_DESPESAS_EXTRAORDINARIAS,
ENGENHARIA_EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
ENGENHARIA_EQUIPAMENTOS_MOVEIS_OU_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
ENGENHARIA_FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
ENGENHARIA_HONORARIOS_DE_PERITO,
ENGENHARIA_INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_TRINTA_DIAS_EXCETO_PARA_REFORMAS_OU_AMPLIACOES,
ENGENHARIA_LUCROS_CESSANTES,
ENGENHARIA_MANUTENCAO_AMPLA_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_MANUTENCAO_SIMPLES_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_OBRAS_CONCLUIDAS,
ENGENHARIA_OBRAS_TEMPORARIAS,
ENGENHARIA_OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
ENGENHARIA_PROPRIEDADES_CIRCUNVIZINHAS,
ENGENHARIA_RECOMPOSICAO_DE_DOCUMENTOS,
ENGENHARIA_RESPONSABILIDADE_CIVIL_EMPREGADOR,
ENGENHARIA_FUNDACAO,
ENGENHARIA_STANDS_DE_VENDA,
ENGENHARIA_TRANSPORTE_TERRESTRE,
ENGENHARIA_TUMULTOS_GREVES_E_LOCKOUT,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
BANCOS_INFIDELIDADE_DE_FUNCIONARIOS,
BANCOS_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
BANCOS_VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
BANCOS_VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
RNO_ALAGAMENTO_INUNDACAO,
RNO_ALUGUEL_PERDA_OU_PAGAMENTO,
RNO_ANUNCIOS_LUMINOSOS,
RNO_BAGAGEM,
RNO_BASICA_INCENDIO_RAIO_EXPLOSAO,
RNO_BASICA_DANOS_MATERIAIS,
RNO_BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
RNO_BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
RNO_CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
RNO_DANOS_ELETRICOS,
RNO_DANOS_NA_FABRICACAO,
RNO_DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS_SPRINKLERS,
RNO_DESMORONAMENTO,
RNO_DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
RNO_DESPESAS_EXTRAORDINARIAS,
RNO_DESPESAS_FIXA,
RNO_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
RNO_EQUIPAMENTOS_ARRENDADOS,
RNO_EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
RNO_EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
RNO_EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
RNO_EQUIPAMENTOS_ELETRONICOS,
RNO_EQUIPAMENTOS_ESTACIONARIOS,
RNO_EQUIPAMENTOS_MOVEIS,
RNO_EQUIPAMENTOS_PORTATEIS,
RNO_FIDELIDADE_DE_EMPREGADOS,
RNO_HONORARIOS_DE_PERITOS,
RNO_IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
RNO_IMPACTO_DE_VEICULOS_TERRESTRES,
RNO_LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
RNO_LUCROS_CESSANTES,
RNO_MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
RNO_PATIOS,
RNO_QUEBRA_DE_MAQUINAS,
RNO_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RNO_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
RNO_ROUBO_DE_BENS_DE_HOSPEDES,
RNO_ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
RNO_ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
RNO_ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
RNO_TERRORISMO_E_SABOTAGEM,
RNO_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
RNO_VAZAMENTO_DE_TUBULACOES_E_TANQUES,
RNO_VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
RNO_VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
isSeparateContractingAllowed:
description: Permissão para Contratação Separada
type: boolean
maxLMI:
description: Valor de Limite Máximo de Indenização (LMI) solicitado
allOf:
- $ref: '#/components/schemas/AmountDetails'
internalCode:
description: "Código interno da cobertura da seguradora"
type: string
maxLength: 500
QuotePatrimonialBusinessRiskLocation:
type: object
description: Objeto que agrupa dados de local de risco.
properties:
address:
type: string
maxLength: 100
description: Logradouro do Local de Risco
example: "Avenida Paulista, 2000"
additionalInfo:
type: string
maxLength: 100
description: Complemento do Local de Risco *
example: "Apartamento 1304"
districtName:
type: string
maxLength: 100
description: Bairro do Local de Risco *
example: "Cerqueira César"
townName:
type: string
maxLength: 100
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
description: Município do Local de Risco
example: "São Paulo"
countrySubDivision:
type: string
description: Sigla da Unidade da Federação do Local de Risco
example: AC
enum: [AC,
AL,
AP,
AM,
BA,
CE,
DF,
ES,
GO,
MA,
MT,
MS,
MG,
PA,
PB,
PR,
PE,
PI,
RJ,
RN,
RS,
RO,
RR,
SC,
SP,
SE,
TO]
postCode:
type: string
maxLength: 8
description: CEP do Local de Risco
example: "1310200"
billingAddress:
type: string
maxLength: 100
description: Logradouro do Local de Cobrança
example: "Avenida Paulista, 2000"
billingAdditionalInfo:
type: string
maxLength: 100
description: Complemento do Local de Cobrança *
example: "Apartamento 1304"
billingDistrictName:
type: string
maxLength: 100
description: Bairro do Local de Cobrança *
example: "Cerqueira César"
billingTownName:
type: string
maxLength: 100
description: Município do Local de Cobrança
example: "São Paulo"
billingCountrySubDivision:
type: string
description: Sigla da Unidade da Federação do Local de Cobrança
example: AC
enum: [AC,
AL,
AP,
AM,
BA,
CE,
DF,
ES,
GO,
MA,
MT,
MS,
MG,
PA,
PB,
PR,
PE,
PI,
RJ,
RN,
RS,
RO,
RR,
SC,
SP,
SE,
TO]
billingPostCode:
type: string
maxLength: 8
description: CEP do Local de Cobrança
example: "1310200"
propertyUsageType:
description: Tipo de moradia
type: string
example: HABITUAL
enum: [
HABITUAL,
VERANEIO,
DESOCUPADO,
IMOVEL_COM_ATIVIDADE_COMERCIAL_REMUNERADA,
ALUGUEL_POR_TEMPORADA
]
propertyBuildType:
description: Tipo de construção
type: string
example: SUPERIOR
enum: [
SUPERIOR,
SOLIDA,
MISTA,
INFERIOR
]
isListedDisappropriatedCondemned:
description: Imóvel tombado, desapropriado ou condenado por órgão público?
type: boolean
isUnderConstructionRenovation:
description: O imóvel está em construção ou reforma?
type: boolean
securityProtection:
description: O imóvel possui sistemas de protecionais de segurança?
type: array
items:
type: string
example: CAMERA_CFTV
enum: [
CAMERA_CFTV,
PORTARIA_VINTE_E_QUATRO_HORAS,
CONTROLE_DE_ACESSO,
ALARME_DISPOSITIVO_ANTI_FURTO,
VIGILANCIA_TERCEIRIZADA,
SERVICO_DE_VIGILANCIA_ARMADA_VINTE_E_QUATRO_HORAS,
CONDOMINIO_FECHADO,
CERCA_ELETRICA,
BARREIRAS_FISICAS,
SENSORES_INFRAVERMELHO,
NAO_POSSUI
]
fireProtection:
description: O imóvel possui sistemas de protecionais de incêndio?
type: array
items:
type: string
example: EXTINTOR
enum: [
EXTINTOR,
HIDRANTES,
SPRINKLER_CHUVEIROS_AUTOMATICOS,
DETECTOR_DE_FUMACA_CALOR,
BRIGADA_DE_INCENDIO,
BOMBEIROS_A_MENOS_DE_TRES_QUILOMETROS,
ALARME_DE_INCENCIO_COM_MONITORAMENTO_VINTE_E_QUATRO_HORAS,
NAO_POSSUI
]
propertyUseType:
description: Uso do imóvel
type: string
example: PROPRIO
enum: [
PROPRIO,
ALUGADO
]
isMainlyOpen:
description: Predominância de construções abertas / semi-abertas?
type: boolean
hasInsulatingPanels:
description: Existe isopainel (chapas metálicas com isolamento interno)?
type: boolean
isInMall:
description: Localizado em Shopping?
type: boolean
QuoteStatusPatrimonialBusiness:
type: object
required:
- quoteCustomer
- quoteData
- quotes
properties:
quoteCustomer:
description: Objeto que agrupa as categorias de dados cadastrais do cliente.
oneOf:
- $ref: '#/components/schemas/PersonalQuoteCustomer'
- $ref: '#/components/schemas/BusinessQuoteCustomer'
quoteData:
$ref: '#/components/schemas/ResultQuoteQuotePatrimonialBusiness'
quotes:
type: array
minItems: 1
description: Lista de cotações enviadas pela seguradora. Condicional a cotação ter sido aceita pela seguradora.
items:
required:
- premiumInfo
- coverages
- quoteDateTime
- insurerQuoteId
type: object
description: Informações da cotação enviada pela seguradora
properties:
insurerQuoteId:
type: string
description: |
Id da proposta da segurada
quoteDateTime:
type: string
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2023-05-21T08:30:00Z'
description: Data e hora da cotação
susepProcessNumbers:
description: "Número do Processo Susep das Coberturas"
type: array
items:
type: string
maxLength: 50
updatingIndex:
description: Índice de atualização dos valores do contrato
type: string
example: IPCA
enum: [
IPCA,
IGP_M,
INPC,
OUTROS,
NAO_SE_APLICA
]
updatingIndexOthers:
description: Descrição para quando o tipo de índice de atualização for outros.
type: string
updatingPeriodicity:
description: Periodicidade de atualização
type: string
example: ANUAL
enum: [
ANUAL,
OUTROS
]
updatingPeriodicityOthers:
description: Descrição para quando o tipo de periodicidade de atualização for outros.
type: string
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/ResultQuotePatrimonialBusinessCoverage'
assistances:
type: array
description: Lista que agrupa dados de assistências.
items:
$ref: '#/components/schemas/QuoteResultAssistance'
premiumInfo:
$ref: '#/components/schemas/QuoteResultPremium'
quoteCustomData:
$ref: '#/components/schemas/QuoteCustomData'
ResultQuotePatrimonialBusinessCoverage:
type: object
required:
- branch
- code
- isSeparateContractingAllowed
- maxLMI
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: "0111"
code:
type: string
description: Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
example: RESIDENCIAL_IMOVEL_BASICA
enum: [
RESIDENCIAL_IMOVEL_BASICA,
RESIDENCIAL_IMOVEL_AMPLA,
RESIDENCIAL_INCENDIO,
RESIDENCIAL_QUEDA_DE_RAIO,
RESIDENCIAL_EXPLOSAO,
RESIDENCIAL_IMPACTO_DE_AERONAVES,
RESIDENCIAL_ALAGAMENTO,
RESIDENCIAL_DANOS_ELETRICOS,
RESIDENCIAL_DANOS_POR_AGUA,
RESIDENCIAL_RESPONSABILIDADE_CIVIL_FAMILIAR,
RESIDENCIAL_VENDAVAL,
RESIDENCIAL_DANOS_A_EQUIPAMENTOS_ELETRONICOS,
RESIDENCIAL_TERREMOTO,
RESIDENCIAL_PERDA_E_PAGAMENTO_DE_ALUGUEL,
RESIDENCIAL_ROUBO_E_SUBTRACAO_DE_BENS,
RESIDENCIAL_QUEBRA_DE_VIDROS,
RESIDENCIAL_IMPACTO_DE_VEICULOS,
RESIDENCIAL_DESMORONAMENTO,
RESIDENCIAL_TUMULTOS_GREVES_E_LOCKOUTS,
RESIDENCIAL_DESPESAS_EXTRAORDINARIAS,
RESIDENCIAL_JOIAS_E_OBRAS_DE_ARTE,
CONDOMINIAL_COBERTURA_BASICA_SIMPLES,
CONDOMINIAL_COBERTURA_BASICA_AMPLA,
CONDOMINIAL_ANUNCIOS_LUMINOSOS,
CONDOMINIAL_DANOS_AO_JARDIM,
CONDOMINIAL_DANOS_ELETRICOS,
CONDOMINIAL_DESMORONAMENTO,
CONDOMINIAL_DESPESAS_COM_ALUGUEL,
CONDOMINIAL_EQUIPAMENTOS,
CONDOMINIAL_FIDELIDADE_DE_EMPREGADOS,
CONDOMINIAL_IMPACTO_DE_VEICULOS,
CONDOMINIAL_VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
CONDOMINIAL_LUCROS_CESSANTES,
CONDOMINIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
CONDOMINIAL_RESPONSABILIDADE_CIVIL,
CONDOMINIAL_ROUBO,
CONDOMINIAL_VALORES,
CONDOMINIAL_VAZAMENTO,
CONDOMINIAL_VENDAVAL,
CONDOMINIAL_ALAGAMENTO,
CONDOMINIAL_TUMULTO,
EMPRESARIAL_INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
EMPRESARIAL_DANOS_ELETRICOS,
EMPRESARIAL_VENDAVAL_ATE_FUMACA,
EMPRESARIAL_DESMORONAMENTO,
EMPRESARIAL_ALAGAMENTO_E_INUNDACAO,
EMPRESARIAL_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
EMPRESARIAL_ROUBO_E_FURTO_QUALIFICADO,
EMPRESARIAL_VALORES,
EMPRESARIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
EMPRESARIAL_ANUNCIOS_LUMINOSOS,
EMPRESARIAL_FIDELIDADE_DE_EMPREGADOS,
EMPRESARIAL_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
EMPRESARIAL_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
EMPRESARIAL_DERRAME,
EMPRESARIAL_VAZAMENTO,
EMPRESARIAL_EQUIPAMENTOS,
EMPRESARIAL_QUEBRA_DE_MAQUINAS,
EMPRESARIAL_RESPONSABILIDADE_CIVIL,
EMPRESARIAL_DESPESAS_EXTRAORDINARIAS,
EMPRESARIAL_LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
EMPRESARIAL_PERDA_OU_PAGAMENTO_DE_ALUGUEL,
EMPRESARIAL_PEQUENAS_OBRAS_DE_ENGENHARIA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
DIVERSOS_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
CESSANTES_LUCRO_BRUTO_LUCRO_LIQUIDO_E_DESPESAS_FIXAS,
CESSANTES_LUCRO_LIQUIDO,
CESSANTES_DESPESAS_FIXAS,
CESSANTES_PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
ENGENHARIA_OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
ENGENHARIA_AFRETAMENTOS_DE_AERONAVES,
ENGENHARIA_ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
ENGENHARIA_DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
ENGENHARIA_DANOS_MORAIS,
ENGENHARIA_DESPESAS_COM_DESENTULHO_DO_LOCAL,
ENGENHARIA_DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
ENGENHARIA_DESPESAS_EXTRAORDINARIAS,
ENGENHARIA_EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
ENGENHARIA_EQUIPAMENTOS_MOVEIS_OU_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
ENGENHARIA_FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
ENGENHARIA_HONORARIOS_DE_PERITO,
ENGENHARIA_INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_TRINTA_DIAS_EXCETO_PARA_REFORMAS_OU_AMPLIACOES,
ENGENHARIA_LUCROS_CESSANTES,
ENGENHARIA_MANUTENCAO_AMPLA_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_MANUTENCAO_SIMPLES_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_OBRAS_CONCLUIDAS,
ENGENHARIA_OBRAS_TEMPORARIAS,
ENGENHARIA_OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
ENGENHARIA_PROPRIEDADES_CIRCUNVIZINHAS,
ENGENHARIA_RECOMPOSICAO_DE_DOCUMENTOS,
ENGENHARIA_RESPONSABILIDADE_CIVIL_EMPREGADOR,
ENGENHARIA_FUNDACAO,
ENGENHARIA_STANDS_DE_VENDA,
ENGENHARIA_TRANSPORTE_TERRESTRE,
ENGENHARIA_TUMULTOS_GREVES_E_LOCKOUT,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
BANCOS_INFIDELIDADE_DE_FUNCIONARIOS,
BANCOS_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
BANCOS_VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
BANCOS_VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
RNO_ALAGAMENTO_INUNDACAO,
RNO_ALUGUEL_PERDA_OU_PAGAMENTO,
RNO_ANUNCIOS_LUMINOSOS,
RNO_BAGAGEM,
RNO_BASICA_INCENDIO_RAIO_EXPLOSAO,
RNO_BASICA_DANOS_MATERIAIS,
RNO_BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
RNO_BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
RNO_CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
RNO_DANOS_ELETRICOS,
RNO_DANOS_NA_FABRICACAO,
RNO_DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS_SPRINKLERS,
RNO_DESMORONAMENTO,
RNO_DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
RNO_DESPESAS_EXTRAORDINARIAS,
RNO_DESPESAS_FIXA,
RNO_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
RNO_EQUIPAMENTOS_ARRENDADOS,
RNO_EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
RNO_EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
RNO_EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
RNO_EQUIPAMENTOS_ELETRONICOS,
RNO_EQUIPAMENTOS_ESTACIONARIOS,
RNO_EQUIPAMENTOS_MOVEIS,
RNO_EQUIPAMENTOS_PORTATEIS,
RNO_FIDELIDADE_DE_EMPREGADOS,
RNO_HONORARIOS_DE_PERITOS,
RNO_IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
RNO_IMPACTO_DE_VEICULOS_TERRESTRES,
RNO_LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
RNO_LUCROS_CESSANTES,
RNO_MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
RNO_PATIOS,
RNO_QUEBRA_DE_MAQUINAS,
RNO_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RNO_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
RNO_ROUBO_DE_BENS_DE_HOSPEDES,
RNO_ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
RNO_ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
RNO_ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
RNO_TERRORISMO_E_SABOTAGEM,
RNO_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
RNO_VAZAMENTO_DE_TUBULACOES_E_TANQUES,
RNO_VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
RNO_VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
isSeparateContractingAllowed:
description: Permissão para Contratação Separada
type: boolean
maxLMI:
description: Valor de Limite Máximo de Indenização (LMI) solicitado
allOf:
- $ref: '#/components/schemas/AmountDetails'
deductible:
description: Informações de franquia
allOf:
- $ref: '#/components/schemas/Deductible'
POS:
description: Informações de POS
allOf:
- $ref: '#/components/schemas/POS'
internalCode:
description: "Código interno da cobertura da seguradora"
type: string
maxLength: 500
gracePeriod:
type: integer
maxLength: 5
description: "Período de carência. OBS: Obrigatório, se houver"
gracePeriodicity:
type: string
description: "Periodicidade da carência. OBS: Obrigatório, se houver"
example: DIA
enum: [DIA,
MES,
ANO]
gracePeriodCountingMethod:
type: string
description: "Indicador de dias úteis ou corridos da carência. OBS: Obrigatório, se houver"
example: DIAS_UTEIS
enum: [DIAS_UTEIS,
DIAS_CORRIDOS]
gracePeriodStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de início da carência. OBS: Obrigatório, se houver"
gracePeriodEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim da carência. OBS: Obrigatório, se houver"
ResultQuoteQuotePatrimonialBusiness:
type: object
description: Objeto que agrupa dados específicos do ramo de cotação.
required:
- coverages
- isCollectiveStipulated
- hasOneRiskLocation
properties:
isCollectiveStipulated:
description: "Apólice é coletiva ou por estipulação?"
type: boolean
hasOneRiskLocation:
description: "Trata-se uma apólice com apenas um local de risco?"
type: boolean
termStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de vigência dentro de 24 horas"
termEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim de vigência até as 24 horas"
insuranceType:
type: string
description: Tipo de Seguro
example: NOVO
enum: [NOVO,
RENOVACAO]
policyId:
description: Número para identificar a apólice atual
type: string
maxLength: 100
example: "111111"
insurerId:
description: Nome para identifcar a congênere de renovação
type: string
maxLength: 100
currency:
description: Moeda de emissão do contrato de acordo com ISO-4217.
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
maxLMG:
description: Valor Limite máximo de garantia (LMG)
allOf:
- $ref: '#/components/schemas/AmountDetails'
includesAssistanceServices:
description: Deseja contratação de serviços de assistência
type: boolean
claimAmount:
description: Valor do sinistro
allOf:
- $ref: '#/components/schemas/AmountDetails'
claimDescription:
description: Descrição do sinistro
type: string
maxLength: 1000
insuredObject:
$ref: '#/components/schemas/QuotePatrimonialBusinessResultInsuredObject'
beneficiaries:
type: array
description: Lista de dados de beneficiários.
items:
$ref: '#/components/schemas/QuotePatrimonialBusinessBeneficiary'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/QuotePatrimonialBusinessCoverage'
QuotePatrimonialBusinessResultInsuredObject:
type: object
description: Objeto que agrupa os dados de objeto segurado.
required:
- identification
properties:
identification:
type: string
maxLength: 100
description: "Identificador do objeto segurado. Obs.: Para Fiança Locatícia, é a identificação do Contrato de Locação."
riskAmount:
description: "Valor em Risco"
allOf:
- $ref: '#/components/schemas/AmountDetails'
mainActivity:
description: "Principal atividade do local de risco"
type: string
example: COMERCIO
enum: [COMERCIO,
INDUSTRIA,
SERVICO]
businessActivity:
description: Código CNAE da atividade principal (caso aplicável)
type: string
maxLength: 7
businessActivityDescription:
description: Descrição do código CNAE da atividade principal
type: string
maxLength: 100
professionalRegisterOrganization:
description: Conselho de registro da categoria (Para profissionais liberais que não possuam CNPJ)
type: string
maxLength: 100
example: OAB-PR
professionalRegisterNumber:
description: Número de registro no conselho
type: string
maxLength: 50
example: OAB-PR
selfEmployeeJobTitle:
description: Título para autônomos com contratação na pessoa física, que possuam registro na respectiva prefeitura do local de risco
type: string
example: ADMINISTRADORES
enum: [
ADMINISTRADORES,
ADVOGADOS,
AGROPECUARISTA,
AGRONOMOS,
ALFAIATE,
ARQUITETOS,
ARQUIVISTAS,
ARTESAO,
ARTISTAS,
ATORES,
ATUARIOS,
AUTORES_TEATRAIS,
BACHAREIS_EM_CIENCIAS_DA_COMPUTACAO,
BARBEIRO_CABELEIREIRO,
BARISTA,
BIBLIOTECARIO,
BIOMEDICOS,
BIOLOGOS,
CENOGRAFOS,
CHAVEIRO,
CINEASTA,
COMPOSITORES_ARTISTICOS_MUSICAIS_E_PLASTICOS,
CONFEITEIRO,
CONTADORES,
CORRETORES_DE_IMOVEIS,
COSTUREIRA,
CUIDADOR,
DESENHISTA,
DESIGNER,
ECONOMISTAS,
EDUCADORES_FISICOS,
ELETRICISTA,
ENCANADOR,
ENFERMEIROS,
ENGENHEIROS,
ENOLOGO,
ESCRITOR,
ESTATITICOS,
ESTETICISTA,
FARMACEUTICO,
FEIRANTE,
FISIOTERAPEUTAS,
FLORICULTOR,
FONOAUDIOLOGOS,
FOTOGRAFO,
GESSEIRO,
GEOLOGOS,
GRAFICO_TIPOGRAFO,
JOALHEIRO,
JORNALEIRO,
JORNALISTAS,
LEILOEIROS,
MARCENEIRO_CARPINTEIRO,
MECANICO_FUNILEIRO,
MESTRE_DE_CERIMONIA,
MODELO,
MUSEOLOGOS,
MEDICO,
MEDICOS_VETERINARIOS,
MUSICO,
NUTRICIONISTA,
OCEANOGRAFOS,
ODONTOLOGISTA,
OFTALMOLOGISTA,
ORTOPEDISTA,
PADEIRO,
PARTEIRAS,
PEDREIRO_MESTRE_DE_OBRAS,
PERFUMISTA,
PERSONAL_TRAINER,
PINTOR,
PODOLOGO,
PROFESSOR,
PROFESSORES_PARTICULARES,
PROFISSIONAL_DE_TECNOLOGIA_DA_INFORMACAO_TI,
PROJETISTA,
PROTETICO,
PROTETICOS_DENTARIOS,
PSICOLOGOS,
PUBLICITARIOS,
QUIMICOS,
RELACOES_PUBLICAS,
RELOJOEIRO,
SAPATEIRO,
SERRALHEIRO,
SOCIOLOGOS,
SOMMELIER,
TAPECEIRO,
TECNOLOGOS,
TERAPEUTAS_OCUPACIONAIS,
TIPOGRAFO,
TRADUTORES,
TECNICO_EM_INFORMATICA,
TECNICOS_AGRICOLAS,
TECNICOS_EM_CONTABILIDADE,
TECNICOS_EM_RADIOLOGIA,
TECNICOS_INDUSTRIAIS,
VETERINARIO,
VIDRACEIRO,
ZOOTECNISTAS,
OUTROS
]
selfEmployeeJobTitleOthers:
type: string
description: Descrição do título de autonomo com contratação na pessoa física para quando o tipo for outros.
propertiesForCoverage:
description: "Deseja cobertura para:"
type: string
example: PREDIO_E_CONTEUDO
enum: [
PREDIO_E_CONTEUDO,
APENAS_PARA_PREDIO,
APENAS_CONTEUDO
]
riskLocationInfo:
$ref: '#/components/schemas/QuotePatrimonialBusinessRiskLocation'
wasThereAClaim:
description: Houve sinistro no local nos últimos 12 meses?
type: boolean
claimNotifications:
description: Lista de sinistros e valores
type: array
items:
$ref: '#/components/schemas/ClaimNotification'
PolicyDataPatrimonialDiverseRisks:
$ref: '#/components/schemas/PolicyDataPatrimonial'
QuoteDataPatrimonialDiverseRisks:
type: object
required:
- coverages
- isCollectiveStipulated
- productModalityType
description: Objeto que agrupa dados específicos do ramo de cotação.
properties:
productModalityType:
type: boolean
description: A modalidade do produto é obras de arte, joalherias, valores, assemelhados ou Cartão/Pix?
isCollectiveStipulated:
description: "Apólice é coletiva ou por estipulação?"
type: boolean
includesAssistanceServices:
description: Deseja contratação de serviços de assistência
type: boolean
termStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de vigência dentro de 24 horas"
termEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim de vigência até as 24 horas"
insuranceTermStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim de vigência até as 24 horas"
insuranceType:
type: string
description: Tipo de Seguro
example: NOVO
enum: [NOVO,
RENOVACAO]
policyId:
description: Número para identificar a apólice atual
type: string
maxLength: 100
example: "111111"
insurerId:
description: Nome para identifcar a congênere de renovação
type: string
maxLength: 100
currency:
description: Moeda de emissão do contrato de acordo com ISO-4217.
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
insuredObjectType:
description: Tipo e/ou modalidade de bem segurado
type: string
example: EQUIPAMENTO_MOVEL
enum: ['EQUIPAMENTO_MOVEL',
'EQUIPAMENTO_ESTACIONARIO',
'EQUIPAMENTOS_PORTÁTEIS']
maxLMG:
description: Valor Limite máximo de garantia (LMG)
allOf:
- $ref: '#/components/schemas/AmountDetails'
insuredObject:
$ref: '#/components/schemas/QuotePatrimonialDiverseRisksInsuredObject'
beneficiaries:
type: array
description: Lista de dados de beneficiários.
items:
$ref: '#/components/schemas/QuotePatrimonialDiverseRisksBeneficiary'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/QuotePatrimonialDiverseRisksCoverage'
QuotePatrimonialDiverseRisksBeneficiary:
type: object
properties:
identification:
description: Documento de Identificação do Beneficiário
type: string
maxLength: 60
example: "12345678900"
identificationType:
description: Tipo de Documento do Beneficiário
type: string
example: CPF
enum: [
CPF,
CNPJ,
OUTROS
]
identificationTypeOthers:
type: string
description: descrição para quando o tipo de documento do Beneficiário for outros.
example: PASSAPORTE
name:
description: Nome ou Razão Social do Beneficiário
type: string
maxLength: 60
example: "Nome Sobrenome"
QuotePatrimonialDiverseRisksInsuredObject:
type: object
description: Objeto que agrupa os dados de objeto segurado.
properties:
identification:
type: string
maxLength: 100
description: "Identificador do objeto segurado. Obs.: Para Fiança Locatícia, é a identificação do Contrato de Locação."
equipmentType:
description: Modalide de Equipamentos Móveis, Estácionários e/ou Arrendados, Portátil
type: string
example: EQUIPAMENTO_DE_CONSTRUCAO_CIVIL
enum: [
EQUIPAMENTO_DE_CONSTRUCAO_CIVIL,
EQUIPAMENTO_MEDICO_ODONTOLOGICO,
EQUIPAMENTOS_DE_MEDIÇÃO,
EQUIPAMENTOS_INDUSTRIAIS,
EQUIPAMENTOS_DE_USO_COMERCIAL
]
equipmentCategory:
description: Informar a categoria do equipamento
type: string
example: FIXED_MACHINERY
enum: [
FIXED_MACHINERY,
SELF_PROPELLED_MACHINERY,
PORTABLE_EQUIPMENT
]
equipmentData:
oneOf:
- $ref: '#/components/schemas/FixedMachinery'
- $ref: '#/components/schemas/SelfPropelledMachinery'
- $ref: '#/components/schemas/PortableEquipment'
geographicRegion:
description: Descrição da região geográfica
type: string
example: ZONA_URBANA
enum: [
ZONA_URBANA,
ZONA_RURAL]
propertiesForCoverage:
description: "Deseja cobertura para:"
type: string
example: PREDIO_E_CONTEUDO
enum: [
PREDIO_E_CONTEUDO,
APENAS_PARA_PREDIO,
APENAS_CONTEUDO
]
isNewValueContract: ## GB
description: Contratar Valor de novo? (sem depreciação)
type: boolean
riskLocationInfo:
$ref: '#/components/schemas/QuotePatrimonialDiverseRisksRiskLocation'
wasThereAClaim:
description: Houve sinistro no local nos últimos 12 meses?
type: boolean
claimNotifications:
description: Lista de sinistros e valores
type: array
items:
$ref: '#/components/schemas/ClaimNotification'
QuotePatrimonialDiverseRisksRiskLocation:
type: object
description: Objeto que agrupa dados de local de risco.
properties:
isSameAsTheProponent:
type: boolean
description: Endereço do Local de Risco é o mesmo do proponente?
address:
type: string
maxLength: 100
description: Logradouro do Local de Risco
example: "Avenida Paulista, 2000"
additionalInfo:
type: string
maxLength: 100
description: Complemento *
example: "Apartamento 1304"
districtName:
type: string
maxLength: 100
description: Bairro *
example: "Cerqueira César"
townName:
type: string
maxLength: 100
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
description: Município
example: "São Paulo"
countrySubDivision:
type: string
description: Sigla da Unidade da Federação
example: AC
enum: [AC,
AL,
AP,
AM,
BA,
CE,
DF,
ES,
GO,
MA,
MT,
MS,
MG,
PA,
PB,
PR,
PE,
PI,
RJ,
RN,
RS,
RO,
RR,
SC,
SP,
SE,
TO]
postCode:
type: string
maxLength: 8
description: CEP
example: "1310200"
billingAddress:
type: string
maxLength: 100
description: Logradouro do Local de Cobrança
example: "Avenida Paulista, 2000"
billingAdditionalInfo:
type: string
maxLength: 100
description: Complemento do Local de Cobrança *
example: "Apartamento 1304"
billingDistrictName:
type: string
maxLength: 100
description: Bairro do Local de Cobrança *
example: "Cerqueira César"
billingTownName:
type: string
maxLength: 100
description: Município do Local de Cobrança
example: "São Paulo"
billingCountrySubDivision:
type: string
description: Sigla da Unidade da Federação do Local de Cobrança
example: AC
enum: [AC,
AL,
AP,
AM,
BA,
CE,
DF,
ES,
GO,
MA,
MT,
MS,
MG,
PA,
PB,
PR,
PE,
PI,
RJ,
RN,
RS,
RO,
RR,
SC,
SP,
SE,
TO]
billingPostCode:
type: string
maxLength: 8
description: CEP do Local de Cobrança
example: "1310200"
securityProtection:
description: Quais itens de segurança dispõe?
type: array
items:
type: string
example: CAMERA_CFTV
enum: [
CAMERA_CFTV,
PORTARIA_HORAS,
ALARME_DISPOSITIVO_ANTI_FURTO,
VIGILANCIA_TERCEIRIZADA,
CONDOMINIO_FECHADO,
CERCA_ELETRICA,
GRADES_EM_JANELAS_E_PORTAS,
NAO_POSSUI]
fireProtection:
description: O imóvel possui sistemas de protecionais de incêndio?
type: array
items:
type: string
example: EXTINTOR
enum: [
EXTINTOR,
HIDRANTES,
SPRINKLER_CHUVEIROS_AUTOMATICOS,
DETECTOR_DE_FUMACA,
ALARME_DE_INCENDIO,
NAO_POSSUI]
QuotePatrimonialDiverseRisksCoverage:
type: object
required:
- branch
- code
- isSeparateContractingAllowed
- maxLMI
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: "0111"
code:
type: string
description: Código da cobertura, conforme Anexo II do Manual de Escopo de Dados
example: RESIDENCIAL_IMOVEL_BASICA
enum: [
RESIDENCIAL_IMOVEL_BASICA,
RESIDENCIAL_IMOVEL_AMPLA,
RESIDENCIAL_INCENDIO,
RESIDENCIAL_QUEDA_DE_RAIO,
RESIDENCIAL_EXPLOSAO,
RESIDENCIAL_IMPACTO_DE_AERONAVES,
RESIDENCIAL_ALAGAMENTO,
RESIDENCIAL_DANOS_ELETRICOS,
RESIDENCIAL_DANOS_POR_AGUA,
RESIDENCIAL_RESPONSABILIDADE_CIVIL_FAMILIAR,
RESIDENCIAL_VENDAVAL,
RESIDENCIAL_DANOS_A_EQUIPAMENTOS_ELETRONICOS,
RESIDENCIAL_TERREMOTO,
RESIDENCIAL_PERDA_E_PAGAMENTO_DE_ALUGUEL,
RESIDENCIAL_ROUBO_E_SUBTRACAO_DE_BENS,
RESIDENCIAL_QUEBRA_DE_VIDROS,
RESIDENCIAL_IMPACTO_DE_VEICULOS,
RESIDENCIAL_DESMORONAMENTO,
RESIDENCIAL_TUMULTOS_GREVES_E_LOCKOUTS,
RESIDENCIAL_DESPESAS_EXTRAORDINARIAS,
RESIDENCIAL_JOIAS_E_OBRAS_DE_ARTE,
CONDOMINIAL_COBERTURA_BASICA_SIMPLES,
CONDOMINIAL_COBERTURA_BASICA_AMPLA,
CONDOMINIAL_ANUNCIOS_LUMINOSOS,
CONDOMINIAL_DANOS_AO_JARDIM,
CONDOMINIAL_DANOS_ELETRICOS,
CONDOMINIAL_DESMORONAMENTO,
CONDOMINIAL_DESPESAS_COM_ALUGUEL,
CONDOMINIAL_EQUIPAMENTOS,
CONDOMINIAL_FIDELIDADE_DE_EMPREGADOS,
CONDOMINIAL_IMPACTO_DE_VEICULOS,
CONDOMINIAL_VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
CONDOMINIAL_LUCROS_CESSANTES,
CONDOMINIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
CONDOMINIAL_RESPONSABILIDADE_CIVIL,
CONDOMINIAL_ROUBO,
CONDOMINIAL_VALORES,
CONDOMINIAL_VAZAMENTO,
CONDOMINIAL_VENDAVAL,
CONDOMINIAL_ALAGAMENTO,
CONDOMINIAL_TUMULTO,
EMPRESARIAL_INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
EMPRESARIAL_DANOS_ELETRICOS,
EMPRESARIAL_VENDAVAL_ATE_FUMACA,
EMPRESARIAL_DESMORONAMENTO,
EMPRESARIAL_ALAGAMENTO_E_INUNDACAO,
EMPRESARIAL_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
EMPRESARIAL_ROUBO_E_FURTO_QUALIFICADO,
EMPRESARIAL_VALORES,
EMPRESARIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
EMPRESARIAL_ANUNCIOS_LUMINOSOS,
EMPRESARIAL_FIDELIDADE_DE_EMPREGADOS,
EMPRESARIAL_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
EMPRESARIAL_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
EMPRESARIAL_DERRAME,
EMPRESARIAL_VAZAMENTO,
EMPRESARIAL_EQUIPAMENTOS,
EMPRESARIAL_QUEBRA_DE_MAQUINAS,
EMPRESARIAL_RESPONSABILIDADE_CIVIL,
EMPRESARIAL_DESPESAS_EXTRAORDINARIAS,
EMPRESARIAL_LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
EMPRESARIAL_PERDA_OU_PAGAMENTO_DE_ALUGUEL,
EMPRESARIAL_PEQUENAS_OBRAS_DE_ENGENHARIA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
DIVERSOS_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
CESSANTES_LUCRO_BRUTO_LUCRO_LIQUIDO_E_DESPESAS_FIXAS,
CESSANTES_LUCRO_LIQUIDO,
CESSANTES_DESPESAS_FIXAS,
CESSANTES_PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
ENGENHARIA_OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
ENGENHARIA_AFRETAMENTOS_DE_AERONAVES,
ENGENHARIA_ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
ENGENHARIA_DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
ENGENHARIA_DANOS_MORAIS,
ENGENHARIA_DESPESAS_COM_DESENTULHO_DO_LOCAL,
ENGENHARIA_DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
ENGENHARIA_DESPESAS_EXTRAORDINARIAS,
ENGENHARIA_EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
ENGENHARIA_EQUIPAMENTOS_MOVEIS_OU_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
ENGENHARIA_FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
ENGENHARIA_HONORARIOS_DE_PERITO,
ENGENHARIA_INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_TRINTA_DIAS_EXCETO_PARA_REFORMAS_OU_AMPLIACOES,
ENGENHARIA_LUCROS_CESSANTES,
ENGENHARIA_MANUTENCAO_AMPLA_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_MANUTENCAO_SIMPLES_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_OBRAS_CONCLUIDAS,
ENGENHARIA_OBRAS_TEMPORARIAS,
ENGENHARIA_OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
ENGENHARIA_PROPRIEDADES_CIRCUNVIZINHAS,
ENGENHARIA_RECOMPOSICAO_DE_DOCUMENTOS,
ENGENHARIA_RESPONSABILIDADE_CIVIL_EMPREGADOR,
ENGENHARIA_FUNDACAO,
ENGENHARIA_STANDS_DE_VENDA,
ENGENHARIA_TRANSPORTE_TERRESTRE,
ENGENHARIA_TUMULTOS_GREVES_E_LOCKOUT,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
BANCOS_INFIDELIDADE_DE_FUNCIONARIOS,
BANCOS_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
BANCOS_VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
BANCOS_VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
RNO_ALAGAMENTO_INUNDACAO,
RNO_ALUGUEL_PERDA_OU_PAGAMENTO,
RNO_ANUNCIOS_LUMINOSOS,
RNO_BAGAGEM,
RNO_BASICA_INCENDIO_RAIO_EXPLOSAO,
RNO_BASICA_DANOS_MATERIAIS,
RNO_BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
RNO_BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
RNO_CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
RNO_DANOS_ELETRICOS,
RNO_DANOS_NA_FABRICACAO,
RNO_DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS_SPRINKLERS,
RNO_DESMORONAMENTO,
RNO_DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
RNO_DESPESAS_EXTRAORDINARIAS,
RNO_DESPESAS_FIXA,
RNO_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
RNO_EQUIPAMENTOS_ARRENDADOS,
RNO_EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
RNO_EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
RNO_EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
RNO_EQUIPAMENTOS_ELETRONICOS,
RNO_EQUIPAMENTOS_ESTACIONARIOS,
RNO_EQUIPAMENTOS_MOVEIS,
RNO_EQUIPAMENTOS_PORTATEIS,
RNO_FIDELIDADE_DE_EMPREGADOS,
RNO_HONORARIOS_DE_PERITOS,
RNO_IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
RNO_IMPACTO_DE_VEICULOS_TERRESTRES,
RNO_LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
RNO_LUCROS_CESSANTES,
RNO_MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
RNO_PATIOS,
RNO_QUEBRA_DE_MAQUINAS,
RNO_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RNO_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
RNO_ROUBO_DE_BENS_DE_HOSPEDES,
RNO_ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
RNO_ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
RNO_ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
RNO_TERRORISMO_E_SABOTAGEM,
RNO_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
RNO_VAZAMENTO_DE_TUBULACOES_E_TANQUES,
RNO_VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
RNO_VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
isSeparateContractingAllowed:
description: Permissão para Contratação Separada
type: boolean
maxLMI:
description: Valor de Limite Máximo de Indenização (LMI) solicitado
allOf:
- $ref: '#/components/schemas/AmountDetails'
internalCode:
description: "Código interno da cobertura da seguradora"
type: string
maxLength: 500
QuoteStatusPatrimonialDiverseRisks:
type: object
required:
- quoteCustomer
- quoteData
- quotes
properties:
quoteCustomer:
description: Objeto que agrupa as categorias de dados cadastrais do cliente.
oneOf:
- $ref: '#/components/schemas/PersonalQuoteCustomer'
- $ref: '#/components/schemas/BusinessQuoteCustomer'
quoteData:
$ref: '#/components/schemas/ResultQuotePatrimonialDiverseRisks'
quotes:
type: array
minItems: 1
description: Lista de cotações enviadas pela seguradora.
items:
required:
- premiumInfo
- coverages
- quoteDateTime
- insurerQuoteId
type: object
description: Informações da cotação enviada pela seguradora
properties:
insurerQuoteId:
type: string
description: |
Id da proposta da segurada
quoteDateTime:
type: string
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2023-05-21T08:30:00Z'
description: Data e hora da cotação
susepProcessNumbers:
description: "Número do Processo Susep das Coberturas"
type: array
items:
type: string
maxLength: 50
example: 'XXXXXXX1234'
updatingIndex:
description: Índice de atualização dos valores do contrato
type: string
example: IPCA
enum: [
IPCA,
IGP_M,
INPC,
OUTROS,
NAO_SE_APLICA
]
updatingIndexOthers:
type: string
description: Descrição para quando o tipo de índice de atualização for outros.
updatingPeriodicity:
description: Periodicidade de atualização
type: string
example: ANUAL
enum: [
ANUAL,
OUTROS
]
updatingPeriodicityOthers:
type: string
description: Descrição para quando o tipo de periodicidade de atualização for outros.
example: MENSAL
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/ResultQuotePatrimonialDiverseRisksCoverage'
assistances:
type: array
description: Lista que agrupa dados de assistências.
items:
$ref: '#/components/schemas/QuoteResultAssistance'
premiumInfo:
$ref: '#/components/schemas/QuoteResultPremium'
quoteCustomData:
$ref: '#/components/schemas/QuoteCustomData'
ResultQuotePatrimonialDiverseRisksCoverage:
type: object
required:
- branch
- code
- isSeparateContractingAllowed
- maxLMI
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: "0111"
code:
type: string
description: Código da cobertura, conforme Anexo II do Manual de Escopo de Dados
example: RESIDENCIAL_IMOVEL_BASICA
enum: [
RESIDENCIAL_IMOVEL_BASICA,
RESIDENCIAL_IMOVEL_AMPLA,
RESIDENCIAL_INCENDIO,
RESIDENCIAL_QUEDA_DE_RAIO,
RESIDENCIAL_EXPLOSAO,
RESIDENCIAL_IMPACTO_DE_AERONAVES,
RESIDENCIAL_ALAGAMENTO,
RESIDENCIAL_DANOS_ELETRICOS,
RESIDENCIAL_DANOS_POR_AGUA,
RESIDENCIAL_RESPONSABILIDADE_CIVIL_FAMILIAR,
RESIDENCIAL_VENDAVAL,
RESIDENCIAL_DANOS_A_EQUIPAMENTOS_ELETRONICOS,
RESIDENCIAL_TERREMOTO,
RESIDENCIAL_PERDA_E_PAGAMENTO_DE_ALUGUEL,
RESIDENCIAL_ROUBO_E_SUBTRACAO_DE_BENS,
RESIDENCIAL_QUEBRA_DE_VIDROS,
RESIDENCIAL_IMPACTO_DE_VEICULOS,
RESIDENCIAL_DESMORONAMENTO,
RESIDENCIAL_TUMULTOS_GREVES_E_LOCKOUTS,
RESIDENCIAL_DESPESAS_EXTRAORDINARIAS,
RESIDENCIAL_JOIAS_E_OBRAS_DE_ARTE,
CONDOMINIAL_COBERTURA_BASICA_SIMPLES,
CONDOMINIAL_COBERTURA_BASICA_AMPLA,
CONDOMINIAL_ANUNCIOS_LUMINOSOS,
CONDOMINIAL_DANOS_AO_JARDIM,
CONDOMINIAL_DANOS_ELETRICOS,
CONDOMINIAL_DESMORONAMENTO,
CONDOMINIAL_DESPESAS_COM_ALUGUEL,
CONDOMINIAL_EQUIPAMENTOS,
CONDOMINIAL_FIDELIDADE_DE_EMPREGADOS,
CONDOMINIAL_IMPACTO_DE_VEICULOS,
CONDOMINIAL_VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
CONDOMINIAL_LUCROS_CESSANTES,
CONDOMINIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
CONDOMINIAL_RESPONSABILIDADE_CIVIL,
CONDOMINIAL_ROUBO,
CONDOMINIAL_VALORES,
CONDOMINIAL_VAZAMENTO,
CONDOMINIAL_VENDAVAL,
CONDOMINIAL_ALAGAMENTO,
CONDOMINIAL_TUMULTO,
EMPRESARIAL_INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
EMPRESARIAL_DANOS_ELETRICOS,
EMPRESARIAL_VENDAVAL_ATE_FUMACA,
EMPRESARIAL_DESMORONAMENTO,
EMPRESARIAL_ALAGAMENTO_E_INUNDACAO,
EMPRESARIAL_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
EMPRESARIAL_ROUBO_E_FURTO_QUALIFICADO,
EMPRESARIAL_VALORES,
EMPRESARIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
EMPRESARIAL_ANUNCIOS_LUMINOSOS,
EMPRESARIAL_FIDELIDADE_DE_EMPREGADOS,
EMPRESARIAL_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
EMPRESARIAL_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
EMPRESARIAL_DERRAME,
EMPRESARIAL_VAZAMENTO,
EMPRESARIAL_EQUIPAMENTOS,
EMPRESARIAL_QUEBRA_DE_MAQUINAS,
EMPRESARIAL_RESPONSABILIDADE_CIVIL,
EMPRESARIAL_DESPESAS_EXTRAORDINARIAS,
EMPRESARIAL_LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
EMPRESARIAL_PERDA_OU_PAGAMENTO_DE_ALUGUEL,
EMPRESARIAL_PEQUENAS_OBRAS_DE_ENGENHARIA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
DIVERSOS_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
CESSANTES_LUCRO_BRUTO_LUCRO_LIQUIDO_E_DESPESAS_FIXAS,
CESSANTES_LUCRO_LIQUIDO,
CESSANTES_DESPESAS_FIXAS,
CESSANTES_PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
ENGENHARIA_OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
ENGENHARIA_AFRETAMENTOS_DE_AERONAVES,
ENGENHARIA_ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
ENGENHARIA_DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
ENGENHARIA_DANOS_MORAIS,
ENGENHARIA_DESPESAS_COM_DESENTULHO_DO_LOCAL,
ENGENHARIA_DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
ENGENHARIA_DESPESAS_EXTRAORDINARIAS,
ENGENHARIA_EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
ENGENHARIA_EQUIPAMENTOS_MOVEIS_OU_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
ENGENHARIA_FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
ENGENHARIA_HONORARIOS_DE_PERITO,
ENGENHARIA_INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_TRINTA_DIAS_EXCETO_PARA_REFORMAS_OU_AMPLIACOES,
ENGENHARIA_LUCROS_CESSANTES,
ENGENHARIA_MANUTENCAO_AMPLA_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_MANUTENCAO_SIMPLES_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_OBRAS_CONCLUIDAS,
ENGENHARIA_OBRAS_TEMPORARIAS,
ENGENHARIA_OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
ENGENHARIA_PROPRIEDADES_CIRCUNVIZINHAS,
ENGENHARIA_RECOMPOSICAO_DE_DOCUMENTOS,
ENGENHARIA_RESPONSABILIDADE_CIVIL_EMPREGADOR,
ENGENHARIA_FUNDACAO,
ENGENHARIA_STANDS_DE_VENDA,
ENGENHARIA_TRANSPORTE_TERRESTRE,
ENGENHARIA_TUMULTOS_GREVES_E_LOCKOUT,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
BANCOS_INFIDELIDADE_DE_FUNCIONARIOS,
BANCOS_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
BANCOS_VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
BANCOS_VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
RNO_ALAGAMENTO_INUNDACAO,
RNO_ALUGUEL_PERDA_OU_PAGAMENTO,
RNO_ANUNCIOS_LUMINOSOS,
RNO_BAGAGEM,
RNO_BASICA_INCENDIO_RAIO_EXPLOSAO,
RNO_BASICA_DANOS_MATERIAIS,
RNO_BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
RNO_BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
RNO_CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
RNO_DANOS_ELETRICOS,
RNO_DANOS_NA_FABRICACAO,
RNO_DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS_SPRINKLERS,
RNO_DESMORONAMENTO,
RNO_DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
RNO_DESPESAS_EXTRAORDINARIAS,
RNO_DESPESAS_FIXA,
RNO_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
RNO_EQUIPAMENTOS_ARRENDADOS,
RNO_EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
RNO_EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
RNO_EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
RNO_EQUIPAMENTOS_ELETRONICOS,
RNO_EQUIPAMENTOS_ESTACIONARIOS,
RNO_EQUIPAMENTOS_MOVEIS,
RNO_EQUIPAMENTOS_PORTATEIS,
RNO_FIDELIDADE_DE_EMPREGADOS,
RNO_HONORARIOS_DE_PERITOS,
RNO_IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
RNO_IMPACTO_DE_VEICULOS_TERRESTRES,
RNO_LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
RNO_LUCROS_CESSANTES,
RNO_MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
RNO_PATIOS,
RNO_QUEBRA_DE_MAQUINAS,
RNO_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RNO_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
RNO_ROUBO_DE_BENS_DE_HOSPEDES,
RNO_ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
RNO_ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
RNO_ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
RNO_TERRORISMO_E_SABOTAGEM,
RNO_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
RNO_VAZAMENTO_DE_TUBULACOES_E_TANQUES,
RNO_VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
RNO_VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
isSeparateContractingAllowed:
description: Permissão para Contratação Separada
type: boolean
maxLMI:
description: Valor de Limite Máximo de Indenização (LMI) solicitado
allOf:
- $ref: '#/components/schemas/AmountDetails'
deductible:
description: Informações de franquia
allOf:
- $ref: '#/components/schemas/Deductible'
POS:
description: Informações de POS
allOf:
- $ref: '#/components/schemas/POS'
internalCode:
description: "Código interno da cobertura da seguradora"
type: string
maxLength: 500
gracePeriod:
type: integer
maxLength: 5
description: "Período de carência. OBS: Obrigatório, se houver"
gracePeriodicity:
type: string
description: "Periodicidade da carência. OBS: Obrigatório, se houver"
example: DIA
enum: [DIA,
MES,
ANO]
gracePeriodCountingMethod:
type: string
description: "Indicador de dias úteis ou corridos da carência. OBS: Obrigatório, se houver"
example: DIAS_UTEIS
enum: [DIAS_UTEIS,
DIAS_CORRIDOS]
gracePeriodStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de início da carência. OBS: Obrigatório, se houver"
gracePeriodEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim da carência. OBS: Obrigatório, se houver"
ResultQuotePatrimonialDiverseRisks:
type: object
description: Objeto que agrupa dados específicos do ramo de cotação.
required:
- coverages
- isCollectiveStipulated
- productModalityType
properties:
productModalityType:
type: boolean
description: A modalidade do produto é obras de arte, joalherias, valores, assemelhados ou Cartão/Pix?
isCollectiveStipulated:
description: "Apólice é coletiva ou por estipulação?"
type: boolean
includesAssistanceServices:
description: Deseja contratação de serviços de assistência
type: boolean
termStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de vigência dentro de 24 horas"
termEndDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim de vigência até as 24 horas"
insuranceTermStartDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
description: "Data de fim de vigência até as 24 horas"
insuranceType:
type: string
description: Tipo de Seguro
example: NOVO
enum: [NOVO,
RENOVACAO]
policyId:
description: Número para identificar a apólice atual
type: string
maxLength: 100
example: "111111"
insurerId:
description: Nome para identifcar a congênere de renovação
type: string
maxLength: 100
currency:
description: Moeda de emissão do contrato de acordo com ISO-4217.
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
insuredObjectType:
description: Tipo e/ou modalidade de bem segurado
type: string
example: EQUIPAMENTO_MOVEL
enum: ['EQUIPAMENTO_MOVEL',
'EQUIPAMENTO_ESTACIONARIO',
'EQUIPAMENTOS_PORTÁTEIS']
maxLMG:
description: Valor Limite máximo de garantia (LMG)
allOf:
- $ref: '#/components/schemas/AmountDetails'
insuredObject:
$ref: '#/components/schemas/QuotePatrimonialDiverseRisksResultInsuredObject'
beneficiaries:
type: array
description: Lista de dados de beneficiários.
items:
$ref: '#/components/schemas/QuotePatrimonialDiverseRisksBeneficiary'
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
$ref: '#/components/schemas/QuotePatrimonialDiverseRisksCoverage'
QuotePatrimonialDiverseRisksResultInsuredObject:
type: object
description: Objeto que agrupa os dados de objeto segurado.
required:
- identification
properties:
identification:
type: string
maxLength: 100
description: "Identificador do objeto segurado. Obs.: Para Fiança Locatícia, é a identificação do Contrato de Locação."
equipmentType:
description: Modalide de Equipamentos Móveis, Estácionários e/ou Arrendados, Portátil
type: string
example: EQUIPAMENTO_DE_CONSTRUCAO_CIVIL
enum: [
EQUIPAMENTO_DE_CONSTRUCAO_CIVIL,
EQUIPAMENTO_MEDICO_ODONTOLOGICO,
EQUIPAMENTOS_DE_MEDIÇÃO,
EQUIPAMENTOS_INDUSTRIAIS,
EQUIPAMENTOS_DE_USO_COMERCIAL
]
equipmentData:
oneOf:
- $ref: '#/components/schemas/FixedMachinery'
- $ref: '#/components/schemas/SelfPropelledMachinery'
- $ref: '#/components/schemas/PortableEquipment'
geographicRegion:
description: Descrição da região geográfica
type: string
example: ZONA_URBANA
enum: [
ZONA_URBANA,
ZONA_RURAL]
propertiesForCoverage:
description: "Deseja cobertura para:"
type: string
example: PREDIO_E_CONTEUDO
enum: [
PREDIO_E_CONTEUDO,
APENAS_PARA_PREDIO,
APENAS_CONTEUDO
]
isNewValueContract: ## GB
description: Contratar Valor de novo? (sem depreciação)
type: boolean
riskLocationInfo:
$ref: '#/components/schemas/QuotePatrimonialDiverseRisksRiskLocation'
wasThereAClaim:
description: Houve sinistro no local nos últimos 12 meses?
type: boolean
claimNotifications:
description: Lista de sinistros e valores
type: array
items:
$ref: '#/components/schemas/ClaimNotification'
FixedMachinery:
type: object
description: Objeto que agrupa os dados de Equipamento Estacionário.
properties:
fixedMachinery:
description: Equipamento é Estacionário?
type: boolean
mainBranch:
type: string
maxLength: 20
description: Código do ramo da atividade da empresa consultada, segundo padrão CNAE (Classificação Nacional de Atividades Econômicas).
equipmentLocal:
description: Local de operação do equipamento estacionário
type: string
example: COMERCIO
enum: [
SERVICOS,
INDUSTRIA,
COMERCIO,
HOSPITAL/CLINICA,
RESIDENCIAL,
ZONA_RURAL]
forAgriculturalOrMixedActivities:
description: Equipamentos utilizados na Atividade Agrícola, aquícola, pecuária ou florestal ou atividade mista (Agrícola + Riscos Diversos)
type: boolean
equipmentDescription:
description: Descrição do Equipamento
type: string
maxLength: 200
brand:
description: Fabricante ou Marca
type: string
maxLength: 200
manufacturingYear:
description: Ano de Fabricação
type: string
serialNumber:
description: Número de série ou chassi
type: string
brandNew:
description: Equipamento Zero km?
type: boolean
invoiceIssuedDate:
description: Data de Emissão da Nota Fiscal
type: string
maxLength: 10
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
invoiceNumber:
description: Número da Nota Fiscal
type: string
isRented:
description: Equipamento é alugado?
type: boolean
isBorrowed:
description: Equipamento é locado/cedido a terceiros?
type: boolean
isFinanced:
description: Equipamento é arrendado ou financiado?
type: boolean
ownOperation:
description: A utilização/operação do equipamento é feita exclusivamente pelo proprietário e/ou seus funcionários?
type: boolean
operationLocation:
description: Equipamento opera em local fechado ou ao ar-livre?
type: string
example: LOCAL_FECHADO
enum: [
LOCAL_FECHADO,
AR-LIVRE]
buildingSiteOperation:
description: Equipamento está operando em canteiro de obra?
type: boolean
SelfPropelledMachinery:
type: object
description: Objeto que agrupa os dados de Equipamento Móvel.
properties:
selfPropelledMachinery:
description: Equipamento é Móvel?
type: boolean
mainBranch:
type: string
maxLength: 20
description: Código do ramo da atividade da empresa consultada, segundo padrão CNAE (Classificação Nacional de Atividades Econômicas).
equipmentLocal:
description: Local de operação do equipamento móvel
type: string
example: COMERCIO
enum: [
SERVICOS,
INDUSTRIA,
COMERCIO,
HOSPITAL/CLINICA,
RESIDENCIAL,
ZONA_RURAL]
forAgriculturalOrMixedActivities:
description: Equipamentos utilizados na Atividade Agrícola, aquícola, pecuária ou florestal ou atividade mista (Agrícola + Riscos Diversos)
type: boolean
equipmentDescription:
description: Descrição do Equipamento
type: string
maxLength: 200
brand:
description: Fabricante ou Marca
type: string
maxLength: 200
manufacturingYear:
description: Ano de Fabricação
type: string
serialNumber:
description: Número de série ou chassi
type: string
brandNew:
description: Equipamento Zero km?
type: boolean
invoiceIssuedDate:
description: Data de Emissão da Nota Fiscal
type: string
maxLength: 10
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
invoiceNumber:
description: Número da Nota Fiscal
type: string
isRented:
description: Equipamento é alugado?
type: boolean
isBorrowed:
description: Equipamento é locado/cedido a terceiros?
type: boolean
isFinanced:
description: Equipamento é arrendado ou financiado?
type: boolean
ownOperation:
description: A utilização/operação do equipamento é feita exclusivamente pelo proprietário e/ou seus funcionários?
type: boolean
operationLocation:
description: Equipamento opera em local fechado ou ao ar-livre?
type: string
example: LOCAL_FECHADO
enum: [
LOCAL_FECHADO,
AR-LIVRE]
buildingSiteOperation:
description: Equipamento está operando em canteiro de obra?
type: boolean
closeToWaterOperation:
description: Opera próximo a rio, mar ou lago?
type: boolean
onWaterOperation:
description: Opera sobre a água?
type: boolean
hasTracker:
description: Os equipamentos possuem GPS ou rastreador instalado?
type: boolean
undergroundWork:
description: Equipamento é utilizado em Obras Subterrânes e/ou escavação de túneis?
type: boolean
###
fixedOnVehicles:
description: Equipamentos são acoplados, fixados ou instalados a veículos?
type: boolean
PortableEquipment:
type: object
description: Objeto que agrupa os dados de Equipamentos Portáteis.
properties:
portableType:
description: Modalides de Equipamentos Portáteis
type: string
example: SMARTPHONE
enum: [
'SMARTPHONE',
'NOTEBOOK',
'TABLET',
'SMARTWATCH',
'CAMERAS_FILMADORAS_E_EQUIPAMENTOS_AUDIOVISUAIS',
'BIKE',
'PATINETE_OU_SCOOTER_ELETRICO_COM_DISPENSA_DE_CNH_E_REGISTRO_DETRAN',
'MEDICOS_CIRURGICOS_ODONTOLOGICOS_OU_ESTETICOS',
'INSTRUMENTOS_MUSICAIS']
brand:
description: Fabricante ou Marca do Equipamento Portátil
type: string
maxLength: 200
equipmentModel:
description: Modelo do Equipamento Portátil
type: string
maxLength: 200
serialNumber:
description: Número de série
type: string
invoiceIssuedDate:
description: Data de Emissão da Nota Fiscal
type: string
maxLength: 10
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2022-10-02'
invoiceNumber:
description: Número da Nota Fiscal
type: string
brandNew:
description: Equipamento Zero km?
type: boolean
IMEI:
description: IMEI (em caso de Smartphones)
type: string
isRented:
description: Equipamento é alugado?
type: boolean
isBorrowed:
description: Equipamento é locado/cedido a terceiros?
type: boolean
isFinanced:
description: Equipamento é arrendado ou financiado?
type: boolean
userCPF:
description: CPF de quem utiliza o aparelho
type: string
geographicalCoverage:
description: Âmbito geográfico de cobertura
type: string
example: TERRITORIO_NACIONAL
enum: [
'TERRITORIO_NACIONAL',
'EXTERIOR',
'AMBOS']
HistoricalPersonalComplimentaryInformationData:
$ref: "#/components/schemas/PersonalComplimentaryInformationData"
HistoricalPersonalIdentificationData:
$ref: "#/components/schemas/PersonalIdentificationData"
PersonalProcurator:
type: object
required:
- nature
properties:
nature:
$ref: '#/components/schemas/EnumProcuratorsNaturePersonal'
cpfNumber:
type: string
maxLength: 11
pattern: '^\d{11}$'
example: '73677831148'
description: '(Caso Natureza dos poderes vigentes de representante for “Representante legal” ou “Procurador”) CPF do representante'
civilName:
type: string
maxLength: 70
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: Elza Milena Stefany Teixeira
description: '(Caso Natureza dos poderes vigentes de representante for “Representante legal” ou “Procurador”) Nome ou razão social do representante'
socialName:
type: string
maxLength: 70
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: 'string'
description: '(Caso Natureza dos poderes vigentes de representante for “Representante legal” ou “Procurador”) Nome social do representante'
additionalProperties: false
HistoricalPersonalQualificationData:
$ref: "#/components/schemas/PersonalQualificationData"
HistoricalBusinessComplimentaryInformationData:
$ref: "#/components/schemas/BusinessComplimentaryInformationData"
HistoricalBusinessIdentificationData:
$ref: "#/components/schemas/BusinessIdentificationData"
BusinessProcurator:
type: object
required:
- nature
properties:
nature:
$ref: '#/components/schemas/EnumProcuratorsNatureBusiness'
cnpjCpfNumber:
type: string
maxLength: 14
pattern: '^\d{11}$|^\d{14}$'
example: '73677831148'
description: '(Caso Natureza dos poderes vigentes de representante for “Representante legal” ou “Procurador”) CPF ou CNPJ do representante'
civilName:
type: string
maxLength: 70
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: Elza Milena Stefany Teixeira
description: '(Caso Natureza dos poderes vigentes de representante for “Representante legal” ou “Procurador”) Nome ou razão social do representante'
socialName:
type: string
maxLength: 70
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: 'string'
description: '(Caso Natureza dos poderes vigentes de representante for “Representante legal” ou “Procurador”) Nome social do representante'
additionalProperties: false
HistoricalBusinessQualificationData:
$ref: "#/components/schemas/BusinessQualificationData"
BusinessComplimentaryInformationData: ## schema dados cadastrais de fase 2 - atualização pendente
type: object
description: 'Objeto que reúne as informações relativas ao relacionamento do cliente junto à Instituição. Considera-se relacionamento as informações que permitam conhecer desde quando a pessoa consultada é cliente da instituição, bem como um indicador dos produtos e serviços que ela consome atualmente e seus representantes'
required:
- startDate
- updateDateTime
- productsServices
properties:
updateDateTime:
type: string
format: date-time
maxLength: 20
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2020-07-21T08:30:00Z'
description: 'Data e hora da atualização do bloco de Relacionamento, conforme especificação RFC-3339, formato UTC.'
startDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2014-05-21'
description: Data mais antiga de início de relacionamento, considerando todos os contratos (vigentes e não vigentes). Os contratos não vigentes considerados devem contemplar, no mínimo o período indicado na Tabela 4.1.
relationshipBeginning:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2014-05-21'
description: Campo deve ser preenchido com a data da apólice/contrato vigente mais antiga. (caso haja contrato vigente)
productsServices:
type: array
minItems: 1
items:
type: object
description: Lista de todos os contratos vigentes e não vigentes.
required:
- contract
- type
properties:
contract:
type: string
maxLength: 60
description: Campo deve conter todos os contratos do cliente nos últimos 12 meses (número da apólice individual ou contrato ou certificado ou bilhete)
type:
$ref: '#/components/schemas/EnumProductServiceType'
insuranceLineCode:
type: string
maxLength: 4
example: '6272'
description: Indicar para cada contrato, caso aplicável, o código do ramo, conforme listagem de códigos definida em regulamentação específica sobre contabilização em ramos. - Caso tipo de produto do contrato for “Seguros de Danos.
procurators:
type: array
items:
$ref: '#/components/schemas/BusinessProcurator'
minItems: 1
description: Lista dos representantes. De preenchimento obrigatório se houver representante.
additionalProperties: false
additionalProperties: false
BusinessIdentificationData: ## schema dados cadastrais de fase 2 - atualização pendente
type: object
description: Conjunto de informações relativas a Identificação ou seja a ação e o efeito de identificar de forma única a pessoa jurídica através de seus dados cadastrais
required:
- updateDateTime
- brandName
- companyInfo
- businessName
- document
- contact
properties:
updateDateTime:
type: string
maxLength: 20
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
description: 'Data e hora da atualização do bloco, conforme especificação RFC-3339'
businessId:
type: string
maxLength: 100
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
example: 578-psd-71md6971kjh-2d414
description: Um identificador único e imutável usado para identificar o recurso cliente pessoa jurídica dentro da transmissora. Este identificador não tem significado para o cliente que deu o consentimento
brandName:
type: string
maxLength: 80
pattern: '[\w\W\s]*'
example: Organização A
description: |
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes
companyInfo:
type: object
description: Informações referente a sociedade a qual a marca pertence.
required:
- name
- cnpjNumber
properties:
cnpjNumber:
type: string
pattern: '\d{14}|^NA$'
example: '01773247000563'
description: |
Número completo do CNPJ da instituição responsável pelo Cadastro - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
Deve-se ter apenas os números do CNPJ, sem máscara
name:
type: string
maxLength: 70
pattern: '[\w\W\s]*'
example: Empresa da Organização A
description: Nome da Instituição, pertencente à Marca, responsável pela Dependência
businessName:
type: string
maxLength: 70
pattern: '[\w\W\s]*'
example: Luiza e Benjamin Assessoria Jurídica Ltda
description: Razão social da empresa consultada é o termo registrado sob o qual uma pessoa jurídica (PJ) se individualiza e exerce suas atividades. Também pode ser chamada por denominação social ou firma empresarial
businessTradeName:
type: string
maxLength: 70
pattern: '[\w\W\s]*'
example: Organização B
description: Nome fantasia - Se Aplicável
incorporationDate:
type: string
maxLength: 10
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2012-05-21'
description: 'Data de constituição, conforme especificação RFC-3339'
document:
$ref: '#/components/schemas/BusinessDocument'
type:
type: string
example: PRIVADO
enum:
- PRIVADO
- PUBLICO
description: Campo deve ser preenchido com o Tipo Pessoa Jurídica
contact:
$ref: '#/components/schemas/BusinessContact'
parties:
$ref: '#/components/schemas/BusinessParties'
BusinessQualificationData: ## schema dados cadastrais de fase 2 - atualização pendente
type: object
description: 'Objeto que reúne as informações relativas ao processo de qualificação.'
required:
- updateDateTime
properties:
updateDateTime:
type: string
maxLength: 20
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
description: 'Data e hora da atualização do bloco, conforme especificação RFC-3339'
mainBranch:
type: string
maxLength: 20
description: 'Código do ramo da atividade da empresa consultada, segundo padrão CNAE (Classificação Nacional de Atividades Econômicas).'
secondaryBranch:
type: string
maxLength: 200
description: Códigos relativos às demais atividades econômicas da empresa, segundo padrão CNAE (Classificação Nacional de Atividades Econômicas). Se disponível.
informedRevenue:
type: object
description: Objeto que agrupa dados de receita informada.
properties:
incomeFrequency:
$ref: '#/components/schemas/EnumIncomeFrequency'
currency:
description: 'Moeda referente ao valor do faturamento, segundo modelo ISO-4217.'
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
amount:
type: string
nullable: true
pattern: '^\d{1,16}\.\d{2}$'
example: '100000.04'
description: |
Valor do faturamento
year:
type: string
format: date-fullyear
pattern: '^\d{4}$'
example: '2010'
description: 'Ano de referência do faturamento, conforme especificação RFC-3339.'
additionalProperties: false
informedPatrimony:
type: object
description: Objeto que agrupa dados de informações de patrimônio.
properties:
currency:
description: 'Moeda referente ao valor do patrimônio, segundo modelo ISO-4217.'
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
amount:
type: string
nullable: true
pattern: '^-?\d{1,15}\.\d{2}$'
example: '100000.04'
description: |
Valor do patrimônio
date:
type: string
maxLength: 10
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2012-05-21'
description: 'Data de referência do patrimônio, conforme especificação RFC-3339.'
additionalProperties: false
additionalProperties: false
PersonalComplimentaryInformationData: ## schema dados cadastrais de fase 2 - atualização pendente
type: object
description: 'Objeto que reúne as informações relativas ao relacionamento do cliente junto à Instituição. Considera-se relacionamento as informações que permitam conhecer desde quando a pessoa consultada é cliente da instituição, bem como um indicador dos produtos e serviços que ela consome atualmente e seus representantes'
required:
- updateDateTime
- productsServices
- startDate
properties:
updateDateTime:
type: string
format: date-time
maxLength: 20
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
description: 'Data e hora da atualização do bloco de Relacionamento, conforme especificação RFC-3339, formato UTC.'
startDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2014-05-21'
description: Data mais antiga de início de relacionamento, considerando todos os contratos (vigentes e não vigentes). Os contratos não vigentes considerados devem contemplar, no mínimo o período indicado na Tabela 4.1.
relationshipBeginning:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2014-05-21'
description: Campo deve ser preenchido com a data da apólice/contrato vigente mais antiga (caso haja contrato vigente)
productsServices:
type: array
minItems: 1
items:
type: object
description: Lista de todos os contratos vigentes e não vigentes.
required:
- contract
- type
properties:
contract:
type: string
maxLength: 60
description: Campo deve conter todos os contratos do cliente nos últimos 12 meses (número da apólice individual ou contrato ou certificado ou bilhete)
type:
$ref: '#/components/schemas/EnumProductServiceType'
insuranceLineCode:
type: string
maxLength: 4
example: '6272'
description: Indicar para cada contrato, caso aplicável, o código do ramo, conforme listagem de códigos definida em regulamentação específica sobre contabilização em ramos. Obs - Caso tipo de produto do contrato for “Seguros de Danos”
procurators:
type: array
items:
$ref: '#/components/schemas/PersonalProcurator'
minItems: 1
description: Lista dos representantes. De preenchimento obrigatório se houver representante.
additionalProperties: false
additionalProperties: false
PersonalIdentificationData: ## schema dados cadastrais de fase 2 - atualização pendente
type: object
description: Conjunto de informações relativas a Identificação ou seja a ação e o efeito de identificar de forma única a pessoa natural através de seus dados cadastrais.
required:
- updateDateTime
- brandName
- companyInfo
- civilName
- hasBrazilianNationality
- contact
- cpfNumber
properties:
updateDateTime:
type: string
maxLength: 20
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
description: 'Data e hora da atualização do bloco, conforme especificação RFC-3339'
personalId:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
maxLength: 100
description: Um identificador único e imutável usado para identificar o recurso cliente pessoa natural dentro da transmissora. Este identificador não tem significado para o cliente que deu o consentimento
example: 578-psd-71md6971kjh-2d414
brandName:
type: string
maxLength: 80
pattern: '[\w\W\s]*'
description: Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes
example: Organização A
civilName:
type: string
maxLength: 70
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: Juan Kaique Cláudio Fernandes
description: 'Nome civil completo da pessoa natural (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte)'
socialName:
type: string
maxLength: 70
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: 'string'
description: |
Nome social da pessoa natural, se houver.
(aquele pelo qual travestis e transexuais se reconhecem,
bem como são identificados por sua comunidade e em seu meio social, conforme Decreto Local).
cpfNumber:
type: string
maxLength: 11
pattern: '^\d{11}$|^NA$'
description: |
Número completo do CPF. Atributo que corresponde às informações mínimas exigidas pela Regulamentação em vigor. O CPF é o Cadastro de Pessoa natural. Ele é um documento feito pela Receita Federal e serve para identificar os contribuintes. O CPF é uma numeração com 11 dígitos, que só mudam por decisão judicial. O documento é emitido pela receita federal
Condicional a seleção de true em hasBrazilianNationality
companyInfo:
type: object
description: Informações referente a sociedade a qual a marca pertence.
required:
- name
- cnpjNumber
properties:
cnpjNumber:
type: string
pattern: '\d{14}|^NA$'
maxLength: 14
example: '01773247000563'
description: |
Número completo do CNPJ da instituição responsável pelo Cadastro - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
Deve-se ter apenas os números do CNPJ, sem máscara
name:
type: string
maxLength: 70
pattern: '[\w\W\s]*'
example: Empresa da Organização A
description: Nome da Instituição, pertencente à Marca, responsável pela Dependência
documents:
$ref: '#/components/schemas/PersonalDocuments'
hasBrazilianNationality:
type: boolean
nullable: true
example: false
description: Informa se o Cliente tem nacionalidade brasileira.
otherNationalitiesInfo:
type: string
enum: [AFG,ALA,ALB,DZA,ASM,AND,AGO,AIA,ATA,ATG,ARG,ARM,ABW,AUS,AUT,AZE,BHS,BHR,BGD,BRB,BLR,BEL,BLZ,BEN,BMU,BTN,BOL,BES,BIH,BWA,BVT,IOT,BRN,BGR,BFA,BDI,CPV,KHM,CMR,CAN,CYM,CAF,TCD,CHL,CHN,CXR,CCK,COL,COM,COG,COD,COK,CRI,CIV,HRV,CUB,CUW,CYP,CZE,DNK,DJI,DMA,DOM,ECU,EGY,SLV,GNQ,ERI,EST,SWZ,ETH,FLK,FRO,FJI,FIN,FRA,GUF,PYF,ATF,GAB,GMB,GEO,DEU,GHA,GIB,GRC,GRL,GRD,GLP,GUM,GTM,GGY,GIN,GNB,GUY,HTI,HMD,VAT,HND,HKG,HUN,ISL,IND,IDN,IRN,IRQ,IRL,IMN,ISR,ITA,JAM,JPN,JEY,JOR,KAZ,KEN,KIR,PRK,KOR,KWT,KGZ,LAO,LVA,LBN,LSO,LBR,LBY,LIE,LTU,LUX,MAC,MDG,MWI,MYS,MDV,MLI,MLT,MHL,MTQ,MRT,MUS,MYT,MEX,FSM,MDA,MCO,MNG,MNE,MSR,MAR,MOZ,MMR,NAM,NRU,NPL,NLD,NCL,NZL,NIC,NER,NGA,NIU,NFK,MKD,MNP,NOR,OMN,PAK,PLW,PSE,PAN,PNG,PRY,PER,PHL,PCN,POL,PRT,PRI,QAT,REU,ROU,RUS,RWA,BLM,SHN,KNA,LCA,MAF,SPM,VCT,WSM,SMR,STP,SAU,SEN,SRB,SYC,SLE,SGP,SXM,SVK,SVN,SLB,SOM,ZAF,SGS,SSD,ESP,LKA,SDN,SUR,SJM,SWE,CHE,SYR,TWN,TJK,TZA,THA,TLS,TGO,TKL,TON,TTO,TUN,TUR,TKM,TCA,TUV,UGA,UKR,ARE,GBR,USA,UMI,URY,UZB,VUT,VEN,VNM,VGB,VIR,WLF,ESH,YEM,ZMB,ZWE]
example: CAN
description: Código do pais de acordo com o código “alpha3” do ISO-3166
otherDocuments:
$ref: '#/components/schemas/OtherPersonalDocuments'
contact:
$ref: '#/components/schemas/PersonalContact'
civilStatusCode:
$ref: '#/components/schemas/EnumCivilStatusCode'
sex:
type: string
maxLength: 20
example: FEMININO
birthDate:
type: string
maxLength: 10
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2021-05-21'
description: 'Data de nascimento, conforme especificação RFC-3339'
filiation:
type: object
description: Objeto que agrupa os dados de pessoa relativa à filiação.
properties:
type:
$ref: '#/components/schemas/EnumFiliationType'
civilName:
type: string
maxLength: 70
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: Marcelo Cláudio Fernandes
description: |
Nome civil completo da pessoa relativa à filiação.
(Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento,
com o qual será identificada por toda a sua vida, bem como após a sua morte).
identificationDetails:
type: object
description: Informações referente ao cônjuge.
properties:
civilName:
type: string
maxLength: 70
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: Juan Kaique Cláudio Fernandes
description: 'Nome civil completo da pessoa natural (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte)'
cpfNumber:
type: string
maxLength: 11
pattern: '^\d{11}$|^NA$'
description: |
Número completo do CPF. Atributo que corresponde às informações mínimas exigidas pela Regulamentação em vigor. O CPF é o Cadastro de Pessoa natural. Ele é um documento feito pela Receita Federal e serve para identificar os contribuintes. O CPF é uma numeração com 11 dígitos, que só mudam por decisão judicial. O documento é emitido pela receita federal
Condicional a seleção de true em hasBrazilianNationality
additionalProperties: false
PersonalQualificationData: ## schema dados cadastrais de fase 2 - atualização pendente
type: object
description: 'Conjunto de informações relativas ao processo de qualificação.'
required:
- pepIdentification
- updateDateTime
- lifePensionPlans
properties:
updateDateTime:
type: string
maxLength: 20
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
description: 'Data e hora da atualização do bloco, conforme especificação RFC-3339'
pepIdentification:
type: string
description: 'Campo deve ser preenchido com a exposição política do segurado:'
example: NAO_EXPOSTO
enum:
- NAO_EXPOSTO
- PESSOA_POLITICAMENTE_EXPOSTA_PPE
- PESSOA_PROXIMA_A_PESSOA_POLITICAMENTE_EXPOSTA_PPEE
- SEM_INFORMACAO
occupation:
type: array
minItems: 1
items:
type: object
description: Objeto agrupador de informações relativas ocupação da pessoa natural
properties:
details:
type: string
maxLength: 100
description: 'Ocupação'
occupationCode:
type: string
maxLength: 100
example: 'RECEITA_FEDERAL'
description: 'Código da ocupação'
occupationCodeType:
type: string
example: RFB
enum:
- RFB
- CBO
- OUTROS
description: 'Tipo de código da ocupação'
occupationCodeTypeOthers:
description: Descricao do tipo de codigo da ocupacao quando for informada a opcao OUTROS
type: string
maxLength: 100
lifePensionPlans:
type: string
description: Condição de proponente qualificado, aplicável à contratação de planos de previdência e vida por sobrevivência
example: SIM
enum:
- SIM
- NAO
- NAO_SE_APLICA
informedRevenue:
type: object
description: Objeto que agrupa dados de receita informada.
properties:
incomeFrequency:
$ref: '#/components/schemas/EnumIncomeFrequency'
currency:
description: 'Moeda referente ao valor da renda, segundo modelo ISO-4217.'
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
amount:
type: string
nullable: true
pattern: '^-?\d{1,15}\.\d{2}$'
example: '100000.04'
description: |
Valor do rendimento
date:
type: string
maxLength: 10
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2012-05-21'
description: 'Data de referência da renda, conforme especificação RFC-3339.'
additionalProperties: false
informedPatrimony:
type: object
description: Objeto que agrupa dados de informações de patrimônio.
properties:
currency:
description: 'Moeda referente ao valor do patrimônio, segundo modelo ISO-4217.'
type: string
example: BRL
enum: [AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG]
amount:
type: string
nullable: true
pattern: '^-?\d{1,15}\.\d{2}$'
example: '100000.04'
description: |
Valor do patrimônio
year:
type: string
maxLength: 4
format: date-fullyear
pattern: '^\d{4}$'
example: '2010'
description: 'Ano de referência do patrimônio, conforme especificação RFC-3339.'
additionalProperties: false
additionalProperties: false
QuoteStatus:
type: object
required:
- status
- statusUpdateDateTime
properties:
status:
description: Status da cotação.
type: string
minItems: 1
example: RCVD
enum: [RCVD,
EVAL,
ACPT,
RJCT,
ACKN,
CANC]
rejectionReason:
description: Campo condicionado ao status "RJCT", que deve apresentar a justificativa a recusa ao risco.
type: string
maxLength: 1024
statusUpdateDateTime:
type: string
description: Data e hora da atualização do status.
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
PersonalDocuments:
type: array
description: Objeto agrupador de informações relativas a Documentos da pessoa natural
items:
type: object
properties:
type:
$ref: '#/components/schemas/EnumPersonalDocumentType'
documentTypeOthers:
description: Descricao do tipo de documento quando for informada a opcao OUTROS
type: string
maxLength: 100
number:
type: string
maxLength: 20
description: Número/código do(s) documento(s) de identificação - Se aplicável.
example: '15291908'
expirationDate:
type: string
maxLength: 10
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2023-05-21'
description: Data de validade do(s) documento(s) de identificação - Se aplicável.
issueLocation:
type: string
maxLength: 40
description: Local de emissão - Se aplicável.
additionalProperties: false
OtherPersonalDocuments:
type: object
description: Objeto que agrupa dados de outros documentos.
properties:
type:
type: string
maxLength: 40
description: Tipo do(s) documento(s) estrangeiro(s) de identificação
example: 'SOCIAL SEC'
number:
type: string
maxLength: 20
description: Número/código do(s) documento(s) de identificação.
example: '15291908'
country:
type: string
maxLength: 40
description: País do(s) documento(s) estrangeiro(s) de identificação.
expirationDate:
type: string
maxLength: 10
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2023-05-21'
description: Data de vigência do documento de registro - conforme especificação RFC-3339.
additionalProperties: false
BusinessDocument:
type: object
required:
- businesscnpjNumber
description: Objeto agrupador de informações relativas a Documentos da pessoa natural
properties:
businesscnpjNumber:
type: string
maxLength: 14
pattern: '\d{14}|^NA$'
example: '50685362006773'
description: |
Número completo do CNPJ da Empresa consultada - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os números do CNPJ, sem máscara
Condicional ao Brasil no (BRA) campo País de emissão do documento de registro
businessRegisterNumberOriginCountry:
type: string
maxLength: 20
description: |
Aplicável somente as pessoas jurídicas com domicílio ou sede no exterior desobrigadas de inscrição no CNPJ.
country:
description: Código do pais de acordo com o código “alpha3” do ISO-3166.
type: string
enum: [AFG,ALA,ALB,DZA,ASM,AND,AGO,AIA,ATA,ATG,ARG,ARM,ABW,AUS,AUT,AZE,BHS,BHR,BGD,BRB,BLR,BEL,BLZ,BEN,BMU,BTN,BOL,BES,BIH,BWA,BVT,BRA,IOT,BRN,BGR,BFA,BDI,CPV,KHM,CMR,CAN,CYM,CAF,TCD,CHL,CHN,CXR,CCK,COL,COM,COG,COD,COK,CRI,CIV,HRV,CUB,CUW,CYP,CZE,DNK,DJI,DMA,DOM,ECU,EGY,SLV,GNQ,ERI,EST,SWZ,ETH,FLK,FRO,FJI,FIN,FRA,GUF,PYF,ATF,GAB,GMB,GEO,DEU,GHA,GIB,GRC,GRL,GRD,GLP,GUM,GTM,GGY,GIN,GNB,GUY,HTI,HMD,VAT,HND,HKG,HUN,ISL,IND,IDN,IRN,IRQ,IRL,IMN,ISR,ITA,JAM,JPN,JEY,JOR,KAZ,KEN,KIR,PRK,KOR,KWT,KGZ,LAO,LVA,LBN,LSO,LBR,LBY,LIE,LTU,LUX,MAC,MDG,MWI,MYS,MDV,MLI,MLT,MHL,MTQ,MRT,MUS,MYT,MEX,FSM,MDA,MCO,MNG,MNE,MSR,MAR,MOZ,MMR,NAM,NRU,NPL,NLD,NCL,NZL,NIC,NER,NGA,NIU,NFK,MKD,MNP,NOR,OMN,PAK,PLW,PSE,PAN,PNG,PRY,PER,PHL,PCN,POL,PRT,PRI,QAT,REU,ROU,RUS,RWA,BLM,SHN,KNA,LCA,MAF,SPM,VCT,WSM,SMR,STP,SAU,SEN,SRB,SYC,SLE,SGP,SXM,SVK,SVN,SLB,SOM,ZAF,SGS,SSD,ESP,LKA,SDN,SUR,SJM,SWE,CHE,SYR,TWN,TJK,TZA,THA,TLS,TGO,TKL,TON,TTO,TUN,TUR,TKM,TCA,TUV,UGA,UKR,ARE,GBR,USA,UMI,URY,UZB,VUT,VEN,VNM,VGB,VIR,WLF,ESH,YEM,ZMB,ZWE]
example: BRA
expirationDate:
type: string
maxLength: 10
format: date
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2023-05-21'
description: 'Data de vigência do documento de registro - conforme especificação RFC-3339.'
additionalProperties: false
AmountDetails:
type: object
description: Detalhes de valores/limites
required:
- amount
- unitType
properties:
amount:
type: string
pattern: '^(^(100\.\00|\d{1,2}\.\d{2})$|^(\d{1,6})$|^(\d{1,15}\.\d{2})$)$'
description: |
Valor.
Exemplos de preenchimento do campo:
PORCENTAGEM: 90.85
MONETARIO: 62500.67
OUTROS: 1000 (Exemplo de outro tipo: horas)
unitType:
description: "Tipo da unidade referente ao valor inserido no campo Amount"
type: string
enum: [PORCENTAGEM, MONETARIO, OUTROS]
unitTypeOthers:
description: Caso o tipo do valor informado for "Outros", esse campo deve ser preenchido com o tipo do valor, obrigatoriamente.
type: string
example: Horas
unit:
description: Preenchimento obrigatório em caso de valor "MONETARIO" ser informado no campo "unitType"
type: object
required:
- code
- description
properties:
code:
type: string
enum: [ د.إ , Af, L, Դ, Kz, $, ƒ, ман, КМ, ৳, лв, ب.د, ₣, Bs., R$, P, Br, ¥, ₡, Kč, kr, د.ج, £,
Nfk, N/A, €, ლ, ₵, D, Q, Kn, G, Ft, Rp, ₪, ₹, ع.د, ﷼, Sh, ៛, ₩, د.ك, 〒, ₭, ل.ل, Rs,
ل.د, د.م., ден, K, ₮, UM, ₨, ރ., MK, RM, MTn, ₦, C$, ر.ع., B/., S/., ₱, zł, ₲, ر.ق, din,
р., ر.س, Le, Db, ل.س, ฿, ЅМ, m, د.ت, T$, ₤, ₴, Bs F, ₫, Vt, T, R, ZK ]
example: R$
description:
type: string
description: Moeda da Parcela, de acordo com ISO-4217.
example: BRL
enum: [ AFN,AFA,ALL,ALK,DZD,USD,EUR,ADP,ESP,FRF,AOA,AOK,AON,AOR,XCD,ARS,ARA,ARP,ARY,AMD,RUR,AWG,AUD,ATS,AZN,AYM,AZM,BSD,BHD,BDT,BBD,BYN,BYB,BYR,BEC,BEF,BEL,BZD,XOF,BMD,INR,BTN,BOP,BOB,BOV,BAM,BAD,BWP,NOK,BRL,BRB,BRC,BRE,BRN,BRR,BND,BGN,BGJ,BGK,BGL,BUK,BIF,CVE,KHR,XAF,CAD,KYD,CLP,CLF,CNY,COP,COU,KMF,CDF,NZD,CRC,HRK,HRD,CUP,CUC,ANG,CYP,CZK,CSJ,CSK,DKK,DJF,DOP,ECS,ECV,EGP,SVC,GQE,ERN,EEK,SZL,ETB,XEU,FKP,FJD,FIM,XPF,GMD,GEL,GEK,DDM,DEM,GHS,GHC,GHP,GIP,GRD,GTQ,GBP,GNF,GNE,GNS,GWE,GWP,GYD,HTG,ITL,HNL,HKD,HUF,ISK,ISJ,IDR,XDR,IRR,IQD,IEP,ILS,ILP,ILR,JMD,JPY,JOD,KZT,KES,KPW,KRW,KWD,KGS,LAJ,LAK,LVL,LVR,LBP,LSL,ZAR,LSM,ZAL,LRD,LYD,CHF,LTL,LTT,LUC,LUF,LUL,MOP,MGA,MGF,MWK,MYR,MVR,MVQ,MLF,MTL,MTP,MRU,MRO,MUR,XUA,MXN,MXV,MXP,MDL,MNT,MAD,MZN,MZE,MZM,MMK,NAD,NPR,NLG,NIO,NIC,NGN,MKD,OMR,PKR,PAB,PGK,PYG,PEN,PEH,PEI,PES,PHP,PLN,PLZ,PTE,QAR,RON,ROK,ROL,RUB,RWF,SHP,WST,STN,STD,SAR,RSD,CSD,SCR,SLL,SGD,XSU,SKK,SIT,SBD,SOS,SSP,SDG,RHD,ESA,ESB,LKR,SDD,SDP,SRD,SRG,SEK,CHE,CHW,CHC,SYP,TWD,TJS,TJR,TZS,THB,TPE,TOP,TTD,TND,TRY,TRL,TMT,TMM,UGX,UGS,UGW,UAH,UAK,SUR,AED,USS,USN,UYU,UYI,UYW,UYN,UYP,UZS,VUV,VEB,VEF,VES,VND,VNC,YER,YDD,YUD,YUM,YUN,ZRN,ZRZ,ZMW,ZMK,ZWL,ZWC,ZWD,ZWN,ZWR,XBA,XFO,XBB,XRE,XBC,XBD,XFU,XTS,XXX,XAU,XPD,XPT,XAG ]
QuoteCustomData:
type: object
description: Objeto que agrupa as categorias de dados customizáveis em listas.
properties:
customerIdentification:
type: array
items:
$ref: '#/components/schemas/CustomInfoData'
customerQualification:
type: array
items:
$ref: '#/components/schemas/CustomInfoData'
customerComplimentaryInfo:
type: array
items:
$ref: '#/components/schemas/CustomInfoData'
generalQuoteInfo:
type: array
items:
$ref: '#/components/schemas/CustomInfoData'
riskLocationInfo:
type: array
items:
$ref: '#/components/schemas/CustomInfoData'
insuredObjects:
type: array
items:
$ref: '#/components/schemas/CustomInfoData'
beneficiaries:
type: array
items:
$ref: '#/components/schemas/CustomInfoData'
coverages:
type: array
items:
$ref: '#/components/schemas/CustomInfoData'
generalClaimInfo:
type: array
items:
$ref: '#/components/schemas/CustomInfoData'
CustomInfoData:
type: object
description: Objeto para identificação dos campos e valores de dados customizáveis.
required:
- fieldId
- value
properties:
fieldId:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
maxLength: 100
description: Um identificador único usado para identificar o valor transmitido.
example: "578-psd-71md6971kjh-2d414"
value:
description: Valor do campo identificado acima, esse campo pode ser implementado como qualquer tipo de dado (objeto, texto, número, booleano, etc.)
additionalProperties: false
EnumProductServiceType:
type: string
enum:
- MICROSSEGUROS
- TITULOS_DE_CAPITALIZACAO
- SEGUROS_DE_PESSOAS
- PLANOS_DE_PREVIDENCIA_COMPLEMENTAR
- SEGUROS_DE_DANOS
example: MICROSSEGUROS
description: Tipos de produtos.
PersonalContact:
type: object
description: Conjunto de informações referentes às formas para contatar o cliente.
required:
- postalAddresses
properties:
postalAddresses:
type: array
items:
$ref: '#/components/schemas/PersonalPostalAddress'
minItems: 1
description: Lista de endereços da pessoa física.
phones:
type: array
items:
$ref: '#/components/schemas/CustomerPhone'
minItems: 1
description: Lista com telefones de contato da pessoa física.
emails:
type: array
items:
$ref: '#/components/schemas/CustomerEmail'
minItems: 1
description: Lista e-mails de contato
additionalProperties: false
CustomerEmail:
type: object
properties:
email:
type: string
description: Endereço de email
maxLength: 320
pattern: '^\S+@\S+\.\S+$'
example: nome@br.net
additionalProperties: false
CustomerPhone:
type: object
properties:
countryCallingCode:
type: string
maxLength: 4
pattern: '^\d{1,4}$'
example: '55'
description: Número de DDI (Discagem Direta Internacional) para telefone de acesso ao Cliente - se aplicável
areaCode:
$ref: '#/components/schemas/EnumAreaCode'
number:
type: string
maxLength: 11
pattern: '^([0-9]{8,11})|^NA$'
example: '29875132'
description: Número de telefone do cliente
phoneExtension:
type: string
maxLength: 5
pattern: '^\d{1,5}$|^NA$'
description: Número do ramal. De preenchimento obrigatório se fizer parte da identificação do número do telefone informado
example: '932'
additionalProperties: false
PersonalPostalAddress:
type: object
required:
- address
- townName
- countrySubDivision
- postCode
- country
properties:
address:
type: string
maxLength: 200
pattern: '[\w\W\s]*'
example: 'Av Naburo Ykesaki, 1270'
description: Corresponde ao endereço residencial do cliente.
additionalInfo:
type: string
maxLength: 30
pattern: '[\w\W\s]*'
example: Fundos
description: Alguns logradouros ainda necessitam ser especificados por meio de complemento.
districtName:
type: string
maxLength: 50
pattern: '[\w\W\s]*'
example: Centro
description: Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas.
townName:
type: string
maxLength: 50
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: Marília
description: |
Localidade: O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado.
countrySubDivision:
$ref: '#/components/schemas/EnumCountrySubDivision'
postCode:
type: string
pattern: '\d{8}|^NA$'
maxLength: 8
example: '10000000'
description: |
Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios. p.ex. '01311000'.
country:
description: País do segurado (de acordo com o código "alpha3" do ISO-3166)
type: string
enum: [AFG,ALA,ALB,DZA,ASM,AND,AGO,AIA,ATA,ATG,ARG,ARM,ABW,AUS,AUT,AZE,BHS,BHR,BGD,BRB,BLR,BEL,BLZ,BEN,BMU,BTN,BOL,BES,BIH,BWA,BVT,BRA,IOT,BRN,BGR,BFA,BDI,CPV,KHM,CMR,CAN,CYM,CAF,TCD,CHL,CHN,CXR,CCK,COL,COM,COG,COD,COK,CRI,CIV,HRV,CUB,CUW,CYP,CZE,DNK,DJI,DMA,DOM,ECU,EGY,SLV,GNQ,ERI,EST,SWZ,ETH,FLK,FRO,FJI,FIN,FRA,GUF,PYF,ATF,GAB,GMB,GEO,DEU,GHA,GIB,GRC,GRL,GRD,GLP,GUM,GTM,GGY,GIN,GNB,GUY,HTI,HMD,VAT,HND,HKG,HUN,ISL,IND,IDN,IRN,IRQ,IRL,IMN,ISR,ITA,JAM,JPN,JEY,JOR,KAZ,KEN,KIR,PRK,KOR,KWT,KGZ,LAO,LVA,LBN,LSO,LBR,LBY,LIE,LTU,LUX,MAC,MDG,MWI,MYS,MDV,MLI,MLT,MHL,MTQ,MRT,MUS,MYT,MEX,FSM,MDA,MCO,MNG,MNE,MSR,MAR,MOZ,MMR,NAM,NRU,NPL,NLD,NCL,NZL,NIC,NER,NGA,NIU,NFK,MKD,MNP,NOR,OMN,PAK,PLW,PSE,PAN,PNG,PRY,PER,PHL,PCN,POL,PRT,PRI,QAT,REU,ROU,RUS,RWA,BLM,SHN,KNA,LCA,MAF,SPM,VCT,WSM,SMR,STP,SAU,SEN,SRB,SYC,SLE,SGP,SXM,SVK,SVN,SLB,SOM,ZAF,SGS,SSD,ESP,LKA,SDN,SUR,SJM,SWE,CHE,SYR,TWN,TJK,TZA,THA,TLS,TGO,TKL,TON,TTO,TUN,TUR,TKM,TCA,TUV,UGA,UKR,ARE,GBR,USA,UMI,URY,UZB,VUT,VEN,VNM,VGB,VIR,WLF,ESH,YEM,ZMB,ZWE]
example: BRA
additionalProperties: false
EnumCountrySubDivision:
type: string
description: 'Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. p.ex. ''AC''. São consideradas apenas as siglas para os estados brasileiros'
enum:
- AC
- AL
- AP
- AM
- BA
- CE
- DF
- ES
- GO
- MA
- MT
- MS
- MG
- PA
- PB
- PR
- PE
- PI
- RJ
- RN
- RS
- RO
- RR
- SC
- SP
- SE
- TO
example: SP
EnumCivilStatusCode:
type: string
enum:
- SOLTEIRO
- CASADO
- VIUVO
- SEPARADO_JUDICIALMENTE
- DIVORCIADO
- UNIAO_ESTAVEL
- OUTROS
example: SOLTEIRO
description: |
Estado civil do cliente.
EnumAreaCode:
type: string
example: '19'
description: Número de DDD (Discagem Direta à Distância) do telefone do cliente - se houver
enum:
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '21'
- '22'
- '24'
- '27'
- '28'
- '31'
- '32'
- '33'
- '34'
- '35'
- '37'
- '38'
- '41'
- '42'
- '43'
- '44'
- '45'
- '46'
- '47'
- '48'
- '49'
- '51'
- '53'
- '54'
- '55'
- '61'
- '62'
- '63'
- '64'
- '65'
- '66'
- '67'
- '68'
- '69'
- '71'
- '73'
- '74'
- '75'
- '77'
- '79'
- '81'
- '82'
- '83'
- '84'
- '85'
- '86'
- '87'
- '88'
- '89'
- '91'
- '92'
- '93'
- '94'
- '95'
- '96'
- '97'
- '98'
- '99'
- NA
EnumIncomeFrequency:
type: string
enum:
- DIARIA
- SEMANAL
- QUINZENAL
- MENSAL
- BIMESTRAL
- TRIMESTRAL
- SEMESTRAL
- ANUAL
description: |
Frequência da renda informada.
EnumPersonalDocumentType:
type: string
enum:
- CNH
- RG
- NIF
- RNE
- OUTROS
- SEM_OUTROS_DOCUMENTOS
example: CNH
description: |
Tipo do(s) documento(s) de identificação.
EnumFiliationType:
type: string
enum:
- MAE
- PAI
- SEM_FILIACAO
description: Tipo de filiação.
EnumProcuratorsNaturePersonal:
type: string
enum:
- REPRESENTANTE_LEGAL
- PROCURADOR
- NAO_SE_APLICA
example: PROCURADOR
description: |
Natureza dos poderes vigentes de representante
EnumProcuratorsNatureBusiness:
type: string
enum:
- REPRESENTANTE_LEGAL
- PROCURADOR
- NAO_SE_APLICA
example: PROCURADOR
description: |
Natureza dos poderes vigentes de representante
BusinessParties:
type: array
description: Conjunto de informações referentes ao vínculo com uma pessoa.
items:
type: object
properties:
type:
type: string
example: SOCIO
description: Tipo de vínculo com a pessoa jurídica
enum:
- SOCIO
- ADMINISTRADOR
civilName:
type: string
maxLength: 70
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: Juan Kaique Cláudio Fernandes
description: 'Nome civil completo da pessoa natural (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte)'
socialName:
type: string
maxLength: 70
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: 'string'
description: |
Nome social da pessoa natural, se houver.
(aquele pelo qual travestis e transexuais se reconhecem,
bem como são identificados por sua comunidade e em seu meio social, conforme Decreto Local).
startDate:
type: string
format: date
maxLength: 10
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
example: '2014-05-21'
description: 'Data de início da participação, conforme especificação RFC-3339.'
shareholding:
type: string
format: double
pattern: '^100\.0{1,9}$|^\d{1,2}\.\d{1,9}$'
example: '0.510000'
description: |
Percentual de participação societária (informar com 6 casas decimais).
O Sócio só deve ser informado se sua participação societária for igual ou superior a 25%.
documentType:
type: string
maxLength: 15
example: CPF
description: 'Tipo de documento de identificação do sócio ou administrador'
documentNumber:
type: string
maxLength: 20
pattern: '[\w\W\s]*'
example: '73677831148'
description: Número do documento informado. Campo Texto Livre para preencher número e dígito do documento se houver
documentCountry:
type: string
enum: [AFG,ALA,ALB,DZA,ASM,AND,AGO,AIA,ATA,ATG,ARG,ARM,ABW,AUS,AUT,AZE,BHS,BHR,BGD,BRB,BLR,BEL,BLZ,BEN,BMU,BTN,BOL,BES,BIH,BWA,BVT,BRA,IOT,BRN,BGR,BFA,BDI,CPV,KHM,CMR,CAN,CYM,CAF,TCD,CHL,CHN,CXR,CCK,COL,COM,COG,COD,COK,CRI,CIV,HRV,CUB,CUW,CYP,CZE,DNK,DJI,DMA,DOM,ECU,EGY,SLV,GNQ,ERI,EST,SWZ,ETH,FLK,FRO,FJI,FIN,FRA,GUF,PYF,ATF,GAB,GMB,GEO,DEU,GHA,GIB,GRC,GRL,GRD,GLP,GUM,GTM,GGY,GIN,GNB,GUY,HTI,HMD,VAT,HND,HKG,HUN,ISL,IND,IDN,IRN,IRQ,IRL,IMN,ISR,ITA,JAM,JPN,JEY,JOR,KAZ,KEN,KIR,PRK,KOR,KWT,KGZ,LAO,LVA,LBN,LSO,LBR,LBY,LIE,LTU,LUX,MAC,MDG,MWI,MYS,MDV,MLI,MLT,MHL,MTQ,MRT,MUS,MYT,MEX,FSM,MDA,MCO,MNG,MNE,MSR,MAR,MOZ,MMR,NAM,NRU,NPL,NLD,NCL,NZL,NIC,NER,NGA,NIU,NFK,MKD,MNP,NOR,OMN,PAK,PLW,PSE,PAN,PNG,PRY,PER,PHL,PCN,POL,PRT,PRI,QAT,REU,ROU,RUS,RWA,BLM,SHN,KNA,LCA,MAF,SPM,VCT,WSM,SMR,STP,SAU,SEN,SRB,SYC,SLE,SGP,SXM,SVK,SVN,SLB,SOM,ZAF,SGS,SSD,ESP,LKA,SDN,SUR,SJM,SWE,CHE,SYR,TWN,TJK,TZA,THA,TLS,TGO,TKL,TON,TTO,TUN,TUR,TKM,TCA,TUV,UGA,UKR,ARE,GBR,USA,UMI,URY,UZB,VUT,VEN,VNM,VGB,VIR,WLF,ESH,YEM,ZMB,ZWE]
example: BRA
description: |
País de emissão do documento. Código do pais de acordo com o código alpha3 do ISO-3166.
documentExpirationDate:
type: string
format: date
maxLength: 10
example: '2021-05-21'
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$'
description: 'Data de validade do documento informado, conforme especificação RFC-3339.'
additionalProperties: false
BusinessContact:
type: object
description: Conjunto de informações referentes às formas para contatar o cliente.
required:
- postalAddresses
properties:
postalAddresses:
type: array
description: Lista que agrupa os dados de endereço da pessoa jurídica.
items:
$ref: '#/components/schemas/BusinessPostalAddress'
minItems: 1
phones:
type: array
items:
$ref: '#/components/schemas/CustomerPhone'
minItems: 1
description: Lista com telefones de contato da pessoa jurídica.
emails:
type: array
items:
$ref: '#/components/schemas/CustomerEmail'
minItems: 1
description: Lista e-mails de contato
additionalProperties: false
BusinessPostalAddress:
type: object
required:
- address
- townName
- countrySubDivision
- postCode
- country
properties:
address:
type: string
maxLength: 200
pattern: '[\w\W\s]*'
example: 'Av Naburo Ykesaki, 1270'
description: Corresponde ao endereço residencial do cliente.
additionalInfo:
type: string
maxLength: 30
pattern: '[\w\W\s]*'
example: Fundos
description: Alguns logradouros ainda necessitam ser especificados por meio de complemento.
districtName:
type: string
maxLength: 50
pattern: '[\w\W\s]*'
example: Centro
description: Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas.
townName:
type: string
maxLength: 50
pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
example: Marília
description: |
Localidade: O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado.
countrySubDivision:
$ref: '#/components/schemas/EnumCountrySubDivision'
postCode:
type: string
pattern: '\d{8}|^NA$'
maxLength: 8
example: '10000000'
description: |
Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios. p.ex. '01311000'.
ibgeTownCode:
type: string
pattern: '\d{7}|^NA$'
maxLength: 7
example: '1750000'
description: |
Código IBGE do município
country:
type: string
maxLength: 60
example: Brasil
countryCode:
description: País do segurado (de acordo com o código "alpha3" do ISO-3166)
type: string
enum: [AFG,ALA,ALB,DZA,ASM,AND,AGO,AIA,ATA,ATG,ARG,ARM,ABW,AUS,AUT,AZE,BHS,BHR,BGD,BRB,BLR,BEL,BLZ,BEN,BMU,BTN,BOL,BES,BIH,BWA,BVT,BRA,IOT,BRN,BGR,BFA,BDI,CPV,KHM,CMR,CAN,CYM,CAF,TCD,CHL,CHN,CXR,CCK,COL,COM,COG,COD,COK,CRI,CIV,HRV,CUB,CUW,CYP,CZE,DNK,DJI,DMA,DOM,ECU,EGY,SLV,GNQ,ERI,EST,SWZ,ETH,FLK,FRO,FJI,FIN,FRA,GUF,PYF,ATF,GAB,GMB,GEO,DEU,GHA,GIB,GRC,GRL,GRD,GLP,GUM,GTM,GGY,GIN,GNB,GUY,HTI,HMD,VAT,HND,HKG,HUN,ISL,IND,IDN,IRN,IRQ,IRL,IMN,ISR,ITA,JAM,JPN,JEY,JOR,KAZ,KEN,KIR,PRK,KOR,KWT,KGZ,LAO,LVA,LBN,LSO,LBR,LBY,LIE,LTU,LUX,MAC,MDG,MWI,MYS,MDV,MLI,MLT,MHL,MTQ,MRT,MUS,MYT,MEX,FSM,MDA,MCO,MNG,MNE,MSR,MAR,MOZ,MMR,NAM,NRU,NPL,NLD,NCL,NZL,NIC,NER,NGA,NIU,NFK,MKD,MNP,NOR,OMN,PAK,PLW,PSE,PAN,PNG,PRY,PER,PHL,PCN,POL,PRT,PRI,QAT,REU,ROU,RUS,RWA,BLM,SHN,KNA,LCA,MAF,SPM,VCT,WSM,SMR,STP,SAU,SEN,SRB,SYC,SLE,SGP,SXM,SVK,SVN,SLB,SOM,ZAF,SGS,SSD,ESP,LKA,SDN,SUR,SJM,SWE,CHE,SYR,TWN,TJK,TZA,THA,TLS,TGO,TKL,TON,TTO,TUN,TUR,TKM,TCA,TUV,UGA,UKR,ARE,GBR,USA,UMI,URY,UZB,VUT,VEN,VNM,VGB,VIR,WLF,ESH,YEM,ZMB,ZWE]
example: BRA
geographicCoordinates:
$ref: '#/components/schemas/GeographicCoordinates'
additionalProperties: false
GeographicCoordinates:
type: object
description: 'Conjunto de informações, que correspondem aos valores das coordenadas geográficas em graus decimais, no Sistema de referência WGS84'
properties:
latitude:
description: |
Informação da Latitude referente a geolocalização informada. Entre -90 e 90.p.ex. '-23.5475000'. (2 casas antes da vírgula, 11 posições)
type: string
pattern: '^-?(90\.0{1,9}|[0-8][0-9]\.\d{1,9})$'
example: '-23.5475000'
longitude:
description: |
Informação da Longitude referente a geolocalização informada. Entre -180 e 180. p.ex '-46.6361100'. (3 casas antes da vírgula, 11 posições)
type: string
pattern: '^-?(180\.0{1,9}|1[0-7]\d{1}\.\d{1,9}|\d{1,2}\.\d{1,9})$'
example: '-46.6361100'
additionalProperties: false
RevokePatchPayload:
type: object
required:
- data
properties:
data:
type: object
description: Revogação de LEAD.
required:
- author
properties:
author:
type: object
required:
- identificationType
- identificationNumber
properties:
identificationType:
type: string
description: Tipo identificação (CPF ou CNPJ) do solicitante do cancelamento/revogação.
enum: [CPF,CNPJ]
example: CPF
identificationNumber:
type: string
description: Número de identificação (CPF ou CNPJ) do solicitante do cancelamento/revogação.
maxLength: 20
pattern: '[\w\W\s]*'
example: '73677831148'
ResponseRevokePatch:
type: object
required:
- data
properties:
data:
type: object
description: Objeto contendo informações da atualização.
required:
- status
properties:
status:
description: Status da cotação.
type: string
example: CANC
enum: [CANC]
PatchPayload:
type: object
required:
- data
properties:
data:
type: object
required:
- status
- author
properties:
status:
description: Status da cotação.
type: string
example: CANC
enum: [ACKN,CANC]
insurerQuoteId:
type: string
description: |
Id da proposta da segurada
Esse ID é utilizado em jornadas de cotação completa/firme e leva o número identificador da proposta aceita (ACKN) pelo cliente.
Condicional ao status de ACKN.
author:
type: object
required:
- identificationType
- identificationNumber
properties:
identificationType:
type: string
description: Tipo identificação (CPF ou CNPJ) do solicitante do cancelamento/revogação.
enum: [CPF,CNPJ]
example: CPF
identificationNumber:
type: string
description: Número de identificação (CPF ou CNPJ) do solicitante do cancelamento/revogação.
maxLength: 20
pattern: '[\w\W\s]*'
example: '73677831148'
ResponsePatch:
type: object
required:
- data
properties:
data:
type: object
description: Objeto contendo informações da atualização.
required:
- status
properties:
status:
description: Status da cotação.
type: string
example: CANC
enum: [ACKN,CANC]
insurerQuoteId:
type: string
description: |
Id da proposta da segurada
Esse ID é utilizado em jornadas de cotação completa/firme e leva o número identificador da proposta aceita (ACKN) pelo cliente.
Condicional ao status de ACKN.
protocolNumber:
description: Protocolo referente a cotação aceita. Condicional ao status de ACKN.
type: string
maxLength: 60
protocolDateTime:
description: Data e hora do protocolamento da cotação, conforme especificação RFC-3339, formato UTC. Condicional ao status de ACKN.
type: string
maxLength: 2048
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-08-20T08:30:00Z'
links:
description: Condicional ao status de ACKN.
type: object
required:
- redirect
properties:
redirect:
type: string
example: http://www.abcseguros.com/propostas_cotacao?propID=003
description: Link interno da seguradora, onde o cliente é redirecionado para conclusão da contratação
Links:
type: object
properties:
self:
type: string
description: URL da página atualmente requisitada
example: 'https://api.organizacao.com.br/open-insurance/quote-patrimonial/v1'
first:
type: string
description: URL da primeira página de registros
example: 'https://api.organizacao.com.br/open-insurance/quote-patrimonial/v1'
prev:
type: string
description: URL da página anterior de registros
example: 'https://api.organizacao.com.br/open-insurance/quote-patrimonial/v1'
next:
type: string
description: URL da próxima página de registros
example: 'https://api.organizacao.com.br/open-insurance/quote-patrimonial/v1'
last:
type: string
description: URL da última página de registros
example: 'https://api.organizacao.com.br/open-insurance/quote-patrimonial/v1'
Meta:
type: object
properties:
totalRecords:
type: integer
description: Total de registros encontrados
example: 10
totalPages:
type: integer
description: Total de páginas para os registros encontrados
example: 1
required:
- totalRecords
- totalPages
ResponseError:
type: object
required:
- errors
properties:
errors:
type: array
minItems: 1
maxItems: 13
items:
type: object
required:
- code
- title
- detail
properties:
code:
description: Código de erro específico do endpoint
type: string
pattern: '[\w\W\s]*'
maxLength: 255
title:
description: Título legível por humanos deste erro específico
type: string
maxLength: 255
detail:
description: Descrição legível por humanos deste erro específico
type: string
maxLength: 2048
requestDateTime:
description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.'
type: string
maxLength: 20
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-08-20T08:30:00Z'
additionalProperties: false
meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
422ResponseErrorCreateQuote:
type: object
required:
- errors
properties:
errors:
type: object
minItems: 1
required:
- code
- title
- detail
properties:
code:
type: string
enum:
- ERRO_IDEMPOTENCIA
- NAO_INFORMADO
example: 'ERRO_IDEMPOTENCIA'
description: 'Código do erro 422 de Entidade não processada.'
title:
type: string
maxLength: 255
pattern: '[\w\W\s*]'
example: 'Tentativa de alteração de requisição já processada'
description: |
- ERRO_ IDEMPOTENCIA: Tentativa de alteração de requisição já processada
- NÃO_INFORMADO: Não informada pelo servidor
detail:
type: string
maxLength: 2048
pattern: '[\w\W\s*]'
example: 'Tentativa de alteração de requisição já processada'
description: |
- ERRO_ IDEMPOTENCIA: Tentativa de alteração de requisição já processada
- NÃO_INFORMADO: Não informada pelo servidor
XFapiInteractionId:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
maxLength: 100
description: 'Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.'
QuoteRequestPatrimonialLead:
type: object
required:
- data
properties:
data:
type: object
required:
- consentId
- expirationDateTime
- quoteCustomer
- quoteData
properties:
consentId:
description: |
O consentId é o identificador único do consentimento e deverá ser um URN - Uniform Resource Name.
Um URN, conforme definido na [RFC8141](https://tools.ietf.org/html/rfc8141) é um Uniform Resource
Identifier - URI - que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN
seja um identificador de recurso persistente e independente da localização.
Considerando a string urn:initiator:C1DD93123 como exemplo para consentId temos:
- o namespace(urn)
- o identificador associado ao namespace da instituição transnmissora (initiator)
- o identificador específico dentro do namespace (C1DD93123).
Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na [RFC8141](https://tools.ietf.org/html/rfc8141).
type: string
pattern: '^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*''%\/?#]+$'
maxLength: 256
example: 'urn:initiator:C1DD93123'
expirationDateTime:
description: 'Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).'
type: string
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
maxLength: 20
quoteCustomer:
type: object
description: Objeto que agrupa as categorias de dados cadastrais do cliente.
properties:
identificationData:
oneOf:
- $ref: '#/components/schemas/PersonalIdentificationData'
- $ref: '#/components/schemas/BusinessIdentificationData'
qualificationData:
oneOf:
- $ref: '#/components/schemas/PersonalQualificationData'
- $ref: '#/components/schemas/BusinessQualificationData'
complimentaryInformationData:
oneOf:
- $ref: '#/components/schemas/PersonalComplimentaryInformationData'
- $ref: '#/components/schemas/BusinessComplimentaryInformationData'
historicalData:
type: object
description: Objeto que agrupa todos dados históricos do cliente
properties:
customer:
type: object
description: Dados cadastrais históricos do cliente.
properties:
identificationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalIdentificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessIdentificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
qualificationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalQualificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessQualificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
complimentaryInformationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalComplimentaryInformationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessComplimentaryInformationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
policies:
$ref: '#/components/schemas/PolicyDataPatrimonialLead' ## schema dados transacionais de fase 2 - atualização pendente
quoteData:
type: object
required:
- coverages
description: Objeto que agrupa dados específicos do ramo de cotação.
properties:
coverages:
type: array
description: Lista que agrupa os dados de coberturas.
items:
type: object
required:
- branch
- code
- description
properties:
branch:
description: Grupo e ramo da cobertura
type: string
maxLength: 4
example: "0111"
code:
type: string
description: Código da cobertura, conforme Anexo II do Manual de Escopo de Dados
example: RESIDENCIAL_IMOVEL_BASICA
enum: [
RESIDENCIAL_IMOVEL_BASICA,
RESIDENCIAL_IMOVEL_AMPLA,
RESIDENCIAL_INCENDIO,
RESIDENCIAL_QUEDA_DE_RAIO,
RESIDENCIAL_EXPLOSAO,
RESIDENCIAL_IMPACTO_DE_AERONAVES,
RESIDENCIAL_ALAGAMENTO,
RESIDENCIAL_DANOS_ELETRICOS,
RESIDENCIAL_DANOS_POR_AGUA,
RESIDENCIAL_RESPONSABILIDADE_CIVIL_FAMILIAR,
RESIDENCIAL_VENDAVAL,
RESIDENCIAL_DANOS_A_EQUIPAMENTOS_ELETRONICOS,
RESIDENCIAL_TERREMOTO,
RESIDENCIAL_PERDA_E_PAGAMENTO_DE_ALUGUEL,
RESIDENCIAL_ROUBO_E_SUBTRACAO_DE_BENS,
RESIDENCIAL_QUEBRA_DE_VIDROS,
RESIDENCIAL_IMPACTO_DE_VEICULOS,
RESIDENCIAL_DESMORONAMENTO,
RESIDENCIAL_TUMULTOS_GREVES_E_LOCKOUTS,
RESIDENCIAL_DESPESAS_EXTRAORDINARIAS,
RESIDENCIAL_JOIAS_E_OBRAS_DE_ARTE,
CONDOMINIAL_COBERTURA_BASICA_SIMPLES,
CONDOMINIAL_COBERTURA_BASICA_AMPLA,
CONDOMINIAL_ANUNCIOS_LUMINOSOS,
CONDOMINIAL_DANOS_AO_JARDIM,
CONDOMINIAL_DANOS_ELETRICOS,
CONDOMINIAL_DESMORONAMENTO,
CONDOMINIAL_DESPESAS_COM_ALUGUEL,
CONDOMINIAL_EQUIPAMENTOS,
CONDOMINIAL_FIDELIDADE_DE_EMPREGADOS,
CONDOMINIAL_IMPACTO_DE_VEICULOS,
CONDOMINIAL_VIDA_E_ACIDENTES_PESSOAIS_EMPREGADOS,
CONDOMINIAL_LUCROS_CESSANTES,
CONDOMINIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
CONDOMINIAL_RESPONSABILIDADE_CIVIL,
CONDOMINIAL_ROUBO,
CONDOMINIAL_VALORES,
CONDOMINIAL_VAZAMENTO,
CONDOMINIAL_VENDAVAL,
CONDOMINIAL_ALAGAMENTO,
CONDOMINIAL_TUMULTO,
EMPRESARIAL_INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO,
EMPRESARIAL_DANOS_ELETRICOS,
EMPRESARIAL_VENDAVAL_ATE_FUMACA,
EMPRESARIAL_DESMORONAMENTO,
EMPRESARIAL_ALAGAMENTO_E_INUNDACAO,
EMPRESARIAL_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
EMPRESARIAL_ROUBO_E_FURTO_QUALIFICADO,
EMPRESARIAL_VALORES,
EMPRESARIAL_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
EMPRESARIAL_ANUNCIOS_LUMINOSOS,
EMPRESARIAL_FIDELIDADE_DE_EMPREGADOS,
EMPRESARIAL_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
EMPRESARIAL_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
EMPRESARIAL_DERRAME,
EMPRESARIAL_VAZAMENTO,
EMPRESARIAL_EQUIPAMENTOS,
EMPRESARIAL_QUEBRA_DE_MAQUINAS,
EMPRESARIAL_RESPONSABILIDADE_CIVIL,
EMPRESARIAL_DESPESAS_EXTRAORDINARIAS,
EMPRESARIAL_LUCROS_CESSANTES_DESPESAS_FIXAS_LUCRO_LIQUIDO_LUCRO_BRUTO,
EMPRESARIAL_PERDA_OU_PAGAMENTO_DE_ALUGUEL,
EMPRESARIAL_PEQUENAS_OBRAS_DE_ENGENHARIA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA,
DIVERSOS_DANOS_DE_CAUSA_EXTERNA_E_ROUBO,
DIVERSOS_ROUBO,
SERVICOS_EMERGENCIAIS,
SERVICOS_DE_CONVENIENCIA,
GARANTIA_ESTENDIDA_ORIGINAL,
GARANTIA_ESTENDIDA_AMPLIADA,
GARANTIA_ESTENDIDA_REDUZIDA,
COMPLEMENTACAO_DE_GARANTIA,
CESSANTES_LUCRO_BRUTO_LUCRO_LIQUIDO_E_DESPESAS_FIXAS,
CESSANTES_LUCRO_LIQUIDO,
CESSANTES_DESPESAS_FIXAS,
CESSANTES_PERDA_DE_RECEITA_OU_INTERRUPCAO_DE_NEGOCIOS,
ENGENHARIA_OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM,
ENGENHARIA_AFRETAMENTOS_DE_AERONAVES,
ENGENHARIA_ARMAZENAGEM_FORA_DO_CANTEIRO_DE_OBRAS_OU_LOCAL_SEGURADO,
ENGENHARIA_DANOS_EM_CONSEQUENCIA_DE_ERRO_DE_PROJETO_RISCO_DO_FABRICANTE,
ENGENHARIA_DANOS_MORAIS,
ENGENHARIA_DESPESAS_COM_DESENTULHO_DO_LOCAL,
ENGENHARIA_DESPESAS_DE_SALVAMENTO_E_CONTENCAO_DE_SINISTROS,
ENGENHARIA_DESPESAS_EXTRAORDINARIAS,
ENGENHARIA_EQUIPAMENTOS_DE_ESCRITORIO_E_INFORMATICA,
ENGENHARIA_EQUIPAMENTOS_MOVEIS_OU_ESTACIONARIOS_UTILIZADOS_NA_OBRA,
ENGENHARIA_FERRAMENTAS_DE_PEQUENO_E_MEDIO_PORTE,
ENGENHARIA_HONORARIOS_DE_PERITO,
ENGENHARIA_INCENDIO_APOS_O_TERMINO_DE_OBRAS_ATE_TRINTA_DIAS_EXCETO_PARA_REFORMAS_OU_AMPLIACOES,
ENGENHARIA_LUCROS_CESSANTES,
ENGENHARIA_MANUTENCAO_AMPLA_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_MANUTENCAO_SIMPLES_ATE_VINTE_E_QUATRO_MESES,
ENGENHARIA_OBRAS_CONCLUIDAS,
ENGENHARIA_OBRAS_TEMPORARIAS,
ENGENHARIA_OBRAS_INSTALACOES_CONTRATADAS_ACEITAS_E_OU_COLOCADAS_EM_OPERACAO,
ENGENHARIA_PROPRIEDADES_CIRCUNVIZINHAS,
ENGENHARIA_RECOMPOSICAO_DE_DOCUMENTOS,
ENGENHARIA_RESPONSABILIDADE_CIVIL_EMPREGADOR,
ENGENHARIA_FUNDACAO,
ENGENHARIA_STANDS_DE_VENDA,
ENGENHARIA_TRANSPORTE_TERRESTRE,
ENGENHARIA_TUMULTOS_GREVES_E_LOCKOUT,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE,
BANCOS_DANOS_MATERIAIS_CAUSADOS_AOS_CAIXAS_ELETRONICOS_ATM,
BANCOS_INFIDELIDADE_DE_FUNCIONARIOS,
BANCOS_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRE_FORTE,
BANCOS_VALORES_NO_INTERIOR_DE_CAIXAS_ELETRONICOS_ATM,
BANCOS_VALORES_EM_MAOS_DE_PORTADORES_EM_TRANSITO,
RNO_ALAGAMENTO_INUNDACAO,
RNO_ALUGUEL_PERDA_OU_PAGAMENTO,
RNO_ANUNCIOS_LUMINOSOS,
RNO_BAGAGEM,
RNO_BASICA_INCENDIO_RAIO_EXPLOSAO,
RNO_BASICA_DANOS_MATERIAIS,
RNO_BASICA_DE_OBRAS_CIVIS_EM_CONSTRUCAO_E_INSTALACOES_E_MONTAGENS,
RNO_BENS_DE_TERCEIROS_EM_PODER_DO_SEGURADO,
RNO_CARGA_DESCARGA_ICAMENTO_E_DESCIDA,
RNO_DANOS_ELETRICOS,
RNO_DANOS_NA_FABRICACAO,
RNO_DERRAME_D_AGUA_OU_OUTRA_SUBSTANCIA_LIQUIDA_DE_INSTALACOES_DE_CHUVEIROS_AUTOMATICOS_SPRINKLERS,
RNO_DESMORONAMENTO,
RNO_DESPESAS_ADICIONAIS_OUTRAS_DESPESAS,
RNO_DESPESAS_EXTRAORDINARIAS,
RNO_DESPESAS_FIXA,
RNO_DETERIORACAO_DE_MERCADORIAS_EM_AMBIENTES_FRIGORIFICADOS,
RNO_EQUIPAMENTOS_ARRENDADOS,
RNO_EQUIPAMENTOS_CEDIDOS_A_TERCEIROS,
RNO_EQUIPAMENTOS_CINEMATOGRAFICOS_FOTOGRAFICOS_DE_AUDIO_E_VIDEO,
RNO_EQUIPAMENTOS_DIVERSOS_OUTRAS_MODALIDADES,
RNO_EQUIPAMENTOS_ELETRONICOS,
RNO_EQUIPAMENTOS_ESTACIONARIOS,
RNO_EQUIPAMENTOS_MOVEIS,
RNO_EQUIPAMENTOS_PORTATEIS,
RNO_FIDELIDADE_DE_EMPREGADOS,
RNO_HONORARIOS_DE_PERITOS,
RNO_IMPACTO_DE_VEICULOS_E_QUEDA_DE_AERONAVES,
RNO_IMPACTO_DE_VEICULOS_TERRESTRES,
RNO_LINHAS_DE_TRANSMISSAO_E_DISTRIBUICAO,
RNO_LUCROS_CESSANTES,
RNO_MOVIMENTACAO_INTERNA_DE_MERCADORIAS,
RNO_PATIOS,
RNO_QUEBRA_DE_MAQUINAS,
RNO_QUEBRA_DE_VIDROS_ESPELHOS_MARMORES_E_GRANITOS,
RNO_RECOMPOSICAO_DE_REGISTROS_E_DOCUMENTOS,
RNO_ROUBO_DE_BENS_DE_HOSPEDES,
RNO_ROUBO_DE_VALORES_EM_TRANSITO_EM_MAOS_DE_PORTADOR,
RNO_ROUBO_E_FURTO_MEDIANTE_ARROMBAMENTO,
RNO_ROUBO_E_OU_FURTO_QUALIFICADO_DE_VALORES_NO_INTERIOR_DO_ESTABELECIMENTO_DENTRO_E_OU_FORA_DE_COFRES_FORTES_OU_CAIXAS_FORTES,
RNO_TERRORISMO_E_SABOTAGEM,
RNO_TUMULTOS_GREVES_LOCKOUT_E_ATOS_DOLOSOS,
RNO_VAZAMENTO_DE_TUBULACOES_E_TANQUES,
RNO_VAZAMENTO_DE_TUBULACOES_HIDRAULICAS,
RNO_VENDAVAL_FURACAO_CICLONE_TORNADO_GRANIZO_QUEDA_DE_AERONAVES_OU_QUAISQUER_OUTROS_ENGENHOS_AEREOS_OU_ESPACIAIS_IMPACTO_DE_VEICULOS_TERRESTRES_E_FUMACA,
OUTRAS
]
description:
description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
type: string
maxLength: 500
###### quoteRequest
ResponseQuotePatrimonialLead:
type: object
required:
- data
- links
- meta
properties:
data:
$ref: '#/components/schemas/QuoteStatus'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
QuoteRequestPatrimonialHome:
type: object
required:
- data
properties:
data:
type: object
required:
- consentId
- expirationDateTime
- quoteData
- quoteCustomer
properties:
consentId:
description: |
O consentId é o identificador único do consentimento e deverá ser um URN - Uniform Resource Name.
Um URN, conforme definido na [RFC8141](https://tools.ietf.org/html/rfc8141) é um Uniform Resource
Identifier - URI - que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN
seja um identificador de recurso persistente e independente da localização.
Considerando a string urn:initiator:C1DD93123 como exemplo para consentId temos:
- o namespace(urn)
- o identificador associado ao namespace da instituição transnmissora (initiator)
- o identificador específico dentro do namespace (C1DD93123).
Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na [RFC8141](https://tools.ietf.org/html/rfc8141).
type: string
pattern: '^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*''%\/?#]+$'
maxLength: 256
example: 'urn:initiator:C1DD93123'
expirationDateTime:
description: 'Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).'
type: string
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
maxLength: 20
quoteCustomer:
type: object
description: Objeto que agrupa as categorias de dados cadastrais do cliente.
properties:
identificationData:
oneOf:
- $ref: '#/components/schemas/PersonalIdentificationData'
- $ref: '#/components/schemas/BusinessIdentificationData'
qualificationData:
oneOf:
- $ref: '#/components/schemas/PersonalQualificationData'
- $ref: '#/components/schemas/BusinessQualificationData'
complimentaryInformationData:
oneOf:
- $ref: '#/components/schemas/PersonalComplimentaryInformationData'
- $ref: '#/components/schemas/BusinessComplimentaryInformationData'
quoteData:
$ref: '#/components/schemas/QuoteDataPatrimonialHome'
quoteCustomData:
$ref: '#/components/schemas/QuoteCustomData'
historicalData:
type: object
description: Objeto que agrupa todos dados históricos do cliente.
properties:
customer:
type: object
description: Dados históricos cadastrais do cliente
properties:
identificationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalIdentificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessIdentificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
qualificationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalQualificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessQualificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
complimentaryInformationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalComplimentaryInformationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessComplimentaryInformationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
policies:
$ref: '#/components/schemas/PolicyDataPatrimonialHome' ## schema dados transacionais de fase 2 - atualização pendente
###### quoteRequest
ResponseQuoteStatusPatrimonialHome:
type: object
required:
- data
- links
- meta
properties:
data:
type: object
required:
- status
- statusUpdateDateTime
properties:
status:
description: Status da cotação.
type: string
example: CANC
enum: [RCVD,
EVAL,
ACPT,
RJCT,
ACKN,
CANC]
rejectionReason:
description: Campo condicionado ao status "RJCT", que deve apresentar a justificativa a recusa ao risco.
type: string
maxLength: 1024
statusUpdateDateTime:
type: string
description: Data e hora da atualização do status.
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
quoteInfo:
description: Objeto que agrupa todos os dados de cotação. Condicional ao pedido de cotação já ter sido aceita.
allOf:
- $ref: '#/components/schemas/QuoteStatusPatrimonialHome'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
ResponseQuotePatrimonialHome:
type: object
required:
- data
- links
- meta
properties:
data:
$ref: '#/components/schemas/QuoteStatus'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
QuoteRequestPatrimonialCondominium:
type: object
required:
- data
properties:
data:
type: object
required:
- consentId
- expirationDateTime
- quoteData
- quoteCustomer
properties:
consentId:
description: |
O consentId é o identificador único do consentimento e deverá ser um URN - Uniform Resource Name.
Um URN, conforme definido na [RFC8141](https://tools.ietf.org/html/rfc8141) é um Uniform Resource
Identifier - URI - que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN
seja um identificador de recurso persistente e independente da localização.
Considerando a string urn:initiator:C1DD93123 como exemplo para consentId temos:
- o namespace(urn)
- o identificador associado ao namespace da instituição transnmissora (initiator)
- o identificador específico dentro do namespace (C1DD93123).
Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na [RFC8141](https://tools.ietf.org/html/rfc8141).
type: string
pattern: '^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*''%\/?#]+$'
maxLength: 256
example: 'urn:initiator:C1DD93123'
expirationDateTime:
description: 'Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).'
type: string
format: date-time
example: '2021-05-21T08:30:00Z'
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
maxLength: 20
quoteCustomer:
type: object
description: Objeto que agrupa as categorias de dados cadastrais do cliente.
properties:
identificationData:
oneOf:
- $ref: '#/components/schemas/PersonalIdentificationData'
- $ref: '#/components/schemas/BusinessIdentificationData'
qualificationData:
oneOf:
- $ref: '#/components/schemas/PersonalQualificationData'
- $ref: '#/components/schemas/BusinessQualificationData'
complimentaryInformationData:
oneOf:
- $ref: '#/components/schemas/PersonalComplimentaryInformationData'
- $ref: '#/components/schemas/BusinessComplimentaryInformationData'
quoteData:
$ref: '#/components/schemas/QuoteDataPatrimonialCondominium'
quoteCustomData:
$ref: '#/components/schemas/QuoteCustomData'
historicalData:
type: object
description: Objeto que agrupa todos dados históricos do cliente.
properties:
customer:
type: object
description: Dados históricos cadastrais do cliente
properties:
identificationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalIdentificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessIdentificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
qualificationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalQualificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1)
- $ref: '#/components/schemas/HistoricalBusinessQualificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
complimentaryInformationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalComplimentaryInformationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessComplimentaryInformationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
policies:
$ref: '#/components/schemas/PolicyDataPatrimonialCondominium' ## schema dados transacionais de fase 2 - atualização pendente
###### quoteRequest
ResponseQuoteStatusPatrimonialCondominium:
type: object
required:
- data
- links
- meta
properties:
data:
type: object
required:
- status
- statusUpdateDateTime
properties:
status:
description: Status da cotação.
type: string
example: CANC
enum: [RCVD,
EVAL,
ACPT,
RJCT,
ACKN,
CANC]
rejectionReason:
description: Campo condicionado ao status "RJCT", que deve apresentar a justificativa a recusa ao risco.
type: string
maxLength: 1024
statusUpdateDateTime:
type: string
description: Data e hora da atualização do status.
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
quoteInfo:
description: Objeto que agrupa todos os dados de cotação. Condicional ao pedido de cotação já ter sido aceita.
allOf:
- $ref: '#/components/schemas/QuoteStatusPatrimonialCondominium'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
ResponseQuotePatrimonialCondominium:
type: object
required:
- data
- links
- meta
properties:
data:
$ref: '#/components/schemas/QuoteStatus'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
QuoteRequestPatrimonialBusiness:
type: object
required:
- data
properties:
data:
type: object
required:
- consentId
- expirationDateTime
- quoteData
- quoteCustomer
properties:
consentId:
description: |
O consentId é o identificador único do consentimento e deverá ser um URN - Uniform Resource Name.
Um URN, conforme definido na [RFC8141](https://tools.ietf.org/html/rfc8141) é um Uniform Resource
Identifier - URI - que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN
seja um identificador de recurso persistente e independente da localização.
Considerando a string urn:initiator:C1DD93123 como exemplo para consentId temos:
- o namespace(urn)
- o identificador associado ao namespace da instituição transnmissora (initiator)
- o identificador específico dentro do namespace (C1DD93123).
Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na [RFC8141](https://tools.ietf.org/html/rfc8141).
type: string
pattern: '^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*''%\/?#]+$'
maxLength: 256
example: 'urn:initiator:C1DD93123'
expirationDateTime:
description: 'Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).'
type: string
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
maxLength: 20
quoteCustomer:
type: object
description: Objeto que agrupa as categorias de dados cadastrais do cliente.
properties:
identificationData:
oneOf:
- $ref: '#/components/schemas/PersonalIdentificationData'
- $ref: '#/components/schemas/BusinessIdentificationData'
qualificationData:
oneOf:
- $ref: '#/components/schemas/PersonalQualificationData'
- $ref: '#/components/schemas/BusinessQualificationData'
complimentaryInformationData:
oneOf:
- $ref: '#/components/schemas/PersonalComplimentaryInformationData'
- $ref: '#/components/schemas/BusinessComplimentaryInformationData'
quoteData:
$ref: '#/components/schemas/QuoteDataPatrimonialBusiness'
quoteCustomData:
$ref: '#/components/schemas/QuoteCustomData'
historicalData:
type: object
description: Objeto que agrupa todos dados históricos do cliente.
properties:
customer:
type: object
description: Dados históricos cadastrais do cliente
properties:
identificationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalIdentificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessIdentificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
qualificationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalQualificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessQualificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
complimentaryInformationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalComplimentaryInformationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessComplimentaryInformationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
policies:
$ref: '#/components/schemas/PolicyDataPatrimonialBusiness' ## schema dados transacionais de fase 2 - atualização pendente
###### quoteRequest
ResponseQuoteStatusPatrimonialBusiness:
type: object
required:
- data
- links
- meta
properties:
data:
type: object
required:
- status
- statusUpdateDateTime
properties:
status:
description: Status da cotação.
type: string
example: CANC
enum: [RCVD,
EVAL,
ACPT,
RJCT,
ACKN,
CANC]
rejectionReason:
description: Campo condicionado ao status "RJCT", que deve apresentar a justificativa a recusa ao risco.
type: string
maxLength: 1024
statusUpdateDateTime:
type: string
description: Data e hora da atualização do status.
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
quoteInfo:
description: Objeto que agrupa todos os dados de cotação. Condicional ao pedido de cotação já ter sido aceita.
allOf:
- $ref: '#/components/schemas/QuoteStatusPatrimonialBusiness'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
ResponseQuotePatrimonialBusiness:
type: object
required:
- data
- links
- meta
properties:
data:
$ref: '#/components/schemas/QuoteStatus'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
QuoteRequestPatrimonialDiverseRisks:
type: object
required:
- data
properties:
data:
type: object
required:
- consentId
- expirationDateTime
- quoteData
- quoteCustomer
properties:
consentId:
description: |
O consentId é o identificador único do consentimento e deverá ser um URN - Uniform Resource Name.
Um URN, conforme definido na [RFC8141](https://tools.ietf.org/html/rfc8141) é um Uniform Resource
Identifier - URI - que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN
seja um identificador de recurso persistente e independente da localização.
Considerando a string urn:initiator:C1DD93123 como exemplo para consentId temos:
- o namespace(urn)
- o identificador associado ao namespace da instituição transnmissora (initiator)
- o identificador específico dentro do namespace (C1DD93123).
Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na [RFC8141](https://tools.ietf.org/html/rfc8141).
type: string
pattern: '^urn:[a-zA-Z0-9][a-zA-Z0-9-]{0,31}:[a-zA-Z0-9()+,\-.:=@;$_!*''%\/?#]+$'
maxLength: 256
example: 'urn:initiator:C1DD93123'
expirationDateTime:
description: 'Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).'
type: string
format: date-time
pattern: '^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
maxLength: 20
quoteCustomer:
type: object
description: Objeto que agrupa as categorias de dados cadastrais do cliente.
properties:
identificationData:
oneOf:
- $ref: '#/components/schemas/PersonalIdentificationData'
- $ref: '#/components/schemas/BusinessIdentificationData'
qualificationData:
oneOf:
- $ref: '#/components/schemas/PersonalQualificationData'
- $ref: '#/components/schemas/BusinessQualificationData'
complimentaryInformationData:
oneOf:
- $ref: '#/components/schemas/PersonalComplimentaryInformationData'
- $ref: '#/components/schemas/BusinessComplimentaryInformationData'
quoteData:
$ref: '#/components/schemas/QuoteDataPatrimonialDiverseRisks'
quoteCustomData:
$ref: '#/components/schemas/QuoteCustomData'
historicalData:
type: object
description: Objeto que agrupa todos dados históricos do cliente.
properties:
customer:
type: object
description: Objeto que agrupa as categorias de dados históricos cadastrais do cliente.
properties:
identificationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalIdentificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessIdentificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
qualificationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalQualificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessQualificationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
complimentaryInformationData:
oneOf:
- $ref: '#/components/schemas/HistoricalPersonalComplimentaryInformationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
- $ref: '#/components/schemas/HistoricalBusinessComplimentaryInformationData' ## schema dados cadastrais de fase 2 (customers v1.1.1) - atualização pendente
policies:
$ref: '#/components/schemas/PolicyDataPatrimonialDiverseRisks' ## schema dados transacionais de fase 2 - atualização pendente
###### quoteRequest
ResponseQuoteStatusPatrimonialDiverseRisks:
type: object
required:
- data
- links
- meta
properties:
data:
type: object
required:
- status
- statusUpdateDateTime
properties:
status:
description: Status da cotação.
type: string
example: CANC
enum: [RCVD,
EVAL,
ACPT,
RJCT,
ACKN,
CANC]
rejectionReason:
description: Campo condicionado ao status "RJCT", que deve apresentar a justificativa a recusa ao risco.
type: string
maxLength: 1024
statusUpdateDateTime:
type: string
description: Data e hora da atualização do status.
format: date-time
pattern: '^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])T(?:[01]\d|2[0123]):(?:[012345]\d):(?:[012345]\d)Z$'
example: '2021-05-21T08:30:00Z'
quoteInfo:
description: Objeto que agrupa todos os dados de cotação. Condicional ao pedido de cotação já ter sido aceita.
allOf:
- $ref: '#/components/schemas/QuoteStatusPatrimonialDiverseRisks'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
ResponseQuotePatrimonialDiverseRisks:
type: object
required:
- data
- links
- meta
properties:
data:
$ref: '#/components/schemas/QuoteStatus'
links:
$ref: '#/components/schemas/Links'
meta:
$ref: '#/components/schemas/Meta'
parameters:
consentId:
name: consentId
in: path
required: true
schema:
type: string
maxLength: 60
Authorization:
name: Authorization
in: header
description: Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
required: true
schema:
type: string
pattern: '[\w\W\s]*'
maxLength: 2048
page:
name: page
in: query
description: Número da página que está sendo requisitada (o valor da primeira página é 1).
schema:
type: integer
default: 1
minimum: 1
format: int32
pageSize:
name: page-size
in: query
description: Quantidade total de registros por páginas.
schema:
type: integer
default: 25
minimum: 1
format: int32
maximum: 1000
xCustomerUserAgent:
name: x-customer-user-agent
in: header
description: Indica o user-agent que o usuário utiliza.
required: false
schema:
type: string
pattern: '[\w\W\s]*'
minLength: 1
maxLength: 100
xFapiAuthDate:
name: x-fapi-auth-date
in: header
description: 'Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a [RFC7231](https://tools.ietf.org/html/rfc7231). Exemplo: Sun, 10 Sep 2017 19:43:31 UTC'
required: false
schema:
type: string
pattern: '^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$'
minLength: 29
maxLength: 29
xFapiCustomerIpAddress:
name: x-fapi-customer-ip-address
in: header
description: O endereço IP do usuário se estiver atualmente logado com o receptor.
required: false
schema:
type: string
pattern: '[\w\W\s]*'
minLength: 1
maxLength: 100
xFapiInteractionId:
name: x-fapi-interaction-id
in: header
description: 'Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.'
required: true
schema:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
minLength: 1
maxLength: 100
xIdempotencyKey:
name: x-idempotency-key
in: header
description: |
Cabeçalho HTTP personalizado. Identificador de solicitação
exclusivo para suportar a idempotência.
required: true
schema:
type: string
minLength: 1
maxLength: 40
pattern: ^(?!\s)(.*)(\S)$
securitySchemes:
OpenId:
type: openIdConnect
openIdConnectUrl: 'https://auth.mockbank.poc.raidiam.io/.well-known/openid-configuration'
OAuth2Security:
type: oauth2
flows:
clientCredentials:
tokenUrl: "https://authserver.example/token"
scopes:
quote-patrimonial-lead: Escopo necessário para acesso à API Quote Patrimonial.
quote-patrimonial-home: Escopo necessário para acesso à API Quote Patrimonial.
quote-patrimonial-condominium: Escopo necessário para acesso à API Quote Patrimonial.
quote-patrimonial-business: Escopo necessário para acesso à API Quote Patrimonial.
quote-patrimonial-diverse-risks: Escopo necessário para acesso à API Quote Patrimonial.
responses:
BadRequest:
description: 'A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL'
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
Forbidden:
description: O token tem escopo incorreto ou uma política de segurança foi violada
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
InternalServerError:
description: Ocorreu um erro no gateway da API ou no microsserviço
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
MethodNotAllowed:
description: O consumidor tentou acessar o recurso com um método não suportado
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
NotAcceptable:
description: A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
NotFound:
description: O recurso solicitado não existe ou não foi implementado
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
TooManyRequests:
description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido'
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
Unauthorized:
description: Cabeçalho de autenticação ausente/inválido ou token inválido
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
UnprocessableEntity:
description: O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/ResponseError'
UnprocessableEntityQuote:
description: Seguir as orientações presentes na descrição deste endpoint
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/422ResponseErrorCreateQuote'
OKResponseQuoteRequestPatrimonialLead:
description: Dados de PatrimonialLead criados com sucesso
headers:
x-fapi-interaction-id:
schema:
$ref: '#/components/schemas/XFapiInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseQuotePatrimonialLead'
200UpdatedQuotePatrimonialLead:
description: "Atualização de PatrimonialLead feita com sucesso"
headers:
x-fapi-interaction-id:
description: |
Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação.
Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
schema:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
minLength: 1
maxLength: 100
example: 73cac523-d3ae-2289-b106-330a6218710d
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseRevokePatch'
OKResponseQuoteRequestPatrimonialHome:
description: Dados de PatrimonialHome criados com sucesso
headers:
x-fapi-interaction-id:
schema:
$ref: '#/components/schemas/XFapiInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseQuotePatrimonialHome'
200QuoteStatusPatrimonialHome:
description: Dados de PatrimonialHome obtidos com sucesso
headers:
x-fapi-interaction-id:
description: |
Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação.
Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
schema:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
minLength: 1
maxLength: 100
example: 73cac523-d3ae-2289-b106-330a6218710d
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseQuoteStatusPatrimonialHome'
200UpdatedQuotePatrimonialHome:
description: "Atualização de PatrimonialHome feita com sucesso"
headers:
x-fapi-interaction-id:
description: |
Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação.
Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
schema:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
minLength: 1
maxLength: 100
example: 73cac523-d3ae-2289-b106-330a6218710d
content:
application/json:
schema:
$ref: '#/components/schemas/ResponsePatch'
OKResponseQuoteRequestPatrimonialCondominium:
description: Dados de PatrimonialCondominium criados com sucesso
headers:
x-fapi-interaction-id:
schema:
$ref: '#/components/schemas/XFapiInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseQuotePatrimonialCondominium'
200QuoteStatusPatrimonialCondominium:
description: Dados de PatrimonialCondominium obtidos com sucesso
headers:
x-fapi-interaction-id:
description: |
Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação.
Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
schema:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
minLength: 1
maxLength: 100
example: 73cac523-d3ae-2289-b106-330a6218710d
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseQuoteStatusPatrimonialCondominium'
200UpdatedQuotePatrimonialCondominium:
description: "Atualização de PatrimonialCondominium feita com sucesso"
headers:
x-fapi-interaction-id:
description: |
Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação.
Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
schema:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
minLength: 1
maxLength: 100
example: 73cac523-d3ae-2289-b106-330a6218710d
content:
application/json:
schema:
$ref: '#/components/schemas/ResponsePatch'
OKResponseQuoteRequestPatrimonialBusiness:
description: Dados de PatrimonialBusiness criados com sucesso
headers:
x-fapi-interaction-id:
schema:
$ref: '#/components/schemas/XFapiInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseQuotePatrimonialBusiness'
200QuoteStatusPatrimonialBusiness:
description: Dados de PatrimonialBusiness obtidos com sucesso
headers:
x-fapi-interaction-id:
description: |
Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação.
Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
schema:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
minLength: 1
maxLength: 100
example: 73cac523-d3ae-2289-b106-330a6218710d
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseQuoteStatusPatrimonialBusiness'
200UpdatedQuotePatrimonialBusiness:
description: "Atualização de PatrimonialBusiness feita com sucesso"
headers:
x-fapi-interaction-id:
description: |
Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação.
Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
schema:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
minLength: 1
maxLength: 100
example: 73cac523-d3ae-2289-b106-330a6218710d
content:
application/json:
schema:
$ref: '#/components/schemas/ResponsePatch'
OKResponseQuoteRequestPatrimonialDiverseRisks:
description: Dados de PatrimonialDiverseRisks criados com sucesso
headers:
x-fapi-interaction-id:
schema:
$ref: '#/components/schemas/XFapiInteractionId'
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseQuotePatrimonialDiverseRisks'
200QuoteStatusPatrimonialDiverseRisks:
description: Dados de PatrimonialDiverseRisks obtidos com sucesso
headers:
x-fapi-interaction-id:
description: |
Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação.
Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
schema:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
minLength: 1
maxLength: 100
example: 73cac523-d3ae-2289-b106-330a6218710d
content:
application/json:
schema:
$ref: '#/components/schemas/ResponseQuoteStatusPatrimonialDiverseRisks'
200UpdatedQuotePatrimonialDiverseRisks:
description: "Atualização de PatrimonialDiverseRisks feita com sucesso"
headers:
x-fapi-interaction-id:
description: |
Um UID [RFC4122](https://tools.ietf.org/html/rfc4122) usado como um ID de correlação.
Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
schema:
type: string
pattern: '^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$'
minLength: 1
maxLength: 100
example: 73cac523-d3ae-2289-b106-330a6218710d
content:
application/json:
schema:
$ref: '#/components/schemas/ResponsePatch'