openapi: 3.0.0 info: title: API InsurancePerson - Open Insurance Brasil description: | API de Pessoas do Open Insurance Brasil - Fase 2.\ Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.\ Não possui segregação entre pessoa natural e pessoa jurídica.\ Requer consentimento do cliente para todos os 'endpoints'. # Orientações A `Role` do diretório de participantes relacionada à presente API é a `DADOS`.\ 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 devolvidos na consulta desde que o `consentId` relacionado corresponda a um consentimento válido e com o status `AUTHORISED`.\ É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).\ 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 a consulta de dados em cada `endpoint` da presente API. ## Permissions necessárias para a API InsurancePerson Para cada um dos `paths` desta API, além dos escopos (`scopes`) indicados existem `permissions` que deverão ser observadas: ### `/` - permissions: - GET: **DAMAGES_AND_PEOPLE_PERSON_READ** ### `/{policyId}/policy-info` - permissions: - GET: **DAMAGES_AND_PEOPLE_PERSON_POLICYINFO_READ** ### `/{policyId}/premium` - permissions: - GET: **DAMAGES_AND_PEOPLE_PERSON_PREMIUM_READ** ### `/{policyId}/claim` - permissions: - GET: **DAMAGES_AND_PEOPLE_PERSON_CLAIM_READ** version: 1.5.0 contact: name: Governança do Open Insurance Brasil url: "https://www.gov.br/susep/" servers: - url: "https://api.organizacao.com.br/open-insurance/insurance-person/v1" description: Servidor de Produção - url: "https://api.organizacao.com.br/open-insurance/insurance-person/v1" description: Servidor de Homologação tags: - name: "InsurancePerson" paths: /insurance-person: get: tags: - InsurancePerson summary: Obtem a lista de identificação de InsurancePerson description: "Método para obter a lista de identificação de InsurancePerson" operationId: "getInsurancePerson" parameters: - $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/OKResponseInsurancePerson" "204": $ref: "#/components/responses/NoContent" "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" security: - OpenId: - openid OAuth2Security: - "consent:consentId" - insurance-person /insurance-person/{policyId}/policy-info: get: tags: - InsurancePerson summary: Obtém as informações gerais da apólice identificada por {policyId} description: "Método para obter as informações gerais da apólice" operationId: "getInsurancePersonpolicyIdPolicyInfo" parameters: - $ref: "#/components/parameters/Authorization" - $ref: "#/components/parameters/xFapiAuthDate" - $ref: "#/components/parameters/xFapiCustomerIpAddress" - $ref: "#/components/parameters/xFapiInteractionId" - $ref: "#/components/parameters/xCustomerUserAgent" - $ref: "#/components/parameters/policyId" responses: "200": $ref: "#/components/responses/OKResponseInsurancePersonPolicyInfo" "204": $ref: "#/components/responses/NoContent" "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" security: - OpenId: - openid OAuth2Security: - "consent:consentId" - insurance-person /insurance-person/{policyId}/premium: get: tags: - InsurancePerson summary: Obtém os dados de prêmio da apólice identificada por {policyId} description: "Método para obter os dados de prêmio da apólice." operationId: "getInsurancePersonpolicyIdPremium" parameters: - $ref: "#/components/parameters/Authorization" - $ref: "#/components/parameters/xFapiAuthDate" - $ref: "#/components/parameters/xFapiCustomerIpAddress" - $ref: "#/components/parameters/xFapiInteractionId" - $ref: "#/components/parameters/xCustomerUserAgent" - $ref: "#/components/parameters/policyId" responses: "200": $ref: "#/components/responses/OKResponseInsurancePersonPremium" "204": $ref: "#/components/responses/NoContent" "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" security: - OpenId: - openid OAuth2Security: - "consent:consentId" - insurance-person /insurance-person/{policyId}/claim: get: tags: - InsurancePerson summary: Obtém os dados de sinistro da apólice identificada por {policyId} description: "Método para obter os dados de sinistro associados à apólice" operationId: "getInsurancePersonpolicyIdClaims" parameters: - $ref: "#/components/parameters/Authorization" - $ref: "#/components/parameters/xFapiAuthDate" - $ref: "#/components/parameters/xFapiCustomerIpAddress" - $ref: "#/components/parameters/xFapiInteractionId" - $ref: "#/components/parameters/xCustomerUserAgent" - $ref: "#/components/parameters/policyId" - $ref: "#/components/parameters/page" - $ref: "#/components/parameters/pageSize" responses: "200": $ref: "#/components/responses/OKResponseInsurancePersonClaims" "204": $ref: "#/components/responses/NoContent" "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" security: - OpenId: - openid OAuth2Security: - "consent:consentId" - insurance-person components: schemas: ResponseInsurancePerson: type: object required: - data - links - meta properties: data: type: array items: type: object required: - brand properties: brand: type: object description: Marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes. required: - name - companies properties: name: type: string description: Nome da Marca maxLength: 500 example: EMPRESA A SEGUROS companies: type: array items: type: object required: - companyName - cnpjNumber - policies properties: companyName: description: Nome da sociedade pertencente à marca type: string maxLength: 200 cnpjNumber: description: CNPJ da sociedade pertencente à marca type: string pattern: '^\d{14}$' example: "12345678901234" policies: type: array items: type: object required: - productName - policyId properties: productName: description: Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade type: string maxLength: 100 example: Produto A Pessoas policyId: description: Identificador da apólice ou bilhete type: string maxLength: 60 example: "111111" links: $ref: "#/components/schemas/Links" meta: $ref: "#/components/schemas/Meta" ResponseInsurancePersonPolicyInfo: type: object required: - data - links - meta properties: data: $ref: "#/components/schemas/InsurancePersonPolicyInfo" links: $ref: "#/components/schemas/Links" meta: $ref: "#/components/schemas/Meta" InsurancePersonPolicyInfo: type: object required: - documentType - policyId - issuanceType - issuanceDate - termStartDate - termEndDate - 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: identificação do contrato/apólice, em caso de contratação coletiva, obrigatório caso Tipo de contratação seja COLETIVO type: string maxLength: 60 example: "111111" susepProcessNumber: description: Numero SUSEP da apolice conforme regulamentacao vigente (Obrigatorio caso apolice 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 Emissao type: string enum: [EMISSAO_PROPRIA, COSSEGURO_ACEITO] example: EMISSAO_PROPRIA issuanceDate: description: Data de emissao do documento type: string format: date maxLength: 10 example: "2022-12-31" termStartDate: description: Data de início de vigência do documento type: string format: date maxLength: 10 example: "2022-12-31" termEndDate: description: Data de fim de vigência do documento type: string format: date maxLength: 10 example: "2022-12-31" leadInsurerCode: description: Codigo da seguradora lider para contratos com arranjo de cosseguro type: string maxLength: 1024 example: "ABC123" leadInsurerPolicyId: description: Identificador da apolice seguradora lider para apolice de cosseguro aceito type: string maxLength: 1024 example: "ABC123" withdrawals: $ref: "#/components/schemas/WithdrawalInfo" portabilities: $ref: "#/components/schemas/PortabilityInfo" proposalId: description: Identificador da Proposta type: string maxLength: 60 example: "ABC123" insureds: type: array items: $ref: "#/components/schemas/PersonalInfo" beneficiaries: type: array items: $ref: "#/components/schemas/BeneficiaryInfo" principals: type: array items: $ref: "#/components/schemas/PersonalInfo" intermediaries: type: array items: $ref: "#/components/schemas/Intermediary" insuredObjects: type: array items: $ref: "#/components/schemas/InsurancePersonInsuredObject" coverages: type: array items: $ref: "#/components/schemas/InsurancePersonCoverage" coinsuranceRetainedPercentage: description: Percentual Retido em Cosseguro (Quando ha cosseguro) type: string pattern: '^\d{1,3}\.\d{1,9}$' example: "10.00" coinsurers: type: array 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 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" 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] gracePeriodStartDate: type: string format: date maxLength: 10 example: "2022-12-31" description: "Data de início da carência. OBS: Obrigatório, se houver" gracePeriodEndDate: type: string format: date maxLength: 10 example: "2022-12-31" 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 example: "2020-12-31" amount: allOf: - $ref: "#/components/schemas/AmountDetails" movementDate: description: Data Movimentação (liquidação) type: string format: date 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 example: "2020-12-31" movementDate: description: Data Movimentação (liquidação) type: string format: date 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/Participante type: string maxLength: 60 example: "12345678900" identificationType: description: Tipo de Documento do Segurado/Participante 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 do Segurado/Participante type: string maxLength: 60 example: Nome Sobrenome postCode: description: Código Postal do Segurado/Participante type: string maxLength: 60 example: "10000000" email: description: E-mail do Segurado/Participante (caso possua) type: string maxLength: 256 city: description: Cidade do Segurado/Participante (por extenso) type: string maxLength: 60 state: description: Estado do Segurado/Participante (por extenso) type: string maxLength: 60 country: description: País do Segurado/Participante (de acordo com o código "alpha3" do ISO-3166) type: string maxLength: 3 pattern: '^(\w{3}){1}$' example: BRA address: description: Endereço do Segurado/Participante (restante do endereço, excluindo cidade, estado e país) type: string maxLength: 60 addressAdditionalInfo: type: string maxLength: 30 pattern: '[\w\W\s]*' example: Fundos description: Alguns logradouros ainda necessitam ser especificados por meio de complemento. BeneficiaryInfo: type: object required: - identification - identificationType - name properties: identification: description: Documento de Identificação do beneficiário. type: string maxLength: 60 example: "12345678900" identificationType: description: Tipo de Documento do beneficiário. type: string enum: [CPF, CNPJ, OUTROS] example: CPF identificationTypeOthers: description: Descrição do Tipo de Documento quando for informada a opção OUTROS type: string example: OUTROS name: description: Nome ou Razão Social do beneficiário. type: string maxLength: 60 example: Nome Sobrenome 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) type: string maxLength: 3 pattern: '^(\w{3}){1}$' example: BRA 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 ] 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 ] 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 ] 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] tripScope: description: Abrangência da viagem. (Caso contrato Viagem) type: string enum: [NACIONAL, INTERNACIONAL, NACIONAL_E_INTERNACIONAL] insuredCapitalType: description: Modalidade de capital segurado. (Caso contrato Prestamista - exceto Habitacional e Rural) type: string enum: [FIXO, VINCULADO, VARIAVEL] moneylenderType: description: Tipo de prestamista. (Caso contrato Prestamista - exceto Habitacional e Rural) type: string enum: [BASICO, EMPRESARIAL, EMPRESARIAL_INTEGRAL] 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: 1 - Mortalidade Geral / Beneficiário - AT49 M enum: [ 1 - Mortalidade Geral / Beneficiário - AT49 M, 2 - Mortalidade Geral / Beneficiário - AT49 F, 3 - Mortalidade Geral / Beneficiário - AT50 M, 4 - Mortalidade Geral / Beneficiário - AT50 F, 5 - Mortalidade Geral / Beneficiário - AT55 M, 6 - Mortalidade Geral / Beneficiário - AT55 F, 7 - Mortalidade Geral / Beneficiário - AT71 M, 8 - Mortalidade Geral / Beneficiário - AT71 F, 9 - Mortalidade Geral / Beneficiário - AT83 M, 10 - Mortalidade Geral / Beneficiário - AT83 F, 11 - Mortalidade Geral / Beneficiário - AT2000 M, 12 - Mortalidade Geral / Beneficiário - AT2000 F, 13 - Mortalidade Geral / Beneficiário - CS041, 14 - Mortalidade Geral / Beneficiário - CSO58, 15 - Mortalidade Geral / Beneficiário - CSO80 M, 16 - Mortalidade Geral / Beneficiário - CSO80 F, 17 - Mortalidade Geral / Beneficiário - CSG 60, 18 - Mortalidade Geral / Beneficiário - GAM71 M, 19 - Mortalidade Geral / Beneficiário - GAM71 F, 20 - Mortalidade Geral / Beneficiário - SGB51, 21 - Mortalidade Geral / Beneficiário - SGB55, 22 - Mortalidade Geral / Beneficiário - SGB71, 23 - Mortalidade Geral / Beneficiário - SGB75, 24 - Mortalidade Geral / Beneficiário - GKF70, 25 - Mortalidade Geral / Beneficiário - GKF80, 26 - Mortalidade Geral / Beneficiário - GKF95, 27 - Mortalidade Geral / Beneficiário - GKM70, 28 - Mortalidade Geral / Beneficiário - GKM80, 29 - Mortalidade Geral / Beneficiário - GKM95, 30 - Mortalidade Geral / Beneficiário - UP 84, 31 - Mortalidade de Inválidos - IAPB 57, 32 - Mortalidade de Inválidos - IAPB57 - Nivelada, 33 - Mortalidade de Inválidos - ZIMMERMANN, 34 - Mortalidade de Inválidos - WINKLEVOSS, 35 - Mortalidade de Inválidos - BENTZIEN, 36 - Mortalidade de Inválidos - EXP. IAPC, 37 - Mortalidade de Inválidos - TASA27, 38 - Mortalidade de Inválidos - MULLER, 39 - Entrada em Invalidez - IAPB 57 FRACA, 40 - Entrada em Invalidez - IAPB 57 FORTE, 41 - Entrada em Invalidez - ZIMMERMANN, 42 - Entrada em Invalidez - ÁLVARO VINDAS, 43 - Entrada em Invalidez - TASA 27, 44 - Entrada em Invalidez - MULLER, 45 - Entrada em Invalidez - HUNTER, 46 - Mortalidade Geral / Beneficiário - EB7, 47 - Mortalidade Geral / Beneficiário - UP94 M, 48 - Mortalidade Geral / Beneficiário - AT49, 49 - Mortalidade Geral / Beneficiário - AT2000 female suavizada 10%, 49 - Entrada em Invalidez - AT2000 female suavizada 10%, 50 - Mortalidade Geral / Beneficiário - TGA, 50 - Entrada em Invalidez - TGA, 51 - Mortalidade Geral / Beneficiário - AT2000 male suavizada 10%, 52 - Mortalidade Geral / Beneficiário - BR-EMSsb-V.2010-m, 53 - Mortalidade Geral / Beneficiário - BR-EMSsb-V.2010-f, 54 - Entrada em Invalidez - SUSEP_IBGE, 55 - Mortalidade Geral / Beneficiário - Percentual Fixo, 55 - Mortalidade de Inválidos - Percentual Fixo, 55 - Entrada em Invalidez - Percentual Fixo, 56 - Mortalidade Geral / Beneficiário - Perpétua, 56 - Mortalidade de Inválidos - Perpétua, 56 - Entrada em Invalidez - Perpétua, 57 - Mortalidade Geral / Beneficiário - BR-EMSmt-V.2010-m, 57 - Mortalidade de Inválidos - BR-EMSmt-V.2010-m, 57 - Entrada em Invalidez - BR-EMSmt-V.2010-m, 58 - Mortalidade Geral / Beneficiário - BR-EMSmt-V.2010-f, 58 - Mortalidade de Inválidos - BR-EMSmt-V.2010-f, 58 - Entrada em Invalidez - BR-EMSmt-V.2010-f, 59 - Mortalidade Geral / Beneficiário - BR-EMSsb-V.2015-m, 59 - Mortalidade de Inválidos - BR-EMSsb-V.2015-m, 59 - Entrada em Invalidez - BR-EMSsb-V.2015-m, 60 - Mortalidade Geral / Beneficiário - BR-EMSsb-V.2015-f, 60 - Mortalidade de Inválidos - BR-EMSsb-V.2015-f, 60 - Entrada em Invalidez - BR-EMSsb-V.2015-f, 61 - Mortalidade Geral / Beneficiário - BR-EMSmt-V.2015-m, 61 - Mortalidade de Inválidos - BR-EMSmt-V.2015-m, 61 - Entrada em Invalidez - BR-EMSmt-V.2015-m, 62 - Mortalidade Geral / Beneficiário - BR-EMSmt-V.2015-f, 62 - Mortalidade de Inválidos - BR-EMSmt-V.2015-f, 62 - Entrada em Invalidez - BR-EMSmt-V.2015-f, 63 - Mortalidade Geral / Beneficiário - BR-EMSsb-m, 63 - Mortalidade de Inválidos - BR-EMSsb-m, 63 - Entrada em Invalidez - BR-EMSsb-m, 64 - Mortalidade Geral / Beneficiário - BR-EMSsb-f, 64 - Mortalidade de Inválidos - BR-EMSsb-f, 64 - Entrada em Invalidez - BR-EMSsb-f, 65 - Mortalidade Geral / Beneficiário - BR-EMSmt-m, 65 - Mortalidade de Inválidos - BR-EMSmt-m, 65 - Entrada em Invalidez - BR-EMSmt-m, 66 - Mortalidade Geral / Beneficiário - BR-EMSmt-f, 66 - Mortalidade de Inválidos - BR-EMSmt-f, 66 - Entrada em Invalidez - BR-EMSmt-f, 67 - Mortalidade Geral / Beneficiário - BR-EMSsb-V.2021-m, 67 - Mortalidade de Inválidos - BR-EMSsb-V.2021-m, 67 - Entrada em Invalidez - BR-EMSsb-V.2021-m, 68 - Mortalidade Geral / Beneficiário - BR-EMSsb-V.2021-f, 68 - Mortalidade de Inválidos - BR-EMSsb-V.2021-f, 68 - Entrada em Invalidez - BR-EMSsb-V.2021-f, 69 - Mortalidade Geral / Beneficiário - BR-EMSmt-V.2021-m, 69 - Mortalidade de Inválidos - BR-EMSmt-V.2021-m, 69 - Entrada em Invalidez - BR-EMSmt-V.2021-m, 70 - Mortalidade Geral / Beneficiário - BR-EMSmt-V.2021-f, 70 - Mortalidade de Inválidos - BR-EMSmt-V.2021-f, 70 - Entrada em Invalidez - BR-EMSmt-V.2021-f, 99 - Mortalidade Geral / Beneficiário - OUTRAS, 99 - Mortalidade de Inválidos - OUTRAS, 99 - Entrada em Invalidez - OUTRAS] pmbacInterestRate: description: Taxa de Juros PMBaC (quando houver) type: string pattern: '^\d{1,3}\.\d{1,9}$' example: "10.00" incomeInterestRate: description: Taxa de Juros Rendas (quando houver) type: string pattern: '^\d{1,3}\.\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 ] 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: Campo de detalhamento do Tipo de Franquia quando a opcao escolhida 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 Uteis ou Corridos (Caso aplicavel) type: string enum: [DIAS_UTEIS, DIAS_CORRIDOS] example: DIAS_UTEIS periodStartDate: description: Data de Inicio da Franquia type: string format: date example: "2022-05-16" periodEndDate: description: Data de Fim da Franquia type: string format: date example: "2022-05-17" description: description: Descricao 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 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: Percentual do POS type: string pattern: '^\d{1,3}\.\d{1,9}$' example: "10.00" Coinsurer: type: object required: - identification - cededPercentage properties: identification: description: Identificacao da congenere, cessionario do cosseguro. Obrigatorio quando ha cosseguro. type: string maxLength: 60 cededPercentage: description: Percentual cedido para a congenere para contratos de cosseguro cedido. Obrigatorio quando ha cosseguro type: string pattern: '^\d{1,3}\.\d{1,9}$' example: "10.00" ResponseInsurancePersonPremium: type: object required: - data - links - meta properties: data: $ref: "#/components/schemas/InsurancePersonPremium" links: $ref: "#/components/schemas/Links" meta: $ref: "#/components/schemas/Meta" InsurancePersonPremium: type: object required: - amount - paymentsQuantity - coverages - payments properties: amount: description: Valor Total do Premio (Exceto para seguros de pessoas cuja periodicidade do Premio seja periodica) allOf: - $ref: "#/components/schemas/AmountDetails" paymentsQuantity: description: Quantidade de parcelas do premio do contrato (Exceto para seguros de pessoas cuja periodicidade do Premio seja periodica) type: number maxLength: 3 example: 4 coverages: type: array items: $ref: "#/components/schemas/InsurancePersonPremiumCoverage" payments: type: array 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 ] description: description: Campo de detalhamento do Codigo da cobertura. Obrigatorio quando a opcao escolhida para o mesmo for OUTRAS type: string maxLength: 500 premiumAmount: $ref: "#/components/schemas/AmountDetails" Payment: type: object description: Historico de Movimentos de Premios (Para seguros de pessoas com vigencia acima de 12 meses, limitar o historico aos ultimos 12 meses) required: - movementDate - movementType - movementPaymentsNumber - amount - maturityDate properties: movementDate: description: Data do movimento de premio type: string format: date 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. Obrigatorio caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO ou 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: number 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 example: "2022-12-31" tellerId: description: Documento do Pagador/Recebedor. Obrigatorio caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO ou LIQUIDACAO_DE_CUSTO_DE_AQUISICAO type: string maxLength: 1024 tellerIdType: description: Tipo do Documento do Pagador/Recebedor. Obrigatorio caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO ou 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 Razao Social do Pagador/Recebedor. Obrigatorio caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO ou LIQUIDACAO_DE_CUSTO_DE_AQUISICAO type: string maxLength: 100 financialInstitutionCode: description: Codigo da Instituicao Financeiro do Pagamento. Obrigatorio caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO ou LIQUIDACAO_DE_CUSTO_DE_AQUISICAO type: string maxLength: 100 paymentType: description: Meio de Pagamento. Obrigatorio caso Tipo de Movimento for LIQUIDACAO_DE_PREMIO ou LIQUIDACAO_DE_CUSTO_DE_AQUISICAO type: string enum: [BOLETO, TED, TEF, CARTAO, DOC, CHEQUE, DESCONTO_EM_FOLHA, PIX, DINHEIRO_EM_ESPECIE, OUTROS] example: BOLETO paymentTypeOthers: description: Descricao do Meio de Pagamento quando for informada a opcao OUTROS type: string ResponseInsurancePersonClaims: type: object required: - data - links - meta properties: data: type: array items: $ref: "#/components/schemas/InsurancePersonClaim" minItems: 0 links: $ref: "#/components/schemas/Links" meta: $ref: "#/components/schemas/Meta" 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 ] statusAlterationDate: description: Data de alteracao do status do sinistro type: string format: date maxLength: 10 example: "2022-12-31" occurrenceDate: description: Data de ocorrencia do sinistro type: string format: date maxLength: 10 example: "2022-12-31" warningDate: description: Data de aviso do sinistro type: string format: date maxLength: 10 example: "2022-12-31" warningRegisterDate: description: Data do Registro de Aviso a Seguradora type: string format: date maxLength: 10 example: "2022-12-31" thirdPartyClaimDate: description: Data de reclamacao do terceiro type: string format: date maxLength: 10 example: "2022-12-31" amount: $ref: "#/components/schemas/AmountDetails" denialJustification: description: Justificativa da Negativa (Caso Status do Sinistro for ENCERRADO_SEM_INDENIZACAO type: string 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 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 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 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 ] 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 format: date example: "2022-12-31" thirdPartyClaimDate: description: Data de Reclamacao do Terceiro por Cobertura (Caso aplicavel) type: string format: date example: "2022-12-31" AmountDetails: type: object description: Detalhes de valores/limites required: - amount - unit properties: amount: type: string pattern: '^\d{1,16}\.\d{2}$' example: "2000.00" unit: type: object required: - code - description properties: code: type: string maxLength: 2 example: R$ description: type: string description: Moeda da Parcela, de acordo com ISO-4217. pattern: ^(\w{3})$ example: BRL Links: type: object properties: self: type: string description: URL da página atualmente requisitada pattern: ^(https:\/\/)(.*?)(\/open-insurance\/insurance-person\/v\d+)(\/insurance-person.*)?$ example: "https://api.organizacao.com.br/open-insurance/insurance-person/v1/insurance-person" first: type: string description: URL da primeira página de registros pattern: ^(https:\/\/)(.*?)(\/open-insurance\/insurance-person\/v\d+)(\/insurance-person.*)?$ example: "https://api.organizacao.com.br/open-insurance/insurance-person/v1/insurance-person" prev: type: string description: URL da página anterior de registros pattern: ^(https:\/\/)(.*?)(\/open-insurance\/insurance-person\/v\d+)(\/insurance-person.*)?$ example: "https://api.organizacao.com.br/open-insurance/insurance-person/v1/insurance-person" next: type: string description: URL da próxima página de registros pattern: ^(https:\/\/)(.*?)(\/open-insurance\/insurance-person\/v\d+)(\/insurance-person.*)?$ example: "https://api.organizacao.com.br/open-insurance/insurance-person/v1/insurance-person" last: type: string description: URL da última página de registros pattern: ^(https:\/\/)(.*?)(\/open-insurance\/insurance-person\/v\d+)(\/insurance-person.*)?$ example: "https://api.organizacao.com.br/open-insurance/insurance-person/v1/insurance-person" 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 - requestDateTime properties: code: description: Código de erro específico do endpoint type: string pattern: '[\w\W\s]*' maxLength: 255 title: description: Título legível por humanos deste erro específico type: string maxLength: 255 detail: description: Descrição legível por humanos deste erro específico type: string maxLength: 2048 requestDateTime: description: "Data e hora da consulta, conforme especificação RFC-3339, formato UTC." type: string maxLength: 2048 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.' parameters: policyId: name: policyId 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 securitySchemes: OpenId: type: openIdConnect openIdConnectUrl: "https://auth.mockbank.poc.raidiam.io/.well-known/openid-configuration" OAuth2Security: type: oauth2 description: Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados. flows: authorizationCode: authorizationUrl: "https://authserver.example/authorization" tokenUrl: "https://authserver.example/token" scopes: insurance-person: Escopo necessário para acesso à API. O controle dos endpoints específicos é feito via permissions. responses: OKResponseInsurancePerson: description: Dados de ResponseInsurancePerson obtidos com sucesso headers: x-fapi-interaction-id: schema: $ref: "#/components/schemas/XFapiInteractionId" content: application/json: schema: $ref: "#/components/schemas/ResponseInsurancePerson" OKResponseInsurancePersonPolicyInfo: description: Dados de ResponseInsurancePersonPolicyInfo obtidos com sucesso headers: x-fapi-interaction-id: schema: $ref: "#/components/schemas/XFapiInteractionId" content: application/json: schema: $ref: "#/components/schemas/ResponseInsurancePersonPolicyInfo" OKResponseInsurancePersonClaims: description: Dados de ResponseInsurancePersonClaims obtidos com sucesso headers: x-fapi-interaction-id: schema: $ref: "#/components/schemas/XFapiInteractionId" content: application/json: schema: $ref: "#/components/schemas/ResponseInsurancePersonClaims" OKResponseInsurancePersonPremium: description: Dados de ResponseInsurancePersonPremium obtidos com sucesso headers: x-fapi-interaction-id: schema: $ref: "#/components/schemas/XFapiInteractionId" content: application/json: schema: $ref: "#/components/schemas/ResponseInsurancePersonPremium" 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 presente." content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/ResponseError" NoContent: description: "O recurso solicitado não existe ou não foi localizado." content: application/json; charset=utf-8: schema: $ref: "#/components/schemas/ResponseError" 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"