openapi: 3.0.0 info: title: API Quote Person - Open Insurance Brasil description: | API de Cotação Pessoas 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 e Firme OPIN.\ Requer consentimento do cliente para todos os 'endpoints'. # Orientações A `Role` do diretório de participantes relacionada à presente API é a ``.\ Para todos os `endpoints` desta API é previsto o envio de um `token` através do header `Authorization`.\ Este `token` deverá estar relacionado ao consentimento (identificado pelo `consentId`) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos dados relacionados ao `consentId` específico.\ 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`.\ Além disso, as `permissions` necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.\ Relacionamos a seguir as `permissions` necessárias para o envio de dados em cada `endpoint` da presente API. ## Permissions necessárias para a API Person 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_PERSON_LEAD_CREATE** ### `/lead/request/{consentId}` - permissions: - PATCH: **QUOTE_PERSON_LEAD_UPDATE** ### `/life/request/{consentId}/quote-status` - permissions: - GET: **QUOTE_PERSON_LIFE_READ** ### `/life/request` - permissions: - POST: **QUOTE_PERSON_LIFE_CREATE** ### `/life/request/{consentId}` - permissions: - PATCH: **QUOTE_PERSON_LIFE_UPDATE** ### `/travel/request/{consentId}/quote-status` - permissions: - GET: **QUOTE_PERSON_TRAVEL_READ** ### `/travel/request` - permissions: - POST: **QUOTE_PERSON_TRAVEL_CREATE** ### `/travel/request/{consentId}` - permissions: - PATCH: **QUOTE_PERSON_TRAVEL_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 email: gt-interfaces@openinsurancebr.org url: https://www.gov.br/susep servers: - url: https://api.organizacao.com.br/open-insurance/quote-person/v1 description: Servidor de Produção - url: https://api.organizacao.com.br/open-insurance/quote-person/v1 description: Servidor de Homologação tags: - name: PersonLead description: Iniciação de serviços de seguro Cotação Pessoas Lead (PersonLead) - name: PersonLife description: Iniciação de serviços de seguro Cotação Pessoas Vida (PersonLife) - name: PersonTravel description: Iniciação de serviços de seguro Cotação Pessoas Viagem (PersonTravel) paths: /lead/request: post: tags: - PersonLead summary: Envia dados de cotação e contratação de PersonLead description: Método para criação de solicitação de cotação e contratação de PersonLead operationId: postQuotePersonLead 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/QuoteRequestPersonLead' responses: '201': $ref: '#/components/responses/OKResponseQuoteRequestPersonLead' '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: - OpenId: - openid OAuth2Security: - consent:consentId - quote-person-lead /lead/request/{consentId}: patch: tags: - PersonLead summary: Atualiza dados de cotação e contratação de PersonLead identificado por consentId description: Método para atualização de solicitação de cotação e contratação de PersonLead operationId: patchQuotePersonLead 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/200UpdatedQuotePersonLead' '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: - OpenId: - openid OAuth2Security: - consent:consentId - quote-person-lead /life/request: post: tags: - PersonLife summary: Envia dados de cotação e contratação de PersonLife description: Método para criação de solicitação de cotação e contratação de PersonLife operationId: postQuotePersonLife 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/QuoteRequestPersonLife' responses: '201': $ref: '#/components/responses/OKResponseQuoteRequestPersonLife' '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: - OpenId: - openid OAuth2Security: - consent:consentId - quote-person-life /life/request/{consentId}/quote-status: get: tags: - PersonLife summary: Obtém os dados de cotação e contratação de PersonLife identificado por consentId description: Método para consulta dos dados de solicitação de cotação e contratação de PersonLife operationId: getQuotePersonLife 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/200QuoteStatusPersonLife' '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: - OpenId: - openid OAuth2Security: - consent:consentId - quote-person-life /life/request/{consentId}: patch: tags: - PersonLife summary: Atualiza dados de cotação e contratação de PersonLife identificado por consentId description: Método para atualização de solicitação de cotação e contratação de PersonLife operationId: patchQuotePersonLife 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/200UpdatedQuotePersonLife' '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: - OpenId: - openid OAuth2Security: - consent:consentId - quote-person-life /travel/request: post: tags: - PersonTravel summary: Envia dados de cotação e contratação de PersonTravel description: Método para criação de solicitação de cotação e contratação de PersonTravel operationId: postQuotePersonTravel 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/QuoteRequestPersonTravel' responses: '201': $ref: '#/components/responses/OKResponseQuoteRequestPersonTravel' '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: - OpenId: - openid OAuth2Security: - consent:consentId - quote-person-travel /travel/request/{consentId}/quote-status: get: tags: - PersonTravel summary: Obtém os dados de cotação e contratação de PersonTravel identificado por consentId description: Método para consulta dos dados de solicitação de cotação e contratação de PersonTravel operationId: getQuotePersonTravel 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/200QuoteStatusPersonTravel' '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: - OpenId: - openid OAuth2Security: - consent:consentId - quote-person-travel /travel/request/{consentId}: patch: tags: - PersonTravel summary: Atualiza dados de cotação e contratação de PersonTravel identificado por consentId description: Método para atualização de solicitação de cotação e contratação de PersonTravel operationId: patchQuotePersonTravel 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/200UpdatedQuotePersonTravel' '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: - OpenId: - openid OAuth2Security: - consent:consentId - quote-person-travel components: schemas: PolicyDataPersonLead: type: array description: Lista que agrupa os dados das apólices em categorias. items: type: object properties: policyInfo: $ref: '#/components/schemas/InsurancePersonPolicyInfo' premium: $ref: '#/components/schemas/InsurancePersonPremium' claim: oneOf: - $ref: '#/components/schemas/InsurancePersonClaim' - $ref: '#/components/schemas/InsurancePersonClaimRecipient' PolicyDataPersonLife: type: array description: Lista que agrupa os dados das apólices em categorias. items: type: object properties: policyInfo: $ref: '#/components/schemas/InsurancePersonPolicyInfo' premium: $ref: '#/components/schemas/InsurancePersonPremium' claim: oneOf: - $ref: '#/components/schemas/InsurancePersonClaim' - $ref: '#/components/schemas/InsurancePersonClaimRecipient' QuoteDataPersonLife: $ref: '#/components/schemas/QuotePerson' QuoteStatusPersonLife: $ref: '#/components/schemas/QuotePersonResult' PolicyDataPersonTravel: type: array description: Lista que agrupa os dados das apólices em categorias. items: type: object properties: policyInfo: $ref: '#/components/schemas/InsurancePersonPolicyInfo' premium: $ref: '#/components/schemas/InsurancePersonPremium' claim: oneOf: - $ref: '#/components/schemas/InsurancePersonClaim' - $ref: '#/components/schemas/InsurancePersonClaimRecipient' QuoteDataPersonTravel: $ref: '#/components/schemas/QuotePersonTravel' QuoteStatusPersonTravel: $ref: '#/components/schemas/QuotePersonTravelResult' QuotePerson: type: object required: - termStartDate - termType - termEndDate - includeAssistanceServices - requestedCoverages properties: termStartDate: type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-10-27' description: Vigência das 24 horas do dia termEndDate: type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-10-27' description: Até as 24 horas do dia termType: type: string enum: - ANUAL - ANUAL_INTERMITENTE - PLURIANUAL - PLURIANUAL_INTERMITENTE - SEMESTRAL - SEMESTRAL_INTERMITENTE - MENSAL - MENSAL_INTERMITENTE - DIARIO - DIARIO_INTERMITENTE - OUTROS description: Tipo de vigência termTypeOthers: description: Descricao do tipo de vigência quando for informada a opcao OUTROS type: string maxLength: 100 havePersonInsurance: description: Possui seguro de pessoas vigente? type: boolean policies: type: array description: Lista que agrupa os dados das apólices em categorias. items: type: object properties: 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 usedCoverages: type: array items: description: Quais coberturas foram acionadas? allOf: - $ref: '#/components/schemas/EnumCodeCoverage' requestedCoverages: type: array description: Lista que Agrupa informações de coberturas solicitadas. items: $ref: '#/components/schemas/Coverage' includeAssistanceServices: description: Deseja contratação de serviços de assistência? type: boolean totalPremiumAmount: description: Valor total do prêmio anual allOf: - $ref: '#/components/schemas/AmountDetails' 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' coverages: type: array description: Lista que agrupa os dados de coberturas. items: type: object properties: code: description: Código da cobertura de suguro pessoas allOf: - $ref: '#/components/schemas/EnumCodeCoverage' insuredCapital: description: Capital segurado allOf: - $ref: '#/components/schemas/AmountDetails' insuredPerson: description: Informações do Segurado allOf: - $ref: '#/components/schemas/InsuredPerson' QuotePersonResult: type: object required: - quoteCustomer - quoteData - quotes properties: quoteCustomer: description: Dados da pessoa física allOf: - $ref: '#/components/schemas/PersonalCustomerInfo' quoteData: description: Dados Gerais da Cotação allOf: - $ref: '#/components/schemas/QuoteInfoForPersonResult' quotes: type: array description: Lista de cotações enviadas pela seguradora. minItems: 1 items: required: - insurerQuoteId - quoteDateTime - susepProcessNumbers 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 example: '2023-05-21T08:30:00Z' description: Data e hora da cotação 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$ insuredPerson: description: Informações do Segurado allOf: - $ref: '#/components/schemas/InsuredPerson' requestedCoverages: type: array description: Lista que Agrupa informações de coberturas solicitadas. items: $ref: '#/components/schemas/CoverageResult' assistanceInfo: type: array items: $ref: '#/components/schemas/Assistance' premiumInfo: $ref: '#/components/schemas/Premium' susepProcessNumbers: description: Número do Processo Susep das Coberturas type: array items: type: string maxLength: 50 quoteCustomData: $ref: '#/components/schemas/QuoteCustomData' QuoteInfoForPersonResult: type: object properties: termStartDate: type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-10-27' description: Vigência das 24 horas do dia termEndDate: type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-10-27' description: Até as 24 horas do dia termType: type: string enum: - ANUAL - ANUAL_INTERMITENTE - PLURIANUAL - PLURIANUAL_INTERMITENTE - SEMESTRAL - SEMESTRAL_INTERMITENTE - MENSAL - MENSAL_INTERMITENTE - DIARIO - DIARIO_INTERMITENTE - OUTROS maxLength: 23 description: Tipo de vigência termTypeOthers: description: Descricao do tipo de vigência quando for informada a opcao OUTROS type: string maxLength: 100 havePersonInsurance: description: Possui seguro de pessoas vigente? type: boolean policies: type: array description: Lista que agrupa os dados das apólices em categorias. items: type: object properties: 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 coverages: type: array description: Lista que agrupa os dados de coberturas. items: $ref: '#/components/schemas/Coverage' usedCoverages: type: array items: description: Quais coberturas foram acionadas? allOf: - $ref: '#/components/schemas/EnumCodeCoverage' totalPremiumAmount: description: Valor total do prêmio anual allOf: - $ref: '#/components/schemas/AmountDetails' 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' InsuredPerson: type: object properties: weight: description: Peso type: string height: description: Altura type: string smoker: description: É fumante? type: boolean occupationModel: description: Modelo de exercício da profissão type: string enum: - CLT - AUTONOMO - PESSOA_JURIDICA - SOCIO_PROPRIETARIO_DE_EMPRESA_MEI - DESEMPREGADO_NAO_EXERCE_ATIVIDADE_PROFISSIONAL occupation: description: Profissão type: string isSportsperson: description: Pratica esportes de aventura? type: boolean sports: type: array items: type: object properties: sport: type: string description: Qual esporte é praticado? enum: - ACADEMIA - ACQUARIDE - ACROBACIA_AÉREA - AGGRESSIVE_INLINE - ALPINISMO - APNEIA_ACIMA_DE_6_METROS - APNEIA_ATÉ_6_METROS - ARBORISMO - ARCO_E_FLECHA - ARTES_MARCIAIS - ARVORISMO - ASA_DELTA - ASA_DELTA-HANG_GLIDING - ATLETISMO - AUTOMOBILISMO - BADMINTON - BALONISMO - BANANA-BOAT - BASE_JUMP - BASQUETEBOL - BEISEBOL - BIATHLON - BICICLETA_DE_MONTANHA - BICICROSS-BMX - BODYBOARD - BOIA_CROSS - BOLICHE - BOULDER - BOXE - BUNGEE_JUMP - CAÇA - CAÇA_SUBMARINA - CAÇADORES - CACHOEIRISMO - CAIAQUE - CAIAQUE_ATÉ_NÍVEL_3 - CAMINHADA_(HIKKING) - CAMPING - CANIONISMO_(CANYONING) - CANOAGEM - CANOAGEM_NÍVEIS_4_E_5 - CANOAGEM_NÍVEL_5 - CARVEBOARD - CASCADING - CAVALGADA - CAVALGADA_EM_PÔNEI - CICLISMO - CICLISMO_DE_ESTRADA - CICLISMO_DE_PISTA - CICLOTURISMO - CORRIDA - CORRIDA_AÉREA - CORRIDA_COM_EMBARCAÇÃO - CORRIDA_COM_MOTOCICLETA - CORRIDA_DE_AVENTURA - CORRIDA_NA_MONTANHA - CRÍQUETE - CRÓQUETE - CURLING - DIRIGÍVEL - DRAG_RACERS_PROVA_DE_ARRANCADA - DRIFT - DUCK - EJECT_X - EQUITAÇÃO - EQUITAÇÃO_EM_COMPETIÇÃO - ESCALADA - ESCALADA_INDOOR - ESCALADA_NO_GELO - ESCALADA_OUTDOOR_ACIMA_DE_4000_METROS - ESCALADA_OUTDOOR_ATÉ_4000_METROS - ESPELEOLOGIA - ESPELEOTURISMO - ESPORTE_DE_VELOCIDADE - ESPORTES_COM_BOLA - ESQUI - ESQUI_AQUÁTICO - ESQUI_FORA_DA_PISTA - ESQUIBUNDA - FLUTUAÇÃO_SNORKELING - FLYBOARD - FUTEBOL - FUTEBOL_GAÉLICO_IRLANDÊS - GINÁSTICA_AERÓBICA - GINÁSTICA_ARTÍSTICA - GOLFE - GRASSBOARD - HANDEBOL - HIGHLINE - HIKKING - HIPISMO - HÓQUEI - HÓQUEI_EM_PATINS - HÓQUEI_SOB_O_GELO - JET_SKI - KAITESURFING - KART - KAYAKSURF - LAND_YACHTING - LONGBOARD frequency: description: Com que frequência? type: string enum: - ATE_3_VEZES_ANO - ACIMA_DE_3_VEZES_ANO includeSport: description: Deseja incluir outro esporte? type: boolean injuryTimeOff: description: Está afastado das atividades profissionais (INSS)? type: boolean CID: description: CID da doença type: string maxLength: 10 cancerPatient: description: É paciente oncológico? type: boolean cancerRemissionDuration: description: Há quanto tempo está em remissão? (meses) type: integer maxLength: 3 partnerCoverage: description: Deseja cobertura para cônjuge? type: boolean partnerInfo: type: object properties: partnerCoverageAmount: description: Valor da cobertura para cônjuge allOf: - $ref: '#/components/schemas/AmountDetails' partnerBirth: description: Data de nascimento do cônjuge type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-10-27' partnerOccupation: description: Profissão do cônjuge type: string childCoverage: description: Deseja cobertura para filhos? type: boolean children: type: array description: Lista que agrupa os dados dos filhos. items: type: object properties: childBirth: description: Data de nascimento do filho type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-10-27' isChildSportsperson: description: Pratica esportes de aventura? type: boolean Premium: type: object description: Objeto que agrupa dados de prêmio. required: - totalPremiumAmount - totalNetAmount - IOF - paymentsQuantity - payments - periodicity properties: totalNetAmount: description: Valor de prêmio líquido total allOf: - $ref: '#/components/schemas/AmountDetails' IOF: description: Valor do IOF allOf: - $ref: '#/components/schemas/AmountDetails' totalPremiumAmount: description: Valor total do prêmio do contrato allOf: - $ref: '#/components/schemas/AmountDetails' paymentsQuantity: description: Quantidade de parcelas do prêmio do contrato type: integer maxLength: 3 example: 4 payments: type: array items: $ref: '#/components/schemas/PaymentQuote' periodicity: type: string description: Periodicidade de pagamento do Prêmio enum: - MENSAL - BIMESTRAL - TRIMESTRAL - QUADRIMESTRAL - SEMESTRAL - ANUAL - A_VISTA/UNICO interestRateOverPayments: description: Taxa de juros sobre o parcelamento do prêmio type: string pattern: ^\d{1,3}\.\d{1,9}$ example: '10.00' PaymentQuote: 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 enum: - BOLETO - TED - TEF - CARTAO - DOC - CHEQUE - DESCONTO_EM_FOLHA - PIX - DINHEIRO_EM_ESPECIE - OUTROS paymentTypeOthers: description: Descricao do Meio de Pagamento quando for informada a opcao OUTROS type: string maxLength: 100 Coverage: type: object required: - branch - code - isSeparateContractingAllowed - insuredCapital properties: branch: description: Grupo e ramo da cobertura type: string maxLength: 4 example: '0111' code: description: Código da cobertura de suguro pessoas allOf: - $ref: '#/components/schemas/EnumCodeCoverage' 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 insuredCapital: description: Capital segurado allOf: - $ref: '#/components/schemas/AmountDetails' CoverageResult: type: object required: - branch - code - isSeparateContractingAllowed properties: branch: description: Grupo e ramo da cobertura type: string maxLength: 4 example: '0111' code: description: Código da cobertura de suguro pessoas allOf: - $ref: '#/components/schemas/EnumCodeCoverage' 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 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 enum: - DIAS_UTEIS - DIAS_CORRIDOS example: DIAS_UTEIS gracePeriodStartDate: type: string format: date 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 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 premiumAmount: description: Valor de Prêmio da Cobertura allOf: - $ref: '#/components/schemas/AmountDetails' deductible: description: Informações de franquia allOf: - $ref: '#/components/schemas/DeductibleQuote' POS: description: Informações de POS allOf: - $ref: '#/components/schemas/POSQuote' ClaimNotification: type: object description: Valores de sinistros 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 DeductibleQuote: type: object required: - type properties: type: description: Tipo de Franquia type: string maxLength: 9 enum: - REDUZIDA - NORMAL - MAJORADA - DEDUTIVEL - OUTROS typeAdditionalInfo: description: Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS") type: string maxLength: 500 deductibleAmount: 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 maxLength: 3 enum: - DIA - MES - ANO periodCountingMethod: description: Indicador de Dias Úteis ou Corridos (Caso aplicável) type: string enum: - DIAS_UTEIS - DIAS_CORRIDOS 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 POSQuote: type: object required: - applicationType - description - fullIndemnityDeductible properties: applicationType: description: Forma de Aplicação do POS type: string maxLength: 10 enum: - VALOR - PERCENTUAL - OUTROS applicationTypeOthers: description: Descricao do Forma de Aplicação do POS quando for informada a opcao OUTROS type: string maxLength: 100 description: description: Descrição do POS type: string maxLength: 60 example: Descrição de exemplo minValue: description: Valor Mínimo do POS allOf: - $ref: '#/components/schemas/AmountDetails' maxValue: description: Valor Máximo do POS allOf: - $ref: '#/components/schemas/AmountDetails' percentage: description: Percentual do POS type: string pattern: ^100\.0{1,9}$|^\d{1,2}\.\d{1,9}$ example: '10.5' fullIndemnityDeductible: description: Franquia sobre indenização integral allOf: - $ref: '#/components/schemas/AmountDetails' Assistance: type: object required: - type - service - description - assistancePremiumAmount properties: type: description: Tipo de prestação de serviços type: string 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 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' EnumCodeCoverage: type: string enum: - MORTE - MORTE_ACIDENTAL - INVALIDEZ_TOTAL_POR_ACIDENTE - INVALIDEZ_PARCIAL_POR_ACIDENTE - INVALIDEZ_TOTAL_E PARCIAL_POR_ACIDENTE - INVALIDEZ_FUNCIONAL_PERMANENTE_TOTAL_POR_DOENÇA - INVALIDEZ_LABORATIVA_PERMANENTE_TOTAL_POR_DOENÇA - DESEMPREGO_PERDA_DE_RENDA - INCAPACIDADE_TEMPORÁRIA - DOENÇA_GRAVE - INTERNAÇÃO_HOSPITALAR - DESPESAS_MÉDICAS_HOSPITALARES_E_ODONTOLÓGICAS_BRASIL - DESPESAS_MÉDICAS_HOSPITALARES_E_ODONTOLÓGICAS_EXTERIOR - TRANSPLANTE_DE_ÓRGÃOS - CIRURGIA - TRASLADO_DE_CORPO - REGRESSO_SANITÁRIO - TRASLADO_MÉDICO - CANCELAMENTO_DE_VIAGEM - REGRESSO_ANTECIPADO - SOBREVIVÊNCIA - OUTRAS QuotePersonTravel: type: object required: - coverages properties: termStartDate: type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-10-27' description: Vigência das 24 horas do dia termEndDate: type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-10-27' description: Até as 24 horas do dia contractCurrency: description: Moeda de emissão do contrato, de acordo com ISO-4217. allOf: - $ref: '#/components/schemas/EnumCurrencyCode' travelType: description: Tipo de viagem type: string enum: - LAZER - NEGOCIOS_CONGRESSOS - INTERCAMBIO - TRATAMENTO_DE_DOENCAS internationalTrip: description: Viagem é internacional? type: boolean destinationCountry: description: Qual o país de destino? allOf: - $ref: '#/components/schemas/EnumCountryCode' goingThroughEurope: description: Vai passar pela Europa? type: boolean destinationContinent: description: Qual é o continente de destino? type: string enum: - AMERICA - AFRICA - EUROPA - ASIA - OCEANIA - ANTARTIDA departureDate: description: Data de embarque type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-11-30' disembarkationDate: description: Data de desembarque type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-11-30' isOngoingTrip: description: A viagem já iniciou? type: boolean transportationType: description: Qual o meio de transporte para a viagem? type: string enum: - AEREO - MARITIMA - AEREO_MARITIMA - TERRESTRE isCruise: description: Trata-se de Cruzeiro? type: boolean travelersCounter: description: Quantas pessoas viajarão com você? type: integer travelers: type: array description: Dados dos viajantes items: $ref: '#/components/schemas/Traveler' covid19Coverage: description: Deseja coberturas para planos com covid-19? type: boolean diseasesCoverage: description: Deseja coberturas para doenças infecciosas, bacterianas ou virais? (Malária, Febre Amarela, etc) type: boolean coverages: type: array description: Lista que agrupa os dados de coberturas. items: $ref: '#/components/schemas/CoverageForTravel' includeAssistanceServices: description: Deseja contratação de serviços de assistência? type: boolean QuotePersonTravelResult: type: object required: - quoteData - quoteCustomer - quotes properties: quoteCustomer: description: Dados da pessoa física allOf: - $ref: '#/components/schemas/PersonalCustomerInfo' quoteData: description: Dados Gerais da Cotação allOf: - $ref: '#/components/schemas/QuoteInfoForTravelResult' quotes: type: array minItems: 1 description: Lista de cotações enviadas pela seguradora. items: type: object description: Informações da cotação enviada pela seguradora required: - insurerQuoteId - quoteDateTime - susepProcessNumbers properties: insurerQuoteId: type: string description: | Id da proposta da segurada quoteDateTime: type: string format: date-time example: '2023-05-21T08:30:00Z' description: Data e hora da cotação 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$ coverages: type: array description: Lista que agrupa os dados de coberturas. items: $ref: '#/components/schemas/CoverageResultForTravel' susepProcessNumbers: description: Número do Processo Susep das Coberturas type: array items: type: string maxLength: 50 premiumInfo: $ref: '#/components/schemas/Premium' quoteCustomData: $ref: '#/components/schemas/QuoteCustomData' QuoteInfoForTravelResult: type: object properties: termStartDate: type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-10-27' description: Vigência das 24 horas do dia termEndDate: type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-10-27' description: Até as 24 horas do dia contractCurrency: description: Moeda de emissão do contrato, de acordo com ISO-4217. allOf: - $ref: '#/components/schemas/EnumCurrencyCode' travelType: description: Tipo de viagem type: string enum: - LAZER - NEGOCIOS_CONGRESSOS - INTERCAMBIO - TRATAMENTO_DE_DOENCAS internationalTrip: description: Viagem é internacional? type: boolean destinationCountry: description: Qual o país de destino? allOf: - $ref: '#/components/schemas/EnumCountryCode' goingThroughEurope: description: Vai passar pela Europa? type: boolean destinationContinent: description: Qual é o continente de destino? type: string enum: - AMERICA - AFRICA - EUROPA - ASIA - OCEANIA - ANTARTIDA departureDate: description: Data de embarque type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-11-30' disembarkationDate: description: Data de desembarque type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2022-11-30' isOngoingTrip: description: A viagem já iniciou? type: boolean transportationType: description: Qual o meio de transporte para a viagem? type: string enum: - AEREO - MARITIMA - AEREO_MARITIMA - TERRESTRE isCruise: description: Trata-se de Cruzeiro? type: boolean travelersCounter: description: Quantas pessoas viajarão com você? type: integer travelers: type: array description: Dados dos viajantes items: $ref: '#/components/schemas/Traveler' covid19Coverage: description: Deseja coberturas para planos com covid-19? type: boolean diseasesCoverage: description: Deseja coberturas para doenças infecciosas, bacterianas ou virais? (Malária, Febre Amarela, etc) type: boolean includeAssistanceServices: description: Deseja contratação de serviços de assistência? type: boolean Traveler: type: object description: Dados dos Viajantes para cotação properties: travelerAge: description: Qual a idade dos viajantes? type: integer isPregnant: description: Quantos dos viajantes estão gestantes? type: boolean pregnancyWeeksCounter: description: Quantas semanas de gestação? (obrigatório, caso isPregnant seja verdadeiro) type: integer hasPublicServices: description: Quantos dos viajantes possuem função pública? type: boolean hasPublicServantRelationship: description: Quantos viajantes possuem relacionamento com Agente Público? type: boolean CoverageForTravel: type: object required: - branch - code - isSeparateContractingAllowed properties: branch: description: Grupo e ramo da cobertura type: string maxLength: 4 example: '0111' code: description: Código da cobertura de suguro pessoas allOf: - $ref: '#/components/schemas/EnumCodeCoverage' 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' maxLMG: description: Valor de Limite Máximo de Garantia (LMG) solicitado allOf: - $ref: '#/components/schemas/AmountDetails' CoverageResultForTravel: type: object required: - branch - code - isSeparateContractingAllowed - maxLMI properties: branch: description: Grupo e ramo da cobertura type: string maxLength: 4 example: '0111' code: description: Código da cobertura de suguro pessoas allOf: - $ref: '#/components/schemas/EnumCodeCoverage' 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 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 enum: - DIAS_UTEIS - DIAS_CORRIDOS example: DIAS_UTEIS gracePeriodStartDate: type: string format: date 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 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 maxLMI: description: Valor de Limite Máximo de Indenização (LMI) solicitado allOf: - $ref: '#/components/schemas/AmountDetails' maxLMG: description: Valor de Limite Máximo de Garantia (LMG) solicitado allOf: - $ref: '#/components/schemas/AmountDetails' premiumAmount: description: Valor de Prêmio da Cobertura allOf: - $ref: '#/components/schemas/AmountDetails' deductible: description: Informações de franquia allOf: - $ref: '#/components/schemas/DeductibleQuote' POS: description: Informações de POS allOf: - $ref: '#/components/schemas/POSQuote' PersonalCustomerInfo: type: object properties: identification: $ref: '#/components/schemas/PersonalIdentificationData' qualification: $ref: '#/components/schemas/PersonalQualificationData' complimentaryInfo: $ref: '#/components/schemas/PersonalComplimentaryInformationData' InsurancePersonPolicyInfo: type: object description: Objeto que agrupa dados de ápolice. required: - documentType - policyId - issuanceType - issuanceDate - termStartDate - termEndDate - maxLMG - withdrawals - portabilities - proposalId - insureds - insuredObjects - PMBaC 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 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 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 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 conjugatedPlan: description: O plano é conjugado? type: boolean example: true withdrawals: $ref: '#/components/schemas/WithdrawalInfo' portabilities: $ref: '#/components/schemas/PortabilityInfo' 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 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/InsurancePersonInsuredObject' coverages: type: array description: Lista que agrupa os dados de coberturas. items: $ref: '#/components/schemas/InsurancePersonCoverage' 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' PMBaC: type: object description: PMBaC required: - pmbacAmount properties: pmbacAmount: description: | Valor PMBaC (fim do mês) Valor da Provisão Matemática de Benefícios a Conceder (PMBaC), no fim de cada mês. Caso não haja saldo informar nulo allOf: - $ref: '#/components/schemas/AmountDetails' GraceInfo: type: array description: Informações de Carência em caso de regime financeiro de Repartição de Capitais de Cobertura e de Capitalização (Caso seguro individual) items: type: object required: - type - gracePeriod - gracePeriodicity - gracePeriodCountingMethod - gracePeriodStartDate - gracePeriodEndDate - period properties: type: description: Tipo de Carência (Quando houver) type: string enum: - PORTABILIDADE - RESGATE example: RESGATE 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' enum: - DIAS_UTEIS - DIAS_CORRIDOS example: DIAS_UTEIS 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 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 da carência. OBS: Obrigatório, se houver' period: type: integer maxLength: 5 description: Prazo de Carência entre Resgates (Caso Tipo de Carência 1. Portabilidade ou 2. Resgate for selecionada) WithdrawalInfo: type: array description: Informações de resgate, Obrigatório se houver em caso de regime financeiro de Capitalização items: type: object required: - occurrenceWithdrawal properties: occurrenceWithdrawal: type: boolean description: Indica se houve resgate example: true type: description: Tipo de resgate type: string enum: - TOTAL - PARCIAL example: PARCIAL requestDate: description: Data solicitação type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2020-12-31' amount: description: Valor do resgate allOf: - $ref: '#/components/schemas/AmountDetails' movementDate: description: Data Movimentação (liquidação) type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ example: '2020-12-31' withdrawalCause: description: Natureza do Resgate (Caso Ocorrência do resgate for Sim) type: string enum: - RESGATE_REGULAR - MORTE - INVALIDEZ - PAGAMENTO_FINANCEIRO_PROGRAMADO - CUSTEIO_DE_COBERTURA_DE_RISCOS_EM_PLANOS_CONJUGADOS - ASSISTENCIA_FINANCEIRA PortabilityInfo: type: array description: Informações de portabilidade, Obrigatório se houver em caso de regime financeiro de Capitalização items: type: object required: - occurrencePortability properties: occurrencePortability: type: boolean description: Indica se houve portabilidade example: true direction: description: Direção do fluxo de portabilidade type: string enum: - ENTRADA - SAIDA example: ENTRADA type: type: string description: Tipo de portabilidade enum: - TOTAL - PARCIAL example: PARCIAL amount: $ref: '#/components/schemas/AmountDetails' requestDate: description: Data solicitação type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 10 example: '2020-12-31' movementDate: description: Data Movimentação (liquidação) type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 10 example: '2020-12-31' sourceEntityCode: description: Código FIP da entidade de origem (cedente) da portabilidade type: string example: ABC123 targetEntityCode: description: Código FIP da entidade de origem destino (cessionária) da portabilidade type: string example: ABC123 sourceEntitySusepProcessNumber: description: Processo Susep do Plano Origem type: string maxLength: 60 example: ABC123 PersonalInfo: type: object required: - identification - identificationType - name - postCode - 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 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: '2022-12-31' name: description: Nome ou Razão Social do segurado type: string maxLength: 60 example: Nome Sobrenome postCode: description: Código Postal do segurado type: string pattern: ^\d{8}$ example: '10000000' email: description: E-mail do segurado (caso possua) type: string maxLength: 256 pattern: ^\S+@\S+\.\S+$ city: description: Cidade do segurado (por extenso) type: string maxLength: 60 state: description: Estado do segurado (por extenso) type: string maxLength: 60 country: description: País do segurado (de acordo com o código "alpha3" do ISO-3166) allOf: - $ref: '#/components/schemas/EnumCountryCode' address: description: Endereço do segurado (restante do endereço, excluindo cidade, estado e país) type: string maxLength: 60 BeneficiaryInfo: type: object required: - identification - identificationType - name properties: identification: description: Documento de Identificação da Pessoa type: string maxLength: 60 example: '12345678900' identificationType: description: Tipo de Documento da Pessoa 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 da Pessoa type: string maxLength: 60 example: Nome Sobrenome 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) allOf: - $ref: '#/components/schemas/EnumCountrySubDivision' country: description: País do Tomador/Garantidor (de acordo com o código "alpha3" do ISO-3166) allOf: - $ref: '#/components/schemas/EnumCountryCode' 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 Intermediary: type: object required: - name - type properties: type: description: Tipo do Intermediador type: string enum: - CORRETOR - REPRESENTANTE - ESTIPULANTE_AVERBADOR_INSTITUIDOR - CORRESPONDENTE - AGENTE_DE_MICROSSEGUROS - OUTROS example: REPRESENTANTE typeOthers: description: Descrição do Tipo do Intermediador quando for informada a opção OUTROS type: string example: OUTROS identification: description: Documento de Identificação da Intermediador (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: ^\d{1,60}$ example: '12345678900' brokerId: description: Identificador do Intermediador (Caso Tipo de Intermediador for CORRETOR) código SUSEP do corretor(a) type: string maxLength: 100 identificationType: description: Tipo de Documento da Intermediador type: string enum: - CPF - CNPJ - OUTROS example: CPF identificationTypeOthers: description: Descrição do Tipo de Documento quando for informada a opção OUTROS type: string example: OUTROS 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) allOf: - $ref: '#/components/schemas/EnumCountryCode' 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 InsurancePersonInsuredObject: type: object required: - type - description - coverages properties: type: description: Tipo do objeto segurado type: string enum: - CONTRATO - PROCESSO_ADMINISTRATIVO - PROCESSO_JUDICIAL - AUTOMOVEL - CONDUTOR - FROTA - PESSOA - OUTROS example: CONTRATO typeAdditionalInfo: description: Descricao do tipo do objeto segurado(caso tipo de objeto segurado for outros) type: string maxLength: 100 description: description: Descricao do objeto segurado type: string maxLength: 1024 amount: $ref: '#/components/schemas/AmountDetails' coverages: type: array items: $ref: '#/components/schemas/InsurancePersonInsuredObjectCoverage' InsurancePersonInsuredObjectCoverage: type: object required: - branch - code - susepProcessNumber - LMI - termStartDate - termEndDate - feature - type - triggerEvent - financialType - benefitPaymentModality properties: branch: type: string maxLength: 4 example: '0111' description: Grupo e Ramo da Cobertura (Conforme regulamentação Susep vigente) code: description: Codigo da cobertura type: string enum: - MORTE - MORTE_ACIDENTAL - INVALIDEZ_TOTAL_POR_ACIDENTE - INVALIDEZ_PARCIAL_POR_ACIDENTE - INVALIDEZ_TOTAL_E_PARCIAL_POR_ACIDENTE - INVALIDEZ_FUNCIONAL_PERMANENTE_TOTAL_POR_DOENCA - INVALIDEZ_LABORATIVA_PERMANENTE_TOTAL_POR_DOENCA - DESEMPREGO_PERDA_DE_RENDA - INCAPACIDADE_TEMPORARIA - DOENCA_GRAVE - INTERNACAO_HOSPITALAR - DESPESAS_MEDICAS_HOSPITALARES_E_ODONTOLOGICAS_BRASIL - DESPESAS_MEDICAS_HOSPITALARES_E_ODONTOLOGICAS_EXTERIOR - TRANSPLANTE_DE_ORGAOS - CIRURGIA - TRASLADO_DE_CORPO - REGRESSO_SANITARIO - TRASLADO_MEDICO - CANCELAMENTO_DE_VIAGEM - REGRESSO_ANTECIPADO - SOBREVIVENCIA - OUTRAS example: MORTE description: description: Campo de detalhamento do Codigo da cobertura. Obrigatorio quando a opcao escolhida para o mesmo for OUTRAS type: string maxLength: 500 internalCode: type: string maxLength: 500 description: Código interno da cobertura da seguradora(obrigatório se houver) susepProcessNumber: type: string description: Número do processo administrativo da Susep relacionado à cobertura contratada LMI: description: Limite Maximo de Indenizacao (LMI) ou Capital Segurado (Para seguros de pessoas, deve ser preenchido com o valor do Capital Segurado) allOf: - $ref: '#/components/schemas/AmountDetails' isLMISublimit: description: Limite Maximo de Indenização (LMI) seria sublimite (caso aplicavel)? type: boolean example: false termStartDate: description: Data de inicio de vigencia da cobertura type: string format: date maxLength: 10 example: '2022-12-31' termEndDate: description: Data de fim de vigencia da cobertura type: string format: date maxLength: 10 example: '2022-12-31' isMainCoverage: description: Cobertura Principal type: boolean example: true feature: description: Caracteristica da cobertura type: string enum: - MASSIFICADOS - MASSIFICADOS_MICROSEGUROS - GRANDES_RISCOS example: MASSIFICADOS type: description: Tipo de cobertura type: string enum: - PARAMETRICO - INTERMITENTE - REGULAR_COMUM - CAPITAL_GLOBAL - PARAMETRICO_E_INTERMITENTE example: PARAMETRICO grace: $ref: '#/components/schemas/GraceInfo' insuredDependentsInclusionClause: description: Cláusula de Inclusão de Dependentes Segurados (Caso contrato de Funeral, Acidentes Pessoais, Doenças Graves ou Doença Terminal, Eventos Aleatórios, Vida, Desemprego/Perda de Renda e Viagem e Educacional) type: string enum: - NAO_HA - FACULTATIVA - AUTOMATICA example: NAO_HA tripScope: description: Abrangência da viagem. (Caso contrato Viagem) type: string enum: - NACIONAL - INTERNACIONAL - NACIONAL_E_INTERNACIONAL example: NACIONAL insuredCapitalType: description: Modalidade de capital segurado. (Caso contrato Prestamista - exceto Habitacional e Rural) type: string enum: - FIXO - VINCULADO - VARIAVEL example: FIXO moneylenderType: description: Tipo de prestamista. (Caso contrato Prestamista - exceto Habitacional e Rural) type: string enum: - BASICO - EMPRESARIAL - EMPRESARIAL_INTEGRAL example: BASICO creditor: type: object properties: identification: description: Identificação do credor. (Caso contrato Prestamista - exceto Habitacional e Rural) type: string maxLength: 60 pattern: ^\d{1,60}$ example: '12345678901' identificationType: description: Tipo de documento do credor. (Caso contrato Prestamista - exceto Habitacional e Rural) type: string enum: - CPF - CNPJ - OUTROS identificationTypeOthers: description: Descricao do campo de Tipo de documento do credor quando a opcao escolhida for OUTROS type: string maxLength: 100 name: description: Nome ou razão social do credor. (Caso contrato Prestamista - exceto Habitacional e Rural) type: string maxLength: 60 obligations: type: array items: type: object properties: type: description: Tipo de obrigação. (Caso contrato Prestamista - exceto Habitacional e Rural) type: string enum: - EMPRESTIMO - CONSORCIO - CONDOMINIO - OUTROS typeOthers: description: Descrição Tipo da Obrigação. (Caso tipo de obrigação OUTROS e caso contrato Prestamista - exceto Habitacional e Rural) type: string maxLength: 500 personIdentification: description: (Caso contrato Prestamista) type: object properties: identification: description: Documento de Identificação da Pessoa type: string maxLength: 60 example: '12345678900' identificationType: description: Tipo de Documento da Pessoa type: string enum: - CPF - CNPJ - OUTROS example: CPF identificationTypeOthers: description: Descricao do campo de Tipo de Documento da Pessoa quando a opcao escolhida for OUTROS type: string maxLength: 100 name: description: Nome ou Razão Social da Pessoa type: string maxLength: 60 example: Nome Sobrenome insuredCapitalPercentage: description: Percentual do Capital Segurado. (Caso contrato Prestamista - exceto Habitacional e Rural) type: string pattern: ^\d{1,3}\.\d{1,9}$ example: '20.00' dependents: description: Segurados dependentes type: array items: type: object properties: identification: description: Documento de Identificação (caso a opção "2. Facultativa" seja selecionada no campo "Cláusula de Inclusão de Dependentes Segurados") type: string maxLength: 60 pattern: ^\d{1,60}$ example: '12345678901234' identificationType: description: Tipo de Documento da Pessoa type: string enum: - CPF - CNPJ - OUTROS example: CPF identificationTypeOthers: description: Descricao do campo de Tipo de Documento da Pessoa quando a opcao escolhida for OUTROS type: string maxLength: 100 name: description: Nome ou Razão Social da Pessoa type: string maxLength: 60 example: Nome Sobrenome kinshipDegree: description: Grau de Parentesco (caso preenchido o campo "Cláusula de Inclusão de Dependentes" for igual a 3-Automático) type: string enum: - CONJUGE - PAIS - SOGROS - AVOS - BISAVOS - FILHOS - NETOS - BISNETOS - IRMAOS - TIOS - SOBRINHOS educationalInstitution: description: Referente a seguro educacional type: object properties: identification: description: Documento de Identificação da Pessoa type: string maxLength: 60 example: '12345678901' identificationType: description: Tipo de Documento da Pessoa type: string enum: - CNPJ - OUTROS example: CNPJ identificationTypeOthers: description: Descricao do campo de Tipo de Documento da Pessoa quando a opcao escolhida for OUTROS type: string maxLength: 100 name: description: Nome ou Razão Social da Pessoa type: string maxLength: 60 example: Nome Sobrenome biometricTable: description: Tabua biometrica, se houver type: string example: AT49_M enum: - AT49_M - AT49_F - AT50_M - AT50_F - AT55_M - AT55_F - AT71_M - AT71_F - AT83_M - AT83_F - AT2000_M - AT2000_F - CS041 - CSO58 - CSO80_M - CSO80_F - CSG_60 - GAM71_M - GAM71_F - SGB51 - SGB55 - SGB71 - SGB75 - GKF70 - GKF80 - GKF95 - GKM70 - GKM80 - GKM95 - UP_84 - IAPB_57 - IAPB57_NIVELADA - ZIMMERMANN - WINKLEVOSS - BENTZIEN - EXP_IAPC - IAPB_57_FRACA - IAPB_57_FORTE - ALVARO_VINDAS - TASA_27 - MULLER - HUNTER - EB7 - UP94_M - AT49 - AT2000_FEMALE_SUAVIZADA_10 - TGA - AT2000_MALE_SUAVIZADA_10 - BR_EMSSB_V2010M - BR_EMSSB_V2010F - SUSEP_IBGE - PERCENTUAL_FIXO - PERPETUA - BR_EMSMT_V2010M - BR_EMSMT_V2010F - BR_EMSSB_V2015M - BR_EMSSB_V2015F - BR_EMSMT_V2015M - BR_EMSMT_V2015F - BR_EMSMT_M - BR_EMSMT_F - BR_EMSSB_M - BR_EMSSB_F - BR_EMSSB_V2021M - BR_EMSSB_V2021F - BR_EMSMT_V2021M - BR_EMSMT_V2021F - OUTRAS pmbacInterestRate: description: Taxa de Juros PMBaC (quando houver) type: string pattern: ^100\.0{1,9}$|^\d{1,2}\.\d{1,9}$ example: '10.00' incomeInterestRate: description: Taxa de Juros Rendas (quando houver) type: string pattern: ^100\.0{1,9}$|^\d{1,2}\.\d{1,9}$ example: '10.00' pricingForm: type: string description: Forma de tarifacao (quando houver) enum: - POR_IDADE - TAXA_MEDIA - FAIXA_ETARIA - OUTROS example: POR_IDADE pricingFormOthers: description: Descricao da forma de tarifacao quando for informada a opcao OUTROS type: string triggerEvent: description: Indica o tipo de evento gerador aplicavel a cobertura type: string enum: - INVALIDEZ - MORTE - OUTROS example: INVALIDEZ triggerEventOthers: description: Descricao do evento gerador quando for informada a opcao OUTROS type: string financialType: type: string description: Regime financeiro enum: - REPARTICAO_SIMPLES - REPARTICAO_POR_CAPITAIS_DE_COBERTURA - CAPITALIZACAO example: REPARTICAO_SIMPLES benefitPaymentModality: description: Forma de Pagamento do Benefício type: string enum: - RENDA - UNICO example: RENDA coverageUpdateIndex: description: Indice de precos referente a atualizacao monetaria anual do valor da cobertura type: string enum: - IPC-FGV - IGP-DI-FGV - IPCA-IBGE - IGPM-FGV - INPC-IBGE - TR - OUTROS example: IGPM-FGV coverageUpdateIndexOthers: description: Descricao do Indice de precos referente a atualizacao monetaria anual do valor da cobertura quando for informada a opcao OUTROS type: string periodicityValue: description: Periodicidade de Atualizacao da cobertura (quando houver) type: integer example: 5 periodicity: description: Unidade da Periodicidade de Atualizacao da Cobertura type: string enum: - DIA - MES - ANO example: DIA indexLag: description: Defasagem do indice de precos aplicado na atualizacao da renda (em meses) type: integer example: 5 pmbacMonetaryUpdateIndex: description: | Indice de Precos Garantido PMBaC Obrigatorio em caso de regime financeiro de Capitalizacao type: string enum: - IPC-FGV - IGP-DI-FGV - IPCA-IBGE - IGPM-FGV - INPC-IBGE - TR - OUTROS example: IGPM-FGV pmbacMonetaryUpdateIndexOthers: description: Descricao do Indice de Precos Garantido PMBaC quando for informada a opcao OUTROS type: string pmbacIndexLag: description: | Defasagem do Indice PMBaC (em meses) Obrigatorio em caso de regime financeiro de Capitalizacao type: integer example: 5 InsurancePersonCoverage: type: object required: - branch - code minProperties: 3 properties: branch: description: Grupo e ramo da cobertura type: string maxLength: 4 example: '0111' code: type: string description: Codigo da cobertura enum: - MORTE - MORTE_ACIDENTAL - INVALIDEZ_TOTAL_POR_ACIDENTE - INVALIDEZ_PARCIAL_POR_ACIDENTE - INVALIDEZ_TOTAL_E_PARCIAL_POR_ACIDENTE - INVALIDEZ_FUNCIONAL_PERMANENTE_TOTAL_POR_DOENCA - INVALIDEZ_LABORATIVA_PERMANENTE_TOTAL_POR_DOENCA - DESEMPREGO_PERDA_DE_RENDA - INCAPACIDADE_TEMPORARIA - DOENCA_GRAVE - INTERNACAO_HOSPITALAR - DESPESAS_MEDICAS_HOSPITALARES_E_ODONTOLOGICAS_BRASIL - DESPESAS_MEDICAS_HOSPITALARES_E_ODONTOLOGICAS_EXTERIOR - TRANSPLANTE_DE_ORGAOS - CIRURGIA - TRASLADO_DE_CORPO - REGRESSO_SANITARIO - TRASLADO_MEDICO - CANCELAMENTO_DE_VIAGEM - REGRESSO_ANTECIPADO - SOBREVIVENCIA - OUTRAS example: MORTE description: description: Campo de detalhamento do Codigo da Cobertura quando a opcao escolhida 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: Informações de franquia required: - applicationType properties: applicationType: description: Forma de Aplicacao do POS type: string enum: - VALOR - PERCENTUAL - OUTROS example: VALOR valueOthers: description: Valor para quando a opção for OUTROS allOf: - $ref: '#/components/schemas/AmountDetails' description: description: Descricao do POS (caso Forma de aplicacao do POS for Outros) type: string maxLength: 60 example: Descricao de exemplo minValue: description: Valor minimo do POS (caso aplicavel) allOf: - $ref: '#/components/schemas/AmountDetails' maxValue: description: Valor maximo do POS (caso aplicavel) allOf: - $ref: '#/components/schemas/AmountDetails' percentage: description: Valor Percentual do POS allOf: - $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' InsurancePersonPremium: 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: description: Valor Total do Premio (Exceto para seguros de pessoas cuja periodicidade do Premio seja periodica) allOf: - $ref: '#/components/schemas/AmountDetails' coverages: type: array description: Lista que agrupa os dados de coberturas. items: $ref: '#/components/schemas/InsurancePersonPremiumCoverage' payments: type: array description: Lista que agrupa os dados de pagamentos. items: $ref: '#/components/schemas/Payment' InsurancePersonPremiumCoverage: type: object required: - branch - code - premiumAmount properties: branch: description: Grupo e ramo da cobertura type: string maxLength: 4 example: '0111' code: type: string description: Codigo da cobertura enum: - MORTE - MORTE_ACIDENTAL - INVALIDEZ_TOTAL_POR_ACIDENTE - INVALIDEZ_PARCIAL_POR_ACIDENTE - INVALIDEZ_TOTAL_E_PARCIAL_POR_ACIDENTE - INVALIDEZ_FUNCIONAL_PERMANENTE_TOTAL_POR_DOENCA - INVALIDEZ_LABORATIVA_PERMANENTE_TOTAL_POR_DOENCA - DESEMPREGO_PERDA_DE_RENDA - INCAPACIDADE_TEMPORARIA - DOENCA_GRAVE - INTERNACAO_HOSPITALAR - DESPESAS_MEDICAS_HOSPITALARES_E_ODONTOLOGICAS_BRASIL - DESPESAS_MEDICAS_HOSPITALARES_E_ODONTOLOGICAS_EXTERIOR - TRANSPLANTE_DE_ORGAOS - CIRURGIA - TRASLADO_DE_CORPO - REGRESSO_SANITARIO - TRASLADO_MEDICO - CANCELAMENTO_DE_VIAGEM - REGRESSO_ANTECIPADO - SOBREVIVENCIA - OUTRAS example: MORTE description: description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS") type: string maxLength: 500 premiumAmount: $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 - ESTORNO_DE_PREMIO - ESTORNO_DE_RESTITUICAO_DE_PREMIO - ESTORNO_DE_CUSTO_DE_AQUISICAO - EMISSAO_DE_PREMIO_SEM_ENDOSSO - CANCELAMENTO_DE_PARCELA - EMISSAO_DE_RESTITUICAO_DE_PREMIO_SEM_ENDOSSO - REABERTURA_DE_PARCELA - BAIXA_POR_PERDA - CANCELAMENTO_DE_PREMIO_E_PARCELA_SEM_ENDOSSO - COMPENSACAO_FINANCEIRA 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: description: Valor e moeda da parcela allOf: - $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: Descricao do Tipo de Documento quando for informada a opcao 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 - COMUNICABILIDADE - PIX - DINHEIRO_EM_ESPECIE - OUTROS example: COMUNICABILIDADE paymentTypeOthers: description: Descricao do Meio de Pagamento quando for informada a opcao OUTROS type: string InsurancePersonClaim: type: object required: - identification - status - statusAlterationDate - occurrenceDate - warningDate - warningRegisterDate - amount properties: identification: description: Identificador do processo de sinistro type: string maxLength: 50 documentationDeliveryDate: description: Data de entrega da documentacao completa type: string format: date maxLength: 10 example: '2022-12-31' status: description: Status do sinistro / evento gerador type: string enum: - ABERTO - ENCERRADO_COM_INDENIZACAO - ENCERRADO_SEM_INDENIZACAO - REABERTO - CANCELADO_POR_ERRO_OPERACIONAL - AVALIACAO_INICIAL - ENCERRADO_COM_PAGAMENTO_UNICO_BENEFICIO - ENCERRADO_COM_CONCESSAO_DE_RENDA_BENEFICIO - ENCERRADO_INDEFERIDO_BENEFICIO example: ABERTO statusAlterationDate: description: Data de alteracao do status do sinistro type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 10 example: '2022-12-31' occurrenceDate: description: Data de ocorrencia do sinistro type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 10 example: '2022-12-31' warningDate: description: Data de aviso do sinistro type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 10 example: '2022-12-31' warningRegisterDate: description: Data do Registro de Aviso a Seguradora type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 10 example: '2022-12-31' thirdPartyClaimDate: description: Data de reclamacao do terceiro type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 10 example: '2022-12-31' amount: description: | Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado) allOf: - $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: Descricao da Justificativa da Negativa (Caso Justificativa da Negativa for OUTROS type: string maxLength: 100 coverages: type: array items: $ref: '#/components/schemas/InsurancePersonClaimCoverage' recipient: type: array items: $ref: '#/components/schemas/InsurancePersonClaimRecipient' InsurancePersonClaimRecipient: type: object required: - recipientIdentification - recipientIdentificationType - recipientName - recipientClassification - recipientBirthDate - incomeModality - incomeValueUniquePayment - recipientNumber - concessionStartDate - monetaryUpdateIndex - lastUpdateDate properties: recipientIdentification: description: Documento de identificação do beneficiário da renda concedida type: string maxLength: 60 example: '12345678901' recipientIdentificationType: description: Tipo de Documento da Pessoa type: string enum: - CPF - RG - PASSAPORTE - OUTROS example: CPF recipientIdTypeOthers: description: Descricao do campo de Tipo de Documento da Pessoa quando a opcao escolhida for OUTROS type: string maxLength: 100 recipientName: description: Nome do beneficiário da renda concedida type: string maxLength: 60 example: Nome Sobrenome recipientClassification: description: Classificacao do Beneficiario type: string enum: - SEGURADO - CONJUGE - FILHO_MENOR_DE_IDADE - BENEFICIARIO_INDICADO example: SEGURADO recipientBirthDate: description: Data de nascimento do beneficiário da renda concedida type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 10 example: '1990-12-31' incomeModality: type: string description: Tipo de renda concedida example: RENDA_VITALICIA enum: - PAGAMENTO_UNICO - RENDA_PRAZO_CERTO - RENDA_TEMPORARIA - RENDA_TEMPORARIA_REVERSIVEL - RENDA_TEMPORARIA_PRAZO_MINIMO_GARANTIDO - RENDA_TEMPORARIA_REVERSIVEL_PRAZO_MINIMO_GARANTIDO - RENDA_VITALICIA - RENDA_VITALICIA_REVERSIVEL_BENEFICIARIO_INDICADO - RENDA_VITALICIA_REVERSIVEL_CONJUGE_CONTINUIDADE_MENORES - RENDA_VITALICIA_PRAZO_MINIMO_GARANTIDO - RENDA_VITALICIA_REVERSIVEL_PRAZO_MINIMO_GARANTIDO - RENDA_VITALICIA_REVERSIVEL_CONJUGE - OUTROS incomeModalityOthers: type: string description: Descrição do tipo de renda quando outros example: Outros incomeReversed: type: boolean description: | Declara se já houve a reversão da renda do benefício concedido do segurado para o cônjuge, beneficiário indicado ou filho menor (para alguns Tipos de Renda verificar manual de escopo de dados) example: true incomeValueUniquePayment: $ref: '#/components/schemas/AmountDetails' incomeTerm: type: string description: | Prazo pagamento da parcela ou da renda atuarial ou financeira do benefício concedido (para alguns Tipos de Renda verificar manual de escopo de dados) recipientNumber: type: integer description: Número de benefícios a serem recebidos por ano example: 3 concessionStartDate: description: Data de início de concessão do benefício type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 11 example: '2020-12-31' monetaryUpdateIndex: type: string description: Índice de preços referente à atualização monetária anual do valor da renda enum: - IPC-FGV - IGP-DI-FGV - IPCA-IBGE - IGPM-FGV - INPC-IBGE - TR - OUTROS example: IGPM-FGV monetaryUpdateIndexOthers: description: Descrição do Índice de preços referente à atualização monetária anual do valor da renda quando for informada a opção OUTROS type: string example: OUTROS lastUpdateDate: description: Data da última atualização do benefício type: string format: date pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 12 example: '2020-12-31' InsurancePersonClaimCoverage: type: object required: - branch - code properties: insuredObjectId: description: Identificador do Objeto Segurado (Caso aplicavel) type: string maxLength: 100 branch: description: Grupo e ramo da cobertura type: string maxLength: 4 example: '0111' code: type: string description: Codigo da cobertura enum: - MORTE - MORTE_ACIDENTAL - INVALIDEZ_TOTAL_POR_ACIDENTE - INVALIDEZ_PARCIAL_POR_ACIDENTE - INVALIDEZ_TOTAL_E_PARCIAL_POR_ACIDENTE - INVALIDEZ_FUNCIONAL_PERMANENTE_TOTAL_POR_DOENCA - INVALIDEZ_LABORATIVA_PERMANENTE_TOTAL_POR_DOENCA - DESEMPREGO_PERDA_DE_RENDA - INCAPACIDADE_TEMPORARIA - DOENCA_GRAVE - INTERNACAO_HOSPITALAR - DESPESAS_MEDICAS_HOSPITALARES_E_ODONTOLOGICAS_BRASIL - DESPESAS_MEDICAS_HOSPITALARES_E_ODONTOLOGICAS_EXTERIOR - TRANSPLANTE_DE_ORGAOS - CIRURGIA - TRASLADO_DE_CORPO - REGRESSO_SANITARIO - TRASLADO_MEDICO - CANCELAMENTO_DE_VIAGEM - REGRESSO_ANTECIPADO - SOBREVIVENCIA - OUTRAS example: MORTE description: description: Campo de detalhamento do Codigo da cobertura. Obrigatorio quando a opcao escolhida para o mesmo for OUTRAS type: string maxLength: 500 warningDate: description: Data de Aviso do Sinistro por Cobertura (Caso aplicavel) type: string pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 12 format: date example: '2022-12-31' thirdPartyClaimDate: description: Data de Reclamacao do Terceiro por Cobertura (Caso aplicavel) type: string pattern: ^(\d{4})-(1[0-2]|0[1-9])-(3[01]|[12][0-9]|0[1-9])$ maxLength: 12 format: date example: '2022-12-31' HistoricalPersonalComplimentaryInformationData: $ref: '#/components/schemas/PersonalComplimentaryInformationData' HistoricalPersonalIdentificationData: $ref: '#/components/schemas/PersonalIdentificationData' PersonalProcurator: type: object required: - nature properties: nature: $ref: '#/components/schemas/EnumProcuratorsNaturePersonal' cnpjCpfNumber: type: string maxLength: 14 pattern: ^\d{11}$|^\d{14}$ example: '73677831148' description: (Caso Natureza dos poderes vigentes de representantefor “Representante legal” ou “Procurador”) CPF ou CNPJ do representante civilName: type: string maxLength: 70 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: '[\w\W\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/EnumProcuratorsNaturePersonal' cnpjCpfNumber: type: string maxLength: 14 pattern: ^\d{11}$|^\d{14}$ example: '73677831148' description: (Caso Natureza dos poderes vigentes de representantefor “Representante legal” ou “Procurador”) CPF ou CNPJ do representante civilName: type: string maxLength: 70 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: '[\w\W\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: 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 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 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: 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 format: date-time description: Data e hora da atualização do bloco, conforme especificação RFC-3339 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' 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}$ 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 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 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 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: 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 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 properties: incomeFrequency: $ref: '#/components/schemas/EnumIncomeFrequency' currency: description: Moeda referente ao valor do faturamento, segundo modelo ISO-4217. allOf: - $ref: '#/components/schemas/EnumCurrencyCode' amount: type: string nullable: true pattern: ^-?\d{1,15}\.\d{2,4}$ example: '100000.04' description: | Valor do faturamento year: type: string maxLength: 4 format: date-fullyear example: '2010' description: Ano de referência do faturamento, conforme especificação RFC-3339. additionalProperties: false informedPatrimony: type: object properties: currency: description: Moeda referente ao valor do patrimônio, segundo modelo ISO-4217. allOf: - $ref: '#/components/schemas/EnumCurrencyCode' amount: type: string nullable: true pattern: ^-?\d{1,15}\.\d{2,4}$ example: '100000.04' description: | Valor do patrimônio date: type: string 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: 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 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 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: 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 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: '[\w\W\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: '[\w\W\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}$ 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}$ 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: description: Código do país de acordo com o código “alpha3” do ISO-3166 allOf: - $ref: '#/components/schemas/EnumCountryCode' otherDocuments: $ref: '#/components/schemas/OtherPersonalDocuments' contact: $ref: '#/components/schemas/PersonalContact' civilStatusCode: $ref: '#/components/schemas/EnumCivilStatusCode' civilStatusCodeOthers: description: Descricao do tipo de estado civil quando for informada a opcao OUTROS type: string maxLength: 100 sex: type: string maxLength: 20 example: FEMININO birthDate: type: string 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 properties: type: $ref: '#/components/schemas/EnumFiliationType' civilName: type: string maxLength: 70 pattern: '[\w\W\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: '[\w\W\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}$ 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: type: object description: Conjunto de informações relativas ao processo de qualificação. required: - pepIdentification - updateDateTime - lifePensionPlans properties: updateDateTime: 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' 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 enum: - SIM - NAO - NAO_SE_APLICA informedRevenue: type: object properties: incomeFrequency: $ref: '#/components/schemas/EnumIncomeFrequency' currency: description: Moeda referente ao valor da renda, segundo modelo ISO-4217. allOf: - $ref: '#/components/schemas/EnumCurrencyCode' amount: type: string nullable: true pattern: ^-?\d{1,15}\.\d{2,4}$ example: '100000.04' description: | Valor do rendimento date: type: string 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 properties: currency: description: Moeda referente ao valor do patrimônio, segundo modelo ISO-4217. allOf: - $ref: '#/components/schemas/EnumCurrencyCode' amount: type: string nullable: true pattern: ^-?\d{1,15}\.\d{2,4}$ example: '100000.04' description: | Valor do patrimônio year: type: string maxLength: 4 format: date-fullyear 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 enum: - RCVD - EVAL - ACPT - RJCT - ACKN - CANC rejectionReason: type: string description: Campo condicionado ao status "RJCT", que deve apresentar a justificativa a recusa ao risco. 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$ PersonalDocuments: type: array description: Objeto agrupador de informações relativas a Documentos da pessoa natural items: properties: type: description: Obrigatorio desde que a participante possua a informacao allOf: - $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 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 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 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}$ 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 país de acordo com o código “alpha3” do ISO-3166. allOf: - $ref: '#/components/schemas/EnumCountryCode' expirationDate: type: string 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: type: object required: - code - description properties: code: allOf: - $ref: '#/components/schemas/EnumCurrencySymbol' description: description: Moeda da Parcela, de acordo com ISO-4217. allOf: - $ref: '#/components/schemas/EnumCurrencyCode' QuoteCustomData: type: object description: Objeto que agrupa as categorias de dados customizáveis em listas. properties: customerIdentification: type: array description: Informações de Cadastro de Identificação items: $ref: '#/components/schemas/CustomInfoData' customerQualification: type: array description: Informações de Cadastro de Qualificação items: $ref: '#/components/schemas/CustomInfoData' customerComplimentaryInfo: type: array description: Informações de Cadastro de Relacionamento items: $ref: '#/components/schemas/CustomInfoData' generalQuoteInfo: type: array description: Informações de Cotação de Dados Gerais da Cotação items: $ref: '#/components/schemas/CustomInfoData' riskLocationInfo: type: array description: Informações de Cotação de Informações do Local de Risco items: $ref: '#/components/schemas/CustomInfoData' insuredObjects: type: array description: Informações de Cotação de Objeto Segurado items: $ref: '#/components/schemas/CustomInfoData' beneficiaries: type: array description: Informações do Contrato de Beneficiários items: $ref: '#/components/schemas/CustomInfoData' coverages: type: array description: Informações do Contrato de Coberturas items: $ref: '#/components/schemas/CustomInfoData' generalClaimInfo: type: array description: Informações gerais de sinistros, eventos imprevistos, acidentes e afins 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 natural phones: type: array items: $ref: '#/components/schemas/CustomerPhone' minItems: 1 description: Lista com telefones de contato da pessoa natural 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: '[\w\W\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}$ maxLength: 8 example: '17500001' 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: Código do país de acordo com o código “alpha3” do ISO-3166. allOf: - $ref: '#/components/schemas/EnumCountryCode' 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 EnumCurrencySymbol: type: string description: Símbolo da Moeda. example: R$ 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 EnumCurrencyCode: type: string description: Sigla da Moeda, segundo modelo 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 EnumCountryCode: type: string description: Código do país de acordo com o código “alpha3” do ISO-3166 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 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 description: Tipo de filiação. EnumProcuratorsNaturePersonal: 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: properties: type: type: string maxLength: 13 example: SOCIO description: Tipo de vínculo com a pessoa jurídica enum: - SOCIO - ADMINISTRADOR civilName: type: string maxLength: 70 pattern: '[\w\W\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: '[\w\W\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 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 maxLength: 8 minLength: 8 pattern: ^[01]\.\d{6}$ 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: description: | País de emissão do documento. Código do país de acordo com o código alpha3 do ISO-3166. allOf: - $ref: '#/components/schemas/EnumCountryCode' documentExpirationDate: type: string format: date 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 items: $ref: '#/components/schemas/BusinessPostalAddress' minItems: 1 description: Lista de endereços da pessoa jurídica 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: '[\w\W\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}$ maxLength: 8 example: '17500001' 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: 8 example: '17500001' description: | Código IBGE do município country: type: string maxLength: 60 example: Brasil countryCode: description: Código do país de acordo com o código “alpha3” do ISO-3166. allOf: - $ref: '#/components/schemas/EnumCountryCode' 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 enum: - CANC PatchPayload: type: object required: - data properties: data: type: object required: - status - author properties: status: description: Status da cotação. type: string 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 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 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$ format: date-time 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-person/v1 first: type: string description: URL da primeira página de registros example: https://api.organizacao.com.br/open-insurance/quote-person/v1 prev: type: string description: URL da página anterior de registros example: https://api.organizacao.com.br/open-insurance/quote-person/v1 next: type: string description: URL da próxima página de registros example: https://api.organizacao.com.br/open-insurance/quote-person/v1 last: type: string description: URL da última página de registros example: https://api.organizacao.com.br/open-insurance/quote-person/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 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$ format: date-time example: '2021-08-20T08:30:00Z' additionalProperties: false meta: $ref: '#/components/schemas/Meta' additionalProperties: false 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. QuoteRequestPersonLead: 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: Objeto que agrupa as categorias de dados históricos cadastrais do cliente. properties: identificationData: oneOf: - $ref: '#/components/schemas/HistoricalPersonalIdentificationData' - $ref: '#/components/schemas/HistoricalBusinessIdentificationData' qualificationData: oneOf: - $ref: '#/components/schemas/HistoricalPersonalQualificationData' - $ref: '#/components/schemas/HistoricalBusinessQualificationData' complimentaryInformationData: oneOf: - $ref: '#/components/schemas/HistoricalPersonalComplimentaryInformationData' - $ref: '#/components/schemas/HistoricalBusinessComplimentaryInformationData' policies: $ref: '#/components/schemas/PolicyDataPersonLead' 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: description: Código da cobertura de suguro pessoas allOf: - $ref: '#/components/schemas/EnumCodeCoverage' description: description: Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS") type: string maxLength: 500 quoteCustomData: $ref: '#/components/schemas/QuoteCustomData' ResponseQuotePersonLead: type: object required: - data - links - meta properties: data: $ref: '#/components/schemas/QuoteStatus' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' QuoteRequestPersonLife: 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 históricos 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/QuoteDataPersonLife' 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' - $ref: '#/components/schemas/HistoricalBusinessIdentificationData' qualificationData: oneOf: - $ref: '#/components/schemas/HistoricalPersonalQualificationData' - $ref: '#/components/schemas/HistoricalBusinessQualificationData' complimentaryInformationData: oneOf: - $ref: '#/components/schemas/HistoricalPersonalComplimentaryInformationData' - $ref: '#/components/schemas/HistoricalBusinessComplimentaryInformationData' policies: $ref: '#/components/schemas/PolicyDataPersonLife' ResponseQuoteStatusPersonLife: type: object required: - data - links - meta properties: data: type: object required: - status - statusUpdateDateTime properties: status: description: Status da cotação. type: string 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$ 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/QuoteStatusPersonLife' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' ResponseQuotePersonLife: type: object required: - data - links - meta properties: data: $ref: '#/components/schemas/QuoteStatus' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' QuoteRequestPersonTravel: 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 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/QuoteDataPersonTravel' 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.3 properties: identificationData: oneOf: - $ref: '#/components/schemas/HistoricalPersonalIdentificationData' - $ref: '#/components/schemas/HistoricalBusinessIdentificationData' qualificationData: oneOf: - $ref: '#/components/schemas/HistoricalPersonalQualificationData' - $ref: '#/components/schemas/HistoricalBusinessQualificationData' complimentaryInformationData: oneOf: - $ref: '#/components/schemas/HistoricalPersonalComplimentaryInformationData' - $ref: '#/components/schemas/HistoricalBusinessComplimentaryInformationData' policies: $ref: '#/components/schemas/PolicyDataPersonTravel' ResponseQuoteStatusPersonTravel: type: object required: - data - links - meta properties: data: type: object required: - status - statusUpdateDateTime properties: status: description: Status da cotação. type: string 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$ 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/QuoteStatusPersonTravel' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' ResponseQuotePersonTravel: type: object required: - data - links - meta properties: data: $ref: '#/components/schemas/QuoteStatus' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' 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 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-person-lead: Escopo necessário para acesso à API Person Lead. quote-person-life: Escopo necessário para acesso à API Person Life. quote-person-travel: Escopo necessário para acesso à API Person Travel. 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' OKResponseQuoteRequestPersonLead: description: Dados de PersonLead criados com sucesso headers: x-fapi-interaction-id: schema: $ref: '#/components/schemas/XFapiInteractionId' content: application/json: schema: $ref: '#/components/schemas/ResponseQuotePersonLead' 200UpdatedQuotePersonLead: description: Atualização de PersonLead 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' OKResponseQuoteRequestPersonLife: description: Dados de PersonLife criados com sucesso headers: x-fapi-interaction-id: schema: $ref: '#/components/schemas/XFapiInteractionId' content: application/json: schema: $ref: '#/components/schemas/ResponseQuotePersonLife' 200QuoteStatusPersonLife: description: Dados de PersonLife 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/ResponseQuoteStatusPersonLife' 200UpdatedQuotePersonLife: description: Atualização de PersonLife 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' OKResponseQuoteRequestPersonTravel: description: Dados de PersonTravel criados com sucesso headers: x-fapi-interaction-id: schema: $ref: '#/components/schemas/XFapiInteractionId' content: application/json: schema: $ref: '#/components/schemas/ResponseQuotePersonTravel' 200QuoteStatusPersonTravel: description: Dados de PersonTravel 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/ResponseQuoteStatusPersonTravel' 200UpdatedQuotePersonTravel: description: Atualização de PersonTravel 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'