From 6066e94f82a0c68b4ea55849ef4b091b9e789d8a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andr=C3=A9=20Ferreira=20Trindade?=
<101213393+andretrindade@users.noreply.github.com>
Date: Tue, 9 May 2023 11:00:08 -0300
Subject: [PATCH 01/50] Create 1.0.0.yml
---
swagger-apis/capitalization-bonds/1.0.0.yml | 813 ++++++++++++++++++++
1 file changed, 813 insertions(+)
create mode 100644 swagger-apis/capitalization-bonds/1.0.0.yml
diff --git a/swagger-apis/capitalization-bonds/1.0.0.yml b/swagger-apis/capitalization-bonds/1.0.0.yml
new file mode 100644
index 000000000..f2c20db09
--- /dev/null
+++ b/swagger-apis/capitalization-bonds/1.0.0.yml
@@ -0,0 +1,813 @@
+openapi: 3.0.0
+info:
+ title: API Capitalization-bonds - Open Finance Brasil
+ description: |
+ As APIs descritas neste documento é referente a API de Capitalização da fase OpenInsurance do Open Finance Brasil.
+ version: 1.0.0-rc2.0
+ license:
+ name: Apache 2.0
+ url: 'https://www.apache.org/licenses/LICENSE-2.0'
+ contact:
+ name: Governança do Open Finance Brasil – Especificações
+ email: gt-interfaces@openbankingbr.org
+ url: 'https://openbanking-brasil.github.io/areadesenvolvedor/'
+servers:
+ - url: 'https://api.banco.com.br/open-banking/opendata-capitalization/v1'
+ description: Servidor de Produção
+ - url: 'https://apih.banco.com.br/open-banking/opendata-capitalization/v1'
+ description: Servidor de Homologação
+tags:
+ - name: Capitalization Bonds
+ description: Operações para consulta das informações de Titulos de Capitalização
+paths:
+ /bonds:
+ get:
+ tags:
+ - Capitalization Bonds
+ summary: Conjunto de informações dos Títulos de Capitalização de uma instituição
+ operationId: capitalizationBondsGetProducts
+ description: Método para obter a lista de todos os títulos de Capitalização de uma instituição
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/pageSize'
+ responses:
+ '200':
+ $ref: '#/components/responses/OKResponseCapitalizationBondsProductsList'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '405':
+ $ref: '#/components/responses/MethodNotAllowed'
+ '429':
+ $ref: '#/components/responses/TooManyRequests'
+ '500':
+ $ref: '#/components/responses/InternalServerError'
+ '529':
+ $ref: '#/components/responses/SiteIsOverloaded'
+components:
+ schemas:
+ CapitalizationBondsProductIdentificationData:
+ type: object
+ required:
+ - participant
+ - society
+ - name
+ - code
+ - modality
+ - costType
+ - termsAndConditions
+ - quotas
+ - capitalizationPeriod
+ - latePayment
+ - contributionPayment
+ - finalRedemptionRate
+ - redemptionPercentageEndTerm
+ - draws
+ - additionalInfo
+ - targetAudience
+ properties:
+ participant:
+ $ref: '#/components/schemas/Participant'
+ society:
+ type: object
+ description: Conjunto de informações relativas à seguradora do produto de open insurance
+ required:
+ - name
+ - cnpjNumber
+ properties:
+ name:
+ type: string
+ description: Nome da Sociedade Seguradora.
+ maxLength: 80
+ example: Society A1
+ cnpjNumber:
+ $ref: '#/components/schemas/Participant/properties/cnpjNumber'
+ additionalProperties: false
+ name:
+ type: string
+ description: 'Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.'
+ maxLength: 80
+ example: ACMEcap
+ code:
+ type: string
+ description: Código único a ser definido pela sociedade.
+ maxLength: 100
+ example: 01234589_cap
+ modality:
+ $ref: '#/components/schemas/EnumCapitalizationBondsProductModality'
+ costType:
+ $ref: '#/components/schemas/EnumCapitalizationBondsProductCostType'
+ termsAndConditions:
+ $ref: '#/components/schemas/TermsAndConditions'
+ quotas:
+ type: array
+ description: Informações relativas às taxas da Quotas praticadas para cada Parcela
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/CapitalizationBondsProductQuota'
+ validity:
+ type: integer
+ format: int32
+ description: Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.
+ maxLength: 3
+ example: 48
+ serieSize:
+ type: integer
+ description: 'Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.'
+ maxLength: 10
+ example: 5000000
+ capitalizationPeriod:
+ $ref: '#/components/schemas/CapitalizationBondsProductCapitalizationPeriod'
+ latePayment:
+ $ref: '#/components/schemas/LatePayment'
+ contributionPayment:
+ $ref: '#/components/schemas/ContributionPayment'
+ redemptionPercentageEndTerm:
+ type: string
+ description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}$'
+ example: '0.019800'
+ finalRedemptionRate:
+ type: string
+ description: Valor percentual (%) de resgate final permitido.
+ pattern: '^\d{1}\.\d{6}$'
+ maxLength: 8
+ minLength: 8
+ example: '0.019800'
+ draws:
+ type: array
+ description: Informações relativas aos Sorteios
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/CapitalizationBondsProductPrizeDraw'
+ additionalInfo:
+ type: string
+ description: 'Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.'
+ maxLength: 1024
+ example: 'https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais'
+ minimumRequirementDetails:
+ type: string
+ description: |
+ Campo aberto (possibilidade de incluir URL).
+ Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
+ tamanho. p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.’
+ maxLength: 1024
+ example: 'https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais'
+ targetAudience:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. Ambas (Pessoa Natural e Jurídica)
+ maxLength: 23
+ enum:
+ - PESSOA_NATURAL
+ - PESSOA_JURIDICA
+ - PESSOA_NATURAL_JURIDICA
+ example: PESSOA_NATURAL
+ additionalProperties: false
+ Participant:
+ type: object
+ description: Conjunto de informações relativas ao participante do produto de Open Finance
+ required:
+ - brand
+ - name
+ - cnpjNumber
+ properties:
+ brand:
+ type: string
+ description: 'Nome da marca reportada pelo participante do Open Finance. 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.'
+ maxLength: 80
+ example: Organização
+ name:
+ type: string
+ description: Nome do participante do Open Finance.
+ maxLength: 80
+ example: Organização A1
+ cnpjNumber:
+ type: string
+ description: '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.'
+ pattern: '^\d{14}$'
+ example: '13456789000112'
+ urlComplementaryList:
+ type: string
+ description: |
+ Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
+
+ - ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
+
+ - 'cnpjNumber' com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
+
+ - Ambos do tipo string;
+
+ - Ambos obrigatórios.
+ maxLength: 1024
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ example: 'https://empresaa1.com/companies'
+ additionalProperties: false
+ EnumCapitalizationBondsProductModality:
+ type: string
+ description: |
+ 1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
+ 2. Instrumento de Garantia: A modalidade tem por objetivo propiciar que a provisão matemática para capitalização do título de capitalização seja utilizada para assegurar o cumprimento de obrigação assumida em contrato principal pelo titular perante terceiro. (Res CNSP 384/20)
+ 3. Compra Programada: A modalidade compra programada garante o valor de resgate em moeda corrente nacional, sendo disponibilizada ao assim desejar e sem qualquer outro custo, pelo recebimento do bem e/ou serviço referenciado no subsidiado por acordos comerciais celebrados com indústrias, atacadistas, empresas comerciais ou prestadores de serviço. (Res CNSP 384/20)
+ 4. Popular: A modalidade popular tem por objetivo propiciar a capitalização da contribuição e a participação do titular em sorteios, sem que haja devolução integral do valor pago. (Res CNSP 384/20)
+ 5. Incentivo: A modalidade incentivo tem por objetivo a vinculação a um evento promocional de caráter comercial instituído pelo subscritor para alavancar a venda de seu(s) produto(s) ou serviços ou para fidelizar seus clientes. (Res CNSP 384/20)
+ 6. Filantropia Premiável: A modalidade filantropia premiável é destinada ao subscritor interessado em contribuir com entidades beneficentes de assistências sociais, certificadas nos termos da legislação vigente, e participar de sorteio(s). (Res CNSP 384/20)
+ minLength: 7
+ maxLength: 24
+ enum:
+ - TRADICIONAL
+ - INSTRUMENTO_GARANTIA
+ - COMPRA_PROGRAMADA
+ - POPULAR
+ - INCENTIVO
+ - FILANTROPIA_PREMIAVEL
+ example: TRADICIONAL
+ EnumCapitalizationBondsProductCostType:
+ type: string
+ description: |
+ Pagamento efetuado ao subscritor à sociedade de capitalização para aquisição do título de capitalização, podendo ser única, periódica ou mensal.
+ 1. Pagamento Único
+ 2. Pagamento Mensal
+ 3. Pagamento Periódico
+ minLength: 15
+ maxLength: 19
+ enum:
+ - PAGAMENTO_UNICO
+ - PAGAMENTO_MENSAL
+ - PAGAMENTO_PERIODICO
+ example: PAGAMENTO_UNICO
+ TermsAndConditions:
+ type: object
+ required:
+ - susepProcessNumber
+ - detail
+ properties:
+ susepProcessNumber:
+ type: string
+ description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
+ minLength: 12
+ maxLength: 20
+ pattern: '^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$'
+ example: 15414.622222/2222-22
+ detail:
+ type: string
+ description: 'Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL)'
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ CapitalizationBondsProductQuota:
+ type: object
+ required:
+ - quota
+ - capitalizationQuota
+ - raffleQuota
+ - chargingQuota
+ properties:
+ quota:
+ type: number
+ format: integer
+ description: Número da parcela.
+ maxLength: 3
+ example: 10
+ capitalizationQuota:
+ type: string
+ description: Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}$'
+ example: '0.019800'
+ raffleQuota:
+ type: string
+ description: 'Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).'
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}$'
+ example: '0.019800'
+ chargingQuota:
+ type: string
+ description: 'Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).'
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}$'
+ example: '0.019800'
+ additionalProperties: false
+ CapitalizationBondsProductCapitalizationPeriod:
+ type: object
+ required:
+ - interestRate
+ - updateIndex
+ - contributionAmount
+ - earlyRedemptions
+ - redemptionPercentageEndTerm
+ - gracePeriodRedemption
+ properties:
+ interestRate:
+ type: string
+ pattern: '^\d{1}\.\d{6}$'
+ description: 'Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).'
+ maxLength: 8
+ minLength: 8
+ example: '0.019800'
+ updateIndex:
+ $ref: '#/components/schemas/CapitalizationBondsProductUpdateIndex'
+ updateIndexAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ contributionAmount:
+ type: array
+ items:
+ $ref: '#/components/schemas/CapitalizationPeriodContributionAmount'
+ minItems: 1
+ earlyRedemptions:
+ minItems: 1
+ type: array
+ items:
+ type: object
+ required:
+ - quota
+ - rate
+ properties:
+ quota:
+ type: number
+ format: integer
+ description: Parcela relativa ao Resgate Antecipado
+ maxLength: 3
+ example: 10
+ rate:
+ type: string
+ description: Taxa relativa ao Resgate Antecipado
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}$'
+ example: '0.019800'
+ additionalProperties: false
+ redemptionPercentageEndTerm:
+ type: string
+ description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}$'
+ example: '0.019800'
+ gracePeriodRedemption:
+ type: number
+ format: integer
+ description: 'Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.'
+ maxLength: 3
+ example: 48
+ additionalProperties: false
+ CapitalizationBondsProductUpdateIndex:
+ type: string
+ maxLength: 37
+ enum:
+ - IPCA
+ - IGPM
+ - INPC
+ - TR
+ - INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
+ - OUTROS
+ example: IPCA
+ description: |
+ Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
+ CapitalizationPeriodContributionAmount:
+ type: object
+ description: |
+ Corresponde ao pagamento efetuado pelo subscritor à sociedade de capitalização para a aquisição do título de capitalização, podendo ser única, periódica ou mensal (Resolução CNSP 384/20). Valores em reais (R$). Esclarecimentos adicionais SUSEP.
+ Na modalidade Tradicional, informar a faixa de valor mínimo e máximo em R$ de contribuição ao plano.
+ Para as demais modalidades, informar a lista com os valores permitidos de contribuição ao plano.
+ Em todas as situações indicar para qual periodicidade de pagamento se aplicam os valores: pagamento mensal, pagamento único ou periódico.
+ required:
+ - periodicity
+ - minimum
+ - maximum
+ - allowedValue
+ properties:
+ periodicity:
+ type: string
+ description: |
+ Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
+ 1. Único
+ 2. Diário
+ 3. Semanal
+ 4. Quinzenal
+ 5. Mensal
+ 6. Bimestral
+ 7. Trimestral
+ 8. Quadrimestral
+ 9. Semestral
+ 10. Anual
+ 11. Outros
+ maxLength: 13
+ enum:
+ - UNICO
+ - DIARIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - QUADRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - OUTROS
+ example: UNICO
+ periodicityAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ minimum:
+ type: string
+ pattern: '^\d{1,16}\.\d{2,4}$'
+ description: |
+ Condicional: Quando modalidade for igual 'TRADICIONAL'
+ Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
+ maxLength: 21
+ example: '1.2222'
+ maximum:
+ type: string
+ pattern: '^\d{1,16}\.\d{2,4}$'
+ description: |
+ Condicional: Quando modalidade for igual 'TRADICIONAL'
+ Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
+ maxLength: 21
+ example: '1.2222'
+ allowedValue:
+ type: number
+ format: double
+ description: |
+ Condicional: Quando modalidade for diferente de 'TRADICIONAL'
+ Lista com os valores permitidos de contribuição ao plano.
+ example: 5000
+ additionalProperties: false
+ LatePayment:
+ type: object
+ required:
+ - suspensionMonths
+ - periodExtensionOption
+ properties:
+ suspensionMonths:
+ type: number
+ description: 'Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).'
+ maxLength: 3
+ example: 10
+ periodExtensionOption:
+ type: boolean
+ description: |
+ Alteração do prazo de vigência original, pela suspensão (não aplicável a pagamento único). A considerar os seguintes domínios:
+ 1. true
+ 2. false
+ example: true
+ additionalProperties: false
+ ContributionPayment:
+ type: object
+ required:
+ - paymentMethod
+ - updateIndex
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/CapitalizationBondsProductPaymentMethod'
+ paymentMethodAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ updateIndex:
+ $ref: '#/components/schemas/CapitalizationBondsProductUpdateIndex'
+ updateIndexAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ additionalProperties: false
+ CapitalizationBondsProductPaymentMethod:
+ type: string
+ maxLength: 27
+ enum:
+ - CARTAO_CREDITO
+ - CARTAO_DEBITO
+ - DEBITO_CONTA_CORRENTE
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PAGAMENTO_PONTOS
+ - OUTROS
+ example: CARTAO_CREDITO
+ description: |
+ Meio de Pagamento utilizado para pagamento da contribuição. A considerar os domínios abaixo:
+ 1. Cartão de Crédito
+ 2. Cartão de Débito
+ 3. Débito em conta corrente
+ 4. Débito em conta poupança
+ 5. Boleto bancário
+ 6. PIX
+ 7. Consignação em Folha de Pagamento
+ 8. Pontos de Programas de Benefício
+ 9. Outros
+ CapitalizationBondsProductPrizeDraw:
+ type: object
+ required:
+ - timeInterval
+ - quantity
+ - prizeMultiplier
+ - earlySettlementRaffle
+ - mandatoryContemplation
+ - minimumContemplationProbability
+ properties:
+ timeInterval:
+ type: string
+ description: |
+ Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
+ - UNICO
+ - DIÁRIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - QUADRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - OUTROS
+ maxLength: 13
+ enum:
+ - UNICO
+ - DIÁRIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - QUADRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - OUTROS
+ example: UNICO
+ timeIntervalAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: '5'
+ quantity:
+ type: number
+ format: integer
+ description: Número da quantidade de sorteios previstos ao longo da vigência.
+ maxLength: 5
+ example: 10000
+ prizeMultiplier:
+ type: number
+ format: integer
+ description: 'Valor dos sorteios representado por múltiplo do valor de contribuição. Por exemplo: 5 vezes valor da contribuição'
+ maxLength: 6
+ example: 5
+ earlySettlementRaffle:
+ description: |
+ Modelo de sorteio que acarreta, ao título contemplado, o seu resgate total obrigatório (Resolução Normativa 384/20). Conforme os domínios:
+ 1. true
+ 2. false
+ type: boolean
+ example: true
+ mandatoryContemplation:
+ type: boolean
+ description: |
+ Possibilidade de realização de sorteio com previsão de que o título sorteado seja obrigatoriamente um título comercializado,
+ desde que atingidos os requisitos definidos nas condições gerais do plano. Conforme os domínios:
+ 1. true
+ 2. false
+ example: true
+ ruleDescription:
+ type: string
+ description: 'Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.'
+ maxLength: 200
+ example: Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.
+ minimumContemplationProbability:
+ type: string
+ pattern: '^\d{1}\.\d{6}$'
+ description: 'Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).'
+ maxLength: 8
+ minLength: 8
+ example: '0.019800'
+ additionalProperties: false
+ Links:
+ type: object
+ description: Referências para outros recusos da API requisitada.
+ required:
+ - self
+ properties:
+ self:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI completo que gerou a resposta atual.
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ first:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ prev:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: "URI da página anterior dessa lista de resultados. Restrição - \tObrigatório quando não for a primeira página da resposta"
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ next:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ last:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ additionalProperties: false
+ OpenDataMeta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - totalRecords
+ - totalPages
+ properties:
+ totalRecords:
+ type: integer
+ format: int32
+ description: Número total de registros no resultado
+ example: 1
+ totalPages:
+ type: integer
+ format: int32
+ description: Número total de páginas no resultado
+ example: 1
+ additionalProperties: false
+ parameters:
+ 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
+ maximum: 2147483647
+ 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
+ responses:
+ OKResponseCapitalizationBondsProductsList:
+ description: Dados de título(s) de capitalização obtidos com sucesso.
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ properties:
+ data:
+ type: array
+ description: Conjunto de informações do Título de Capitalização
+ items:
+ $ref: '#/components/schemas/CapitalizationBondsProductIdentificationData'
+ minItems: 1
+ links:
+ $ref: '#/components/schemas/Links'
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ 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/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ InternalServerError:
+ description: Ocorreu um erro no gateway da API ou no microsserviço
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ MethodNotAllowed:
+ description: O consumidor tentou acessar o recurso com um método não suportado
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ NotFound:
+ description: O recurso solicitado não existe ou não foi implementado
+ content:
+ application/json; charset=utf-8:
+ schema:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ additionalProperties: false
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ TooManyRequests:
+ description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite de requisições concorrentes foi atingido.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ SiteIsOverloaded:
+ description: 'O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ meta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - requestDateTime
+ properties:
+ requestDateTime:
+ description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.'
+ type: string
+ maxLength: 20
+ format: date-time
+ example: '2021-05-21T08:30:00Z'
From a7f5819c5b14d84b1565c6291d1769e62977809f Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 12 May 2023 10:12:15 -0300
Subject: [PATCH 02/50] feat(Pension): ORB-2580 - PC81 - Tipo string aceitar NA
---
dictionary/getPensionRiskCoverages_v1.csv | 20 +-
dictionary/getPensionSurvivalCoverages_v1.csv | 52 +-
swagger-apis/pension/1.0.0.yml | 1519 +++++++++++++++++
3 files changed, 1555 insertions(+), 36 deletions(-)
create mode 100644 swagger-apis/pension/1.0.0.yml
diff --git a/dictionary/getPensionRiskCoverages_v1.csv b/dictionary/getPensionRiskCoverages_v1.csv
index 2ae496c51..719c3656c 100644
--- a/dictionary/getPensionRiskCoverages_v1.csv
+++ b/dictionary/getPensionRiskCoverages_v1.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -13,10 +13,10 @@
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
@@ -45,11 +45,11 @@ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a
";Lista;100;Opcional;;;0;N;"";Não permitido;array;;
/data/coverages/attributes;attributes;Atributos da cobertura;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})|(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})|(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/indemnifiablePeriod;indemnifiablePeriod;"Listagem do pagamento para cada benefício:
1. Quantidade determinada de parcelas;
2. Até o fim de ciclo determinado.
@@ -144,10 +144,10 @@ SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
OUTROS
NAO_HA";0;1;"";Não permitido;string;SORTEIO;
/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
IGP_M
INPC";0;N;"";Não permitido;array;IPCA;
@@ -171,7 +171,7 @@ CAPITALIZACAO";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
-/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para resgate:
diff --git a/dictionary/getPensionSurvivalCoverages_v1.csv b/dictionary/getPensionSurvivalCoverages_v1.csv
index 8beab0b65..84f9b474e 100644
--- a/dictionary/getPensionSurvivalCoverages_v1.csv
+++ b/dictionary/getPensionSurvivalCoverages_v1.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -13,10 +13,10 @@
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;"Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;"Código único a ser definido pela sociedade.
@@ -32,7 +32,7 @@ PREVIDENCIA";1;1;"";Não permitido;string;PREVIDENCIA;
BENEFICIO_DEFINIDO";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/termsAndConditions;termsAndConditions;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/type;type;"1. PGBL
2. PRGP
@@ -61,7 +61,7 @@ VRI
VDR
DEMAIS_PRODUTOS_PREVIDENCIA";0;1;"";Não permitido;string;;
/data/defferalPeriod;defferalPeriod;Período de Diferimento;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
2. IGP-M (FGV);
@@ -71,9 +71,9 @@ IGP_M
INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
/data/defferalPeriod/otherMinimumPerformanceGarantees;otherMinimumPerformanceGarantees;Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.;Texto;12;Obrigatório;;;1;1;"";Não permitido;string;SELIC;
-/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/minimumPremiums;minimumPremiums;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^[A-Z]{3}$;;0;1;"";Não permitido;string;BRL;
+/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
/data/defferalPeriod/minimumPremiums/periodicity;periodicity;;Texto;10;Opcional;;"DIARIO
SEMANAL
QUINZENAL
@@ -83,7 +83,7 @@ TRIMESTRAL
SEMESTRAL
ANUAL
UNICO";0;1;"";Não permitido;string;MENSAL;
-/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;250.00;
+/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;250.00;
/data/defferalPeriod/premiumPaymentMethods;premiumPaymentMethods;;Lista;27;Opcional;;"CARTAO_CREDITO
DEBITO_CONTA
DEBITO_CONTA_POUPANCA
@@ -113,13 +113,13 @@ OUTROS";0;N;"";Não permitido;array;CARTAO_CREDITO;
/data/defferalPeriod/redemptionPaymentTerm;redemptionPaymentTerm;Prazo em dias para pagamento do resgate;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/defferalPeriod/portabilityPaymentTerm;portabilityPaymentTerm;Prazo em dias para pagamento da portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;20;
/data/defferalPeriod/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/defferalPeriod/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Nome Fantasia
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
/data/defferalPeriod/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
-";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+";Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
@@ -127,17 +127,17 @@ INDIRETAMENTE
NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/defferalPeriod/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
-";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.019800;8
+";Texto;8;Opcional;^(\d{1}\.\d{6})|(NA)$;;0;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Regra de Elegibilidade
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/defferalPeriod/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo de Contribuição
-";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
/data/defferalPeriod/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
-";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
-/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^[A-Z]{3}$;;0;1;"";Não permitido;string;BRL;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
/data/grantPeriodBenefit;grantPeriodBenefit;Período de concessão do benefício;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/grantPeriodBenefit/incomeModalities;incomeModalities;;Lista;;Obrigatório;;"PAGAMENTO_UNICO
RENDA_PRAZO_CERTO
@@ -165,7 +165,7 @@ AT_83_MALE_FEMALE
BR_EMSSB_MALE
BR_EMSSB_FEMALE
BR_EMSSB_MALE_FEMALE";0;N;"";Não permitido;array;AT_2000_MALE;
-/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
2. IGP-M (FGV);
@@ -174,15 +174,15 @@ BR_EMSSB_MALE_FEMALE";0;N;"";Não permitido;array;AT_2000_MALE;
IGP_M
INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
-/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/grantPeriodBenefit/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Nome Fantasia
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
/data/grantPeriodBenefit/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
-";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+";Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
@@ -190,24 +190,24 @@ INDIRETAMENTE
NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/grantPeriodBenefit/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
-";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.019800;8
+";Texto;8;Opcional;^(\d{1}\.\d{6})|(NA)$;;0;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Regra de Elegibilidade
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/grantPeriodBenefit/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo de Contribuição
-";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
/data/grantPeriodBenefit/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
-";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
-/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^[A-Z]{3}$;;0;1;"";Não permitido;string;BRL;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
/data/costs;costs;Custos;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/costs/loadingAntecipated;loadingAntecipated;Carregamento antecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/costs/loadingLate;loadingLate;Carregamento postecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
1. Coletivo Averbado;
diff --git a/swagger-apis/pension/1.0.0.yml b/swagger-apis/pension/1.0.0.yml
new file mode 100644
index 000000000..1353c1f50
--- /dev/null
+++ b/swagger-apis/pension/1.0.0.yml
@@ -0,0 +1,1519 @@
+openapi: 3.0.0
+info:
+ title: API Pension - Open Finance Brasil
+ description: |
+ API de Previdência do Open Finance Brasil – Fase 4.
+ API que retorna informações de Previdência.
+ version: 1.0.0
+ license:
+ name: Apache 2.0
+ url: 'https://www.apache.org/licenses/LICENSE-2.0'
+ contact:
+ name: Governança do Open Finance Brasil – Especificações
+ email: gt-interfaces@openbankingbr.org
+ url: 'https://openbanking-brasil.github.io/areadesenvolvedor/'
+servers:
+ - url: 'https://api.banco.com.br/open-banking/opendata-pension/v1'
+ description: Servidor de Produção
+ - url: 'https://apih.banco.com.br/open-banking/opendata-pension/v1'
+ description: Servidor de Homologação
+tags:
+ - name: Risk Coverages
+ description: Operações relacionadas à Previdência com Coberturas de Risco.
+ - name: Survival Coverages
+ description: Operações relacionadas à Previdência com Coberturas de Sobrevivência.
+paths:
+ /risk-coverages:
+ get:
+ tags:
+ - Risk Coverages
+ summary: Informações de Previdência com Cobertura de Riscos.
+ operationId: getPensionRiskCoverages
+ description: Método para obter informações de Previdência de Cobertura de Riscos.
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/pageSize'
+ responses:
+ '200':
+ $ref: '#/components/responses/OKResponseRiskCoveragePension'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '405':
+ $ref: '#/components/responses/MethodNotAllowed'
+ '429':
+ $ref: '#/components/responses/TooManyRequests'
+ '500':
+ $ref: '#/components/responses/InternalServerError'
+ '529':
+ $ref: '#/components/responses/SiteIsOverloaded'
+ /survival-coverages:
+ get:
+ tags:
+ - Survival Coverages
+ summary: Informações de Previdência com Cobertura de Sobrevivência.
+ operationId: getPensionSurvivalCoverages
+ description: Método para obter informações de Previdência de Cobertura de Sobrevivência.
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/pageSize'
+ responses:
+ '200':
+ $ref: '#/components/responses/OKResponseSurvivorCoveragePension'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '405':
+ $ref: '#/components/responses/MethodNotAllowed'
+ '429':
+ $ref: '#/components/responses/TooManyRequests'
+ '500':
+ $ref: '#/components/responses/InternalServerError'
+ '529':
+ $ref: '#/components/responses/SiteIsOverloaded'
+components:
+ schemas:
+ OKResponseRiskCoveragePension:
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/GetRiskPensionContractData'
+ links:
+ $ref: '#/components/schemas/Links'
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ GetRiskPensionContractData:
+ type: object
+ required:
+ - participant
+ - society
+ - name
+ - code
+ - modality
+ - coverages
+ - termsAndConditions
+ - premiumUpdateIndex
+ - otherGuaranteedValues
+ - contributionPayment
+ - minimumRequirement
+ - targetAudience
+ properties:
+ participant:
+ $ref: '#/components/schemas/PensionParticipant'
+ society:
+ $ref: '#/components/schemas/PensionSociety'
+ name:
+ type: string
+ maxLength: 80
+ description: 'Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.'
+ example: Produto A
+ code:
+ type: string
+ maxLength: 80
+ description: Código único a ser definido pela sociedade.
+ example: '0001'
+ modality:
+ $ref: '#/components/schemas/EnumProductModality'
+ coverages:
+ type: array
+ items:
+ $ref: '#/components/schemas/Coverage'
+ assistanceTypes:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumAssistanceType'
+ example:
+ - PET
+ - FUNERAL
+ assistanceTypesAdditionalInfos:
+ type: array
+ items:
+ type: string
+ description: Lista a ser preenchida pelas participantes quando houver 'Outros' no campo 'Tipo de Assistência'.
+ example:
+ - Assistance additional info.
+ additional:
+ $ref: '#/components/schemas/EnumAdditional'
+ termsAndConditions:
+ type: array
+ items:
+ $ref: '#/components/schemas/TermsAndConditions'
+ minItems: 1
+ pmbacRemuneration:
+ $ref: '#/components/schemas/RiskPensionEnumPmbacRemuneration'
+ premiumUpdateIndex:
+ $ref: '#/components/schemas/RiskPensionEnumPremiumUpdateIndex'
+ ageAdjustment:
+ $ref: '#/components/schemas/AgeAdjustment'
+ financialRegimeContractType:
+ $ref: '#/components/schemas/RiskPensionEnumFinancialRegime'
+ reclaim:
+ $ref: '#/components/schemas/RiskPensionReclaim'
+ otherGuaranteedValues:
+ $ref: '#/components/schemas/RiskPensionEnumOtherGuaranteedValues'
+ contributionPayment:
+ $ref: '#/components/schemas/RiskPensionEnumContributionPayment'
+ minimumRequirement:
+ $ref: '#/components/schemas/RiskPensionMinimumRequirement'
+ targetAudience:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. Ambas (Pessoa Natural e Jurídica)
+ maxLength: 23
+ enum:
+ - PESSOA_NATURAL
+ - PESSOA_JURIDICA
+ - PESSOA_NATURAL_JURIDICA
+ example: PESSOA_NATURAL
+ additionalProperties: false
+ OKResponseSurvivalCoveragePension:
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/GetSurvivalPensionContractData'
+ links:
+ $ref: '#/components/schemas/Links'
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ GetSurvivalPensionContractData:
+ type: object
+ required:
+ - participant
+ - name
+ - code
+ - segment
+ - modality
+ - defferalPeriod
+ - grantPeriodBenefit
+ - costs
+ - targetAudience
+ properties:
+ participant:
+ $ref: '#/components/schemas/PensionParticipant'
+ society:
+ $ref: '#/components/schemas/PensionSociety'
+ name:
+ type: string
+ maxLength: 80
+ description: |
+ Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
+ example: Produto A
+ code:
+ type: string
+ maxLength: 80
+ description: |
+ Código único a ser definido pela sociedade.
+ example: '0001'
+ segment:
+ type: string
+ description: |
+ Segmento do qual se trata o produto contratado
+ 1. Seguro de Pessoas
+ 2. Previdência
+ maxLength: 20
+ enum:
+ - SEGURO_PESSOAS
+ - PREVIDENCIA
+ example: PREVIDENCIA
+ modality:
+ type: string
+ description: |
+ 1. Contribuição Variável;
+ 2. Benefício Definido.
+ maxLength: 21
+ enum:
+ - CONTRIBUICAO_VARIAVEL
+ - BENEFICIO_DEFINIDO
+ example: BENEFICIO_DEFINIDO
+ additionalInfo:
+ type: string
+ description: Campo aberto (possibilidade de incluir URL)
+ example: 'https://openinsurance.com.br/aaa'
+ maxLength: 1024
+ termsAndConditions:
+ type: array
+ items:
+ $ref: '#/components/schemas/TermsAndConditions'
+ minItems: 1
+ type:
+ $ref: '#/components/schemas/SurvivalPensionType'
+ defferalPeriod:
+ $ref: '#/components/schemas/SurvivalPensionDefferalPeriod'
+ grantPeriodBenefit:
+ $ref: '#/components/schemas/SurvivalPensionGrantPeriodBenefit'
+ costs:
+ $ref: '#/components/schemas/SurvivalPensionCosts'
+ minimumRequirement:
+ $ref: '#/components/schemas/SurvivalPensionMinimumRequirements'
+ targetAudience:
+ $ref: '#/components/schemas/SurvivalPensionEnumTargetAudience'
+ additionalProperties: false
+ SurvivalPensionInvestmentFund:
+ type: object
+ description: Fundos de Investimento (por fundo).
+ required:
+ - cnpjNumber
+ - name
+ - maximumAdministrationFee
+ - typePerformanceFee
+ properties:
+ cnpjNumber:
+ $ref: '#/components/schemas/CnpjNumber'
+ name:
+ type: string
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Nome Fantasia
+ maxLength: 80
+ example: EMPRESAAPREV
+ maximumAdministrationFee:
+ type: string
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Taxa Máxima de Administração - em %
+ example: '0.019800'
+ maxLength: 8
+ minLength: 8
+ typePerformanceFee:
+ type: string
+ enum:
+ - DIRETAMENTE
+ - INDIRETAMENTE
+ - NAO_APLICA
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Tipo de taxa de performance
+ example: DIRETAMENTE
+ maxLength: 13
+ maximumPerformanceFee:
+ type: string
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Taxa Máxima de Performance - em %
+ maxLength: 8
+ minLength: 8
+ example: '0.019800'
+ eligibilityRule:
+ type: boolean
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Regra de Elegibilidade
+ example: true
+ minimumContributionAmount:
+ type: string
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Valor Mínimo de Contribuição
+ pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ example: '1000.00'
+ maxLength: 21
+ minimumMathematicalProvisionAmount:
+ type: string
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Valor Mínimo do Saldo Provisão matemática
+ pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ example: '1000.00'
+ maxLength: 21
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ SurvivalPensionMinimumRequirements:
+ type: object
+ required:
+ - contractType
+ - participantQualified
+ - contractingMinRequirement
+ properties:
+ contractType:
+ type: string
+ maxLength: 27
+ enum:
+ - COLETIVO_AVERBADO
+ - COLETIVO_INSTITUIDO
+ - INDIVIDUAL
+ description: |
+ O tipo de serviço contratado. A considerar os domínios abaixo:
+ 1. Coletivo Averbado;
+ 2. Coletivo instituído;
+ 3. Individual.
+ example: COLETIVO_AVERBADO
+ participantQualified:
+ type: boolean
+ description: |
+ Indicação se o plano é destinado para participante qualificado. A considerar os domínios abaixo:
+ 1. true
+ 2. false
+ example: true
+ contractingMinRequirement:
+ type: string
+ maxLength: 1024
+ description: Campo aberto (possibilidade de incluir URL)
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ CnpjNumber:
+ type: string
+ description: '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.'
+ pattern: '^(\d{14})|(NA)$'
+ example: '13456789000112'
+ SurvivalPensionDefferalPeriod:
+ type: object
+ description: Período de Diferimento
+ required:
+ - interestRate
+ - updateIndex
+ - otherMinimumPerformanceGarantees
+ - reversalFinancialResults
+ - permissionScheduledFinancialPayments
+ - redemptionPaymentTerm
+ - portabilityPaymentTerm
+ properties:
+ interestRate:
+ type: string
+ maxLength: 8
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ description: Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.
+ example: '0.019800'
+ updateIndex:
+ $ref: '#/components/schemas/UpdateIndex'
+ otherMinimumPerformanceGarantees:
+ type: string
+ description: 'Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.'
+ example: SELIC
+ maxLength: 12
+ reversalFinancialResults:
+ type: string
+ maxLength: 8
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ description: Percentual de reversão de excedente financeiro na concessão. Em %.
+ example: '0.019800'
+ minimumPremiums:
+ type: array
+ items:
+ $ref: '#/components/schemas/SurvivalPensionMinimumPremium'
+ premiumPaymentMethods:
+ type: array
+ items:
+ type: string
+ maxLength: 27
+ enum:
+ - CARTAO_CREDITO
+ - DEBITO_CONTA
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - CARTAO_DEBITO
+ - REGRA_PARCEIRO
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PONTOS_PROGRAMA_BENEFICIO
+ - TED_DOC
+ - OUTROS
+ example: CARTAO_CREDITO
+ permissionExtraordinaryContributions:
+ description: |
+ Se ficam permitidos aportes extraordinários. A considerar os seguintes domínios:
+ 1. true
+ 2. false
+ type: boolean
+ example: true
+ permissionScheduledFinancialPayments:
+ description: |
+ Se ficam permitidos pagamentos financeiros programados. A considerar os seguintes domínios:
+ 1. true
+ 2. false
+ type: boolean
+ example: true
+ gracePeriod:
+ $ref: '#/components/schemas/SurvivalPensionGracePeriod'
+ redemptionPaymentTerm:
+ type: integer
+ description: Prazo em dias para pagamento do resgate
+ maximum: 9999
+ example: 10
+ portabilityPaymentTerm:
+ type: number
+ description: Prazo em dias para pagamento da portabilidade (entre empresas diferentes).
+ example: 20
+ maximum: 9999
+ investmentFunds:
+ type: array
+ items:
+ $ref: '#/components/schemas/SurvivalPensionInvestmentFund'
+ additionalProperties: false
+ SurvivalPensionType:
+ type: string
+ description: |
+ 1. PGBL
+ 2. PRGP
+ 3. PAGP
+ 4. PRSA
+ 5. PRI
+ 6. PDR
+ 7. VGBL
+ 8. VRGP
+ 9. VAGP
+ 10. VRSA
+ 11. VRI
+ 12. VDR
+ 13. Demais produtos de Previdência.
+ maxLength: 27
+ enum:
+ - PGBL
+ - PRGP
+ - PAGP
+ - PRSA
+ - PRI
+ - PDR
+ - VGBL
+ - VRGP
+ - VAGP
+ - VRSA
+ - VRI
+ - VDR
+ - DEMAIS_PRODUTOS_PREVIDENCIA
+ SurvivalPensionGracePeriod:
+ type: object
+ description: Prazo de carência
+ required:
+ - redemption
+ - betweenRedemptionRequests
+ - portability
+ - betweenPortabilityRequests
+ properties:
+ redemption:
+ type: number
+ description: |
+ Prazo em dias de carência para resgate Para Coletivos: Valor máximo da carência.
+ example: 100
+ maximum: 9999
+ betweenRedemptionRequests:
+ type: number
+ description: |
+ Prazo em dias de carência entre pedidos de resgate Para Coletivos: Valor máximo da carência
+ example: 30
+ maximum: 9999
+ portability:
+ type: number
+ description: Prazo em dias de carência para portabilidade (entre empresas diferentes).
+ example: 12
+ maximum: 9999
+ betweenPortabilityRequests:
+ type: number
+ description: Prazo em dias de carência entre pedidos de portabilidade (entre empresas diferentes).
+ example: 15
+ maximum: 9999
+ additionalProperties: false
+ SurvivalPensionCosts:
+ type: object
+ description: Custos
+ required:
+ - loadingAntecipated
+ - loadingLate
+ properties:
+ loadingAntecipated:
+ $ref: '#/components/schemas/SurvivalPensionLoadingAntecipated'
+ loadingLate:
+ $ref: '#/components/schemas/SurvivalPensionLoadingLate'
+ additionalProperties: false
+ SurvivalPensionLoadingAntecipated:
+ type: object
+ description: Carregamento antecipado.
+ required:
+ - minValue
+ - maxValue
+ properties:
+ minValue:
+ type: string
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ maxLength: 8
+ minLength: 8
+ description: Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.
+ example: '0.019800'
+ maxValue:
+ type: string
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ maxLength: 8
+ minLength: 8
+ description: Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.
+ example: '0.019800'
+ additionalProperties: false
+ SurvivalPensionLoadingLate:
+ type: object
+ description: Carregamento postecipado.
+ required:
+ - minValue
+ - maxValue
+ properties:
+ minValue:
+ type: string
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ maxLength: 8
+ minLength: 8
+ description: Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.
+ example: '0.019800'
+ maxValue:
+ type: string
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ maxLength: 8
+ minLength: 8
+ description: Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.
+ example: '0.019800'
+ additionalProperties: false
+ SurvivalPensionMinimumPremium:
+ type: object
+ description: Valor mínimo de prêmio/contribuição
+ properties:
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ periodicity:
+ type: string
+ maxLength: 10
+ example: MENSAL
+ enum:
+ - DIARIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - UNICO
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ description: Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).
+ example: '250.00'
+ additionalProperties: false
+ SurvivalPensionGrantPeriodBenefit:
+ type: object
+ description: Período de concessão do benefício
+ required:
+ - incomeModalities
+ - interestRate
+ - updateIndex
+ - reversalFinancialResults
+ properties:
+ incomeModalities:
+ type: array
+ minItems: 1
+ items:
+ type: string
+ description: |
+ Modalidades de renda disponíveis para contratação.
+ A considerar os seguintes domínios:
+ 1. Pagamento Único
+ 2. Renda por Prazo Certo;
+ 3. Renda Temporária;
+ 4. Renda Temporária Reversível;
+ 5. Renda Temporária com mínimo garantido;
+ 6. Renda Temporária Reversível com Mínimo Garantido;
+ 7. Renda Vitalícia;
+ 8. Renda Vitalícia Reversível ao Beneficiário Indicado
+ 9. Renda Vitalícia Reversível ao Cônjuge com Continuidade de Menores
+ 10. Renda Vitalícia com o Mínimo Garantido;
+ 11. Renda Vitalícia com Prazo mínimo garantido.
+ enum:
+ - PAGAMENTO_UNICO
+ - RENDA_PRAZO_CERTO
+ - RENDA_TEMPORARIA
+ - RENDA_TEMPORARIA_REVERSIVEL
+ - RENDA_TEMPORARIA_MINMO_GARANTIDO
+ - RENDA_TEMPORARIA_REVERSIVEL_MININO_GARANTIDO
+ - RENDA_VITALICIA
+ - RENDA_VITALICIA_REVERSIVEL_BENEFICIARIO_INDICADO
+ - RENDA_VITALICIA_CONJUGE_CONTINUIDADE_MENORES
+ - RENDA_VITALICIA_MINIMO_GARANTIDO
+ - RENDA_VITALICIA_PRAZO_MINIMO_GRANTIDO
+ example: PAGAMENTO_UNICO
+ biometricTable:
+ type: array
+ minItems: 0
+ items:
+ type: string
+ maxLength: 32
+ description: |
+ Tábua biométrica utilizada como parâmetro para conversão em renda atuarial que deve observar a relação discriminada de coberturas, conforme Tabela II.2 do Anexo II.
+ Deverá ser informada a tábua biométrica aplicável à modalidade de renda padrão do plano.
+ enum:
+ - AT_2000_MALE
+ - AT_2000_FEMALE
+ - AT_2000_MALE_FEMALE
+ - AT_2000_MALE_SUAVIZADA_10
+ - AT_2000_FEMALE_SUAVIZADA_10
+ - AT_2000_MALE_FEMALE_SUAVIZADA_10
+ - AT_2000_MALE_SUAVIZADA_15
+ - AT_2000_FEMALE_SUAVIZADA_15
+ - AT_2000_MALE_FEMALE_SUAVIZADA_15
+ - AT_83_MALE
+ - AT_83_FEMALE
+ - AT_83_MALE_FEMALE
+ - BR_EMSSB_MALE
+ - BR_EMSSB_FEMALE
+ - BR_EMSSB_MALE_FEMALE
+ example: AT_2000_MALE
+ interestRate:
+ type: string
+ maxLength: 8
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ description: Taxa de juros garantida utilizada para conversão em renda. Em %
+ example: '0.019800'
+ updateIndex:
+ $ref: '#/components/schemas/UpdateIndex'
+ reversalFinancialResults:
+ type: string
+ maxLength: 8
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ description: Percentual de reversão de excedente financeiro na concessão. Em %.
+ example: '0.019800'
+ investmentFunds:
+ type: array
+ items:
+ $ref: '#/components/schemas/SurvivalPensionInvestmentFund'
+ additionalProperties: false
+ Links:
+ type: object
+ description: Referências para outros recusos da API requisitada.
+ required:
+ - self
+ properties:
+ self:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI completo que gerou a resposta atual.
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ first:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ prev:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: "URI da página anterior dessa lista de resultados. Restrição - \tObrigatório quando não for a primeira página da resposta"
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ next:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ last:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ additionalProperties: false
+ PensionParticipant:
+ type: object
+ description: Conjunto de informações relativas ao participante do produto de Open Finance
+ required:
+ - brand
+ - name
+ - cnpjNumber
+ properties:
+ brand:
+ type: string
+ description: 'Nome da marca reportada pelo participante do Open Finance. 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.'
+ maxLength: 80
+ example: Organização
+ name:
+ type: string
+ description: Nome do participante do Open Finance.
+ maxLength: 80
+ example: Organização A1
+ cnpjNumber:
+ $ref: '#/components/schemas/CnpjNumber'
+ urlComplementaryList:
+ description: |
+ Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
+
+ - ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
+
+ - ‘cnpjNumber’ com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
+
+ - Ambos do tipo string;
+
+ - Ambos obrigatórios.
+ type: string
+ maxLength: 1024
+ pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ example: 'https://empresaa1.com/companies'
+ additionalProperties: false
+ PensionSociety:
+ type: object
+ description: Conjunto de informações relativas à seguradora do produto de open insurance
+ required:
+ - name
+ - cnpjNumber
+ properties:
+ name:
+ type: string
+ description: Nome da Sociedade Seguradora.
+ maxLength: 80
+ example: Society A1
+ cnpjNumber:
+ $ref: '#/components/schemas/CnpjNumber'
+ additionalProperties: false
+ RiskPensionEnumIndemnifiablePeriodType:
+ type: string
+ description: |
+ Listagem do pagamento para cada benefício:
+ 1. Quantidade determinada de parcelas;
+ 2. Até o fim de ciclo determinado.
+ Se for pagamento único, esse campo não se aplica (retorna vazio).
+ enum:
+ - QUANTIDADE_DETERMINADA_PARCELAS
+ - FIM_CICLO_DETERMINADO
+ example: QUANTIDADE_DETERMINADA_PARCELAS
+ SurvivalPensionEnumTargetAudience:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ maxLength: 23
+ enum:
+ - PESSOA_NATURAL
+ - PESSOA_JURIDICA
+ example: PESSOA_NATURAL
+ EnumProductModality:
+ type: string
+ description: - Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
+ maxLength: 33
+ enum:
+ - FUNERAL
+ - PRESTAMISTA
+ - VIAGEM
+ - EDUCACIONAL
+ - DOTAL
+ - ACIDENTES_PESSOAIS
+ - VIDA
+ - PERDA_CERTIFICADO_HABILITACAO_VOO
+ - DOENCAS_GRAVES_DOENCA_TERMINAL
+ - DESEMPREGO_PERDA_RENDA
+ - EVENTOS_ALEATORIOS
+ - PECULIO
+ - PENSAO_PRAZO_CERTO
+ - PENSAO_MENORES_21
+ - PENSAO_MENORES_24
+ - PENSAO_CONJUGE_VITALICIA
+ - PENSAO_CONJUGE_TEMPORARIA
+ example: FUNERAL
+ Coverage:
+ type: object
+ required:
+ - type
+ properties:
+ type:
+ $ref: '#/components/schemas/EnumRiskPensionCoverageType'
+ typeAdditionalInfos:
+ type: array
+ description: |
+ Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
+ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
+ items:
+ type: string
+ maxLength: 100
+ example:
+ - Detalhar os serviços
+ - benefícios
+ - outros
+ attributes:
+ $ref: '#/components/schemas/CoverageAttributes'
+ additionalProperties: false
+ EnumRiskPensionCoverageType:
+ type: string
+ description: 'É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura.'
+ maxLength: 9
+ enum:
+ - MORTE
+ - INVALIDEZ
+ - OUTROS
+ example: MORTE
+ CoverageAttributes:
+ type: object
+ description: Atributos da cobertura
+ required:
+ - minValue
+ - maxValue
+ - indemnifiableDeadline
+ - indemnityPaymentMethod
+ - gracePeriod
+ - excludedRisks
+ - excludedRisksURL
+ - profitModality
+ properties:
+ minValue:
+ $ref: '#/components/schemas/InsurancePensionMinValue'
+ maxValue:
+ $ref: '#/components/schemas/InsurancePensionMaxValue'
+ indemnifiablePeriod:
+ $ref: '#/components/schemas/RiskPensionEnumIndemnifiablePeriodType'
+ indemnifiableDeadline:
+ type: integer
+ description: Número máximo de parcelas indenizáveis. Caso seja relacionado a parcelas.
+ indemnityPaymentMethod:
+ $ref: '#/components/schemas/RiskPensionEnumIndemnityPaymentMethod'
+ gracePeriod:
+ type: object
+ description: Período de carência da cobertura
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: Informar o prazo de carência
+ example: 90
+ maximum: 9999999999
+ unit:
+ $ref: '#/components/schemas/EnumGracePeriodUnit'
+ additionalProperties: false
+ excludedRisks:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumExcludedRisks'
+ excludedRisksURL:
+ type: string
+ maxLength: 1024
+ description: Campo aberto (possibilidade de incluir URL).
+ example: 'https://openinsurance.com.br/aaa'
+ profitModality:
+ $ref: '#/components/schemas/RiskPensionEnumProfitModality'
+ additionalProperties: false
+ RiskPensionGracePeriod:
+ type: object
+ required:
+ - amount
+ - unit
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: Informar o prazo de carência
+ example: 90
+ maximum: 9999999999
+ unit:
+ $ref: '#/components/schemas/RiskPensionEnumGracePeriodUnit'
+ additionalProperties: false
+ TermsAndConditions:
+ type: object
+ required:
+ - susepProcessNumber
+ - detail
+ properties:
+ susepProcessNumber:
+ type: string
+ description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
+ minLength: 12
+ maxLength: 20
+ pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$'
+ example: 15414.622222/2222-22
+ detail:
+ type: string
+ description: 'Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL)'
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ UpdateIndex:
+ type: string
+ maxLength: 5
+ description: |
+ Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
+ 1. IPCA (IBGE);
+ 2. IGP-M (FGV);
+ 3. INPC (IBGE).
+ enum:
+ - IPCA
+ - IGP_M
+ - INPC
+ - NAO_SE_APLICA
+ example: IPCA
+ RiskPensionReclaim:
+ type: object
+ required:
+ - gracePeriod
+ properties:
+ table:
+ type: array
+ items:
+ $ref: '#/components/schemas/RiskPensionReclaimTableItem'
+ minItems: 1
+ gracePeriod:
+ $ref: '#/components/schemas/RiskPensionGracePeriod'
+ differenciatedPercentage:
+ description: Campo aberto (possibilidade de incluir URL)
+ example: |
+ https://openinsurance.com.br/aaa’
+ Obs.: Exceção de cobertura ou critério definido acima será descrito aqui na URL
+ Exemplo: Cobertura X: a partir de 25 meses = 100%
+ maxLength: 1024
+ additionalProperties: false
+ InsurancePensionMinValue:
+ type: object
+ required:
+ - amount
+ - currency
+ description: 'Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.'
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ InsurancePensionMaxValue:
+ type: object
+ required:
+ - amount
+ - currency
+ description: 'Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.'
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ RiskPensionMinimumRequirement:
+ type: object
+ required:
+ - contractType
+ - contractingMinRequirement
+ properties:
+ contractType:
+ type: string
+ description: |
+ O tipo de serviço contratado. A considerar os domínios abaixo:
+ 1. Coletivo;
+ 2. Individual.
+ enum:
+ - COLETIVO
+ - INDIVIDUAL
+ example: COLETIVO
+ contractingMinRequirement:
+ type: string
+ description: Campo aberto contendo todos os requisitos mínimos para contratação (possibilidade de incluir URL).
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ RiskPensionReclaimTableItem:
+ type: object
+ required:
+ - initialMonthRange
+ - finalMonthRange
+ - percentage
+ properties:
+ initialMonthRange:
+ type: integer
+ maxLength: 2
+ example: 1
+ finalMonthRange:
+ type: integer
+ maxLength: 2
+ example: 12
+ percentage:
+ type: string
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ maxLength: 8
+ minLength: 8
+ description: Percentual de faixa de resgate.
+ example: '0.019800'
+ additionalProperties: false
+ RiskPensionEnumPmbacRemuneration:
+ type: object
+ required:
+ - interestRate
+ properties:
+ interestRate:
+ type: string
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
+ description: Taxa de juros para capitalização da PMBaC
+ maxLength: 8
+ minLength: 8
+ example: '0.019800'
+ updateIndexes:
+ type: array
+ items:
+ type: string
+ description: |
+ Índice utilizado na atualização da PMBaC:
+ 1. IPCA (IBGE)
+ 2. IGP-M (FGV)
+ 3. INPC (IBGE)
+ enum:
+ - IPCA
+ - IGP_M
+ - INPC
+ example: IPCA
+ additionalProperties: false
+ AgeAdjustment:
+ type: object
+ required:
+ - criterias
+ - frequency
+ properties:
+ criterias:
+ type: array
+ items:
+ type: string
+ description: |
+ Critério escolhido para reenquadramento etário
+ 1. Após período em anos
+ 2. A cada período em anos
+ 3. Por mudança de faixa etária
+ 4. Não aplicável
+ maxLength: 27
+ example: APOS_PERIODO_ANOS
+ enum:
+ - APOS_PERIODO_ANOS
+ - CADA_PERIODO_ANOS
+ - MUDANCA_FAIXA_ETARIA
+ - NAO_APLICAVEL
+ frequency:
+ type: integer
+ description: 'Período em anos, caso critério de reenquadramento após ou a cada período em anos.'
+ maxLength: 3
+ example: 10
+ additionalProperties: false
+ CurrencyCode:
+ type: string
+ pattern: '^([A-Z]{3})|(NA)$'
+ maxLength: 3
+ description: 'Moeda referente ao valor monetário, seguindo o modelo ISO-4217.'
+ example: BRL
+ EnumExcludedRisks:
+ type: string
+ description: Listagem para indicar quais serão o(s) risco(s) excluído(s) aplicável(is) à(s) cobertura(s).
+ maxLength: 40
+ enum:
+ - ATO_RECONHECIMENTO_PERIGOSO
+ - ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
+ - OPERACOES_GUERRA
+ - FURACOES_CICLONES_TERREMOTOS
+ - MATERIAL_NUCLEAR
+ - DOENCAS_LESOES_PREEXISTENTES
+ - EPIDEMIAS_PANDEMIAS
+ - SUICIDIO
+ - ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
+ - OUTROS
+ example: ATO_RECONHECIMENTO_PERIGOSO
+ EnumAssistanceType:
+ type: string
+ description: 'Lista padronizada de tipo de assistências ofertadas vinculadas ao produto. Por exemplo, Funeral, Bicicleta, Assistência PET – Tabela padrão a ser consolidada com retorno das empresas com a relação de assistências, permitindo um campo ‘Outros’ para assistências não contempladas na tabela padronizada.'
+ maxLength: 43
+ enum:
+ - ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
+ - ARQUITETO_VIRTUAL
+ - ASSESSORIA_FINANCEIRA
+ - AUTOMOVEL
+ - AUXILIO_NATALIDADE
+ - AVALIACAO_CLINICA_PREVENTIVA
+ - BOLSA_PROTEGIDA
+ - CESTA_BASICA
+ - CHECKUP_ODONTOLOGICO
+ - CLUBE_VANTAGENS_BENEFICIOS
+ - CONVALESCENCIA
+ - DECESSO
+ - DESCONTO_FARMACIAS_MEDICAMENTOS
+ - DESPESAS_FARMACEUTICAS_VIAGEM
+ - DIGITAL
+ - EDUCACIONAL
+ - EMPRESARIAL
+ - ENCANADOR
+ - ENTRETENIMENTO
+ - EQUIPAMENTOS_MEDICOS
+ - FIANCAS_DESPESAS_LEGAIS
+ - FISIOTERAPIA
+ - FUNERAL
+ - HELP_LINE
+ - HOSPEDAGEM_ACOMPANHANTE
+ - INTERRUPCAO_VIAGEM
+ - INVENTARIO
+ - MAIS_VIDA
+ - MAMAE_BEBE
+ - MEDICA_ACIDENTE_DOENCA
+ - MOTOCICLETA
+ - MULHER
+ - NUTRICIONISTA
+ - ODONTOLOGICA
+ - ORIENTACAO_FITNESS
+ - ORIENTACAO_JURIDICA
+ - ORIENTACAO_NUTRICIONAL
+ - PERSONAL_FITNESS
+ - ORIENTACAO_PSICOSSOCIAL_FAMILIAR
+ - PERDA_ROUBO_CARTAO
+ - PET
+ - PRORROGACAO_ESTADIA
+ - PROTECAO_DADOS
+ - RECOLOCACAO_PROFISSIONAL
+ - REDE_DESCONTO_NUTRICIONAL
+ - RESIDENCIAL
+ - RETORNO_MENORES_SEGURADO
+ - SAQUE_COACAO
+ - SAUDE_BEM_ESTAR
+ - SEGUNDA_OPINIAO_MEDICA
+ - SENIOR
+ - SUSTENTAVEL_DESCARTE_ECOLOGICO
+ - TELEMEDICINA
+ - VIAGEM
+ - VITIMA
+ - OUTROS
+ example: ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
+ EnumAdditional:
+ type: string
+ enum:
+ - SORTEIO
+ - SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
+ - SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
+ - OUTROS
+ - NAO_HA
+ example: SORTEIO
+ EnumGracePeriodUnit:
+ type: string
+ description: Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
+ maxLength: 10
+ enum:
+ - DIAS
+ - MESES
+ - NAO_APLICA
+ example: MESES
+ RiskPensionEnumGracePeriodUnit:
+ type: string
+ description: |
+ Informar o critério de carência para resgate:
+ 1. Dias;
+ 2. Meses;
+ 3. Não se aplica.
+ enum:
+ - DIAS
+ - MESES
+ - NAO_APLICA
+ example: MESES
+ RiskPensionEnumFinancialRegime:
+ type: string
+ description: |
+ Listagem de regime financeiro para cada combinação de modalidade/cobertura do produto indicando:
+ 1. Repartição simples
+ 2. Repartição Capitais Cobertura
+ 3. Capitalização
+ example: REPARTICAO_SIMPLES
+ enum:
+ - REPARTICAO_SIMPLES
+ - REPARTICAO_CAPITAIS
+ - CAPITALIZACAO
+ RiskPensionEnumPremiumUpdateIndex:
+ type: string
+ description: Índice utilizado na atualização do prêmio/contribuição e do capital segurado/benefício
+ enum:
+ - IPCA
+ - IGPM
+ - INPC
+ example: IPCA
+ RiskPensionEnumContributionPayment:
+ type: object
+ description: Pagamento da contribuição.
+ required:
+ - contributionPaymentMethod
+ - contributionPeriodicity
+ properties:
+ contributionPaymentMethod:
+ type: string
+ example: CARTAO_CREDITO
+ description: |
+ Forma de pagamento da contribuição.
+ - CARTAO_CREDITO
+ - DEBITO_CONTA
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - TED_DOC
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PONTOS_PROGRAMA_BENEFICIO
+ - OUTROS
+ enum:
+ - CARTAO_CREDITO
+ - DEBITO_CONTA
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - TED_DOC
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PONTOS_PROGRAMA_BENEFICIO
+ - OUTROS
+ contributionPaymentMethodAdditionalInfo:
+ type: string
+ pattern: '[\w\W\s]*'
+ example: Informações adicionais
+ maxLength: 140
+ description: |
+ Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
+
+ [Restrição] Obrigatório quando 'contributionPaymentMethod' for igual 'OUTROS'.
+ contributionPeriodicity:
+ type: string
+ example: MENSAL
+ description: |
+ Periodicidade de pagamento da contribuição.
+ - MENSAL
+ - UNICA
+ - ANUAL
+ - TRIMESTRAL
+ - SEMESTRAL
+ - BIMESTRAL
+ - OUTROS
+ enum:
+ - MENSAL
+ - UNICA
+ - ANUAL
+ - TRIMESTRAL
+ - SEMESTRAL
+ - BIMESTRAL
+ - OUTROS
+ contributionPeriodicityAdditionalInfo:
+ type: string
+ pattern: '[\w\W\s]*'
+ example: Informações adicionais
+ maxLength: 140
+ description: |
+ Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
+
+ [Restrição] Obrigatório quando 'contributionPeriodicity' for igual 'OUTROS'.
+ additionalProperties: false
+ RiskPensionEnumIndemnityPaymentMethod:
+ type: string
+ description: |
+ Modalidade de pagamento da indenização, a considerar os domínios abaixo:
+ 1. Único
+ 2. Sob a forma de renda
+ enum:
+ - UNICO
+ - SOB_FORMA_RENDA
+ example: UNICO
+ RiskPensionEnumOtherGuaranteedValues:
+ type: string
+ description: |
+ 1. Saldamento
+ 2. Benefício Prolongado
+ 3. Não se aplica
+ enum:
+ - SALDAMENTO
+ - BENEFICIO_PROLONGADO
+ - NAO_APLICA
+ example: SALDAMENTO
+ RiskPensionEnumProfitModality:
+ type: string
+ description: |
+ Modalidade de pagamento da indenização.
+ enum:
+ - PAGAMENTO_UNICO
+ - FORMA_RENDA
+ example: PAGAMENTO_UNICO
+ ResponseErrorMetaSingle:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ meta:
+ $ref: '#/components/schemas/MetaOnlyRequestDateTime'
+ MetaOnlyRequestDateTime:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - requestDateTime
+ properties:
+ requestDateTime:
+ description: "Data e hora da consulta, conforme especificação RFC-3339, formato UTC."
+ type: string
+ maxLength: 20
+ format: date-time
+ example: "2021-05-21T08:30:00Z"
+ OpenDataResponseError:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ additionalProperties: false
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ OpenDataMeta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - totalRecords
+ - totalPages
+ properties:
+ totalRecords:
+ type: integer
+ format: int32
+ description: Número total de registros no resultado
+ example: 1
+ totalPages:
+ type: integer
+ format: int32
+ description: Número total de páginas no resultado
+ example: 1
+ additionalProperties: false
+ parameters:
+ 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
+ maximum: 2147483647
+ 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
+ responses:
+ OKResponseRiskCoveragePension:
+ description: Dados de previdência de risco obtidos com sucesso da instituição.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OKResponseRiskCoveragePension'
+ OKResponseSurvivorCoveragePension:
+ description: Dados de previdência de sobrevivência obtidos com sucesso da instituição.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OKResponseSurvivalCoveragePension'
+ 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/OpenDataResponseError'
+ NotFound:
+ description: O recurso solicitado não existe ou não foi implementado
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/schemas/OpenDataResponseError'
+ 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/OpenDataResponseError'
+ TooManyRequests:
+ description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite de requisições concorrentes foi atingido.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/schemas/OpenDataResponseError'
+ InternalServerError:
+ description: Ocorreu um erro no gateway da API ou no microsserviço
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/schemas/OpenDataResponseError'
+ SiteIsOverloaded:
+ description: 'O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/schemas/ResponseErrorMetaSingle'
From 6a93ec1cd32e48beb030e286a293c8e95e590fc1 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 12 May 2023 10:27:52 -0300
Subject: [PATCH 03/50] =?UTF-8?q?feat(Pension):=20ORB-2580=20-=20PC81=20-?=
=?UTF-8?q?=20Ajuste=20vers=C3=A3o?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
...entsInvestmentIdTransactionsCurrent_v1.csv | 2 +-
...InvestmentsInvestmentIdTransactions_v1.csv | 2 +-
dictionary/getPensionRiskCoverages_v1.csv | 20 +-
dictionary/getPensionRiskCoverages_vx.csv | 253 ++++++++++++++++++
dictionary/getPensionSurvivalCoverages_v1.csv | 52 ++--
dictionary/getPensionSurvivalCoverages_vx.csv | 229 ++++++++++++++++
swagger-apis/pension/{1.0.0.yml => x.x.x.yml} | 2 +-
7 files changed, 521 insertions(+), 39 deletions(-)
create mode 100644 dictionary/getPensionRiskCoverages_vx.csv
create mode 100644 dictionary/getPensionSurvivalCoverages_vx.csv
rename swagger-apis/pension/{1.0.0.yml => x.x.x.yml} (99%)
diff --git a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
index 9873069b4..8a475089e 100644
--- a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
+++ b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
@@ -1,4 +1,4 @@
-data,,,,,,,,,,,,,,,,,,links,,,,meta
+data,,,,,,,,,,,,,,,,,,links,,,,meta
type,transactionType,typeAdditionalInfo,transactionDate,transactionUnitPrice,,transactionQuantity,transactionGrossValue,,incomeTax,,financialTransactionTax,,transactionNetValue,,remunerationTransactionRate,indexerPercentage,transactionId,self,first,prev,next,requestDateTime
,,,,amount,currency,,amount,currency,amount,currency,amount,currency,amount,currency,,,,,,,,
ENTRADA,COMPRA,string,2018-02-15,1000.000004,BRL,42.25,1000.04,BRL,1000.04,BRL,1000.04,BRL,1000.04,BRL,0.300000,1.100000,ABCD2126019929279212650822221989319253344,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,2021-05-21T08:30:00Z
\ No newline at end of file
diff --git a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
index 39c5e0a48..a9f249090 100644
--- a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
+++ b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
@@ -1,4 +1,4 @@
-data,,,,,,,,,,,,,,,,,,links,,,,meta
+data,,,,,,,,,,,,,,,,,,links,,,,meta
type,transactionType,typeAdditionalInfo,transactionDate,transactionUnitPrice,,transactionQuantity,transactionGrossValue,,incomeTax,,financialTransactionTax,,transactionNetValue,,remunerationTransactionRate,indexerPercentage,transactionId,self,first,prev,next,requestDateTime
,,,,amount,currency,,amount,currency,amount,currency,amount,currency,amount,currency,,,,,,,,
ENTRADA,COMPRA,string,2018-02-15,1000.000004,BRL,42.25,1000.04,BRL,1000.04,BRL,1000.04,BRL,1000.04,BRL,0.300000,1.100000,ABCD2126019929279212650822221989319253344,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,2021-05-21T08:30:00Z
\ No newline at end of file
diff --git a/dictionary/getPensionRiskCoverages_v1.csv b/dictionary/getPensionRiskCoverages_v1.csv
index 719c3656c..2ae496c51 100644
--- a/dictionary/getPensionRiskCoverages_v1.csv
+++ b/dictionary/getPensionRiskCoverages_v1.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -13,10 +13,10 @@
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
@@ -45,11 +45,11 @@ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a
";Lista;100;Opcional;;;0;N;"";Não permitido;array;;
/data/coverages/attributes;attributes;Atributos da cobertura;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})|(NA)$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})|(NA)$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/indemnifiablePeriod;indemnifiablePeriod;"Listagem do pagamento para cada benefício:
1. Quantidade determinada de parcelas;
2. Até o fim de ciclo determinado.
@@ -144,10 +144,10 @@ SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
OUTROS
NAO_HA";0;1;"";Não permitido;string;SORTEIO;
/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
IGP_M
INPC";0;N;"";Não permitido;array;IPCA;
@@ -171,7 +171,7 @@ CAPITALIZACAO";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
-/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para resgate:
diff --git a/dictionary/getPensionRiskCoverages_vx.csv b/dictionary/getPensionRiskCoverages_vx.csv
new file mode 100644
index 000000000..719c3656c
--- /dev/null
+++ b/dictionary/getPensionRiskCoverages_vx.csv
@@ -0,0 +1,253 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
+/data;data;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
+/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
+
+- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
+
+- ‘cnpjNumber’ com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
+
+- Ambos do tipo string;
+
+- Ambos obrigatórios.
+";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
+/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
+/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
+PRESTAMISTA
+VIAGEM
+EDUCACIONAL
+DOTAL
+ACIDENTES_PESSOAIS
+VIDA
+PERDA_CERTIFICADO_HABILITACAO_VOO
+DOENCAS_GRAVES_DOENCA_TERMINAL
+DESEMPREGO_PERDA_RENDA
+EVENTOS_ALEATORIOS
+PECULIO
+PENSAO_PRAZO_CERTO
+PENSAO_MENORES_21
+PENSAO_MENORES_24
+PENSAO_CONJUGE_VITALICIA
+PENSAO_CONJUGE_TEMPORARIA";1;1;"";Não permitido;string;FUNERAL;
+/data/coverages;coverages;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/coverages/type;type;É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura.;Texto;9;Obrigatório;;"MORTE
+INVALIDEZ
+OUTROS";1;1;"";Não permitido;string;MORTE;
+/data/coverages/typeAdditionalInfos;typeAdditionalInfos;"Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
+Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
+";Lista;100;Opcional;;;0;N;"";Não permitido;array;;
+/data/coverages/attributes;attributes;Atributos da cobertura;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})|(NA)$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})|(NA)$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/indemnifiablePeriod;indemnifiablePeriod;"Listagem do pagamento para cada benefício:
+ 1. Quantidade determinada de parcelas;
+ 2. Até o fim de ciclo determinado.
+Se for pagamento único, esse campo não se aplica (retorna vazio).
+";Texto;;Opcional;;"QUANTIDADE_DETERMINADA_PARCELAS
+FIM_CICLO_DETERMINADO";0;1;"";Não permitido;string;QUANTIDADE_DETERMINADA_PARCELAS;
+/data/coverages/attributes/indemnifiableDeadline;indemnifiableDeadline;Número máximo de parcelas indenizáveis. Caso seja relacionado a parcelas.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;;
+/data/coverages/attributes/indemnityPaymentMethod;indemnityPaymentMethod;"Modalidade de pagamento da indenização, a considerar os domínios abaixo:
+ 1. Único
+ 2. Sob a forma de renda
+";Texto;;Obrigatório;;"UNICO
+SOB_FORMA_RENDA";1;1;"";Não permitido;string;UNICO;
+/data/coverages/attributes/gracePeriod;gracePeriod;Período de carência da cobertura;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/coverages/attributes/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Opcional;;;0;1;"";Não permitido;integer;90;
+/data/coverages/attributes/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Opcional;;"DIAS
+MESES
+NAO_APLICA";0;1;"";Não permitido;string;MESES;
+/data/coverages/attributes/excludedRisks;excludedRisks;;Lista;40;Obrigatório;;"ATO_RECONHECIMENTO_PERIGOSO
+ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
+OPERACOES_GUERRA
+FURACOES_CICLONES_TERREMOTOS
+MATERIAL_NUCLEAR
+DOENCAS_LESOES_PREEXISTENTES
+EPIDEMIAS_PANDEMIAS
+SUICIDIO
+ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
+OUTROS";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
+/data/coverages/attributes/excludedRisksURL;excludedRisksURL;Campo aberto (possibilidade de incluir URL).;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
+/data/coverages/attributes/profitModality;profitModality;"Modalidade de pagamento da indenização.
+";Texto;;Obrigatório;;"PAGAMENTO_UNICO
+FORMA_RENDA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;
+/data/assistanceTypes;assistanceTypes;;Lista;43;Opcional;;"ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
+ARQUITETO_VIRTUAL
+ASSESSORIA_FINANCEIRA
+AUTOMOVEL
+AUXILIO_NATALIDADE
+AVALIACAO_CLINICA_PREVENTIVA
+BOLSA_PROTEGIDA
+CESTA_BASICA
+CHECKUP_ODONTOLOGICO
+CLUBE_VANTAGENS_BENEFICIOS
+CONVALESCENCIA
+DECESSO
+DESCONTO_FARMACIAS_MEDICAMENTOS
+DESPESAS_FARMACEUTICAS_VIAGEM
+DIGITAL
+EDUCACIONAL
+EMPRESARIAL
+ENCANADOR
+ENTRETENIMENTO
+EQUIPAMENTOS_MEDICOS
+FIANCAS_DESPESAS_LEGAIS
+FISIOTERAPIA
+FUNERAL
+HELP_LINE
+HOSPEDAGEM_ACOMPANHANTE
+INTERRUPCAO_VIAGEM
+INVENTARIO
+MAIS_VIDA
+MAMAE_BEBE
+MEDICA_ACIDENTE_DOENCA
+MOTOCICLETA
+MULHER
+NUTRICIONISTA
+ODONTOLOGICA
+ORIENTACAO_FITNESS
+ORIENTACAO_JURIDICA
+ORIENTACAO_NUTRICIONAL
+PERSONAL_FITNESS
+ORIENTACAO_PSICOSSOCIAL_FAMILIAR
+PERDA_ROUBO_CARTAO
+PET
+PRORROGACAO_ESTADIA
+PROTECAO_DADOS
+RECOLOCACAO_PROFISSIONAL
+REDE_DESCONTO_NUTRICIONAL
+RESIDENCIAL
+RETORNO_MENORES_SEGURADO
+SAQUE_COACAO
+SAUDE_BEM_ESTAR
+SEGUNDA_OPINIAO_MEDICA
+SENIOR
+SUSTENTAVEL_DESCARTE_ECOLOGICO
+TELEMEDICINA
+VIAGEM
+VITIMA
+OUTROS";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
+/data/assistanceTypesAdditionalInfos;assistanceTypesAdditionalInfos;Lista a ser preenchida pelas participantes quando houver 'Outros' no campo 'Tipo de Assistência'.;Lista;;Opcional;;;0;N;"";Não permitido;array;;
+/data/additional;additional;;Texto;;Opcional;;"SORTEIO
+SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
+SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
+OUTROS
+NAO_HA";0;1;"";Não permitido;string;SORTEIO;
+/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
+/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
+IGP_M
+INPC";0;N;"";Não permitido;array;IPCA;
+/data/premiumUpdateIndex;premiumUpdateIndex;Índice utilizado na atualização do prêmio/contribuição e do capital segurado/benefício;Texto;;Obrigatório;;"IPCA
+IGPM
+INPC";1;1;"";Não permitido;string;IPCA;
+/data/ageAdjustment;ageAdjustment;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/ageAdjustment/criterias;criterias;;Lista;27;Obrigatório;;"APOS_PERIODO_ANOS
+CADA_PERIODO_ANOS
+MUDANCA_FAIXA_ETARIA
+NAO_APLICAVEL";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
+/data/ageAdjustment/frequency;frequency;Período em anos, caso critério de reenquadramento após ou a cada período em anos.;Inteiro;3;Obrigatório;;;1;1;"";Não permitido;integer;10;
+/data/financialRegimeContractType;financialRegimeContractType;"Listagem de regime financeiro para cada combinação de modalidade/cobertura do produto indicando:
+ 1. Repartição simples
+ 2. Repartição Capitais Cobertura
+ 3. Capitalização
+";Texto;;Opcional;;"REPARTICAO_SIMPLES
+REPARTICAO_CAPITAIS
+CAPITALIZACAO";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
+/data/reclaim;reclaim;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
+/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
+/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
+/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
+/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para resgate:
+1. Dias;
+2. Meses;
+3. Não se aplica.
+";Texto;;Obrigatório;;"DIAS
+MESES
+NAO_APLICA";1;1;"";Não permitido;string;MESES;
+/data/reclaim/differenciatedPercentage;differenciatedPercentage;Campo aberto (possibilidade de incluir URL);"";1024;Opcional;;;0;1;"";Não permitido;;"https://openinsurance.com.br/aaa’
+Obs.: Exceção de cobertura ou critério definido acima será descrito aqui na URL
+Exemplo: Cobertura X: a partir de 25 meses = 100%
+";
+/data/otherGuaranteedValues;otherGuaranteedValues;"1. Saldamento
+2. Benefício Prolongado
+3. Não se aplica
+";Texto;;Obrigatório;;"SALDAMENTO
+BENEFICIO_PROLONGADO
+NAO_APLICA";1;1;"";Não permitido;string;SALDAMENTO;
+/data/contributionPayment;contributionPayment;Pagamento da contribuição.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/contributionPayment/contributionPaymentMethod;contributionPaymentMethod;"Forma de pagamento da contribuição.
+ - CARTAO_CREDITO
+ - DEBITO_CONTA
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - TED_DOC
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PONTOS_PROGRAMA_BENEFICIO
+ - OUTROS
+";Texto;;Obrigatório;;"CARTAO_CREDITO
+DEBITO_CONTA
+DEBITO_CONTA_POUPANCA
+BOLETO_BANCARIO
+PIX
+TED_DOC
+CONSIGNACAO_FOLHA_PAGAMENTO
+PONTOS_PROGRAMA_BENEFICIO
+OUTROS";1;1;"";Não permitido;string;CARTAO_CREDITO;
+/data/contributionPayment/contributionPaymentMethodAdditionalInfo;contributionPaymentMethodAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
+
+[Restrição] Obrigatório quando 'contributionPaymentMethod' for igual 'OUTROS'.
+";Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando 'contributionPaymentMethod' for igual 'OUTROS'.
+";Não permitido;string;Informações adicionais;
+/data/contributionPayment/contributionPeriodicity;contributionPeriodicity;"Periodicidade de pagamento da contribuição.
+- MENSAL
+- UNICA
+- ANUAL
+- TRIMESTRAL
+- SEMESTRAL
+- BIMESTRAL
+- OUTROS
+";Texto;;Obrigatório;;"MENSAL
+UNICA
+ANUAL
+TRIMESTRAL
+SEMESTRAL
+BIMESTRAL
+OUTROS";1;1;"";Não permitido;string;MENSAL;
+/data/contributionPayment/contributionPeriodicityAdditionalInfo;contributionPeriodicityAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
+
+[Restrição] Obrigatório quando 'contributionPeriodicity' for igual 'OUTROS'.
+";Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando 'contributionPeriodicity' for igual 'OUTROS'.
+";Não permitido;string;Informações adicionais;
+/data/minimumRequirement;minimumRequirement;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
+1. Coletivo;
+2. Individual.
+";Texto;;Obrigatório;;"COLETIVO
+INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO;
+/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto contendo todos os requisitos mínimos para contratação (possibilidade de incluir URL).;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
+/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. Ambas (Pessoa Natural e Jurídica)
+";Texto;23;Obrigatório;;"PESSOA_NATURAL
+PESSOA_JURIDICA
+PESSOA_NATURAL_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/dictionary/getPensionSurvivalCoverages_v1.csv b/dictionary/getPensionSurvivalCoverages_v1.csv
index 84f9b474e..8beab0b65 100644
--- a/dictionary/getPensionSurvivalCoverages_v1.csv
+++ b/dictionary/getPensionSurvivalCoverages_v1.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -13,10 +13,10 @@
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;"Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;"Código único a ser definido pela sociedade.
@@ -32,7 +32,7 @@ PREVIDENCIA";1;1;"";Não permitido;string;PREVIDENCIA;
BENEFICIO_DEFINIDO";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/termsAndConditions;termsAndConditions;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/type;type;"1. PGBL
2. PRGP
@@ -61,7 +61,7 @@ VRI
VDR
DEMAIS_PRODUTOS_PREVIDENCIA";0;1;"";Não permitido;string;;
/data/defferalPeriod;defferalPeriod;Período de Diferimento;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
2. IGP-M (FGV);
@@ -71,9 +71,9 @@ IGP_M
INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
/data/defferalPeriod/otherMinimumPerformanceGarantees;otherMinimumPerformanceGarantees;Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.;Texto;12;Obrigatório;;;1;1;"";Não permitido;string;SELIC;
-/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/minimumPremiums;minimumPremiums;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
+/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^[A-Z]{3}$;;0;1;"";Não permitido;string;BRL;
/data/defferalPeriod/minimumPremiums/periodicity;periodicity;;Texto;10;Opcional;;"DIARIO
SEMANAL
QUINZENAL
@@ -83,7 +83,7 @@ TRIMESTRAL
SEMESTRAL
ANUAL
UNICO";0;1;"";Não permitido;string;MENSAL;
-/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;250.00;
+/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;250.00;
/data/defferalPeriod/premiumPaymentMethods;premiumPaymentMethods;;Lista;27;Opcional;;"CARTAO_CREDITO
DEBITO_CONTA
DEBITO_CONTA_POUPANCA
@@ -113,13 +113,13 @@ OUTROS";0;N;"";Não permitido;array;CARTAO_CREDITO;
/data/defferalPeriod/redemptionPaymentTerm;redemptionPaymentTerm;Prazo em dias para pagamento do resgate;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/defferalPeriod/portabilityPaymentTerm;portabilityPaymentTerm;Prazo em dias para pagamento da portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;20;
/data/defferalPeriod/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
/data/defferalPeriod/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Nome Fantasia
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
/data/defferalPeriod/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
-";Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
@@ -127,17 +127,17 @@ INDIRETAMENTE
NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/defferalPeriod/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
-";Texto;8;Opcional;^(\d{1}\.\d{6})|(NA)$;;0;1;"";Não permitido;string;0.019800;8
+";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Regra de Elegibilidade
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/defferalPeriod/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo de Contribuição
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
/data/defferalPeriod/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
-/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
+";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
+/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^[A-Z]{3}$;;0;1;"";Não permitido;string;BRL;
/data/grantPeriodBenefit;grantPeriodBenefit;Período de concessão do benefício;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/grantPeriodBenefit/incomeModalities;incomeModalities;;Lista;;Obrigatório;;"PAGAMENTO_UNICO
RENDA_PRAZO_CERTO
@@ -165,7 +165,7 @@ AT_83_MALE_FEMALE
BR_EMSSB_MALE
BR_EMSSB_FEMALE
BR_EMSSB_MALE_FEMALE";0;N;"";Não permitido;array;AT_2000_MALE;
-/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
2. IGP-M (FGV);
@@ -174,15 +174,15 @@ BR_EMSSB_MALE_FEMALE";0;N;"";Não permitido;array;AT_2000_MALE;
IGP_M
INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
-/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
/data/grantPeriodBenefit/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Nome Fantasia
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
/data/grantPeriodBenefit/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
-";Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
@@ -190,24 +190,24 @@ INDIRETAMENTE
NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/grantPeriodBenefit/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
-";Texto;8;Opcional;^(\d{1}\.\d{6})|(NA)$;;0;1;"";Não permitido;string;0.019800;8
+";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Regra de Elegibilidade
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/grantPeriodBenefit/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo de Contribuição
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
/data/grantPeriodBenefit/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
-/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
+";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
+/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^[A-Z]{3}$;;0;1;"";Não permitido;string;BRL;
/data/costs;costs;Custos;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/costs/loadingAntecipated;loadingAntecipated;Carregamento antecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
/data/costs/loadingLate;loadingLate;Carregamento postecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
1. Coletivo Averbado;
diff --git a/dictionary/getPensionSurvivalCoverages_vx.csv b/dictionary/getPensionSurvivalCoverages_vx.csv
new file mode 100644
index 000000000..84f9b474e
--- /dev/null
+++ b/dictionary/getPensionSurvivalCoverages_vx.csv
@@ -0,0 +1,229 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
+/data;data;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
+/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
+
+- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
+
+- ‘cnpjNumber’ com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
+
+- Ambos do tipo string;
+
+- Ambos obrigatórios.
+";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/name;name;"Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
+";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
+/data/code;code;"Código único a ser definido pela sociedade.
+";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
+/data/segment;segment;"Segmento do qual se trata o produto contratado
+1. Seguro de Pessoas
+2. Previdência
+";Texto;20;Obrigatório;;"SEGURO_PESSOAS
+PREVIDENCIA";1;1;"";Não permitido;string;PREVIDENCIA;
+/data/modality;modality;"1. Contribuição Variável;
+2. Benefício Definido.
+";Texto;21;Obrigatório;;"CONTRIBUICAO_VARIAVEL
+BENEFICIO_DEFINIDO";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
+/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
+/data/termsAndConditions;termsAndConditions;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
+/data/type;type;"1. PGBL
+2. PRGP
+3. PAGP
+4. PRSA
+5. PRI
+6. PDR
+7. VGBL
+8. VRGP
+9. VAGP
+10. VRSA
+11. VRI
+12. VDR
+13. Demais produtos de Previdência.
+";Texto;27;Opcional;;"PGBL
+PRGP
+PAGP
+PRSA
+PRI
+PDR
+VGBL
+VRGP
+VAGP
+VRSA
+VRI
+VDR
+DEMAIS_PRODUTOS_PREVIDENCIA";0;1;"";Não permitido;string;;
+/data/defferalPeriod;defferalPeriod;Período de Diferimento;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
+1. IPCA (IBGE);
+2. IGP-M (FGV);
+3. INPC (IBGE).
+";Texto;5;Obrigatório;;"IPCA
+IGP_M
+INPC
+NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
+/data/defferalPeriod/otherMinimumPerformanceGarantees;otherMinimumPerformanceGarantees;Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.;Texto;12;Obrigatório;;;1;1;"";Não permitido;string;SELIC;
+/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/minimumPremiums;minimumPremiums;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
+/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
+/data/defferalPeriod/minimumPremiums/periodicity;periodicity;;Texto;10;Opcional;;"DIARIO
+SEMANAL
+QUINZENAL
+MENSAL
+BIMESTRAL
+TRIMESTRAL
+SEMESTRAL
+ANUAL
+UNICO";0;1;"";Não permitido;string;MENSAL;
+/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;250.00;
+/data/defferalPeriod/premiumPaymentMethods;premiumPaymentMethods;;Lista;27;Opcional;;"CARTAO_CREDITO
+DEBITO_CONTA
+DEBITO_CONTA_POUPANCA
+BOLETO_BANCARIO
+PIX
+CARTAO_DEBITO
+REGRA_PARCEIRO
+CONSIGNACAO_FOLHA_PAGAMENTO
+PONTOS_PROGRAMA_BENEFICIO
+TED_DOC
+OUTROS";0;N;"";Não permitido;array;CARTAO_CREDITO;
+/data/defferalPeriod/permissionExtraordinaryContributions;permissionExtraordinaryContributions;"Se ficam permitidos aportes extraordinários. A considerar os seguintes domínios:
+1. true
+2. false
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
+/data/defferalPeriod/permissionScheduledFinancialPayments;permissionScheduledFinancialPayments;"Se ficam permitidos pagamentos financeiros programados. A considerar os seguintes domínios:
+1. true
+2. false
+";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+/data/defferalPeriod/gracePeriod;gracePeriod;Prazo de carência;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/defferalPeriod/gracePeriod/redemption;redemption;"Prazo em dias de carência para resgate Para Coletivos: Valor máximo da carência.
+";Número;;Obrigatório;;;1;1;"";Não permitido;number;100;
+/data/defferalPeriod/gracePeriod/betweenRedemptionRequests;betweenRedemptionRequests;"Prazo em dias de carência entre pedidos de resgate Para Coletivos: Valor máximo da carência
+";Número;;Obrigatório;;;1;1;"";Não permitido;number;30;
+/data/defferalPeriod/gracePeriod/portability;portability;Prazo em dias de carência para portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;12;
+/data/defferalPeriod/gracePeriod/betweenPortabilityRequests;betweenPortabilityRequests;Prazo em dias de carência entre pedidos de portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;15;
+/data/defferalPeriod/redemptionPaymentTerm;redemptionPaymentTerm;Prazo em dias para pagamento do resgate;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;10;
+/data/defferalPeriod/portabilityPaymentTerm;portabilityPaymentTerm;Prazo em dias para pagamento da portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;20;
+/data/defferalPeriod/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
+/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/defferalPeriod/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+- Nome Fantasia
+";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
+/data/defferalPeriod/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Taxa Máxima de Administração - em %
+";Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Tipo de taxa de performance
+";Texto;13;Obrigatório;;"DIRETAMENTE
+INDIRETAMENTE
+NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
+/data/defferalPeriod/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Taxa Máxima de Performance - em %
+";Texto;8;Opcional;^(\d{1}\.\d{6})|(NA)$;;0;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Regra de Elegibilidade
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
+/data/defferalPeriod/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Valor Mínimo de Contribuição
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+/data/defferalPeriod/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Valor Mínimo do Saldo Provisão matemática
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
+/data/grantPeriodBenefit;grantPeriodBenefit;Período de concessão do benefício;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/grantPeriodBenefit/incomeModalities;incomeModalities;;Lista;;Obrigatório;;"PAGAMENTO_UNICO
+RENDA_PRAZO_CERTO
+RENDA_TEMPORARIA
+RENDA_TEMPORARIA_REVERSIVEL
+RENDA_TEMPORARIA_MINMO_GARANTIDO
+RENDA_TEMPORARIA_REVERSIVEL_MININO_GARANTIDO
+RENDA_VITALICIA
+RENDA_VITALICIA_REVERSIVEL_BENEFICIARIO_INDICADO
+RENDA_VITALICIA_CONJUGE_CONTINUIDADE_MENORES
+RENDA_VITALICIA_MINIMO_GARANTIDO
+RENDA_VITALICIA_PRAZO_MINIMO_GRANTIDO";1;N;"";Não permitido;array;PAGAMENTO_UNICO;
+/data/grantPeriodBenefit/biometricTable;biometricTable;;Lista;32;Opcional;;"AT_2000_MALE
+AT_2000_FEMALE
+AT_2000_MALE_FEMALE
+AT_2000_MALE_SUAVIZADA_10
+AT_2000_FEMALE_SUAVIZADA_10
+AT_2000_MALE_FEMALE_SUAVIZADA_10
+AT_2000_MALE_SUAVIZADA_15
+AT_2000_FEMALE_SUAVIZADA_15
+AT_2000_MALE_FEMALE_SUAVIZADA_15
+AT_83_MALE
+AT_83_FEMALE
+AT_83_MALE_FEMALE
+BR_EMSSB_MALE
+BR_EMSSB_FEMALE
+BR_EMSSB_MALE_FEMALE";0;N;"";Não permitido;array;AT_2000_MALE;
+/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
+1. IPCA (IBGE);
+2. IGP-M (FGV);
+3. INPC (IBGE).
+";Texto;5;Obrigatório;;"IPCA
+IGP_M
+INPC
+NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
+/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
+/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/grantPeriodBenefit/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+- Nome Fantasia
+";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
+/data/grantPeriodBenefit/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Taxa Máxima de Administração - em %
+";Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Tipo de taxa de performance
+";Texto;13;Obrigatório;;"DIRETAMENTE
+INDIRETAMENTE
+NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
+/data/grantPeriodBenefit/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Taxa Máxima de Performance - em %
+";Texto;8;Opcional;^(\d{1}\.\d{6})|(NA)$;;0;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Regra de Elegibilidade
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
+/data/grantPeriodBenefit/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Valor Mínimo de Contribuição
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+/data/grantPeriodBenefit/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Valor Mínimo do Saldo Provisão matemática
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
+/data/costs;costs;Custos;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/costs/loadingAntecipated;loadingAntecipated;Carregamento antecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate;loadingLate;Carregamento postecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
+1. Coletivo Averbado;
+2. Coletivo instituído;
+3. Individual.
+";Texto;27;Obrigatório;;"COLETIVO_AVERBADO
+COLETIVO_INSTITUIDO
+INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO_AVERBADO;
+/data/minimumRequirement/participantQualified;participantQualified;"Indicação se o plano é destinado para participante qualificado. A considerar os domínios abaixo:
+1. true
+2. false
+";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
+/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+";Texto;23;Obrigatório;;"PESSOA_NATURAL
+PESSOA_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/swagger-apis/pension/1.0.0.yml b/swagger-apis/pension/x.x.x.yml
similarity index 99%
rename from swagger-apis/pension/1.0.0.yml
rename to swagger-apis/pension/x.x.x.yml
index 1353c1f50..bca130dd5 100644
--- a/swagger-apis/pension/1.0.0.yml
+++ b/swagger-apis/pension/x.x.x.yml
@@ -4,7 +4,7 @@ info:
description: |
API de Previdência do Open Finance Brasil – Fase 4.
API que retorna informações de Previdência.
- version: 1.0.0
+ version: x.x.x
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0'
From bd85f4e4cc8a512fb840db5cc89213849937110e Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 12 May 2023 10:29:06 -0300
Subject: [PATCH 04/50] feat(Pension): ORB-2580 - PC81 - Ajuste index
---
swagger-apis/pension/index.html | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/swagger-apis/pension/index.html b/swagger-apis/pension/index.html
index 2b7cf310a..bbcd82315 100644
--- a/swagger-apis/pension/index.html
+++ b/swagger-apis/pension/index.html
@@ -47,7 +47,8 @@
const ui = SwaggerUIBundle({
urls: [ {"name": "1.0.0-rc1.0", "url": "./1.0.0-rc1.0.yml"},
{"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"}],
- "urls.primaryName": "1.0.0-rc2.0", // default spec
+ {"name": "x.x.x", "url": "./x.x.x.yml"}],
+ "urls.primaryName": "x.x.x", // default spec
dom_id: '#swagger-ui',
deepLinking: true,
supportedSubmitMethods:[],
From 69805ff23c035678ea46dde93514990b2a66476b Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 12 May 2023 11:05:27 -0300
Subject: [PATCH 05/50] feat(Pension): ORB-2581 - PC81 - Tipo enum aceitar NA
---
dictionary/getPensionRiskCoverages_vx.csv | 42 ++++++++++++-------
dictionary/getPensionSurvivalCoverages_vx.csv | 33 ++++++++++-----
swagger-apis/pension/x.x.x.yml | 24 +++++++++++
3 files changed, 74 insertions(+), 25 deletions(-)
diff --git a/dictionary/getPensionRiskCoverages_vx.csv b/dictionary/getPensionRiskCoverages_vx.csv
index 719c3656c..78d9efb13 100644
--- a/dictionary/getPensionRiskCoverages_vx.csv
+++ b/dictionary/getPensionRiskCoverages_vx.csv
@@ -35,11 +35,13 @@ PENSAO_PRAZO_CERTO
PENSAO_MENORES_21
PENSAO_MENORES_24
PENSAO_CONJUGE_VITALICIA
-PENSAO_CONJUGE_TEMPORARIA";1;1;"";Não permitido;string;FUNERAL;
+PENSAO_CONJUGE_TEMPORARIA
+NA";1;1;"";Não permitido;string;FUNERAL;
/data/coverages;coverages;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/coverages/type;type;É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura.;Texto;9;Obrigatório;;"MORTE
INVALIDEZ
-OUTROS";1;1;"";Não permitido;string;MORTE;
+OUTROS
+NA";1;1;"";Não permitido;string;MORTE;
/data/coverages/typeAdditionalInfos;typeAdditionalInfos;"Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
";Lista;100;Opcional;;;0;N;"";Não permitido;array;;
@@ -55,13 +57,15 @@ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a
2. Até o fim de ciclo determinado.
Se for pagamento único, esse campo não se aplica (retorna vazio).
";Texto;;Opcional;;"QUANTIDADE_DETERMINADA_PARCELAS
-FIM_CICLO_DETERMINADO";0;1;"";Não permitido;string;QUANTIDADE_DETERMINADA_PARCELAS;
+FIM_CICLO_DETERMINADO
+NA";0;1;"";Não permitido;string;QUANTIDADE_DETERMINADA_PARCELAS;
/data/coverages/attributes/indemnifiableDeadline;indemnifiableDeadline;Número máximo de parcelas indenizáveis. Caso seja relacionado a parcelas.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;;
/data/coverages/attributes/indemnityPaymentMethod;indemnityPaymentMethod;"Modalidade de pagamento da indenização, a considerar os domínios abaixo:
1. Único
2. Sob a forma de renda
";Texto;;Obrigatório;;"UNICO
-SOB_FORMA_RENDA";1;1;"";Não permitido;string;UNICO;
+SOB_FORMA_RENDA
+NA";1;1;"";Não permitido;string;UNICO;
/data/coverages/attributes/gracePeriod;gracePeriod;Período de carência da cobertura;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/coverages/attributes/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Opcional;;;0;1;"";Não permitido;integer;90;
/data/coverages/attributes/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Opcional;;"DIAS
@@ -76,11 +80,13 @@ DOENCAS_LESOES_PREEXISTENTES
EPIDEMIAS_PANDEMIAS
SUICIDIO
ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
-OUTROS";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
+OUTROS
+NA";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
/data/coverages/attributes/excludedRisksURL;excludedRisksURL;Campo aberto (possibilidade de incluir URL).;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/coverages/attributes/profitModality;profitModality;"Modalidade de pagamento da indenização.
";Texto;;Obrigatório;;"PAGAMENTO_UNICO
-FORMA_RENDA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;
+FORMA_RENDA
+NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;
/data/assistanceTypes;assistanceTypes;;Lista;43;Opcional;;"ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
ARQUITETO_VIRTUAL
ASSESSORIA_FINANCEIRA
@@ -136,7 +142,8 @@ SUSTENTAVEL_DESCARTE_ECOLOGICO
TELEMEDICINA
VIAGEM
VITIMA
-OUTROS";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
+OUTROS
+NA";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
/data/assistanceTypesAdditionalInfos;assistanceTypesAdditionalInfos;Lista a ser preenchida pelas participantes quando houver 'Outros' no campo 'Tipo de Assistência'.;Lista;;Opcional;;;0;N;"";Não permitido;array;;
/data/additional;additional;;Texto;;Opcional;;"SORTEIO
SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
@@ -150,10 +157,12 @@ NAO_HA";0;1;"";Não permitido;string;SORTEIO;
/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
IGP_M
-INPC";0;N;"";Não permitido;array;IPCA;
+INPC
+NA";0;N;"";Não permitido;array;IPCA;
/data/premiumUpdateIndex;premiumUpdateIndex;Índice utilizado na atualização do prêmio/contribuição e do capital segurado/benefício;Texto;;Obrigatório;;"IPCA
IGPM
-INPC";1;1;"";Não permitido;string;IPCA;
+INPC
+NA";1;1;"";Não permitido;string;IPCA;
/data/ageAdjustment;ageAdjustment;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/ageAdjustment/criterias;criterias;;Lista;27;Obrigatório;;"APOS_PERIODO_ANOS
CADA_PERIODO_ANOS
@@ -166,7 +175,8 @@ NAO_APLICAVEL";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
3. Capitalização
";Texto;;Opcional;;"REPARTICAO_SIMPLES
REPARTICAO_CAPITAIS
-CAPITALIZACAO";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
+CAPITALIZACAO
+NA";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
/data/reclaim;reclaim;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
@@ -210,7 +220,8 @@ PIX
TED_DOC
CONSIGNACAO_FOLHA_PAGAMENTO
PONTOS_PROGRAMA_BENEFICIO
-OUTROS";1;1;"";Não permitido;string;CARTAO_CREDITO;
+OUTROS
+NA";1;1;"";Não permitido;string;CARTAO_CREDITO;
/data/contributionPayment/contributionPaymentMethodAdditionalInfo;contributionPaymentMethodAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
[Restrição] Obrigatório quando 'contributionPaymentMethod' for igual 'OUTROS'.
@@ -230,7 +241,8 @@ ANUAL
TRIMESTRAL
SEMESTRAL
BIMESTRAL
-OUTROS";1;1;"";Não permitido;string;MENSAL;
+OUTROS
+NA";1;1;"";Não permitido;string;MENSAL;
/data/contributionPayment/contributionPeriodicityAdditionalInfo;contributionPeriodicityAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
[Restrição] Obrigatório quando 'contributionPeriodicity' for igual 'OUTROS'.
@@ -241,7 +253,8 @@ OUTROS";1;1;"";Não permitido;string;MENSAL;
1. Coletivo;
2. Individual.
";Texto;;Obrigatório;;"COLETIVO
-INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO;
+INDIVIDUAL
+NA";1;1;"";Não permitido;string;COLETIVO;
/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto contendo todos os requisitos mínimos para contratação (possibilidade de incluir URL).;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
@@ -250,4 +263,5 @@ INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO;
3. Ambas (Pessoa Natural e Jurídica)
";Texto;23;Obrigatório;;"PESSOA_NATURAL
PESSOA_JURIDICA
-PESSOA_NATURAL_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL;
+PESSOA_NATURAL_JURIDICA
+NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/dictionary/getPensionSurvivalCoverages_vx.csv b/dictionary/getPensionSurvivalCoverages_vx.csv
index 84f9b474e..cbed4a218 100644
--- a/dictionary/getPensionSurvivalCoverages_vx.csv
+++ b/dictionary/getPensionSurvivalCoverages_vx.csv
@@ -25,11 +25,13 @@
1. Seguro de Pessoas
2. Previdência
";Texto;20;Obrigatório;;"SEGURO_PESSOAS
-PREVIDENCIA";1;1;"";Não permitido;string;PREVIDENCIA;
+PREVIDENCIA
+NA";1;1;"";Não permitido;string;PREVIDENCIA;
/data/modality;modality;"1. Contribuição Variável;
2. Benefício Definido.
";Texto;21;Obrigatório;;"CONTRIBUICAO_VARIAVEL
-BENEFICIO_DEFINIDO";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
+BENEFICIO_DEFINIDO
+NA";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/termsAndConditions;termsAndConditions;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
@@ -59,7 +61,8 @@ VAGP
VRSA
VRI
VDR
-DEMAIS_PRODUTOS_PREVIDENCIA";0;1;"";Não permitido;string;;
+DEMAIS_PRODUTOS_PREVIDENCIA
+NA";0;1;"";Não permitido;string;;
/data/defferalPeriod;defferalPeriod;Período de Diferimento;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
@@ -82,7 +85,8 @@ BIMESTRAL
TRIMESTRAL
SEMESTRAL
ANUAL
-UNICO";0;1;"";Não permitido;string;MENSAL;
+UNICO
+NA";0;1;"";Não permitido;string;MENSAL;
/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;250.00;
/data/defferalPeriod/premiumPaymentMethods;premiumPaymentMethods;;Lista;27;Opcional;;"CARTAO_CREDITO
DEBITO_CONTA
@@ -94,7 +98,8 @@ REGRA_PARCEIRO
CONSIGNACAO_FOLHA_PAGAMENTO
PONTOS_PROGRAMA_BENEFICIO
TED_DOC
-OUTROS";0;N;"";Não permitido;array;CARTAO_CREDITO;
+OUTROS
+NA";0;N;"";Não permitido;array;CARTAO_CREDITO;
/data/defferalPeriod/permissionExtraordinaryContributions;permissionExtraordinaryContributions;"Se ficam permitidos aportes extraordinários. A considerar os seguintes domínios:
1. true
2. false
@@ -124,7 +129,8 @@ OUTROS";0;N;"";Não permitido;array;CARTAO_CREDITO;
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
INDIRETAMENTE
-NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
+NAO_APLICA
+NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/defferalPeriod/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
";Texto;8;Opcional;^(\d{1}\.\d{6})|(NA)$;;0;1;"";Não permitido;string;0.019800;8
@@ -149,7 +155,8 @@ RENDA_VITALICIA
RENDA_VITALICIA_REVERSIVEL_BENEFICIARIO_INDICADO
RENDA_VITALICIA_CONJUGE_CONTINUIDADE_MENORES
RENDA_VITALICIA_MINIMO_GARANTIDO
-RENDA_VITALICIA_PRAZO_MINIMO_GRANTIDO";1;N;"";Não permitido;array;PAGAMENTO_UNICO;
+RENDA_VITALICIA_PRAZO_MINIMO_GRANTIDO
+NA";1;N;"";Não permitido;array;PAGAMENTO_UNICO;
/data/grantPeriodBenefit/biometricTable;biometricTable;;Lista;32;Opcional;;"AT_2000_MALE
AT_2000_FEMALE
AT_2000_MALE_FEMALE
@@ -164,7 +171,8 @@ AT_83_FEMALE
AT_83_MALE_FEMALE
BR_EMSSB_MALE
BR_EMSSB_FEMALE
-BR_EMSSB_MALE_FEMALE";0;N;"";Não permitido;array;AT_2000_MALE;
+BR_EMSSB_MALE_FEMALE
+NA";0;N;"";Não permitido;array;AT_2000_MALE;
/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
@@ -187,7 +195,8 @@ NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
INDIRETAMENTE
-NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
+NAO_APLICA
+NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/grantPeriodBenefit/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
";Texto;8;Opcional;^(\d{1}\.\d{6})|(NA)$;;0;1;"";Não permitido;string;0.019800;8
@@ -215,7 +224,8 @@ NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
3. Individual.
";Texto;27;Obrigatório;;"COLETIVO_AVERBADO
COLETIVO_INSTITUIDO
-INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO_AVERBADO;
+INDIVIDUAL
+NA";1;1;"";Não permitido;string;COLETIVO_AVERBADO;
/data/minimumRequirement/participantQualified;participantQualified;"Indicação se o plano é destinado para participante qualificado. A considerar os domínios abaixo:
1. true
2. false
@@ -226,4 +236,5 @@ INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO_AVERBADO;
1. Pessoa Natural
2. Pessoa Jurídica
";Texto;23;Obrigatório;;"PESSOA_NATURAL
-PESSOA_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL;
+PESSOA_JURIDICA
+NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/swagger-apis/pension/x.x.x.yml b/swagger-apis/pension/x.x.x.yml
index bca130dd5..aa484fe24 100644
--- a/swagger-apis/pension/x.x.x.yml
+++ b/swagger-apis/pension/x.x.x.yml
@@ -177,6 +177,7 @@ components:
- PESSOA_NATURAL
- PESSOA_JURIDICA
- PESSOA_NATURAL_JURIDICA
+ - NA
example: PESSOA_NATURAL
additionalProperties: false
OKResponseSurvivalCoveragePension:
@@ -234,6 +235,7 @@ components:
enum:
- SEGURO_PESSOAS
- PREVIDENCIA
+ - NA
example: PREVIDENCIA
modality:
type: string
@@ -244,6 +246,7 @@ components:
enum:
- CONTRIBUICAO_VARIAVEL
- BENEFICIO_DEFINIDO
+ - NA
example: BENEFICIO_DEFINIDO
additionalInfo:
type: string
@@ -301,6 +304,7 @@ components:
- DIRETAMENTE
- INDIRETAMENTE
- NAO_APLICA
+ - NA
description: |
Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
@@ -354,6 +358,7 @@ components:
- COLETIVO_AVERBADO
- COLETIVO_INSTITUIDO
- INDIVIDUAL
+ - NA
description: |
O tipo de serviço contratado. A considerar os domínios abaixo:
1. Coletivo Averbado;
@@ -432,6 +437,7 @@ components:
- PONTOS_PROGRAMA_BENEFICIO
- TED_DOC
- OUTROS
+ - NA
example: CARTAO_CREDITO
permissionExtraordinaryContributions:
description: |
@@ -495,6 +501,7 @@ components:
- VRI
- VDR
- DEMAIS_PRODUTOS_PREVIDENCIA
+ - NA
SurvivalPensionGracePeriod:
type: object
description: Prazo de carência
@@ -603,6 +610,7 @@ components:
- SEMESTRAL
- ANUAL
- UNICO
+ - NA
amount:
type: string
maxLength: 21
@@ -650,6 +658,7 @@ components:
- RENDA_VITALICIA_CONJUGE_CONTINUIDADE_MENORES
- RENDA_VITALICIA_MINIMO_GARANTIDO
- RENDA_VITALICIA_PRAZO_MINIMO_GRANTIDO
+ - NA
example: PAGAMENTO_UNICO
biometricTable:
type: array
@@ -676,6 +685,7 @@ components:
- BR_EMSSB_MALE
- BR_EMSSB_FEMALE
- BR_EMSSB_MALE_FEMALE
+ - NA
example: AT_2000_MALE
interestRate:
type: string
@@ -801,6 +811,7 @@ components:
enum:
- QUANTIDADE_DETERMINADA_PARCELAS
- FIM_CICLO_DETERMINADO
+ - NA
example: QUANTIDADE_DETERMINADA_PARCELAS
SurvivalPensionEnumTargetAudience:
type: string
@@ -813,6 +824,7 @@ components:
enum:
- PESSOA_NATURAL
- PESSOA_JURIDICA
+ - NA
example: PESSOA_NATURAL
EnumProductModality:
type: string
@@ -836,6 +848,7 @@ components:
- PENSAO_MENORES_24
- PENSAO_CONJUGE_VITALICIA
- PENSAO_CONJUGE_TEMPORARIA
+ - NA
example: FUNERAL
Coverage:
type: object
@@ -867,6 +880,7 @@ components:
- MORTE
- INVALIDEZ
- OUTROS
+ - NA
example: MORTE
CoverageAttributes:
type: object
@@ -1030,6 +1044,7 @@ components:
enum:
- COLETIVO
- INDIVIDUAL
+ - NA
example: COLETIVO
contractingMinRequirement:
type: string
@@ -1085,6 +1100,7 @@ components:
- IPCA
- IGP_M
- INPC
+ - NA
example: IPCA
additionalProperties: false
AgeAdjustment:
@@ -1137,6 +1153,7 @@ components:
- SUICIDIO
- ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
- OUTROS
+ - NA
example: ATO_RECONHECIMENTO_PERIGOSO
EnumAssistanceType:
type: string
@@ -1199,6 +1216,7 @@ components:
- VIAGEM
- VITIMA
- OUTROS
+ - NA
example: ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
EnumAdditional:
type: string
@@ -1242,6 +1260,7 @@ components:
- REPARTICAO_SIMPLES
- REPARTICAO_CAPITAIS
- CAPITALIZACAO
+ - NA
RiskPensionEnumPremiumUpdateIndex:
type: string
description: Índice utilizado na atualização do prêmio/contribuição e do capital segurado/benefício
@@ -1249,6 +1268,7 @@ components:
- IPCA
- IGPM
- INPC
+ - NA
example: IPCA
RiskPensionEnumContributionPayment:
type: object
@@ -1281,6 +1301,7 @@ components:
- CONSIGNACAO_FOLHA_PAGAMENTO
- PONTOS_PROGRAMA_BENEFICIO
- OUTROS
+ - NA
contributionPaymentMethodAdditionalInfo:
type: string
pattern: '[\w\W\s]*'
@@ -1310,6 +1331,7 @@ components:
- SEMESTRAL
- BIMESTRAL
- OUTROS
+ - NA
contributionPeriodicityAdditionalInfo:
type: string
pattern: '[\w\W\s]*'
@@ -1329,6 +1351,7 @@ components:
enum:
- UNICO
- SOB_FORMA_RENDA
+ - NA
example: UNICO
RiskPensionEnumOtherGuaranteedValues:
type: string
@@ -1348,6 +1371,7 @@ components:
enum:
- PAGAMENTO_UNICO
- FORMA_RENDA
+ - NA
example: PAGAMENTO_UNICO
ResponseErrorMetaSingle:
type: object
From 18310340c1b0bf19224cc00db1d4a2595382b588 Mon Sep 17 00:00:00 2001
From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com>
Date: Fri, 12 May 2023 14:12:32 +0000
Subject: [PATCH 06/50] feat(Capitalization Bonds): ORB-2575 - PC81 - Tipo
string aceitar NA
---
.../capitalizationBondsGetProducts_vx.csv | 187 ++++
swagger-apis/capitalization-bonds/index.html | 5 +-
swagger-apis/capitalization-bonds/x.x.x.yml | 813 ++++++++++++++++++
3 files changed, 1003 insertions(+), 2 deletions(-)
create mode 100644 dictionary/capitalizationBondsGetProducts_vx.csv
create mode 100644 swagger-apis/capitalization-bonds/x.x.x.yml
diff --git a/dictionary/capitalizationBondsGetProducts_vx.csv b/dictionary/capitalizationBondsGetProducts_vx.csv
new file mode 100644
index 000000000..78bda5cce
--- /dev/null
+++ b/dictionary/capitalizationBondsGetProducts_vx.csv
@@ -0,0 +1,187 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
+/data;data;Conjunto de informações do Título de Capitalização;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
+/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}|NA$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
+
+- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
+
+- 'cnpjNumber' com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
+
+- Ambos do tipo string;
+
+- Ambos obrigatórios.
+";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|NA$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}|NA$;;1;1;"";Não permitido;string;13456789000112;
+/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;ACMEcap;
+/data/code;code;Código único a ser definido pela sociedade.;Texto;100;Obrigatório;;;1;1;"";Não permitido;string;01234589_cap;
+/data/modality;modality;"1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
+2. Instrumento de Garantia: A modalidade tem por objetivo propiciar que a provisão matemática para capitalização do título de capitalização seja utilizada para assegurar o cumprimento de obrigação assumida em contrato principal pelo titular perante terceiro. (Res CNSP 384/20)
+3. Compra Programada: A modalidade compra programada garante o valor de resgate em moeda corrente nacional, sendo disponibilizada ao assim desejar e sem qualquer outro custo, pelo recebimento do bem e/ou serviço referenciado no subsidiado por acordos comerciais celebrados com indústrias, atacadistas, empresas comerciais ou prestadores de serviço. (Res CNSP 384/20)
+4. Popular: A modalidade popular tem por objetivo propiciar a capitalização da contribuição e a participação do titular em sorteios, sem que haja devolução integral do valor pago. (Res CNSP 384/20)
+5. Incentivo: A modalidade incentivo tem por objetivo a vinculação a um evento promocional de caráter comercial instituído pelo subscritor para alavancar a venda de seu(s) produto(s) ou serviços ou para fidelizar seus clientes. (Res CNSP 384/20)
+6. Filantropia Premiável: A modalidade filantropia premiável é destinada ao subscritor interessado em contribuir com entidades beneficentes de assistências sociais, certificadas nos termos da legislação vigente, e participar de sorteio(s). (Res CNSP 384/20)
+";Texto;24;Obrigatório;;"TRADICIONAL
+INSTRUMENTO_GARANTIA
+COMPRA_PROGRAMADA
+POPULAR
+INCENTIVO
+FILANTROPIA_PREMIAVEL";1;1;"";Não permitido;string;TRADICIONAL;7
+/data/costType;costType;"Pagamento efetuado ao subscritor à sociedade de capitalização para aquisição do título de capitalização, podendo ser única, periódica ou mensal.
+1. Pagamento Único
+2. Pagamento Mensal
+3. Pagamento Periódico
+";Texto;19;Obrigatório;;"PAGAMENTO_UNICO
+PAGAMENTO_MENSAL
+PAGAMENTO_PERIODICO";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
+/data/termsAndConditions;termsAndConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}|NA$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
+/data/quotas;quotas;Informações relativas às taxas da Quotas praticadas para cada Parcela;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/quotas/quota;quota;Número da parcela.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
+/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/validity;validity;Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.;Inteiro;3;Opcional;;;0;1;"";Não permitido;integer;48;
+/data/serieSize;serieSize;Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;5000000;
+/data/capitalizationPeriod;capitalizationPeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
+";Texto;37;Obrigatório;;"IPCA
+IGPM
+INPC
+TR
+INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
+OUTROS";1;1;"";Não permitido;string;IPCA;
+/data/capitalizationPeriod/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
+/data/capitalizationPeriod/contributionAmount;contributionAmount;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/capitalizationPeriod/contributionAmount/periodicity;periodicity;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
+ 1. Único
+ 2. Diário
+ 3. Semanal
+ 4. Quinzenal
+ 5. Mensal
+ 6. Bimestral
+ 7. Trimestral
+ 8. Quadrimestral
+ 9. Semestral
+ 10. Anual
+ 11. Outros
+";Texto;13;Obrigatório;;"UNICO
+DIARIO
+SEMANAL
+QUINZENAL
+MENSAL
+BIMESTRAL
+TRIMESTRAL
+QUADRIMESTRAL
+SEMESTRAL
+ANUAL
+OUTROS";1;1;"";Não permitido;string;UNICO;
+/data/capitalizationPeriod/contributionAmount/periodicityAdditionalInfo;periodicityAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
+/data/capitalizationPeriod/contributionAmount/minimum;minimum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
+Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
+";Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}|NA$;;1;1;"";Não permitido;string;1.2222;
+/data/capitalizationPeriod/contributionAmount/maximum;maximum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
+Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
+";Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}|NA$;;1;1;"";Não permitido;string;1.2222;
+/data/capitalizationPeriod/contributionAmount/allowedValue;allowedValue;"Condicional: Quando modalidade for diferente de 'TRADICIONAL'
+Lista com os valores permitidos de contribuição ao plano.
+";Número;;Obrigatório;;;1;1;"";Não permitido;number;5000;
+/data/capitalizationPeriod/earlyRedemptions;earlyRedemptions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/capitalizationPeriod/earlyRedemptions/quota;quota;Parcela relativa ao Resgate Antecipado;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
+/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/gracePeriodRedemption;gracePeriodRedemption;Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;48;
+/data/latePayment;latePayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/latePayment/suspensionMonths;suspensionMonths;Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
+/data/latePayment/periodExtensionOption;periodExtensionOption;"Alteração do prazo de vigência original, pela suspensão (não aplicável a pagamento único). A considerar os seguintes domínios:
+1. true
+2. false
+";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+/data/contributionPayment;contributionPayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/contributionPayment/paymentMethod;paymentMethod;"Meio de Pagamento utilizado para pagamento da contribuição. A considerar os domínios abaixo:
+ 1. Cartão de Crédito
+ 2. Cartão de Débito
+ 3. Débito em conta corrente
+ 4. Débito em conta poupança
+ 5. Boleto bancário
+ 6. PIX
+ 7. Consignação em Folha de Pagamento
+ 8. Pontos de Programas de Benefício
+ 9. Outros
+";Texto;27;Obrigatório;;"CARTAO_CREDITO
+CARTAO_DEBITO
+DEBITO_CONTA_CORRENTE
+DEBITO_CONTA_POUPANCA
+BOLETO_BANCARIO
+PIX
+CONSIGNACAO_FOLHA_PAGAMENTO
+PAGAMENTO_PONTOS
+OUTROS";1;1;"";Não permitido;string;CARTAO_CREDITO;
+/data/contributionPayment/paymentMethodAdditionalInfo;paymentMethodAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
+/data/contributionPayment/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
+";Texto;37;Obrigatório;;"IPCA
+IGPM
+INPC
+TR
+INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
+OUTROS";1;1;"";Não permitido;string;IPCA;
+/data/contributionPayment/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
+/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/draws;draws;Informações relativas aos Sorteios;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/draws/timeInterval;timeInterval;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
+ - UNICO
+ - DIÁRIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - QUADRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - OUTROS
+";Texto;13;Obrigatório;;"UNICO
+DIÁRIO
+SEMANAL
+QUINZENAL
+MENSAL
+BIMESTRAL
+TRIMESTRAL
+QUADRIMESTRAL
+SEMESTRAL
+ANUAL
+OUTROS";1;1;"";Não permitido;string;UNICO;
+/data/draws/timeIntervalAdditionalInfo;timeIntervalAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;5;
+/data/draws/quantity;quantity;Número da quantidade de sorteios previstos ao longo da vigência.;Número;5;Obrigatório;;;1;1;"";Não permitido;number;10000;
+/data/draws/prizeMultiplier;prizeMultiplier;Valor dos sorteios representado por múltiplo do valor de contribuição. Por exemplo: 5 vezes valor da contribuição;Número;6;Obrigatório;;;1;1;"";Não permitido;number;5;
+/data/draws/earlySettlementRaffle;earlySettlementRaffle;"Modelo de sorteio que acarreta, ao título contemplado, o seu resgate total obrigatório (Resolução Normativa 384/20). Conforme os domínios:
+ 1. true
+ 2. false
+";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+/data/draws/mandatoryContemplation;mandatoryContemplation;"Possibilidade de realização de sorteio com previsão de que o título sorteado seja obrigatoriamente um título comercializado,
+desde que atingidos os requisitos definidos nas condições gerais do plano. Conforme os domínios:
+ 1. true
+ 2. false
+";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+/data/draws/ruleDescription;ruleDescription;Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.;Texto;200;Opcional;;;0;1;"";Não permitido;string;Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.;
+/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
+/data/minimumRequirementDetails;minimumRequirementDetails;"Campo aberto (possibilidade de incluir URL).
+Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
+tamanho. p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.’
+";Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
+/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. Ambas (Pessoa Natural e Jurídica)
+";Texto;23;Obrigatório;;"PESSOA_NATURAL
+PESSOA_JURIDICA
+PESSOA_NATURAL_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/swagger-apis/capitalization-bonds/index.html b/swagger-apis/capitalization-bonds/index.html
index 2b7cf310a..3d8062e9f 100644
--- a/swagger-apis/capitalization-bonds/index.html
+++ b/swagger-apis/capitalization-bonds/index.html
@@ -46,8 +46,9 @@
// Begin Swagger UI call region
const ui = SwaggerUIBundle({
urls: [ {"name": "1.0.0-rc1.0", "url": "./1.0.0-rc1.0.yml"},
- {"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"}],
- "urls.primaryName": "1.0.0-rc2.0", // default spec
+ {"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"},
+ {"name": "x.x.x", "url": "./x.x.x.yml"}],
+ "urls.primaryName": "x.x.x", // default spec
dom_id: '#swagger-ui',
deepLinking: true,
supportedSubmitMethods:[],
diff --git a/swagger-apis/capitalization-bonds/x.x.x.yml b/swagger-apis/capitalization-bonds/x.x.x.yml
new file mode 100644
index 000000000..556c65828
--- /dev/null
+++ b/swagger-apis/capitalization-bonds/x.x.x.yml
@@ -0,0 +1,813 @@
+openapi: 3.0.0
+info:
+ title: API Capitalization-bonds - Open Finance Brasil
+ description: |
+ As APIs descritas neste documento é referente a API de Capitalização da fase OpenInsurance do Open Finance Brasil.
+ version: x.x.x
+ license:
+ name: Apache 2.0
+ url: 'https://www.apache.org/licenses/LICENSE-2.0'
+ contact:
+ name: Governança do Open Finance Brasil – Especificações
+ email: gt-interfaces@openbankingbr.org
+ url: 'https://openbanking-brasil.github.io/areadesenvolvedor/'
+servers:
+ - url: 'https://api.banco.com.br/open-banking/opendata-capitalization/v1'
+ description: Servidor de Produção
+ - url: 'https://apih.banco.com.br/open-banking/opendata-capitalization/v1'
+ description: Servidor de Homologação
+tags:
+ - name: Capitalization Bonds
+ description: Operações para consulta das informações de Titulos de Capitalização
+paths:
+ /bonds:
+ get:
+ tags:
+ - Capitalization Bonds
+ summary: Conjunto de informações dos Títulos de Capitalização de uma instituição
+ operationId: capitalizationBondsGetProducts
+ description: Método para obter a lista de todos os títulos de Capitalização de uma instituição
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/pageSize'
+ responses:
+ '200':
+ $ref: '#/components/responses/OKResponseCapitalizationBondsProductsList'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '405':
+ $ref: '#/components/responses/MethodNotAllowed'
+ '429':
+ $ref: '#/components/responses/TooManyRequests'
+ '500':
+ $ref: '#/components/responses/InternalServerError'
+ '529':
+ $ref: '#/components/responses/SiteIsOverloaded'
+components:
+ schemas:
+ CapitalizationBondsProductIdentificationData:
+ type: object
+ required:
+ - participant
+ - society
+ - name
+ - code
+ - modality
+ - costType
+ - termsAndConditions
+ - quotas
+ - capitalizationPeriod
+ - latePayment
+ - contributionPayment
+ - finalRedemptionRate
+ - redemptionPercentageEndTerm
+ - draws
+ - additionalInfo
+ - targetAudience
+ properties:
+ participant:
+ $ref: '#/components/schemas/Participant'
+ society:
+ type: object
+ description: Conjunto de informações relativas à seguradora do produto de open insurance
+ required:
+ - name
+ - cnpjNumber
+ properties:
+ name:
+ type: string
+ description: Nome da Sociedade Seguradora.
+ maxLength: 80
+ example: Society A1
+ cnpjNumber:
+ $ref: '#/components/schemas/Participant/properties/cnpjNumber'
+ additionalProperties: false
+ name:
+ type: string
+ description: 'Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.'
+ maxLength: 80
+ example: ACMEcap
+ code:
+ type: string
+ description: Código único a ser definido pela sociedade.
+ maxLength: 100
+ example: 01234589_cap
+ modality:
+ $ref: '#/components/schemas/EnumCapitalizationBondsProductModality'
+ costType:
+ $ref: '#/components/schemas/EnumCapitalizationBondsProductCostType'
+ termsAndConditions:
+ $ref: '#/components/schemas/TermsAndConditions'
+ quotas:
+ type: array
+ description: Informações relativas às taxas da Quotas praticadas para cada Parcela
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/CapitalizationBondsProductQuota'
+ validity:
+ type: integer
+ format: int32
+ description: Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.
+ maxLength: 3
+ example: 48
+ serieSize:
+ type: integer
+ description: 'Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.'
+ maxLength: 10
+ example: 5000000
+ capitalizationPeriod:
+ $ref: '#/components/schemas/CapitalizationBondsProductCapitalizationPeriod'
+ latePayment:
+ $ref: '#/components/schemas/LatePayment'
+ contributionPayment:
+ $ref: '#/components/schemas/ContributionPayment'
+ redemptionPercentageEndTerm:
+ type: string
+ description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}|NA$'
+ example: '0.019800'
+ finalRedemptionRate:
+ type: string
+ description: Valor percentual (%) de resgate final permitido.
+ pattern: '^\d{1}\.\d{6}|NA$'
+ maxLength: 8
+ minLength: 8
+ example: '0.019800'
+ draws:
+ type: array
+ description: Informações relativas aos Sorteios
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/CapitalizationBondsProductPrizeDraw'
+ additionalInfo:
+ type: string
+ description: 'Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.'
+ maxLength: 1024
+ example: 'https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais'
+ minimumRequirementDetails:
+ type: string
+ description: |
+ Campo aberto (possibilidade de incluir URL).
+ Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
+ tamanho. p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.’
+ maxLength: 1024
+ example: 'https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais'
+ targetAudience:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. Ambas (Pessoa Natural e Jurídica)
+ maxLength: 23
+ enum:
+ - PESSOA_NATURAL
+ - PESSOA_JURIDICA
+ - PESSOA_NATURAL_JURIDICA
+ example: PESSOA_NATURAL
+ additionalProperties: false
+ Participant:
+ type: object
+ description: Conjunto de informações relativas ao participante do produto de Open Finance
+ required:
+ - brand
+ - name
+ - cnpjNumber
+ properties:
+ brand:
+ type: string
+ description: 'Nome da marca reportada pelo participante do Open Finance. 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.'
+ maxLength: 80
+ example: Organização
+ name:
+ type: string
+ description: Nome do participante do Open Finance.
+ maxLength: 80
+ example: Organização A1
+ cnpjNumber:
+ type: string
+ description: '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.'
+ pattern: '^\d{14}|NA$'
+ example: '13456789000112'
+ urlComplementaryList:
+ type: string
+ description: |
+ Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
+
+ - ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
+
+ - 'cnpjNumber' com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
+
+ - Ambos do tipo string;
+
+ - Ambos obrigatórios.
+ maxLength: 1024
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|NA$'
+ example: 'https://empresaa1.com/companies'
+ additionalProperties: false
+ EnumCapitalizationBondsProductModality:
+ type: string
+ description: |
+ 1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
+ 2. Instrumento de Garantia: A modalidade tem por objetivo propiciar que a provisão matemática para capitalização do título de capitalização seja utilizada para assegurar o cumprimento de obrigação assumida em contrato principal pelo titular perante terceiro. (Res CNSP 384/20)
+ 3. Compra Programada: A modalidade compra programada garante o valor de resgate em moeda corrente nacional, sendo disponibilizada ao assim desejar e sem qualquer outro custo, pelo recebimento do bem e/ou serviço referenciado no subsidiado por acordos comerciais celebrados com indústrias, atacadistas, empresas comerciais ou prestadores de serviço. (Res CNSP 384/20)
+ 4. Popular: A modalidade popular tem por objetivo propiciar a capitalização da contribuição e a participação do titular em sorteios, sem que haja devolução integral do valor pago. (Res CNSP 384/20)
+ 5. Incentivo: A modalidade incentivo tem por objetivo a vinculação a um evento promocional de caráter comercial instituído pelo subscritor para alavancar a venda de seu(s) produto(s) ou serviços ou para fidelizar seus clientes. (Res CNSP 384/20)
+ 6. Filantropia Premiável: A modalidade filantropia premiável é destinada ao subscritor interessado em contribuir com entidades beneficentes de assistências sociais, certificadas nos termos da legislação vigente, e participar de sorteio(s). (Res CNSP 384/20)
+ minLength: 7
+ maxLength: 24
+ enum:
+ - TRADICIONAL
+ - INSTRUMENTO_GARANTIA
+ - COMPRA_PROGRAMADA
+ - POPULAR
+ - INCENTIVO
+ - FILANTROPIA_PREMIAVEL
+ example: TRADICIONAL
+ EnumCapitalizationBondsProductCostType:
+ type: string
+ description: |
+ Pagamento efetuado ao subscritor à sociedade de capitalização para aquisição do título de capitalização, podendo ser única, periódica ou mensal.
+ 1. Pagamento Único
+ 2. Pagamento Mensal
+ 3. Pagamento Periódico
+ minLength: 15
+ maxLength: 19
+ enum:
+ - PAGAMENTO_UNICO
+ - PAGAMENTO_MENSAL
+ - PAGAMENTO_PERIODICO
+ example: PAGAMENTO_UNICO
+ TermsAndConditions:
+ type: object
+ required:
+ - susepProcessNumber
+ - detail
+ properties:
+ susepProcessNumber:
+ type: string
+ description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
+ minLength: 12
+ maxLength: 20
+ pattern: '^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}|NA$'
+ example: 15414.622222/2222-22
+ detail:
+ type: string
+ description: 'Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL)'
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ CapitalizationBondsProductQuota:
+ type: object
+ required:
+ - quota
+ - capitalizationQuota
+ - raffleQuota
+ - chargingQuota
+ properties:
+ quota:
+ type: number
+ format: integer
+ description: Número da parcela.
+ maxLength: 3
+ example: 10
+ capitalizationQuota:
+ type: string
+ description: Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}|NA$'
+ example: '0.019800'
+ raffleQuota:
+ type: string
+ description: 'Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).'
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}|NA$'
+ example: '0.019800'
+ chargingQuota:
+ type: string
+ description: 'Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).'
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}|NA$'
+ example: '0.019800'
+ additionalProperties: false
+ CapitalizationBondsProductCapitalizationPeriod:
+ type: object
+ required:
+ - interestRate
+ - updateIndex
+ - contributionAmount
+ - earlyRedemptions
+ - redemptionPercentageEndTerm
+ - gracePeriodRedemption
+ properties:
+ interestRate:
+ type: string
+ pattern: '^\d{1}\.\d{6}|NA$'
+ description: 'Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).'
+ maxLength: 8
+ minLength: 8
+ example: '0.019800'
+ updateIndex:
+ $ref: '#/components/schemas/CapitalizationBondsProductUpdateIndex'
+ updateIndexAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ contributionAmount:
+ type: array
+ items:
+ $ref: '#/components/schemas/CapitalizationPeriodContributionAmount'
+ minItems: 1
+ earlyRedemptions:
+ minItems: 1
+ type: array
+ items:
+ type: object
+ required:
+ - quota
+ - rate
+ properties:
+ quota:
+ type: number
+ format: integer
+ description: Parcela relativa ao Resgate Antecipado
+ maxLength: 3
+ example: 10
+ rate:
+ type: string
+ description: Taxa relativa ao Resgate Antecipado
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}|NA$'
+ example: '0.019800'
+ additionalProperties: false
+ redemptionPercentageEndTerm:
+ type: string
+ description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
+ maxLength: 8
+ minLength: 8
+ pattern: '^\d{1}\.\d{6}|NA$'
+ example: '0.019800'
+ gracePeriodRedemption:
+ type: number
+ format: integer
+ description: 'Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.'
+ maxLength: 3
+ example: 48
+ additionalProperties: false
+ CapitalizationBondsProductUpdateIndex:
+ type: string
+ maxLength: 37
+ enum:
+ - IPCA
+ - IGPM
+ - INPC
+ - TR
+ - INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
+ - OUTROS
+ example: IPCA
+ description: |
+ Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
+ CapitalizationPeriodContributionAmount:
+ type: object
+ description: |
+ Corresponde ao pagamento efetuado pelo subscritor à sociedade de capitalização para a aquisição do título de capitalização, podendo ser única, periódica ou mensal (Resolução CNSP 384/20). Valores em reais (R$). Esclarecimentos adicionais SUSEP.
+ Na modalidade Tradicional, informar a faixa de valor mínimo e máximo em R$ de contribuição ao plano.
+ Para as demais modalidades, informar a lista com os valores permitidos de contribuição ao plano.
+ Em todas as situações indicar para qual periodicidade de pagamento se aplicam os valores: pagamento mensal, pagamento único ou periódico.
+ required:
+ - periodicity
+ - minimum
+ - maximum
+ - allowedValue
+ properties:
+ periodicity:
+ type: string
+ description: |
+ Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
+ 1. Único
+ 2. Diário
+ 3. Semanal
+ 4. Quinzenal
+ 5. Mensal
+ 6. Bimestral
+ 7. Trimestral
+ 8. Quadrimestral
+ 9. Semestral
+ 10. Anual
+ 11. Outros
+ maxLength: 13
+ enum:
+ - UNICO
+ - DIARIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - QUADRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - OUTROS
+ example: UNICO
+ periodicityAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ minimum:
+ type: string
+ pattern: '^\d{1,16}\.\d{2,4}|NA$'
+ description: |
+ Condicional: Quando modalidade for igual 'TRADICIONAL'
+ Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
+ maxLength: 21
+ example: '1.2222'
+ maximum:
+ type: string
+ pattern: '^\d{1,16}\.\d{2,4}|NA$'
+ description: |
+ Condicional: Quando modalidade for igual 'TRADICIONAL'
+ Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
+ maxLength: 21
+ example: '1.2222'
+ allowedValue:
+ type: number
+ format: double
+ description: |
+ Condicional: Quando modalidade for diferente de 'TRADICIONAL'
+ Lista com os valores permitidos de contribuição ao plano.
+ example: 5000
+ additionalProperties: false
+ LatePayment:
+ type: object
+ required:
+ - suspensionMonths
+ - periodExtensionOption
+ properties:
+ suspensionMonths:
+ type: number
+ description: 'Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).'
+ maxLength: 3
+ example: 10
+ periodExtensionOption:
+ type: boolean
+ description: |
+ Alteração do prazo de vigência original, pela suspensão (não aplicável a pagamento único). A considerar os seguintes domínios:
+ 1. true
+ 2. false
+ example: true
+ additionalProperties: false
+ ContributionPayment:
+ type: object
+ required:
+ - paymentMethod
+ - updateIndex
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/CapitalizationBondsProductPaymentMethod'
+ paymentMethodAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ updateIndex:
+ $ref: '#/components/schemas/CapitalizationBondsProductUpdateIndex'
+ updateIndexAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ additionalProperties: false
+ CapitalizationBondsProductPaymentMethod:
+ type: string
+ maxLength: 27
+ enum:
+ - CARTAO_CREDITO
+ - CARTAO_DEBITO
+ - DEBITO_CONTA_CORRENTE
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PAGAMENTO_PONTOS
+ - OUTROS
+ example: CARTAO_CREDITO
+ description: |
+ Meio de Pagamento utilizado para pagamento da contribuição. A considerar os domínios abaixo:
+ 1. Cartão de Crédito
+ 2. Cartão de Débito
+ 3. Débito em conta corrente
+ 4. Débito em conta poupança
+ 5. Boleto bancário
+ 6. PIX
+ 7. Consignação em Folha de Pagamento
+ 8. Pontos de Programas de Benefício
+ 9. Outros
+ CapitalizationBondsProductPrizeDraw:
+ type: object
+ required:
+ - timeInterval
+ - quantity
+ - prizeMultiplier
+ - earlySettlementRaffle
+ - mandatoryContemplation
+ - minimumContemplationProbability
+ properties:
+ timeInterval:
+ type: string
+ description: |
+ Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
+ - UNICO
+ - DIÁRIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - QUADRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - OUTROS
+ maxLength: 13
+ enum:
+ - UNICO
+ - DIÁRIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - QUADRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - OUTROS
+ example: UNICO
+ timeIntervalAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: '5'
+ quantity:
+ type: number
+ format: integer
+ description: Número da quantidade de sorteios previstos ao longo da vigência.
+ maxLength: 5
+ example: 10000
+ prizeMultiplier:
+ type: number
+ format: integer
+ description: 'Valor dos sorteios representado por múltiplo do valor de contribuição. Por exemplo: 5 vezes valor da contribuição'
+ maxLength: 6
+ example: 5
+ earlySettlementRaffle:
+ description: |
+ Modelo de sorteio que acarreta, ao título contemplado, o seu resgate total obrigatório (Resolução Normativa 384/20). Conforme os domínios:
+ 1. true
+ 2. false
+ type: boolean
+ example: true
+ mandatoryContemplation:
+ type: boolean
+ description: |
+ Possibilidade de realização de sorteio com previsão de que o título sorteado seja obrigatoriamente um título comercializado,
+ desde que atingidos os requisitos definidos nas condições gerais do plano. Conforme os domínios:
+ 1. true
+ 2. false
+ example: true
+ ruleDescription:
+ type: string
+ description: 'Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.'
+ maxLength: 200
+ example: Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.
+ minimumContemplationProbability:
+ type: string
+ pattern: '^\d{1}\.\d{6}|NA$'
+ description: 'Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).'
+ maxLength: 8
+ minLength: 8
+ example: '0.019800'
+ additionalProperties: false
+ Links:
+ type: object
+ description: Referências para outros recusos da API requisitada.
+ required:
+ - self
+ properties:
+ self:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI completo que gerou a resposta atual.
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ first:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ prev:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: "URI da página anterior dessa lista de resultados. Restrição - \tObrigatório quando não for a primeira página da resposta"
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ next:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ last:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ additionalProperties: false
+ OpenDataMeta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - totalRecords
+ - totalPages
+ properties:
+ totalRecords:
+ type: integer
+ format: int32
+ description: Número total de registros no resultado
+ example: 1
+ totalPages:
+ type: integer
+ format: int32
+ description: Número total de páginas no resultado
+ example: 1
+ additionalProperties: false
+ parameters:
+ 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
+ maximum: 2147483647
+ 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
+ responses:
+ OKResponseCapitalizationBondsProductsList:
+ description: Dados de título(s) de capitalização obtidos com sucesso.
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ properties:
+ data:
+ type: array
+ description: Conjunto de informações do Título de Capitalização
+ items:
+ $ref: '#/components/schemas/CapitalizationBondsProductIdentificationData'
+ minItems: 1
+ links:
+ $ref: '#/components/schemas/Links'
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ 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/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ InternalServerError:
+ description: Ocorreu um erro no gateway da API ou no microsserviço
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ MethodNotAllowed:
+ description: O consumidor tentou acessar o recurso com um método não suportado
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ NotFound:
+ description: O recurso solicitado não existe ou não foi implementado
+ content:
+ application/json; charset=utf-8:
+ schema:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ additionalProperties: false
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ TooManyRequests:
+ description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite de requisições concorrentes foi atingido.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ SiteIsOverloaded:
+ description: 'O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ meta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - requestDateTime
+ properties:
+ requestDateTime:
+ description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.'
+ type: string
+ maxLength: 20
+ format: date-time
+ example: '2021-05-21T08:30:00Z'
From af924dbb03d48edc7927445c99242eb749b239bf Mon Sep 17 00:00:00 2001
From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com>
Date: Fri, 12 May 2023 14:28:06 +0000
Subject: [PATCH 07/50] feat(Capitalization Bonds): ORB-2576 - PC81 - Tipo ENUM
aceitar NA
---
.../capitalizationBondsGetProducts_vx.csv | 24 ++++++++++++-------
swagger-apis/capitalization-bonds/x.x.x.yml | 7 ++++++
2 files changed, 23 insertions(+), 8 deletions(-)
diff --git a/dictionary/capitalizationBondsGetProducts_vx.csv b/dictionary/capitalizationBondsGetProducts_vx.csv
index 78bda5cce..56dca78f2 100644
--- a/dictionary/capitalizationBondsGetProducts_vx.csv
+++ b/dictionary/capitalizationBondsGetProducts_vx.csv
@@ -30,14 +30,16 @@ INSTRUMENTO_GARANTIA
COMPRA_PROGRAMADA
POPULAR
INCENTIVO
-FILANTROPIA_PREMIAVEL";1;1;"";Não permitido;string;TRADICIONAL;7
+FILANTROPIA_PREMIAVEL
+NA";1;1;"";Não permitido;string;TRADICIONAL;7
/data/costType;costType;"Pagamento efetuado ao subscritor à sociedade de capitalização para aquisição do título de capitalização, podendo ser única, periódica ou mensal.
1. Pagamento Único
2. Pagamento Mensal
3. Pagamento Periódico
";Texto;19;Obrigatório;;"PAGAMENTO_UNICO
PAGAMENTO_MENSAL
-PAGAMENTO_PERIODICO";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
+PAGAMENTO_PERIODICO
+NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
/data/termsAndConditions;termsAndConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}|NA$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
@@ -56,7 +58,8 @@ IGPM
INPC
TR
INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
-OUTROS";1;1;"";Não permitido;string;IPCA;
+OUTROS
+NA";1;1;"";Não permitido;string;IPCA;
/data/capitalizationPeriod/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
/data/capitalizationPeriod/contributionAmount;contributionAmount;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/capitalizationPeriod/contributionAmount/periodicity;periodicity;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
@@ -81,7 +84,8 @@ TRIMESTRAL
QUADRIMESTRAL
SEMESTRAL
ANUAL
-OUTROS";1;1;"";Não permitido;string;UNICO;
+OUTROS
+NA";1;1;"";Não permitido;string;UNICO;
/data/capitalizationPeriod/contributionAmount/periodicityAdditionalInfo;periodicityAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
/data/capitalizationPeriod/contributionAmount/minimum;minimum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
@@ -122,7 +126,8 @@ BOLETO_BANCARIO
PIX
CONSIGNACAO_FOLHA_PAGAMENTO
PAGAMENTO_PONTOS
-OUTROS";1;1;"";Não permitido;string;CARTAO_CREDITO;
+OUTROS
+NA";1;1;"";Não permitido;string;CARTAO_CREDITO;
/data/contributionPayment/paymentMethodAdditionalInfo;paymentMethodAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
/data/contributionPayment/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
";Texto;37;Obrigatório;;"IPCA
@@ -130,7 +135,8 @@ IGPM
INPC
TR
INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
-OUTROS";1;1;"";Não permitido;string;IPCA;
+OUTROS
+NA";1;1;"";Não permitido;string;IPCA;
/data/contributionPayment/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
@@ -157,7 +163,8 @@ TRIMESTRAL
QUADRIMESTRAL
SEMESTRAL
ANUAL
-OUTROS";1;1;"";Não permitido;string;UNICO;
+OUTROS
+NA";1;1;"";Não permitido;string;UNICO;
/data/draws/timeIntervalAdditionalInfo;timeIntervalAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;5;
/data/draws/quantity;quantity;Número da quantidade de sorteios previstos ao longo da vigência.;Número;5;Obrigatório;;;1;1;"";Não permitido;number;10000;
/data/draws/prizeMultiplier;prizeMultiplier;Valor dos sorteios representado por múltiplo do valor de contribuição. Por exemplo: 5 vezes valor da contribuição;Número;6;Obrigatório;;;1;1;"";Não permitido;number;5;
@@ -184,4 +191,5 @@ tamanho. p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_g
3. Ambas (Pessoa Natural e Jurídica)
";Texto;23;Obrigatório;;"PESSOA_NATURAL
PESSOA_JURIDICA
-PESSOA_NATURAL_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL;
+PESSOA_NATURAL_JURIDICA
+NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/swagger-apis/capitalization-bonds/x.x.x.yml b/swagger-apis/capitalization-bonds/x.x.x.yml
index 556c65828..85f18d766 100644
--- a/swagger-apis/capitalization-bonds/x.x.x.yml
+++ b/swagger-apis/capitalization-bonds/x.x.x.yml
@@ -169,6 +169,7 @@ components:
- PESSOA_NATURAL
- PESSOA_JURIDICA
- PESSOA_NATURAL_JURIDICA
+ - NA
example: PESSOA_NATURAL
additionalProperties: false
Participant:
@@ -228,6 +229,7 @@ components:
- POPULAR
- INCENTIVO
- FILANTROPIA_PREMIAVEL
+ - NA
example: TRADICIONAL
EnumCapitalizationBondsProductCostType:
type: string
@@ -242,6 +244,7 @@ components:
- PAGAMENTO_UNICO
- PAGAMENTO_MENSAL
- PAGAMENTO_PERIODICO
+ - NA
example: PAGAMENTO_UNICO
TermsAndConditions:
type: object
@@ -374,6 +377,7 @@ components:
- TR
- INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
- OUTROS
+ - NA
example: IPCA
description: |
Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
@@ -418,6 +422,7 @@ components:
- SEMESTRAL
- ANUAL
- OUTROS
+ - NA
example: UNICO
periodicityAdditionalInfo:
type: string
@@ -501,6 +506,7 @@ components:
- CONSIGNACAO_FOLHA_PAGAMENTO
- PAGAMENTO_PONTOS
- OUTROS
+ - NA
example: CARTAO_CREDITO
description: |
Meio de Pagamento utilizado para pagamento da contribuição. A considerar os domínios abaixo:
@@ -551,6 +557,7 @@ components:
- SEMESTRAL
- ANUAL
- OUTROS
+ - NA
example: UNICO
timeIntervalAdditionalInfo:
type: string
From 50d4cd519b97018630a8a6fa0e4975b0caba77b0 Mon Sep 17 00:00:00 2001
From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com>
Date: Fri, 12 May 2023 14:46:24 +0000
Subject: [PATCH 08/50] feat(Capitalization Bonds): ORB-2575 - PC81 - Tipo
string aceitar NA
---
.../capitalizationBondsGetProducts_vx.csv | 30 +++++++++----------
swagger-apis/capitalization-bonds/x.x.x.yml | 28 ++++++++---------
2 files changed, 29 insertions(+), 29 deletions(-)
diff --git a/dictionary/capitalizationBondsGetProducts_vx.csv b/dictionary/capitalizationBondsGetProducts_vx.csv
index 78bda5cce..1e5f3f47d 100644
--- a/dictionary/capitalizationBondsGetProducts_vx.csv
+++ b/dictionary/capitalizationBondsGetProducts_vx.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}|NA$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -13,10 +13,10 @@
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|NA$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}|NA$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;ACMEcap;
/data/code;code;Código único a ser definido pela sociedade.;Texto;100;Obrigatório;;;1;1;"";Não permitido;string;01234589_cap;
/data/modality;modality;"1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
@@ -39,17 +39,17 @@ FILANTROPIA_PREMIAVEL";1;1;"";Não permitido;string;TRADICIONAL;7
PAGAMENTO_MENSAL
PAGAMENTO_PERIODICO";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
/data/termsAndConditions;termsAndConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}|NA$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/quotas;quotas;Informações relativas às taxas da Quotas praticadas para cada Parcela;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/quotas/quota;quota;Número da parcela.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/validity;validity;Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.;Inteiro;3;Opcional;;;0;1;"";Não permitido;integer;48;
/data/serieSize;serieSize;Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;5000000;
/data/capitalizationPeriod;capitalizationPeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
";Texto;37;Obrigatório;;"IPCA
IGPM
@@ -85,17 +85,17 @@ OUTROS";1;1;"";Não permitido;string;UNICO;
/data/capitalizationPeriod/contributionAmount/periodicityAdditionalInfo;periodicityAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
/data/capitalizationPeriod/contributionAmount/minimum;minimum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
-";Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}|NA$;;1;1;"";Não permitido;string;1.2222;
+";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;1.2222;
/data/capitalizationPeriod/contributionAmount/maximum;maximum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
-";Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}|NA$;;1;1;"";Não permitido;string;1.2222;
+";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;1.2222;
/data/capitalizationPeriod/contributionAmount/allowedValue;allowedValue;"Condicional: Quando modalidade for diferente de 'TRADICIONAL'
Lista com os valores permitidos de contribuição ao plano.
";Número;;Obrigatório;;;1;1;"";Não permitido;number;5000;
/data/capitalizationPeriod/earlyRedemptions;earlyRedemptions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/capitalizationPeriod/earlyRedemptions/quota;quota;Parcela relativa ao Resgate Antecipado;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
-/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/gracePeriodRedemption;gracePeriodRedemption;Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;48;
/data/latePayment;latePayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/latePayment/suspensionMonths;suspensionMonths;Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
@@ -132,8 +132,8 @@ TR
INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
OUTROS";1;1;"";Não permitido;string;IPCA;
/data/contributionPayment/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
-/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
-/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/draws;draws;Informações relativas aos Sorteios;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/draws/timeInterval;timeInterval;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
- UNICO
@@ -171,7 +171,7 @@ desde que atingidos os requisitos definidos nas condições gerais do plano. Con
2. false
";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
/data/draws/ruleDescription;ruleDescription;Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.;Texto;200;Opcional;;;0;1;"";Não permitido;string;Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.;
-/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
/data/minimumRequirementDetails;minimumRequirementDetails;"Campo aberto (possibilidade de incluir URL).
Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
diff --git a/swagger-apis/capitalization-bonds/x.x.x.yml b/swagger-apis/capitalization-bonds/x.x.x.yml
index 556c65828..1aa12605f 100644
--- a/swagger-apis/capitalization-bonds/x.x.x.yml
+++ b/swagger-apis/capitalization-bonds/x.x.x.yml
@@ -128,12 +128,12 @@ components:
description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '(^\d{1}\.\d{6})|(NA)$'
example: '0.019800'
finalRedemptionRate:
type: string
description: Valor percentual (%) de resgate final permitido.
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '(^\d{1}\.\d{6})|(NA)$'
maxLength: 8
minLength: 8
example: '0.019800'
@@ -192,7 +192,7 @@ components:
cnpjNumber:
type: string
description: '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.'
- pattern: '^\d{14}|NA$'
+ pattern: '(^\d{14})|(NA)$'
example: '13456789000112'
urlComplementaryList:
type: string
@@ -207,7 +207,7 @@ components:
- Ambos obrigatórios.
maxLength: 1024
- pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|NA$'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|(NA)$'
example: 'https://empresaa1.com/companies'
additionalProperties: false
EnumCapitalizationBondsProductModality:
@@ -254,7 +254,7 @@ components:
description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
minLength: 12
maxLength: 20
- pattern: '^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}|NA$'
+ pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$'
example: 15414.622222/2222-22
detail:
type: string
@@ -281,21 +281,21 @@ components:
description: Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
example: '0.019800'
raffleQuota:
type: string
description: 'Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).'
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '(^\d{1}\.\d{6})|(NA)$'
example: '0.019800'
chargingQuota:
type: string
description: 'Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).'
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '(^\d{1}\.\d{6})|(NA)$'
example: '0.019800'
additionalProperties: false
CapitalizationBondsProductCapitalizationPeriod:
@@ -310,7 +310,7 @@ components:
properties:
interestRate:
type: string
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
description: 'Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).'
maxLength: 8
minLength: 8
@@ -347,7 +347,7 @@ components:
description: Taxa relativa ao Resgate Antecipado
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
example: '0.019800'
additionalProperties: false
redemptionPercentageEndTerm:
@@ -355,7 +355,7 @@ components:
description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
example: '0.019800'
gracePeriodRedemption:
type: number
@@ -426,7 +426,7 @@ components:
example: ''
minimum:
type: string
- pattern: '^\d{1,16}\.\d{2,4}|NA$'
+ pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
description: |
Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
@@ -434,7 +434,7 @@ components:
example: '1.2222'
maximum:
type: string
- pattern: '^\d{1,16}\.\d{2,4}|NA$'
+ pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
description: |
Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
@@ -591,7 +591,7 @@ components:
example: Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.
minimumContemplationProbability:
type: string
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
description: 'Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).'
maxLength: 8
minLength: 8
From a8eb7d5552a5a1ee3229a1b0019748e519b9cd03 Mon Sep 17 00:00:00 2001
From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com>
Date: Fri, 12 May 2023 14:54:28 +0000
Subject: [PATCH 09/50] feat(Capitalization Bonds): ORB-2576 - PC81 - Tipo ENUM
aceitar NA
---
.../capitalizationBondsGetProducts_vx.csv | 30 +++++++++----------
swagger-apis/capitalization-bonds/x.x.x.yml | 28 ++++++++---------
2 files changed, 29 insertions(+), 29 deletions(-)
diff --git a/dictionary/capitalizationBondsGetProducts_vx.csv b/dictionary/capitalizationBondsGetProducts_vx.csv
index 56dca78f2..559c49eb9 100644
--- a/dictionary/capitalizationBondsGetProducts_vx.csv
+++ b/dictionary/capitalizationBondsGetProducts_vx.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}|NA$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -13,10 +13,10 @@
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|NA$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}|NA$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;ACMEcap;
/data/code;code;Código único a ser definido pela sociedade.;Texto;100;Obrigatório;;;1;1;"";Não permitido;string;01234589_cap;
/data/modality;modality;"1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
@@ -41,17 +41,17 @@ PAGAMENTO_MENSAL
PAGAMENTO_PERIODICO
NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
/data/termsAndConditions;termsAndConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}|NA$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/quotas;quotas;Informações relativas às taxas da Quotas praticadas para cada Parcela;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/quotas/quota;quota;Número da parcela.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/validity;validity;Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.;Inteiro;3;Opcional;;;0;1;"";Não permitido;integer;48;
/data/serieSize;serieSize;Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;5000000;
/data/capitalizationPeriod;capitalizationPeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
";Texto;37;Obrigatório;;"IPCA
IGPM
@@ -89,17 +89,17 @@ NA";1;1;"";Não permitido;string;UNICO;
/data/capitalizationPeriod/contributionAmount/periodicityAdditionalInfo;periodicityAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
/data/capitalizationPeriod/contributionAmount/minimum;minimum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
-";Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}|NA$;;1;1;"";Não permitido;string;1.2222;
+";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;1.2222;
/data/capitalizationPeriod/contributionAmount/maximum;maximum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
-";Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}|NA$;;1;1;"";Não permitido;string;1.2222;
+";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;1.2222;
/data/capitalizationPeriod/contributionAmount/allowedValue;allowedValue;"Condicional: Quando modalidade for diferente de 'TRADICIONAL'
Lista com os valores permitidos de contribuição ao plano.
";Número;;Obrigatório;;;1;1;"";Não permitido;number;5000;
/data/capitalizationPeriod/earlyRedemptions;earlyRedemptions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/capitalizationPeriod/earlyRedemptions/quota;quota;Parcela relativa ao Resgate Antecipado;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
-/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/gracePeriodRedemption;gracePeriodRedemption;Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;48;
/data/latePayment;latePayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/latePayment/suspensionMonths;suspensionMonths;Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
@@ -138,8 +138,8 @@ INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
OUTROS
NA";1;1;"";Não permitido;string;IPCA;
/data/contributionPayment/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
-/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
-/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/draws;draws;Informações relativas aos Sorteios;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/draws/timeInterval;timeInterval;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
- UNICO
@@ -178,7 +178,7 @@ desde que atingidos os requisitos definidos nas condições gerais do plano. Con
2. false
";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
/data/draws/ruleDescription;ruleDescription;Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.;Texto;200;Opcional;;;0;1;"";Não permitido;string;Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.;
-/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;8;Obrigatório;^\d{1}\.\d{6}|NA$;;1;1;"";Não permitido;string;0.019800;8
+/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
/data/minimumRequirementDetails;minimumRequirementDetails;"Campo aberto (possibilidade de incluir URL).
Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
diff --git a/swagger-apis/capitalization-bonds/x.x.x.yml b/swagger-apis/capitalization-bonds/x.x.x.yml
index 85f18d766..b23085a60 100644
--- a/swagger-apis/capitalization-bonds/x.x.x.yml
+++ b/swagger-apis/capitalization-bonds/x.x.x.yml
@@ -128,12 +128,12 @@ components:
description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '(^\d{1}\.\d{6})|(NA)$'
example: '0.019800'
finalRedemptionRate:
type: string
description: Valor percentual (%) de resgate final permitido.
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '(^\d{1}\.\d{6})|(NA)$'
maxLength: 8
minLength: 8
example: '0.019800'
@@ -193,7 +193,7 @@ components:
cnpjNumber:
type: string
description: '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.'
- pattern: '^\d{14}|NA$'
+ pattern: '(^\d{14})|(NA)$'
example: '13456789000112'
urlComplementaryList:
type: string
@@ -208,7 +208,7 @@ components:
- Ambos obrigatórios.
maxLength: 1024
- pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|NA$'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|(NA)$'
example: 'https://empresaa1.com/companies'
additionalProperties: false
EnumCapitalizationBondsProductModality:
@@ -257,7 +257,7 @@ components:
description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
minLength: 12
maxLength: 20
- pattern: '^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}|NA$'
+ pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$'
example: 15414.622222/2222-22
detail:
type: string
@@ -284,21 +284,21 @@ components:
description: Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
example: '0.019800'
raffleQuota:
type: string
description: 'Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).'
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '(^\d{1}\.\d{6})|(NA)$'
example: '0.019800'
chargingQuota:
type: string
description: 'Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).'
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '(^\d{1}\.\d{6})|(NA)$'
example: '0.019800'
additionalProperties: false
CapitalizationBondsProductCapitalizationPeriod:
@@ -313,7 +313,7 @@ components:
properties:
interestRate:
type: string
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
description: 'Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).'
maxLength: 8
minLength: 8
@@ -350,7 +350,7 @@ components:
description: Taxa relativa ao Resgate Antecipado
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
example: '0.019800'
additionalProperties: false
redemptionPercentageEndTerm:
@@ -358,7 +358,7 @@ components:
description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
maxLength: 8
minLength: 8
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
example: '0.019800'
gracePeriodRedemption:
type: number
@@ -431,7 +431,7 @@ components:
example: ''
minimum:
type: string
- pattern: '^\d{1,16}\.\d{2,4}|NA$'
+ pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
description: |
Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
@@ -439,7 +439,7 @@ components:
example: '1.2222'
maximum:
type: string
- pattern: '^\d{1,16}\.\d{2,4}|NA$'
+ pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
description: |
Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
@@ -598,7 +598,7 @@ components:
example: Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.
minimumContemplationProbability:
type: string
- pattern: '^\d{1}\.\d{6}|NA$'
+ pattern: '^(\d{1}\.\d{6})|(NA)$'
description: 'Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).'
maxLength: 8
minLength: 8
From c203c6058211baa399323b91f32fc46802bc8d7f Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 12 May 2023 13:13:15 -0300
Subject: [PATCH 10/50] fix(Pension): ORB-2581 - PC81 - ajuste index
---
swagger-apis/pension/index.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/swagger-apis/pension/index.html b/swagger-apis/pension/index.html
index bbcd82315..df9552a08 100644
--- a/swagger-apis/pension/index.html
+++ b/swagger-apis/pension/index.html
@@ -46,7 +46,7 @@
// Begin Swagger UI call region
const ui = SwaggerUIBundle({
urls: [ {"name": "1.0.0-rc1.0", "url": "./1.0.0-rc1.0.yml"},
- {"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"}],
+ {"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"},
{"name": "x.x.x", "url": "./x.x.x.yml"}],
"urls.primaryName": "x.x.x", // default spec
dom_id: '#swagger-ui',
From dcdd1466671e8b59b0e8aa7f2ff3932d600205ca Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 12 May 2023 14:05:31 -0300
Subject: [PATCH 11/50] feat(Pension): ORB-2583 - PC81 - Tipo percentual
aceitar -1.000000
---
dictionary/getPensionRiskCoverages_vx.csv | 4 +-
dictionary/getPensionSurvivalCoverages_vx.csv | 24 ++++-----
swagger-apis/pension/x.x.x.yml | 54 +++++++++----------
3 files changed, 41 insertions(+), 41 deletions(-)
diff --git a/dictionary/getPensionRiskCoverages_vx.csv b/dictionary/getPensionRiskCoverages_vx.csv
index 78d9efb13..d6ae5e552 100644
--- a/dictionary/getPensionRiskCoverages_vx.csv
+++ b/dictionary/getPensionRiskCoverages_vx.csv
@@ -154,7 +154,7 @@ NAO_HA";0;1;"";Não permitido;string;SORTEIO;
/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
IGP_M
INPC
@@ -181,7 +181,7 @@ NA";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
-/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para resgate:
diff --git a/dictionary/getPensionSurvivalCoverages_vx.csv b/dictionary/getPensionSurvivalCoverages_vx.csv
index cbed4a218..54cc8e5ad 100644
--- a/dictionary/getPensionSurvivalCoverages_vx.csv
+++ b/dictionary/getPensionSurvivalCoverages_vx.csv
@@ -64,7 +64,7 @@ VDR
DEMAIS_PRODUTOS_PREVIDENCIA
NA";0;1;"";Não permitido;string;;
/data/defferalPeriod;defferalPeriod;Período de Diferimento;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
2. IGP-M (FGV);
@@ -74,7 +74,7 @@ IGP_M
INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
/data/defferalPeriod/otherMinimumPerformanceGarantees;otherMinimumPerformanceGarantees;Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.;Texto;12;Obrigatório;;;1;1;"";Não permitido;string;SELIC;
-/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/minimumPremiums;minimumPremiums;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
/data/defferalPeriod/minimumPremiums/periodicity;periodicity;;Texto;10;Opcional;;"DIARIO
@@ -124,7 +124,7 @@ NA";0;N;"";Não permitido;array;CARTAO_CREDITO;
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
/data/defferalPeriod/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
-";Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+";Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
@@ -133,7 +133,7 @@ NAO_APLICA
NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/defferalPeriod/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
-";Texto;8;Opcional;^(\d{1}\.\d{6})|(NA)$;;0;1;"";Não permitido;string;0.019800;8
+";Texto;9;Opcional;^(\d{1}\.\d{6})|(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Regra de Elegibilidade
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
@@ -173,7 +173,7 @@ BR_EMSSB_MALE
BR_EMSSB_FEMALE
BR_EMSSB_MALE_FEMALE
NA";0;N;"";Não permitido;array;AT_2000_MALE;
-/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
2. IGP-M (FGV);
@@ -182,7 +182,7 @@ NA";0;N;"";Não permitido;array;AT_2000_MALE;
IGP_M
INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
-/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/grantPeriodBenefit/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
@@ -190,7 +190,7 @@ NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
/data/grantPeriodBenefit/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
-";Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+";Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
@@ -199,7 +199,7 @@ NAO_APLICA
NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/grantPeriodBenefit/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
-";Texto;8;Opcional;^(\d{1}\.\d{6})|(NA)$;;0;1;"";Não permitido;string;0.019800;8
+";Texto;9;Opcional;^(\d{1}\.\d{6})|(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Regra de Elegibilidade
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
@@ -212,11 +212,11 @@ NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
/data/costs;costs;Custos;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/costs/loadingAntecipated;loadingAntecipated;Carregamento antecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/costs/loadingLate;loadingLate;Carregamento postecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
1. Coletivo Averbado;
diff --git a/swagger-apis/pension/x.x.x.yml b/swagger-apis/pension/x.x.x.yml
index aa484fe24..3227576fd 100644
--- a/swagger-apis/pension/x.x.x.yml
+++ b/swagger-apis/pension/x.x.x.yml
@@ -291,12 +291,12 @@ components:
example: EMPRESAAPREV
maximumAdministrationFee:
type: string
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
description: |
Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
example: '0.019800'
- maxLength: 8
+ maxLength: 9
minLength: 8
typePerformanceFee:
type: string
@@ -312,11 +312,11 @@ components:
maxLength: 13
maximumPerformanceFee:
type: string
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
description: |
Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
- maxLength: 8
+ maxLength: 9
minLength: 8
example: '0.019800'
eligibilityRule:
@@ -397,9 +397,9 @@ components:
properties:
interestRate:
type: string
- maxLength: 8
+ maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
description: Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.
example: '0.019800'
updateIndex:
@@ -411,9 +411,9 @@ components:
maxLength: 12
reversalFinancialResults:
type: string
- maxLength: 8
+ maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
description: Percentual de reversão de excedente financeiro na concessão. Em %.
example: '0.019800'
minimumPremiums:
@@ -555,15 +555,15 @@ components:
properties:
minValue:
type: string
- pattern: '^(\d{1}\.\d{6})|(NA)$'
- maxLength: 8
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ maxLength: 9
minLength: 8
description: Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.
example: '0.019800'
maxValue:
type: string
- pattern: '^(\d{1}\.\d{6})|(NA)$'
- maxLength: 8
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ maxLength: 9
minLength: 8
description: Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.
example: '0.019800'
@@ -577,14 +577,14 @@ components:
properties:
minValue:
type: string
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
maxLength: 8
minLength: 8
description: Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.
example: '0.019800'
maxValue:
type: string
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
maxLength: 8
minLength: 8
description: Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.
@@ -689,18 +689,18 @@ components:
example: AT_2000_MALE
interestRate:
type: string
- maxLength: 8
+ maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
description: Taxa de juros garantida utilizada para conversão em renda. Em %
example: '0.019800'
updateIndex:
$ref: '#/components/schemas/UpdateIndex'
reversalFinancialResults:
type: string
- maxLength: 8
+ maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
description: Percentual de reversão de excedente financeiro na concessão. Em %.
example: '0.019800'
investmentFunds:
@@ -720,35 +720,35 @@ components:
maxLength: 2000
description: URI completo que gerou a resposta atual.
example: 'https://api.banco.com.br/open-banking/api/v1/resource'
- pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
first:
type: string
format: uri
maxLength: 2000
description: URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
example: 'https://api.banco.com.br/open-banking/api/v1/resource'
- pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
prev:
type: string
format: uri
maxLength: 2000
description: "URI da página anterior dessa lista de resultados. Restrição - \tObrigatório quando não for a primeira página da resposta"
example: 'https://api.banco.com.br/open-banking/api/v1/resource'
- pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
next:
type: string
format: uri
maxLength: 2000
description: URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
example: 'https://api.banco.com.br/open-banking/api/v1/resource'
- pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
last:
type: string
format: uri
maxLength: 2000
description: URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
example: 'https://api.banco.com.br/open-banking/api/v1/resource'
- pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
additionalProperties: false
PensionParticipant:
type: object
@@ -1069,8 +1069,8 @@ components:
example: 12
percentage:
type: string
- pattern: '^(\d{1}\.\d{6})|(NA)$'
- maxLength: 8
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ maxLength: 9
minLength: 8
description: Percentual de faixa de resgate.
example: '0.019800'
@@ -1082,9 +1082,9 @@ components:
properties:
interestRate:
type: string
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
description: Taxa de juros para capitalização da PMBaC
- maxLength: 8
+ maxLength: 9
minLength: 8
example: '0.019800'
updateIndexes:
From 4a64187cdcad0b848028743829289a5bc3f239df Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 12 May 2023 14:08:23 -0300
Subject: [PATCH 12/50] feat(Pension): ORB-2584 - PC81 - Tornar campos tipo
boolean opcionais
---
dictionary/getPensionSurvivalCoverages_vx.csv | 4 ++--
swagger-apis/pension/x.x.x.yml | 2 --
2 files changed, 2 insertions(+), 4 deletions(-)
diff --git a/dictionary/getPensionSurvivalCoverages_vx.csv b/dictionary/getPensionSurvivalCoverages_vx.csv
index 54cc8e5ad..799ccb44f 100644
--- a/dictionary/getPensionSurvivalCoverages_vx.csv
+++ b/dictionary/getPensionSurvivalCoverages_vx.csv
@@ -107,7 +107,7 @@ NA";0;N;"";Não permitido;array;CARTAO_CREDITO;
/data/defferalPeriod/permissionScheduledFinancialPayments;permissionScheduledFinancialPayments;"Se ficam permitidos pagamentos financeiros programados. A considerar os seguintes domínios:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/defferalPeriod/gracePeriod;gracePeriod;Prazo de carência;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/defferalPeriod/gracePeriod/redemption;redemption;"Prazo em dias de carência para resgate Para Coletivos: Valor máximo da carência.
";Número;;Obrigatório;;;1;1;"";Não permitido;number;100;
@@ -229,7 +229,7 @@ NA";1;1;"";Não permitido;string;COLETIVO_AVERBADO;
/data/minimumRequirement/participantQualified;participantQualified;"Indicação se o plano é destinado para participante qualificado. A considerar os domínios abaixo:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
diff --git a/swagger-apis/pension/x.x.x.yml b/swagger-apis/pension/x.x.x.yml
index 3227576fd..27e2e5b62 100644
--- a/swagger-apis/pension/x.x.x.yml
+++ b/swagger-apis/pension/x.x.x.yml
@@ -348,7 +348,6 @@ components:
type: object
required:
- contractType
- - participantQualified
- contractingMinRequirement
properties:
contractType:
@@ -391,7 +390,6 @@ components:
- updateIndex
- otherMinimumPerformanceGarantees
- reversalFinancialResults
- - permissionScheduledFinancialPayments
- redemptionPaymentTerm
- portabilityPaymentTerm
properties:
From 529e1c1b89f4f8c0dcc5dccbe2459cac99a1fd91 Mon Sep 17 00:00:00 2001
From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com>
Date: Fri, 12 May 2023 17:14:48 +0000
Subject: [PATCH 13/50] feat(Capitalization Bonds): ORB-2578 - PC81 - Tipo
percentual
---
.../capitalizationBondsGetProducts_vx.csv | 12 +++++-----
swagger-apis/capitalization-bonds/x.x.x.yml | 24 +++++++++----------
2 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/dictionary/capitalizationBondsGetProducts_vx.csv b/dictionary/capitalizationBondsGetProducts_vx.csv
index 559c49eb9..5b21691f9 100644
--- a/dictionary/capitalizationBondsGetProducts_vx.csv
+++ b/dictionary/capitalizationBondsGetProducts_vx.csv
@@ -45,9 +45,9 @@ NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/quotas;quotas;Informações relativas às taxas da Quotas praticadas para cada Parcela;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/quotas/quota;quota;Número da parcela.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;(^\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;(^\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/validity;validity;Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.;Inteiro;3;Opcional;;;0;1;"";Não permitido;integer;48;
/data/serieSize;serieSize;Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;5000000;
/data/capitalizationPeriod;capitalizationPeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
@@ -99,7 +99,7 @@ Lista com os valores permitidos de contribuição ao plano.
/data/capitalizationPeriod/earlyRedemptions;earlyRedemptions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/capitalizationPeriod/earlyRedemptions/quota;quota;Parcela relativa ao Resgate Antecipado;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
-/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/gracePeriodRedemption;gracePeriodRedemption;Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;48;
/data/latePayment;latePayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/latePayment/suspensionMonths;suspensionMonths;Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
@@ -138,8 +138,8 @@ INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
OUTROS
NA";1;1;"";Não permitido;string;IPCA;
/data/contributionPayment/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
-/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
-/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;8;Obrigatório;(^\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;(^\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;9;Obrigatório;(^\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/draws;draws;Informações relativas aos Sorteios;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/draws/timeInterval;timeInterval;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
- UNICO
diff --git a/swagger-apis/capitalization-bonds/x.x.x.yml b/swagger-apis/capitalization-bonds/x.x.x.yml
index b23085a60..43b11525d 100644
--- a/swagger-apis/capitalization-bonds/x.x.x.yml
+++ b/swagger-apis/capitalization-bonds/x.x.x.yml
@@ -126,15 +126,15 @@ components:
redemptionPercentageEndTerm:
type: string
description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
- maxLength: 8
+ maxLength: 9
minLength: 8
- pattern: '(^\d{1}\.\d{6})|(NA)$'
+ pattern: '(^\d{1}\.\d{6})|(-1.000000)$'
example: '0.019800'
finalRedemptionRate:
type: string
description: Valor percentual (%) de resgate final permitido.
- pattern: '(^\d{1}\.\d{6})|(NA)$'
- maxLength: 8
+ pattern: '(^\d{1}\.\d{6})|(-1.000000)$'
+ maxLength: 9
minLength: 8
example: '0.019800'
draws:
@@ -282,23 +282,23 @@ components:
capitalizationQuota:
type: string
description: Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).
- maxLength: 8
+ maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
example: '0.019800'
raffleQuota:
type: string
description: 'Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).'
- maxLength: 8
+ maxLength: 9
minLength: 8
- pattern: '(^\d{1}\.\d{6})|(NA)$'
+ pattern: '(^\d{1}\.\d{6})|(-1.000000)$'
example: '0.019800'
chargingQuota:
type: string
description: 'Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).'
- maxLength: 8
+ maxLength: 9
minLength: 8
- pattern: '(^\d{1}\.\d{6})|(NA)$'
+ pattern: '(^\d{1}\.\d{6})|(-1.000000)$'
example: '0.019800'
additionalProperties: false
CapitalizationBondsProductCapitalizationPeriod:
@@ -356,9 +356,9 @@ components:
redemptionPercentageEndTerm:
type: string
description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
- maxLength: 8
+ maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
example: '0.019800'
gracePeriodRedemption:
type: number
From bf93456c11d83b9df6cf03194619d8e907f23bf6 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 12 May 2023 14:22:30 -0300
Subject: [PATCH 14/50] fix(Pension): ORB-2583 - PC81 - maxLength campos
percentual
---
dictionary/getPensionSurvivalCoverages_vx.csv | 4 ++--
swagger-apis/pension/x.x.x.yml | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/dictionary/getPensionSurvivalCoverages_vx.csv b/dictionary/getPensionSurvivalCoverages_vx.csv
index 54cc8e5ad..ea72938d2 100644
--- a/dictionary/getPensionSurvivalCoverages_vx.csv
+++ b/dictionary/getPensionSurvivalCoverages_vx.csv
@@ -215,8 +215,8 @@ NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/costs/loadingLate;loadingLate;Carregamento postecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
1. Coletivo Averbado;
diff --git a/swagger-apis/pension/x.x.x.yml b/swagger-apis/pension/x.x.x.yml
index 3227576fd..dedbec6e4 100644
--- a/swagger-apis/pension/x.x.x.yml
+++ b/swagger-apis/pension/x.x.x.yml
@@ -578,14 +578,14 @@ components:
minValue:
type: string
pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
- maxLength: 8
+ maxLength: 9
minLength: 8
description: Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.
example: '0.019800'
maxValue:
type: string
pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
- maxLength: 8
+ maxLength: 9
minLength: 8
description: Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.
example: '0.019800'
From 9984b7755e475226a25816eb8d286c66591655a5 Mon Sep 17 00:00:00 2001
From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com>
Date: Fri, 12 May 2023 17:36:10 +0000
Subject: [PATCH 15/50] feat(Capitalization Bonds): ORB-2578 - PC81 - Tipo
percentual
---
dictionary/capitalizationBondsGetProducts_vx.csv | 6 +++---
swagger-apis/capitalization-bonds/x.x.x.yml | 12 ++++++------
2 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/dictionary/capitalizationBondsGetProducts_vx.csv b/dictionary/capitalizationBondsGetProducts_vx.csv
index 5b21691f9..5f2b2135c 100644
--- a/dictionary/capitalizationBondsGetProducts_vx.csv
+++ b/dictionary/capitalizationBondsGetProducts_vx.csv
@@ -51,7 +51,7 @@ NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
/data/validity;validity;Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.;Inteiro;3;Opcional;;;0;1;"";Não permitido;integer;48;
/data/serieSize;serieSize;Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;5000000;
/data/capitalizationPeriod;capitalizationPeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
";Texto;37;Obrigatório;;"IPCA
IGPM
@@ -98,7 +98,7 @@ Lista com os valores permitidos de contribuição ao plano.
";Número;;Obrigatório;;;1;1;"";Não permitido;number;5000;
/data/capitalizationPeriod/earlyRedemptions;earlyRedemptions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/capitalizationPeriod/earlyRedemptions/quota;quota;Parcela relativa ao Resgate Antecipado;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/gracePeriodRedemption;gracePeriodRedemption;Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;48;
/data/latePayment;latePayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
@@ -178,7 +178,7 @@ desde que atingidos os requisitos definidos nas condições gerais do plano. Con
2. false
";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
/data/draws/ruleDescription;ruleDescription;Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.;Texto;200;Opcional;;;0;1;"";Não permitido;string;Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.;
-/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;8;Obrigatório;^(\d{1}\.\d{6})|(NA)$;;1;1;"";Não permitido;string;0.019800;8
+/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
/data/minimumRequirementDetails;minimumRequirementDetails;"Campo aberto (possibilidade de incluir URL).
Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
diff --git a/swagger-apis/capitalization-bonds/x.x.x.yml b/swagger-apis/capitalization-bonds/x.x.x.yml
index 43b11525d..c516437db 100644
--- a/swagger-apis/capitalization-bonds/x.x.x.yml
+++ b/swagger-apis/capitalization-bonds/x.x.x.yml
@@ -313,9 +313,9 @@ components:
properties:
interestRate:
type: string
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
description: 'Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).'
- maxLength: 8
+ maxLength: 9
minLength: 8
example: '0.019800'
updateIndex:
@@ -348,9 +348,9 @@ components:
rate:
type: string
description: Taxa relativa ao Resgate Antecipado
- maxLength: 8
+ maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
example: '0.019800'
additionalProperties: false
redemptionPercentageEndTerm:
@@ -598,9 +598,9 @@ components:
example: Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.
minimumContemplationProbability:
type: string
- pattern: '^(\d{1}\.\d{6})|(NA)$'
+ pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
description: 'Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).'
- maxLength: 8
+ maxLength: 9
minLength: 8
example: '0.019800'
additionalProperties: false
From 778d4246743d22dbf52d7e6f79c5c3f4e097de64 Mon Sep 17 00:00:00 2001
From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com>
Date: Fri, 12 May 2023 17:42:06 +0000
Subject: [PATCH 16/50] feat(Capitalization Bonds): ORB-2579 - PC81 - Tipo
boolean opicionais
---
dictionary/capitalizationBondsGetProducts_vx.csv | 6 +++---
swagger-apis/capitalization-bonds/x.x.x.yml | 3 ---
2 files changed, 3 insertions(+), 6 deletions(-)
diff --git a/dictionary/capitalizationBondsGetProducts_vx.csv b/dictionary/capitalizationBondsGetProducts_vx.csv
index 5f2b2135c..24ffab827 100644
--- a/dictionary/capitalizationBondsGetProducts_vx.csv
+++ b/dictionary/capitalizationBondsGetProducts_vx.csv
@@ -106,7 +106,7 @@ Lista com os valores permitidos de contribuição ao plano.
/data/latePayment/periodExtensionOption;periodExtensionOption;"Alteração do prazo de vigência original, pela suspensão (não aplicável a pagamento único). A considerar os seguintes domínios:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/contributionPayment;contributionPayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/contributionPayment/paymentMethod;paymentMethod;"Meio de Pagamento utilizado para pagamento da contribuição. A considerar os domínios abaixo:
1. Cartão de Crédito
@@ -171,12 +171,12 @@ NA";1;1;"";Não permitido;string;UNICO;
/data/draws/earlySettlementRaffle;earlySettlementRaffle;"Modelo de sorteio que acarreta, ao título contemplado, o seu resgate total obrigatório (Resolução Normativa 384/20). Conforme os domínios:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/draws/mandatoryContemplation;mandatoryContemplation;"Possibilidade de realização de sorteio com previsão de que o título sorteado seja obrigatoriamente um título comercializado,
desde que atingidos os requisitos definidos nas condições gerais do plano. Conforme os domínios:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/draws/ruleDescription;ruleDescription;Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.;Texto;200;Opcional;;;0;1;"";Não permitido;string;Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.;
/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
diff --git a/swagger-apis/capitalization-bonds/x.x.x.yml b/swagger-apis/capitalization-bonds/x.x.x.yml
index c516437db..eb71978f6 100644
--- a/swagger-apis/capitalization-bonds/x.x.x.yml
+++ b/swagger-apis/capitalization-bonds/x.x.x.yml
@@ -457,7 +457,6 @@ components:
type: object
required:
- suspensionMonths
- - periodExtensionOption
properties:
suspensionMonths:
type: number
@@ -525,8 +524,6 @@ components:
- timeInterval
- quantity
- prizeMultiplier
- - earlySettlementRaffle
- - mandatoryContemplation
- minimumContemplationProbability
properties:
timeInterval:
From 2d94e8a4d746fc4c0608e24d7e27be250bfdcdda Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 12 May 2023 18:18:56 -0300
Subject: [PATCH 17/50] feat(Insurance): ORB-2586 - PC81 - Tipo enum aceitar NA
---
dictionary/getPersonalInsurance_vx.csv | 316 +++++++
swagger-apis/insurances/index.html | 5 +-
swagger-apis/insurances/x.x.x.yml | 1200 ++++++++++++++++++++++++
3 files changed, 1519 insertions(+), 2 deletions(-)
create mode 100644 dictionary/getPersonalInsurance_vx.csv
create mode 100644 swagger-apis/insurances/x.x.x.yml
diff --git a/dictionary/getPersonalInsurance_vx.csv b/dictionary/getPersonalInsurance_vx.csv
new file mode 100644
index 000000000..a5b2ee94c
--- /dev/null
+++ b/dictionary/getPersonalInsurance_vx.csv
@@ -0,0 +1,316 @@
+Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
+/data;data;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
+/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link 'urlComplementaryList', deve ser array de objeto com a estrutura abaixo:
+- 'name' com o valor contido no campo 'LegalEntityName' conforme cadastro no diretório;
+- 'cnpjNumber' com o valor contido no campo CNPJ ('RegistrationNumber') correspondente a esta instituição;
+- Ambos do tipo string;
+- Ambos obrigatórios.
+";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/brand;brand;Nome da marca reportada pela sociedade seguradora participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Marca;
+/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
+/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
+/data/category;category;"Indicar a categoria do Produto:
- Tradicional
- Microsseguro
";Texto;12;Opcional;;"TRADICIONAL
+MICROSSEGURO
+NA";0;1;"";Não permitido;string;TRADICIONAL;
+/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
+PRESTAMISTA
+VIAGEM
+EDUCACIONAL
+DOTAL
+ACIDENTES_PESSOAIS
+VIDA
+PERDA_CERTIFICADO_HABILITACAO_VOO
+DOENCAS_GRAVES_DOENCA_TERMINAL
+DESEMPREGO_PERDA_RENDA
+EVENTOS_ALEATORIOS
+PECULIO
+PENSAO_PRAZO_CERTO
+PENSAO_MENORES_21
+PENSAO_MENORES_24
+PENSAO_CONJUGE_VITALICIA
+PENSAO_CONJUGE_TEMPORARIA
+NA";1;1;"";Não permitido;string;FUNERAL;
+/data/coverages;coverages;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/coverages/type;type;É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura ;Texto;62;Obrigatório;;"ADIANTAMENTO_DOENCA_ESTAGIO_TERMINAL
+AUXILIO_CESTA_BASICA
+AUXILIO_FINANCEIRO_IMEDIATO
+CANCELAMENTO_VIAGEM
+CIRURGIA
+COBERTURA_HERNIA
+COBERTURA_LER_DORT
+CUIDADOS_PROLONGADOS_ACIDENTE
+DESEMPREGO_PERDA_RENDA
+DESPESAS_EXTRA_INVALIDEZ_PERMANENTE_TOTAL_PARCIAL_ACIDENTE_DEI
+DESPESAS_EXTRA_MORTE_DEM
+DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS
+DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS_BRASIL
+DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS_EXTERIOR
+DIARIA_INCAPACIDADE_TOTAL_TEMPORARIA
+DIARIA_INTERNACAO_HOSPITALAR
+INTERNACAO_HOSPITALAR
+DIARIAS_INCAPACIDADE_PECUNIARIA_DIP
+DOENCA_CONGENITA_FILHOS_DCF
+FRATURA_OSSEA
+DOENCAS_TROPICAIS
+INCAPACIDADE_TOTAL_OU_TEMPORARIA
+INVALIDEZ_PERMANENTE_TOTAL_PARCIAL
+INVALIDEZ_TOTAL_ACIDENTE
+INVALIDEZ_PARCIAL_ACIDENTE
+INVALIDEZ_FUNCIONAL_PERMANENTE_DOENCA
+INVALIDEZ_LABORATIVA_DOENCA
+MORTE
+MORTE_ACIDENTAL
+MORTE_CONJUGE
+MORTE_FILHOS
+MORTE_ADIATAMENTO_DOENCA_ESTAGIO_TERMINAL
+PAGAMENTO_ANTECIPADO_ESPECIAL_DOENCA_PROFISSIONAL_PAED
+PERDA_AUTONOMIA_PESSOAL
+PERDA_INVOLUNTARIA_EMPREGO
+QUEIMADURA_GRAVE
+REGRESSO_ANTECIPADO_SANITARIO
+RENDA_INCAPACIDADE_TEMPORARIA
+RESCISAO_CONTRATUAL_CASO_MORTE_RCM
+RESCISAO_TRABALHISTA
+SERVICO_AUXILIO_FUNERAL
+SOBREVIVENCIA
+TRANSPLANTE_ORGAOS
+TRASLADO
+TRANSLADO_CORPO
+VERBA_RESCISORIA
+DOENCA_GRAVE
+TRANSLADO_MEDICO
+OUTROS
+NA";1;1;"";Não permitido;string;INVALIDEZ_PERMANENTE_TOTAL_PARCIAL;
+/data/coverages/typeAdditionalInfos;typeAdditionalInfos;"Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
+Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
+";Lista;100;Opcional;;;0;N;"";Não permitido;array;;
+/data/coverages/attributes;attributes;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/coverages/attributes/indemnityPaymentMethods;indemnityPaymentMethods;Listagem da forma de pagamento da indenização para cada combinação de modalidade/cobertura do produto.;Lista;42;Obrigatório;;"PAGAMENTO_CAPITAL_SEGURADO_VALOR_MONETARIO
+REEMBOLSO_DESPESAS
+PRESTACAO_SERVICOS
+NA";1;N;"";Não permitido;array;;
+/data/coverages/attributes/indemnityPaymentFrequencies;indemnityPaymentFrequencies;Listagem de tipos de frequência de pagamento de indenização para cada combinação de modalidade/cobertura do produto.;Lista;17;Obrigatório;;"INDENIZACAO_UNICA
+DIARIA_OU_PARCELA
+NA";1;N;"";Não permitido;array;INDENIZACAO_UNICA;
+/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/indemnifiablePeriods;indemnifiablePeriods;Listagem de período indenizável para cada combinação de modalidade/cobertura do produto.;Lista;50;Obrigatório;;;1;N;"";Não permitido;array;ATE_FIM_CICLO_DETERMINADO;
+/data/coverages/attributes/maximumQtyIndemnifiableInstallments;maximumQtyIndemnifiableInstallments;Caso o período indenizável seja relacionado a parcelas, listagem de número máximo de parcelas indenizáveis para cada combinação de modalidade/ cobertura do produto.;Inteiro;10;Obrigatório;;;1;1;"";Não permitido;integer;10;
+/data/coverages/attributes/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/coverages/attributes/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Opcional;;;0;1;"";Não permitido;integer;90;
+/data/coverages/attributes/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Opcional;;"DIAS
+MESES
+NAO_APLICA";0;1;"";Não permitido;string;MESES;
+/data/coverages/attributes/gracePeriod/details;details;;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Descrições adicionais do período de carência;
+/data/coverages/attributes/differentiatedGracePeriod;differentiatedGracePeriod;Campo aberto para detalhamento de período de carência diferenciado, se houver.;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;90 DIAS;
+/data/coverages/attributes/deductibleDays;deductibleDays;Listagem de franquia em dias para cada combinação de modalidade/cobertura do produto.;Inteiro;10;Obrigatório;;;1;1;"";Não permitido;integer;10;
+/data/coverages/attributes/differentiatedDeductibleDays;differentiatedDeductibleDays;Detalhamento da franquia em dias diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;15;
+/data/coverages/attributes/deductible;deductible;Listagem de franquia em reais para cada combinação de modalidade/cobertura do produto.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/coverages/attributes/deductible/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/deductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/differentiatedDeductible;differentiatedDeductible;Detalhamento da franquia em reais diferentes para cada cobertura que exista alguma especificidade.
Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/coverages/attributes/differentiatedDeductible/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/differentiatedDeductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/excludedRisks;excludedRisks;;Lista;40;Obrigatório;;"ATO_RECONHECIMENTO_PERIGOSO
+ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
+OPERACOES_GUERRA
+FURACOES_CICLONES_TERREMOTOS
+MATERIAL_NUCLEAR
+DOENCAS_LESOES_PREEXISTENTES
+EPIDEMIAS_PANDEMIAS
+SUICIDIO
+ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
+OUTROS
+NA";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
+/data/coverages/attributes/excludedRisksURL;excludedRisksURL;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
+/data/coverages/attributes/allowApartPurchase;allowApartPurchase;"Indicar se a cobertura pode ser contratada isoladamente ou não:
+ 1. true
+ 2. false
+";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;;
+/data/assistanceTypes;assistanceTypes;;Lista;43;Opcional;;"ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
+ARQUITETO_VIRTUAL
+ASSESSORIA_FINANCEIRA
+AUTOMOVEL
+AUXILIO_NATALIDADE
+AVALIACAO_CLINICA_PREVENTIVA
+BOLSA_PROTEGIDA
+CESTA_BASICA
+CHECKUP_ODONTOLOGICO
+CLUBE_VANTAGENS_BENEFICIOS
+CONVALESCENCIA
+DECESSO
+DESCONTO_FARMACIAS_MEDICAMENTOS
+DESPESAS_FARMACEUTICAS_VIAGEM
+DIGITAL
+EDUCACIONAL
+EMPRESARIAL
+ENCANADOR
+ENTRETENIMENTO
+EQUIPAMENTOS_MEDICOS
+FIANCAS_DESPESAS_LEGAIS
+FISIOTERAPIA
+FUNERAL
+HELP_LINE
+HOSPEDAGEM_ACOMPANHANTE
+INTERRUPCAO_VIAGEM
+INVENTARIO
+MAIS_VIDA
+MAMAE_BEBE
+MEDICA_ACIDENTE_DOENCA
+MOTOCICLETA
+MULHER
+NUTRICIONISTA
+ODONTOLOGICA
+ORIENTACAO_FITNESS
+ORIENTACAO_JURIDICA
+ORIENTACAO_NUTRICIONAL
+PERSONAL_FITNESS
+ORIENTACAO_PSICOSSOCIAL_FAMILIAR
+PERDA_ROUBO_CARTAO
+PET
+PRORROGACAO_ESTADIA
+PROTECAO_DADOS
+RECOLOCACAO_PROFISSIONAL
+REDE_DESCONTO_NUTRICIONAL
+RESIDENCIAL
+RETORNO_MENORES_SEGURADO
+SAQUE_COACAO
+SAUDE_BEM_ESTAR
+SEGUNDA_OPINIAO_MEDICA
+SENIOR
+SUSTENTAVEL_DESCARTE_ECOLOGICO
+TELEMEDICINA
+VIAGEM
+VITIMA
+OUTROS
+NA";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
+/data/assistanceTypesAdditionalInfos;assistanceTypesAdditionalInfos;Lista a ser preenchido pelas participantes quando houver ‘Outros’ no campo ‘Tipo de Assistência’;Lista;;Opcional;;;0;N;"";Não permitido;array;;
+/data/additionals;additionals;;Lista;44;Obrigatório;;"SORTEIO
+SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
+SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
+OUTROS
+NAO_HA";1;N;"";Não permitido;array;SORTEIO;
+/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
+/data/globalCapital;globalCapital;"A considerar os seguintes domínios:
+ 1. true
+ 2. false
+";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+/data/terms;terms;;Lista;23;Obrigatório;;"VITALICIA
+TEMPORARIA_PRAZO_FIXO
+TEMPORARIA_INTERMITENTE
+NA";1;N;"";Não permitido;array;VITALICIA;
+/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.019800;8
+/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
+IGP_M
+INPC
+NA";0;N;"";Não permitido;array;IPCA;
+/data/benefitRecalculation;benefitRecalculation;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/benefitRecalculation/criterias;criterias;;Lista;;Obrigatório;;"INDICE
+VINCULADO_SALDO_DEVEDOR
+VARIAVEL_ACORDO_CRITERIO_ESPECIFICO
+NA";1;N;"";Não permitido;array;;
+/data/benefitRecalculation/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
+IGP_M
+INPC
+NA";0;N;"";Não permitido;array;IPCA;
+/data/ageAdjustment;ageAdjustment;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/ageAdjustment/criterias;criterias;;Lista;27;Obrigatório;;"APOS_PERIODO_ANOS
+CADA_PERIODO_ANOS
+MUDANCA_FAIXA_ETARIA
+NAO_APLICAVEL";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
+/data/ageAdjustment/frequency;frequency;Período em anos, caso critério de reenquadramento após ou a cada período em anos.;Inteiro;3;Obrigatório;;;1;1;"";Não permitido;integer;10;
+/data/financialRegimes;financialRegimes;;Lista;19;Obrigatório;;"REPARTICAO_SIMPLES
+REPARTICAO_CAPITAIS
+CAPITALIZACAO
+NA";1;N;"";Não permitido;array;REPARTICAO_SIMPLES;
+/data/reclaim;reclaim;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
+/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
+/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
+/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
+/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
+/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
+MESES
+NAO_APLICA";1;1;"";Não permitido;string;MESES;
+/data/reclaim/gracePeriod/details;details;;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Descrições adicionais do período de carência;
+/data/reclaim/differenciatedPercentage;differenciatedPercentage;Campo aberto (possibilidade de incluir URL);"";1024;Opcional;;;0;1;"";Não permitido;;"https://openinsurance.com.br/aaa’
+Obs.: Exceção de cobertura ou critério definido acima será descrito aqui na URL
+Exemplo: Cobertura X: a partir de 25 meses = 100%
+";
+/data/otherGuaranteedValues;otherGuaranteedValues;;Lista;20;Opcional;;"SALDAMENTO
+BENEFICIO_PROLONGADO
+NAO_APLICA";0;N;"";Não permitido;array;SALDAMENTO;
+/data/allowPortability;allowPortability;"1. true
+2. false
+";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;;
+/data/portabilityGraceTime;portabilityGraceTime;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/portabilityGraceTime/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
+/data/portabilityGraceTime/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
+MESES
+NAO_APLICA";1;1;"";Não permitido;string;MESES;
+/data/indemnityPaymentMethods;indemnityPaymentMethods;;Lista;18;Obrigatório;;"UNICO
+SOB_FORMA_RENDA
+NA";1;N;"";Não permitido;array;UNICO;
+/data/indemnityPaymentIncomes;indemnityPaymentIncomes;;Lista;38;Opcional;;"CERTA
+TEMPORARIA
+TEMPORARIA_REVERSIVEL
+TEMPORARIO_MINIMO_GARANTIDO
+TEMPORARIA_REVERSIVEL_MINIMO_GARANTIDO
+VITALICIA
+VITALICIA_REVERSIVEL
+VITALICIA_MINIMO_GARANTIDO
+VITALICIA_REVERSIVEL_MINIMO_GARANTIDO
+NA";0;N;"";Não permitido;array;CERTA;
+/data/premiumPayment;premiumPayment;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/premiumPayment/paymentMethods;paymentMethods;;Lista;27;Obrigatório;;"CARTAO_CREDITO
+CARTAO_DEBITO
+DEBITO_CONTA_CORRENTE
+DEBITO_CONTA_POUPANCA
+BOLETO_BANCARIO
+PIX
+CONSIGNACAO_FOLHA_PAGAMENTO
+PONTOS_PROGRAMA_BENEFICIO
+REGRA_PARCEIRO
+NA";1;N;"";Não permitido;array;CARTAO_CREDITO;
+/data/premiumPayment/frequencies;frequencies;;Lista;10;Obrigatório;;"DIARIA
+MENSAL
+UNICA
+ANUAL
+TRIMESTRAL
+SEMESTRAL
+FRACIONADO
+OUTRA
+NA";1;N;"";Não permitido;array;DIARIA;
+/data/premiumPayment/contributionTax;contributionTax;Distribuição de frequência relativa aos valores referentes às taxas cobradas, nos termos do Anexo III.;Texto;500;Opcional;;;0;1;"";Não permitido;string;;
+/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
+/data/minimumRequirement/contractType;contractType;"A considerar os domínios abaixo:
+ 1. Coletivo;
+ 2. Individual
+";Texto;10;Obrigatório;;"COLETIVO
+INDIVIDUAL
+NA";1;1;"";Não permitido;string;COLETIVO;
+/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
+/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. Ambas (Pessoa Natural e Jurídica)
+";Texto;23;Obrigatório;;"PESSOA_NATURAL
+PESSOA_JURIDICA
+PESSOA_NATURAL_JURIDICA
+NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/swagger-apis/insurances/index.html b/swagger-apis/insurances/index.html
index 2b7cf310a..df9552a08 100644
--- a/swagger-apis/insurances/index.html
+++ b/swagger-apis/insurances/index.html
@@ -46,8 +46,9 @@
// Begin Swagger UI call region
const ui = SwaggerUIBundle({
urls: [ {"name": "1.0.0-rc1.0", "url": "./1.0.0-rc1.0.yml"},
- {"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"}],
- "urls.primaryName": "1.0.0-rc2.0", // default spec
+ {"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"},
+ {"name": "x.x.x", "url": "./x.x.x.yml"}],
+ "urls.primaryName": "x.x.x", // default spec
dom_id: '#swagger-ui',
deepLinking: true,
supportedSubmitMethods:[],
diff --git a/swagger-apis/insurances/x.x.x.yml b/swagger-apis/insurances/x.x.x.yml
new file mode 100644
index 000000000..ec08eaa42
--- /dev/null
+++ b/swagger-apis/insurances/x.x.x.yml
@@ -0,0 +1,1200 @@
+openapi: 3.0.0
+info:
+ title: API Seguros - Open Finance Brasil
+ description: |
+ As APIs descritas neste documento são referentes a API de Seguros da fase OpenInsurance do Open Finance Brasil.
+ version: x.x.x
+ license:
+ name: Apache 2.0
+ url: 'https://www.apache.org/licenses/LICENSE-2.0'
+ contact:
+ name: Governança do Open Finance Brasil – Especificações
+ email: gt-interfaces@openbankingbr.org
+ url: 'https://openbanking-brasil.github.io/areadesenvolvedor/'
+servers:
+ - url: 'https://api.banco.com.br/open-banking/opendata-insurance/v1'
+ description: Servidor de Produção
+ - url: 'https://apih.banco.com.br/open-banking/opendata-insurance/v1'
+ description: Servidor de Homologação
+tags:
+ - name: Seguros
+ description: 'Operações para consulta de informações de seguros automotivos, residenciais e pessoais'
+paths:
+ /personals:
+ get:
+ tags:
+ - Seguros
+ summary: Conjunto de informações referentes a seguros pessoais de uma instituição
+ operationId: getPersonalInsurance
+ description: Método para obter a lista de todos os seguros pessoais de uma instituição
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/pageSize'
+ responses:
+ '200':
+ $ref: '#/components/responses/OKResponsePersonalInsuranceList'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '405':
+ $ref: '#/components/responses/MethodNotAllowed'
+ '429':
+ $ref: '#/components/responses/TooManyRequests'
+ '500':
+ $ref: '#/components/responses/InternalServerError'
+ '529':
+ $ref: '#/components/responses/SiteIsOverloaded'
+components:
+ schemas:
+ Participant:
+ type: object
+ description: Conjunto de informações relativas ao participante do produto de Open Finance
+ required:
+ - brand
+ - name
+ - cnpjNumber
+ properties:
+ brand:
+ type: string
+ description: 'Nome da marca reportada pelo participante do Open Finance. 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.'
+ maxLength: 80
+ example: Organização
+ name:
+ type: string
+ description: Nome do participante do Open Finance.
+ maxLength: 80
+ example: Organização A1
+ cnpjNumber:
+ $ref: '#/components/schemas/CnpjNumber'
+ urlComplementaryList:
+ type: string
+ description: |
+ Espera-se que valor de retorno, após acesso ao link 'urlComplementaryList', deve ser array de objeto com a estrutura abaixo:
+ - 'name' com o valor contido no campo 'LegalEntityName' conforme cadastro no diretório;
+ - 'cnpjNumber' com o valor contido no campo CNPJ ('RegistrationNumber') correspondente a esta instituição;
+ - Ambos do tipo string;
+ - Ambos obrigatórios.
+ maxLength: 1024
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ example: 'https://empresaa1.com/companies'
+ additionalProperties: false
+ CnpjNumber:
+ type: string
+ description: '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.'
+ pattern: '^\d{14}$'
+ example: '13456789000112'
+ CurrencyCode:
+ type: string
+ pattern: '^[A-Z]{3}$'
+ maxLength: 3
+ description: 'Moeda referente ao valor monetário, seguindo o modelo ISO-4217.'
+ example: BRL
+ InsurancePensionMinValue:
+ type: object
+ required:
+ - amount
+ - currency
+ description: 'Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.'
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^\d{1,16}\.\d{2,4}$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ InsurancePensionMaxValue:
+ type: object
+ required:
+ - amount
+ - currency
+ description: 'Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.'
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^\d{1,16}\.\d{2,4}$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ GracePeriod:
+ type: object
+ required:
+ - amount
+ - unit
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: Informar o prazo de carência
+ example: 90
+ maximum: 9999999999
+ unit:
+ $ref: '#/components/schemas/EnumGracePeriodUnit'
+ details:
+ type: string
+ maxLength: 500
+ pattern: '[\w\W\s]*'
+ example: Descrições adicionais do período de carência
+ additionalProperties: false
+ TermsAndConditionsItem:
+ type: object
+ required:
+ - susepProcessNumber
+ - detail
+ properties:
+ susepProcessNumber:
+ type: string
+ description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
+ minLength: 12
+ maxLength: 20
+ pattern: '^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$'
+ example: 15414.622222/2222-22
+ detail:
+ type: string
+ description: 'Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL)'
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ EnumProductModality:
+ type: string
+ description: - Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
+ maxLength: 33
+ enum:
+ - FUNERAL
+ - PRESTAMISTA
+ - VIAGEM
+ - EDUCACIONAL
+ - DOTAL
+ - ACIDENTES_PESSOAIS
+ - VIDA
+ - PERDA_CERTIFICADO_HABILITACAO_VOO
+ - DOENCAS_GRAVES_DOENCA_TERMINAL
+ - DESEMPREGO_PERDA_RENDA
+ - EVENTOS_ALEATORIOS
+ - PECULIO
+ - PENSAO_PRAZO_CERTO
+ - PENSAO_MENORES_21
+ - PENSAO_MENORES_24
+ - PENSAO_CONJUGE_VITALICIA
+ - PENSAO_CONJUGE_TEMPORARIA
+ - NA
+ example: FUNERAL
+ EnumGracePeriodUnit:
+ type: string
+ description: Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
+ maxLength: 10
+ enum:
+ - DIAS
+ - MESES
+ - NAO_APLICA
+ example: MESES
+ InsurancePensionEnumPmbacRemuneration:
+ type: object
+ properties:
+ interestRate:
+ type: string
+ pattern: '^\d{1}\.\d{6}$'
+ description: Taxa de juros para capitalização da PMBaC
+ maxLength: 8
+ minLength: 8
+ example: '0.019800'
+ updateIndexes:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumPersonalUpdateIndex'
+ additionalProperties: false
+ AgeAdjustment:
+ type: object
+ required:
+ - criterias
+ - frequency
+ properties:
+ criterias:
+ type: array
+ items:
+ type: string
+ description: |
+ Critério escolhido para reenquadramento etário
+ 1. Após período em anos
+ 2. A cada período em anos
+ 3. Por mudança de faixa etária
+ 4. Não aplicável
+ maxLength: 27
+ example: APOS_PERIODO_ANOS
+ enum:
+ - APOS_PERIODO_ANOS
+ - CADA_PERIODO_ANOS
+ - MUDANCA_FAIXA_ETARIA
+ - NAO_APLICAVEL
+ frequency:
+ type: integer
+ description: 'Período em anos, caso critério de reenquadramento após ou a cada período em anos.'
+ maxLength: 3
+ example: 10
+ additionalProperties: false
+ InsurancePensionEnumFinancialRegime:
+ type: string
+ description: |
+ Listagem de regime financeiro para cada combinação de modalidade/cobertura do produto indicando:
+ 1. Repartição simples
+ 2. Repartição Capitais Cobertura
+ 3. Capitalização
+ maxLength: 19
+ example: REPARTICAO_SIMPLES
+ enum:
+ - REPARTICAO_SIMPLES
+ - REPARTICAO_CAPITAIS
+ - CAPITALIZACAO
+ - NA
+ EnumInsurancePersonalBenefitRecalculationUpdateIndex:
+ type: string
+ description: |
+ Índice utilizado na atualização do prêmio/contribuição e do capital segurado/ benefício, caso critério de atualização por meio de índice
+ enum:
+ - IPCA
+ - IGP_M
+ - INPC
+ - NA
+ example: IPCA
+ EnumPersonalUpdateIndex:
+ type: string
+ description: |
+ Índice utilizado na atualização da PMBaC:
+ 1. IPCA (IBGE)
+ 2. IGP-M (FGV)
+ 3. INPC (IBGE)
+ enum:
+ - IPCA
+ - IGP_M
+ - INPC
+ - NA
+ example: IPCA
+ OpenDataMeta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - totalRecords
+ - totalPages
+ properties:
+ totalRecords:
+ type: integer
+ format: int32
+ description: Número total de registros no resultado
+ example: 1
+ totalPages:
+ type: integer
+ format: int32
+ description: Número total de páginas no resultado
+ example: 1
+ additionalProperties: false
+ OKResponsePersonalInsuranceList:
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/PersonalInsuranceData'
+ links:
+ $ref: '#/components/schemas/Links'
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ PersonalInsuranceData:
+ type: object
+ required:
+ - participant
+ - society
+ - name
+ - code
+ - modality
+ - coverages
+ - additionals
+ - termsAndConditions
+ - globalCapital
+ - terms
+ - financialRegimes
+ - allowPortability
+ - indemnityPaymentMethods
+ - targetAudience
+ properties:
+ participant:
+ $ref: '#/components/schemas/Participant'
+ society:
+ $ref: '#/components/schemas/PersonalInsuranceSociety'
+ name:
+ type: string
+ description: 'Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.'
+ maxLength: 80
+ example: Produto A
+ code:
+ type: string
+ description: Código único a ser definido pela sociedade.
+ maxLength: 80
+ example: '0001'
+ category:
+ type: string
+ description: Indicar a categoria do Produto:
- Tradicional
- Microsseguro
+ maxLength: 12
+ enum:
+ - TRADICIONAL
+ - MICROSSEGURO
+ - NA
+ example: TRADICIONAL
+ modality:
+ $ref: '#/components/schemas/EnumProductModality'
+ coverages:
+ type: array
+ items:
+ $ref: '#/components/schemas/PersonalCoverageItem'
+ minItems: 1
+ assistanceTypes:
+ type: array
+ items:
+ type: string
+ description: 'Lista padronizada de tipo de assistências ofertadas vinculadas ao produto. Por exemplo, Funeral, Bicicleta, Assistência PET – Tabela padrão a ser consolidada com retorno das empresas com a relação de assistências, permitindo um campo ‘Outros’ para assistências não contempladas na tabela padronizada.'
+ maxLength: 43
+ enum:
+ - ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
+ - ARQUITETO_VIRTUAL
+ - ASSESSORIA_FINANCEIRA
+ - AUTOMOVEL
+ - AUXILIO_NATALIDADE
+ - AVALIACAO_CLINICA_PREVENTIVA
+ - BOLSA_PROTEGIDA
+ - CESTA_BASICA
+ - CHECKUP_ODONTOLOGICO
+ - CLUBE_VANTAGENS_BENEFICIOS
+ - CONVALESCENCIA
+ - DECESSO
+ - DESCONTO_FARMACIAS_MEDICAMENTOS
+ - DESPESAS_FARMACEUTICAS_VIAGEM
+ - DIGITAL
+ - EDUCACIONAL
+ - EMPRESARIAL
+ - ENCANADOR
+ - ENTRETENIMENTO
+ - EQUIPAMENTOS_MEDICOS
+ - FIANCAS_DESPESAS_LEGAIS
+ - FISIOTERAPIA
+ - FUNERAL
+ - HELP_LINE
+ - HOSPEDAGEM_ACOMPANHANTE
+ - INTERRUPCAO_VIAGEM
+ - INVENTARIO
+ - MAIS_VIDA
+ - MAMAE_BEBE
+ - MEDICA_ACIDENTE_DOENCA
+ - MOTOCICLETA
+ - MULHER
+ - NUTRICIONISTA
+ - ODONTOLOGICA
+ - ORIENTACAO_FITNESS
+ - ORIENTACAO_JURIDICA
+ - ORIENTACAO_NUTRICIONAL
+ - PERSONAL_FITNESS
+ - ORIENTACAO_PSICOSSOCIAL_FAMILIAR
+ - PERDA_ROUBO_CARTAO
+ - PET
+ - PRORROGACAO_ESTADIA
+ - PROTECAO_DADOS
+ - RECOLOCACAO_PROFISSIONAL
+ - REDE_DESCONTO_NUTRICIONAL
+ - RESIDENCIAL
+ - RETORNO_MENORES_SEGURADO
+ - SAQUE_COACAO
+ - SAUDE_BEM_ESTAR
+ - SEGUNDA_OPINIAO_MEDICA
+ - SENIOR
+ - SUSTENTAVEL_DESCARTE_ECOLOGICO
+ - TELEMEDICINA
+ - VIAGEM
+ - VITIMA
+ - OUTROS
+ - NA
+ example: ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
+ assistanceTypesAdditionalInfos:
+ description: Lista a ser preenchido pelas participantes quando houver ‘Outros’ no campo ‘Tipo de Assistência’
+ type: array
+ items:
+ type: string
+ example:
+ - Assistance additional info.
+ additionals:
+ type: array
+ items:
+ type: string
+ maxLength: 44
+ enum:
+ - SORTEIO
+ - SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
+ - SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
+ - OUTROS
+ - NAO_HA
+ example: SORTEIO
+ termsAndConditions:
+ type: array
+ items:
+ $ref: '#/components/schemas/TermsAndConditionsItem'
+ minItems: 1
+ globalCapital:
+ type: boolean
+ description: |
+ A considerar os seguintes domínios:
+ 1. true
+ 2. false
+ example: true
+ terms:
+ type: array
+ items:
+ type: string
+ description: Define o prazo do plano contratado
- Vitalícia
- Temporária - prazo fixo
- Temporária – intermitente
+ maxLength: 23
+ enum:
+ - VITALICIA
+ - TEMPORARIA_PRAZO_FIXO
+ - TEMPORARIA_INTERMITENTE
+ - NA
+ example: VITALICIA
+ pmbacRemuneration:
+ $ref: '#/components/schemas/InsurancePensionEnumPmbacRemuneration'
+ benefitRecalculation:
+ $ref: '#/components/schemas/BenefitRecalculation'
+ ageAdjustment:
+ $ref: '#/components/schemas/AgeAdjustment'
+ financialRegimes:
+ type: array
+ items:
+ $ref: '#/components/schemas/InsurancePensionEnumFinancialRegime'
+ reclaim:
+ $ref: '#/components/schemas/PersonalInsuranceReclaim'
+ otherGuaranteedValues:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumPersonalInsuranceOtherGuaranteedValues'
+ allowPortability:
+ type: boolean
+ description: |
+ 1. true
+ 2. false
+ portabilityGraceTime:
+ $ref: '#/components/schemas/PersonalInsurancePortabilityGraceTime'
+ indemnityPaymentMethods:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumPersonalInsuranceIndemnityPaymentMethod'
+ indemnityPaymentIncomes:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumPersonalInsuranceIndemnityPaymentIncome'
+ premiumPayment:
+ $ref: '#/components/schemas/PersonalInsurancePremiumPayment'
+ minimumRequirement:
+ $ref: '#/components/schemas/PersonalInsuranceMinimumRequirement'
+ targetAudience:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. Ambas (Pessoa Natural e Jurídica)
+ maxLength: 23
+ enum:
+ - PESSOA_NATURAL
+ - PESSOA_JURIDICA
+ - PESSOA_NATURAL_JURIDICA
+ - NA
+ example: PESSOA_NATURAL
+ additionalProperties: false
+ PersonalCoverageItem:
+ type: object
+ required:
+ - type
+ properties:
+ type:
+ $ref: '#/components/schemas/EnumInsurancePersonalCoverageTypePersonal'
+ typeAdditionalInfos:
+ type: array
+ description: |
+ Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
+ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
+ items:
+ type: string
+ maxLength: 100
+ example:
+ - Detalhar os serviços
+ - benefícios
+ - outros
+ attributes:
+ $ref: '#/components/schemas/PersonalCoverageItemAttributes'
+ additionalProperties: false
+ PersonalCoverageItemAttributes:
+ type: object
+ required:
+ - indemnityPaymentMethods
+ - indemnityPaymentFrequencies
+ - minValue
+ - maxValue
+ - indemnifiablePeriods
+ - maximumQtyIndemnifiableInstallments
+ - gracePeriod
+ - deductibleDays
+ - deductible
+ - excludedRisks
+ - allowApartPurchase
+ properties:
+ indemnityPaymentMethods:
+ description: Listagem da forma de pagamento da indenização para cada combinação de modalidade/cobertura do produto.
+ type: array
+ items:
+ type: string
+ enum:
+ - PAGAMENTO_CAPITAL_SEGURADO_VALOR_MONETARIO
+ - REEMBOLSO_DESPESAS
+ - PRESTACAO_SERVICOS
+ - NA
+ maxLength: 42
+ indemnityPaymentFrequencies:
+ description: Listagem de tipos de frequência de pagamento de indenização para cada combinação de modalidade/cobertura do produto.
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumPersonalIndemnityPaymentFrequencyType'
+ minValue:
+ $ref: '#/components/schemas/InsurancePensionMinValue'
+ maxValue:
+ $ref: '#/components/schemas/InsurancePensionMaxValue'
+ indemnifiablePeriods:
+ description: Listagem de período indenizável para cada combinação de modalidade/cobertura do produto.
+ type: array
+ items:
+ type: string
+ maxLength: 50
+ example: ATE_FIM_CICLO_DETERMINADO
+ maximumQtyIndemnifiableInstallments:
+ type: integer
+ description: 'Caso o período indenizável seja relacionado a parcelas, listagem de número máximo de parcelas indenizáveis para cada combinação de modalidade/ cobertura do produto.'
+ maxLength: 10
+ example: 10
+ gracePeriod:
+ $ref: '#/components/schemas/PersonalInsuranceGracePeriod'
+ differentiatedGracePeriod:
+ type: string
+ description: 'Campo aberto para detalhamento de período de carência diferenciado, se houver.'
+ maxLength: 500
+ pattern: '[\w\W\s]*'
+ example: 90 DIAS
+ deductibleDays:
+ type: integer
+ description: Listagem de franquia em dias para cada combinação de modalidade/cobertura do produto.
+ maxLength: 10
+ example: 10
+ differentiatedDeductibleDays:
+ type: integer
+ description: 'Detalhamento da franquia em dias diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.'
+ maxLength: 10
+ example: 15
+ deductible:
+ type: object
+ required:
+ - amount
+ - currency
+ description: Listagem de franquia em reais para cada combinação de modalidade/cobertura do produto.
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^\d{1,16}\.\d{2,4}$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ differentiatedDeductible:
+ type: object
+ required:
+ - amount
+ - currency
+ description: 'Detalhamento da franquia em reais diferentes para cada cobertura que exista alguma especificidade.
Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.'
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^\d{1,16}\.\d{2,4}$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ excludedRisks:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumExcludedRisks'
+ excludedRisksURL:
+ type: string
+ description: Campo aberto (possibilidade de incluir URL)
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ allowApartPurchase:
+ type: boolean
+ description: |
+ Indicar se a cobertura pode ser contratada isoladamente ou não:
+ 1. true
+ 2. false
+ additionalProperties: false
+ EnumPersonalIndemnityPaymentFrequencyType:
+ type: string
+ description: ''
+ maxLength: 17
+ enum:
+ - INDENIZACAO_UNICA
+ - DIARIA_OU_PARCELA
+ - NA
+ example: INDENIZACAO_UNICA
+ EnumExcludedRisks:
+ type: string
+ description: Listagem para indicar quais serão o(s) risco(s) excluído(s) aplicável(is) à(s) cobertura(s).
+ maxLength: 40
+ enum:
+ - ATO_RECONHECIMENTO_PERIGOSO
+ - ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
+ - OPERACOES_GUERRA
+ - FURACOES_CICLONES_TERREMOTOS
+ - MATERIAL_NUCLEAR
+ - DOENCAS_LESOES_PREEXISTENTES
+ - EPIDEMIAS_PANDEMIAS
+ - SUICIDIO
+ - ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
+ - OUTROS
+ - NA
+ example: ATO_RECONHECIMENTO_PERIGOSO
+ EnumPersonalInsuranceOtherGuaranteedValues:
+ type: string
+ description: |
+ 1. Saldamento
+ 2. Benefício Prolongado
+ 3. Não se aplica
+ maxLength: 20
+ enum:
+ - SALDAMENTO
+ - BENEFICIO_PROLONGADO
+ - NAO_APLICA
+ example: SALDAMENTO
+ EnumPersonalInsuranceIndemnityPaymentMethod:
+ type: string
+ description: |
+ Modalidade de pagamento da indenização, a considerar os domínios abaixo:
+ 1. Único
+ 2. Sob a forma de renda
+ maxLength: 18
+ enum:
+ - UNICO
+ - SOB_FORMA_RENDA
+ - NA
+ example: UNICO
+ EnumPersonalInsuranceIndemnityPaymentIncome:
+ type: string
+ description: |
+ Tipo de renda ou pensão, caso modalidade de pagamento de indenização seja sob a forma de renda:
+ 1. Certa
+ 2. Temporária
+ 3. Temporária reversível
+ 4. Temporário com mínimo garantido
+ 5. Temporária reversível com mínimo garantido
+ 6. Vitalícia
+ 7. Vitalícia reversível
+ 8. Vitalícia com o mínimo garantido
+ 9. Vitalícia reversível como mínimo garantido
+ maxLength: 38
+ enum:
+ - CERTA
+ - TEMPORARIA
+ - TEMPORARIA_REVERSIVEL
+ - TEMPORARIO_MINIMO_GARANTIDO
+ - TEMPORARIA_REVERSIVEL_MINIMO_GARANTIDO
+ - VITALICIA
+ - VITALICIA_REVERSIVEL
+ - VITALICIA_MINIMO_GARANTIDO
+ - VITALICIA_REVERSIVEL_MINIMO_GARANTIDO
+ - NA
+ example: CERTA
+ PersonalInsurancePremiumPayment:
+ type: object
+ required:
+ - paymentMethods
+ - frequencies
+ properties:
+ paymentMethods:
+ type: array
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/EnumPremiumPaymentMethodTypePersonal'
+ frequencies:
+ type: array
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/EnumPersonalInsurancePremiumPaymentFrequency'
+ contributionTax:
+ type: string
+ description: 'Distribuição de frequência relativa aos valores referentes às taxas cobradas, nos termos do Anexo III.'
+ maxLength: 500
+ additionalProperties: false
+ EnumPersonalInsurancePremiumPaymentFrequency:
+ type: string
+ description: |
+ Periodicidade de pagamento do prêmio:
+ 1. Diária
+ 2. Mensal
+ 3. Única
+ 4. Anual
+ 5. Trimestral
+ 6. Semestral
+ 7. Fracionado
+ 8. Outra
+ maxLength: 10
+ enum:
+ - DIARIA
+ - MENSAL
+ - UNICA
+ - ANUAL
+ - TRIMESTRAL
+ - SEMESTRAL
+ - FRACIONADO
+ - OUTRA
+ - NA
+ example: DIARIA
+ PersonalInsuranceMinimumRequirement:
+ type: object
+ required:
+ - contractType
+ - contractingMinRequirement
+ properties:
+ contractType:
+ $ref: '#/components/schemas/EnumContractTypePersonal'
+ contractingMinRequirement:
+ type: string
+ description: Campo aberto (possibilidade de incluir URL)
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ PersonalInsuranceGracePeriod:
+ type: object
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: Informar o prazo de carência
+ example: 90
+ maximum: 9999999999
+ unit:
+ $ref: '#/components/schemas/EnumGracePeriodUnit'
+ details:
+ type: string
+ maxLength: 500
+ pattern: '[\w\W\s]*'
+ example: Descrições adicionais do período de carência
+ additionalProperties: false
+ PersonalInsuranceReclaim:
+ type: object
+ required:
+ - gracePeriod
+ properties:
+ table:
+ type: array
+ items:
+ $ref: '#/components/schemas/PersonalInsuranceReclaimTableItem'
+ minItems: 1
+ gracePeriod:
+ $ref: '#/components/schemas/GracePeriod'
+ differenciatedPercentage:
+ description: Campo aberto (possibilidade de incluir URL)
+ example: |
+ https://openinsurance.com.br/aaa’
+ Obs.: Exceção de cobertura ou critério definido acima será descrito aqui na URL
+ Exemplo: Cobertura X: a partir de 25 meses = 100%
+ maxLength: 1024
+ additionalProperties: false
+ PersonalInsuranceReclaimTableItem:
+ type: object
+ required:
+ - initialMonthRange
+ - finalMonthRange
+ - percentage
+ properties:
+ initialMonthRange:
+ type: integer
+ maxLength: 2
+ example: 1
+ finalMonthRange:
+ type: integer
+ maxLength: 2
+ example: 12
+ percentage:
+ type: string
+ pattern: '^\d{1}\.\d{6}$'
+ maxLength: 8
+ minLength: 8
+ description: Percentual de faixa de resgate.
+ example: '0.019800'
+ additionalProperties: false
+ EnumInsurancePersonalCoverageTypePersonal:
+ type: string
+ description: 'É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura '
+ maxLength: 62
+ enum:
+ - ADIANTAMENTO_DOENCA_ESTAGIO_TERMINAL
+ - AUXILIO_CESTA_BASICA
+ - AUXILIO_FINANCEIRO_IMEDIATO
+ - CANCELAMENTO_VIAGEM
+ - CIRURGIA
+ - COBERTURA_HERNIA
+ - COBERTURA_LER_DORT
+ - CUIDADOS_PROLONGADOS_ACIDENTE
+ - DESEMPREGO_PERDA_RENDA
+ - DESPESAS_EXTRA_INVALIDEZ_PERMANENTE_TOTAL_PARCIAL_ACIDENTE_DEI
+ - DESPESAS_EXTRA_MORTE_DEM
+ - DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS
+ - DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS_BRASIL
+ - DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS_EXTERIOR
+ - DIARIA_INCAPACIDADE_TOTAL_TEMPORARIA
+ - DIARIA_INTERNACAO_HOSPITALAR
+ - INTERNACAO_HOSPITALAR
+ - DIARIAS_INCAPACIDADE_PECUNIARIA_DIP
+ - DOENCA_CONGENITA_FILHOS_DCF
+ - FRATURA_OSSEA
+ - DOENCAS_TROPICAIS
+ - INCAPACIDADE_TOTAL_OU_TEMPORARIA
+ - INVALIDEZ_PERMANENTE_TOTAL_PARCIAL
+ - INVALIDEZ_TOTAL_ACIDENTE
+ - INVALIDEZ_PARCIAL_ACIDENTE
+ - INVALIDEZ_FUNCIONAL_PERMANENTE_DOENCA
+ - INVALIDEZ_LABORATIVA_DOENCA
+ - MORTE
+ - MORTE_ACIDENTAL
+ - MORTE_CONJUGE
+ - MORTE_FILHOS
+ - MORTE_ADIATAMENTO_DOENCA_ESTAGIO_TERMINAL
+ - PAGAMENTO_ANTECIPADO_ESPECIAL_DOENCA_PROFISSIONAL_PAED
+ - PERDA_AUTONOMIA_PESSOAL
+ - PERDA_INVOLUNTARIA_EMPREGO
+ - QUEIMADURA_GRAVE
+ - REGRESSO_ANTECIPADO_SANITARIO
+ - RENDA_INCAPACIDADE_TEMPORARIA
+ - RESCISAO_CONTRATUAL_CASO_MORTE_RCM
+ - RESCISAO_TRABALHISTA
+ - SERVICO_AUXILIO_FUNERAL
+ - SOBREVIVENCIA
+ - TRANSPLANTE_ORGAOS
+ - TRASLADO
+ - TRANSLADO_CORPO
+ - VERBA_RESCISORIA
+ - DOENCA_GRAVE
+ - TRANSLADO_MEDICO
+ - OUTROS
+ - NA
+ example: INVALIDEZ_PERMANENTE_TOTAL_PARCIAL
+ EnumPremiumPaymentMethodTypePersonal:
+ type: string
+ description: |
+ Meio de pagamento escolhido pelo segurado. A considerar os domínios abaixo:
+ 1. Cartão de Crédito
+ 2. Cartão de Débito
+ 3. Débito em conta corrente
+ 4. Débito em conta poupança
+ 5. Boleto bancário
+ 6. PIX
+ 7. Consignação em Folha de Pagamento
+ 8. Pontos de Programa de Benefício
+ 9. Regra de Parceiro
+ maxLength: 27
+ enum:
+ - CARTAO_CREDITO
+ - CARTAO_DEBITO
+ - DEBITO_CONTA_CORRENTE
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PONTOS_PROGRAMA_BENEFICIO
+ - REGRA_PARCEIRO
+ - NA
+ example: CARTAO_CREDITO
+ EnumContractTypePersonal:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+ 1. Coletivo;
+ 2. Individual
+ maxLength: 10
+ enum:
+ - COLETIVO
+ - INDIVIDUAL
+ - NA
+ example: COLETIVO
+ PersonalInsuranceSociety:
+ type: object
+ description: Conjunto de informações relativas à seguradora do produto de open insurance
+ required:
+ - name
+ - cnpjNumber
+ - brand
+ properties:
+ name:
+ type: string
+ description: Nome da Sociedade Seguradora.
+ maxLength: 80
+ example: Society A1
+ cnpjNumber:
+ $ref: '#/components/schemas/CnpjNumber'
+ brand:
+ type: string
+ description: 'Nome da marca reportada pela sociedade seguradora participante do Open Finance. 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.'
+ maxLength: 80
+ example: Marca
+ additionalProperties: false
+ PersonalInsurancePortabilityGraceTime:
+ type: object
+ required:
+ - amount
+ - unit
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: Informar o prazo de carência
+ example: 90
+ maximum: 9999999999
+ unit:
+ $ref: '#/components/schemas/EnumGracePeriodUnit'
+ additionalProperties: false
+ BenefitRecalculation:
+ type: object
+ required:
+ - criterias
+ properties:
+ criterias:
+ type: array
+ items:
+ type: string
+ enum:
+ - INDICE
+ - VINCULADO_SALDO_DEVEDOR
+ - VARIAVEL_ACORDO_CRITERIO_ESPECIFICO
+ - NA
+ updateIndexes:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumInsurancePersonalBenefitRecalculationUpdateIndex'
+ additionalProperties: false
+ Links:
+ type: object
+ description: Referências para outros recusos da API requisitada.
+ required:
+ - self
+ properties:
+ self:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI completo que gerou a resposta atual.
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ first:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ prev:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: "URI da página anterior dessa lista de resultados. Restrição - \tObrigatório quando não for a primeira página da resposta"
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ next:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ last:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ additionalProperties: false
+ Meta:
+ type: object
+ description: Meta informações referente a API requisitada.
+ required:
+ - totalRecords
+ - totalPages
+ - requestDateTime
+ properties:
+ totalRecords:
+ type: integer
+ format: int32
+ description: Número total de registros no resultado
+ example: 1
+ totalPages:
+ type: integer
+ format: int32
+ description: Número total de páginas no resultado
+ example: 1
+ requestDateTime:
+ description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.'
+ type: string
+ maxLength: 20
+ format: date-time
+ example: '2021-05-21T08:30:00Z'
+ additionalProperties: false
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ additionalProperties: false
+ meta:
+ $ref: '#/components/schemas/Meta'
+ additionalProperties: false
+ parameters:
+ 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
+ maximum: 2147483647
+ 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
+ responses:
+ OKResponsePersonalInsuranceList:
+ description: Dados de seguro(s) pessoais obtidos com sucesso.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OKResponsePersonalInsuranceList'
+ 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'
+ 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'
+ 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 de requisições concorrentes foi atingido.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/schemas/ResponseError'
+ SiteIsOverloaded:
+ description: 'O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ meta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - requestDateTime
+ properties:
+ requestDateTime:
+ description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.'
+ type: string
+ maxLength: 20
+ format: date-time
+ example: '2021-05-21T08:30:00Z'
From b0d858313d5f023722d84fc4b792863cd11c8eb8 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Mon, 15 May 2023 09:10:25 -0300
Subject: [PATCH 18/50] feat(Insurance): ORB-2589 - PC81 - Tornar campos tipo
boolean opcionais
---
dictionary/getPersonalInsurance_vx.csv | 6 +++---
swagger-apis/insurances/x.x.x.yml | 3 ---
2 files changed, 3 insertions(+), 6 deletions(-)
diff --git a/dictionary/getPersonalInsurance_vx.csv b/dictionary/getPersonalInsurance_vx.csv
index a5b2ee94c..9c869e39c 100644
--- a/dictionary/getPersonalInsurance_vx.csv
+++ b/dictionary/getPersonalInsurance_vx.csv
@@ -137,7 +137,7 @@ NA";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
/data/coverages/attributes/allowApartPurchase;allowApartPurchase;"Indicar se a cobertura pode ser contratada isoladamente ou não:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;;
/data/assistanceTypes;assistanceTypes;;Lista;43;Opcional;;"ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
ARQUITETO_VIRTUAL
ASSESSORIA_FINANCEIRA
@@ -207,7 +207,7 @@ NAO_HA";1;N;"";Não permitido;array;SORTEIO;
/data/globalCapital;globalCapital;"A considerar os seguintes domínios:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/terms;terms;;Lista;23;Obrigatório;;"VITALICIA
TEMPORARIA_PRAZO_FIXO
TEMPORARIA_INTERMITENTE
@@ -257,7 +257,7 @@ BENEFICIO_PROLONGADO
NAO_APLICA";0;N;"";Não permitido;array;SALDAMENTO;
/data/allowPortability;allowPortability;"1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;;
/data/portabilityGraceTime;portabilityGraceTime;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/portabilityGraceTime/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
/data/portabilityGraceTime/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
diff --git a/swagger-apis/insurances/x.x.x.yml b/swagger-apis/insurances/x.x.x.yml
index ec08eaa42..0a7676da2 100644
--- a/swagger-apis/insurances/x.x.x.yml
+++ b/swagger-apis/insurances/x.x.x.yml
@@ -318,10 +318,8 @@ components:
- coverages
- additionals
- termsAndConditions
- - globalCapital
- terms
- financialRegimes
- - allowPortability
- indemnityPaymentMethods
- targetAudience
properties:
@@ -549,7 +547,6 @@ components:
- deductibleDays
- deductible
- excludedRisks
- - allowApartPurchase
properties:
indemnityPaymentMethods:
description: Listagem da forma de pagamento da indenização para cada combinação de modalidade/cobertura do produto.
From f4ec56cb823aa4566d02bc1f452f22d3c307368b Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Mon, 15 May 2023 10:27:27 -0300
Subject: [PATCH 19/50] feat(Capitalization Bonds): ORB-2575-2 - PC81 - Tipo
string aceitar NA
---
.../capitalizationBondsGetProducts_vx.csv | 28 +++++++++----------
...entsInvestmentIdTransactionsCurrent_v1.csv | 2 +-
...InvestmentsInvestmentIdTransactions_v1.csv | 2 +-
swagger-apis/capitalization-bonds/x.x.x.yml | 26 ++++++++---------
4 files changed, 29 insertions(+), 29 deletions(-)
diff --git a/dictionary/capitalizationBondsGetProducts_vx.csv b/dictionary/capitalizationBondsGetProducts_vx.csv
index 24ffab827..8c7eac664 100644
--- a/dictionary/capitalizationBondsGetProducts_vx.csv
+++ b/dictionary/capitalizationBondsGetProducts_vx.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -16,7 +16,7 @@
";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;ACMEcap;
/data/code;code;Código único a ser definido pela sociedade.;Texto;100;Obrigatório;;;1;1;"";Não permitido;string;01234589_cap;
/data/modality;modality;"1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
@@ -41,17 +41,17 @@ PAGAMENTO_MENSAL
PAGAMENTO_PERIODICO
NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
/data/termsAndConditions;termsAndConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/quotas;quotas;Informações relativas às taxas da Quotas praticadas para cada Parcela;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/quotas/quota;quota;Número da parcela.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;(^\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;(^\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/validity;validity;Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.;Inteiro;3;Opcional;;;0;1;"";Não permitido;integer;48;
/data/serieSize;serieSize;Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;5000000;
/data/capitalizationPeriod;capitalizationPeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
";Texto;37;Obrigatório;;"IPCA
IGPM
@@ -89,17 +89,17 @@ NA";1;1;"";Não permitido;string;UNICO;
/data/capitalizationPeriod/contributionAmount/periodicityAdditionalInfo;periodicityAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
/data/capitalizationPeriod/contributionAmount/minimum;minimum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
-";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;1.2222;
+";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;1.2222;
/data/capitalizationPeriod/contributionAmount/maximum;maximum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
-";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;1.2222;
+";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;1.2222;
/data/capitalizationPeriod/contributionAmount/allowedValue;allowedValue;"Condicional: Quando modalidade for diferente de 'TRADICIONAL'
Lista com os valores permitidos de contribuição ao plano.
";Número;;Obrigatório;;;1;1;"";Não permitido;number;5000;
/data/capitalizationPeriod/earlyRedemptions;earlyRedemptions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/capitalizationPeriod/earlyRedemptions/quota;quota;Parcela relativa ao Resgate Antecipado;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/gracePeriodRedemption;gracePeriodRedemption;Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;48;
/data/latePayment;latePayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/latePayment/suspensionMonths;suspensionMonths;Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
@@ -138,8 +138,8 @@ INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
OUTROS
NA";1;1;"";Não permitido;string;IPCA;
/data/contributionPayment/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
-/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;(^\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;9;Obrigatório;(^\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/draws;draws;Informações relativas aos Sorteios;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/draws/timeInterval;timeInterval;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
- UNICO
@@ -178,7 +178,7 @@ desde que atingidos os requisitos definidos nas condições gerais do plano. Con
2. false
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/draws/ruleDescription;ruleDescription;Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.;Texto;200;Opcional;;;0;1;"";Não permitido;string;Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.;
-/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
/data/minimumRequirementDetails;minimumRequirementDetails;"Campo aberto (possibilidade de incluir URL).
Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
diff --git a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
index 9873069b4..8a475089e 100644
--- a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
+++ b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
@@ -1,4 +1,4 @@
-data,,,,,,,,,,,,,,,,,,links,,,,meta
+data,,,,,,,,,,,,,,,,,,links,,,,meta
type,transactionType,typeAdditionalInfo,transactionDate,transactionUnitPrice,,transactionQuantity,transactionGrossValue,,incomeTax,,financialTransactionTax,,transactionNetValue,,remunerationTransactionRate,indexerPercentage,transactionId,self,first,prev,next,requestDateTime
,,,,amount,currency,,amount,currency,amount,currency,amount,currency,amount,currency,,,,,,,,
ENTRADA,COMPRA,string,2018-02-15,1000.000004,BRL,42.25,1000.04,BRL,1000.04,BRL,1000.04,BRL,1000.04,BRL,0.300000,1.100000,ABCD2126019929279212650822221989319253344,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,2021-05-21T08:30:00Z
\ No newline at end of file
diff --git a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
index 39c5e0a48..a9f249090 100644
--- a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
+++ b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
@@ -1,4 +1,4 @@
-data,,,,,,,,,,,,,,,,,,links,,,,meta
+data,,,,,,,,,,,,,,,,,,links,,,,meta
type,transactionType,typeAdditionalInfo,transactionDate,transactionUnitPrice,,transactionQuantity,transactionGrossValue,,incomeTax,,financialTransactionTax,,transactionNetValue,,remunerationTransactionRate,indexerPercentage,transactionId,self,first,prev,next,requestDateTime
,,,,amount,currency,,amount,currency,amount,currency,amount,currency,amount,currency,,,,,,,,
ENTRADA,COMPRA,string,2018-02-15,1000.000004,BRL,42.25,1000.04,BRL,1000.04,BRL,1000.04,BRL,1000.04,BRL,0.300000,1.100000,ABCD2126019929279212650822221989319253344,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,2021-05-21T08:30:00Z
\ No newline at end of file
diff --git a/swagger-apis/capitalization-bonds/x.x.x.yml b/swagger-apis/capitalization-bonds/x.x.x.yml
index eb71978f6..20fd8b060 100644
--- a/swagger-apis/capitalization-bonds/x.x.x.yml
+++ b/swagger-apis/capitalization-bonds/x.x.x.yml
@@ -128,12 +128,12 @@ components:
description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
maxLength: 9
minLength: 8
- pattern: '(^\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
example: '0.019800'
finalRedemptionRate:
type: string
description: Valor percentual (%) de resgate final permitido.
- pattern: '(^\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
maxLength: 9
minLength: 8
example: '0.019800'
@@ -193,7 +193,7 @@ components:
cnpjNumber:
type: string
description: '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.'
- pattern: '(^\d{14})|(NA)$'
+ pattern: '(^\d{14})$|^(NA)$'
example: '13456789000112'
urlComplementaryList:
type: string
@@ -257,7 +257,7 @@ components:
description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
minLength: 12
maxLength: 20
- pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$'
+ pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$'
example: 15414.622222/2222-22
detail:
type: string
@@ -284,21 +284,21 @@ components:
description: Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).
maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
example: '0.019800'
raffleQuota:
type: string
description: 'Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).'
maxLength: 9
minLength: 8
- pattern: '(^\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
example: '0.019800'
chargingQuota:
type: string
description: 'Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).'
maxLength: 9
minLength: 8
- pattern: '(^\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
example: '0.019800'
additionalProperties: false
CapitalizationBondsProductCapitalizationPeriod:
@@ -313,7 +313,7 @@ components:
properties:
interestRate:
type: string
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
description: 'Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).'
maxLength: 9
minLength: 8
@@ -350,7 +350,7 @@ components:
description: Taxa relativa ao Resgate Antecipado
maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
example: '0.019800'
additionalProperties: false
redemptionPercentageEndTerm:
@@ -358,7 +358,7 @@ components:
description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
example: '0.019800'
gracePeriodRedemption:
type: number
@@ -431,7 +431,7 @@ components:
example: ''
minimum:
type: string
- pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
description: |
Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
@@ -439,7 +439,7 @@ components:
example: '1.2222'
maximum:
type: string
- pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
description: |
Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
@@ -595,7 +595,7 @@ components:
example: Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.
minimumContemplationProbability:
type: string
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
description: 'Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).'
maxLength: 9
minLength: 8
From 1c080d01b60c40e719b3886e9a387517f2ebb3d7 Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Mon, 15 May 2023 10:43:58 -0300
Subject: [PATCH 20/50] =?UTF-8?q?feat(Pension):=20ORB-2580-2=20-=20[PC81]?=
=?UTF-8?q?=20Previd=C3=AAncia=20-=20Tipo=20string?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
dictionary/getPensionRiskCoverages_vx.csv | 14 +++---
dictionary/getPensionSurvivalCoverages_vx.csv | 44 +++++++++----------
swagger-apis/pension/x.x.x.yml | 38 ++++++++--------
3 files changed, 48 insertions(+), 48 deletions(-)
diff --git a/dictionary/getPensionRiskCoverages_vx.csv b/dictionary/getPensionRiskCoverages_vx.csv
index d6ae5e552..c522c1e39 100644
--- a/dictionary/getPensionRiskCoverages_vx.csv
+++ b/dictionary/getPensionRiskCoverages_vx.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -16,7 +16,7 @@
";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
@@ -47,10 +47,10 @@ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a
";Lista;100;Opcional;;;0;N;"";Não permitido;array;;
/data/coverages/attributes;attributes;Atributos da cobertura;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})|(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})|(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})|(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/indemnifiablePeriod;indemnifiablePeriod;"Listagem do pagamento para cada benefício:
1. Quantidade determinada de parcelas;
@@ -151,10 +151,10 @@ SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
OUTROS
NAO_HA";0;1;"";Não permitido;string;SORTEIO;
/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
IGP_M
INPC
@@ -181,7 +181,7 @@ NA";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
-/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para resgate:
diff --git a/dictionary/getPensionSurvivalCoverages_vx.csv b/dictionary/getPensionSurvivalCoverages_vx.csv
index c00e77408..75d0d9915 100644
--- a/dictionary/getPensionSurvivalCoverages_vx.csv
+++ b/dictionary/getPensionSurvivalCoverages_vx.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -16,7 +16,7 @@
";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;"Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;"Código único a ser definido pela sociedade.
@@ -34,7 +34,7 @@ BENEFICIO_DEFINIDO
NA";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/termsAndConditions;termsAndConditions;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/type;type;"1. PGBL
2. PRGP
@@ -64,7 +64,7 @@ VDR
DEMAIS_PRODUTOS_PREVIDENCIA
NA";0;1;"";Não permitido;string;;
/data/defferalPeriod;defferalPeriod;Período de Diferimento;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
2. IGP-M (FGV);
@@ -74,7 +74,7 @@ IGP_M
INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
/data/defferalPeriod/otherMinimumPerformanceGarantees;otherMinimumPerformanceGarantees;Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.;Texto;12;Obrigatório;;;1;1;"";Não permitido;string;SELIC;
-/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/minimumPremiums;minimumPremiums;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
/data/defferalPeriod/minimumPremiums/periodicity;periodicity;;Texto;10;Opcional;;"DIARIO
@@ -87,7 +87,7 @@ SEMESTRAL
ANUAL
UNICO
NA";0;1;"";Não permitido;string;MENSAL;
-/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;250.00;
+/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;250.00;
/data/defferalPeriod/premiumPaymentMethods;premiumPaymentMethods;;Lista;27;Opcional;;"CARTAO_CREDITO
DEBITO_CONTA
DEBITO_CONTA_POUPANCA
@@ -118,13 +118,13 @@ NA";0;N;"";Não permitido;array;CARTAO_CREDITO;
/data/defferalPeriod/redemptionPaymentTerm;redemptionPaymentTerm;Prazo em dias para pagamento do resgate;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/defferalPeriod/portabilityPaymentTerm;portabilityPaymentTerm;Prazo em dias para pagamento da portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;20;
/data/defferalPeriod/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/defferalPeriod/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Nome Fantasia
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
/data/defferalPeriod/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
-";Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+";Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
@@ -133,16 +133,16 @@ NAO_APLICA
NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/defferalPeriod/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
-";Texto;9;Opcional;^(\d{1}\.\d{6})|(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
+";Texto;9;Opcional;^(\d{1}\.\d{6})$|^(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Regra de Elegibilidade
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/defferalPeriod/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo de Contribuição
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
/data/defferalPeriod/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
/data/grantPeriodBenefit;grantPeriodBenefit;Período de concessão do benefício;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/grantPeriodBenefit/incomeModalities;incomeModalities;;Lista;;Obrigatório;;"PAGAMENTO_UNICO
@@ -173,7 +173,7 @@ BR_EMSSB_MALE
BR_EMSSB_FEMALE
BR_EMSSB_MALE_FEMALE
NA";0;N;"";Não permitido;array;AT_2000_MALE;
-/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
2. IGP-M (FGV);
@@ -182,15 +182,15 @@ NA";0;N;"";Não permitido;array;AT_2000_MALE;
IGP_M
INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
-/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})|(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/grantPeriodBenefit/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Nome Fantasia
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
/data/grantPeriodBenefit/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
-";Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+";Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
@@ -199,24 +199,24 @@ NAO_APLICA
NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/grantPeriodBenefit/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
-";Texto;9;Opcional;^(\d{1}\.\d{6})|(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
+";Texto;9;Opcional;^(\d{1}\.\d{6})$|^(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Regra de Elegibilidade
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/grantPeriodBenefit/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo de Contribuição
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
/data/grantPeriodBenefit/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})|(NA)$;;0;1;"";Não permitido;string;1000.00;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
/data/costs;costs;Custos;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/costs/loadingAntecipated;loadingAntecipated;Carregamento antecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/costs/loadingLate;loadingLate;Carregamento postecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;9;Obrigatório;^(\d{1}\.\d{6})|(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
1. Coletivo Averbado;
diff --git a/swagger-apis/pension/x.x.x.yml b/swagger-apis/pension/x.x.x.yml
index fec1a00a0..92eff3676 100644
--- a/swagger-apis/pension/x.x.x.yml
+++ b/swagger-apis/pension/x.x.x.yml
@@ -291,7 +291,7 @@ components:
example: EMPRESAAPREV
maximumAdministrationFee:
type: string
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
description: |
Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
@@ -312,7 +312,7 @@ components:
maxLength: 13
maximumPerformanceFee:
type: string
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
description: |
Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
@@ -330,7 +330,7 @@ components:
description: |
Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo de Contribuição
- pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
example: '1000.00'
maxLength: 21
minimumMathematicalProvisionAmount:
@@ -338,7 +338,7 @@ components:
description: |
Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
- pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
example: '1000.00'
maxLength: 21
currency:
@@ -380,7 +380,7 @@ components:
CnpjNumber:
type: string
description: '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.'
- pattern: '^(\d{14})|(NA)$'
+ pattern: '(^\d{14})$|^(NA)$'
example: '13456789000112'
SurvivalPensionDefferalPeriod:
type: object
@@ -397,7 +397,7 @@ components:
type: string
maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
description: Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.
example: '0.019800'
updateIndex:
@@ -411,7 +411,7 @@ components:
type: string
maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
description: Percentual de reversão de excedente financeiro na concessão. Em %.
example: '0.019800'
minimumPremiums:
@@ -553,14 +553,14 @@ components:
properties:
minValue:
type: string
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
maxLength: 9
minLength: 8
description: Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.
example: '0.019800'
maxValue:
type: string
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
maxLength: 9
minLength: 8
description: Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.
@@ -575,14 +575,14 @@ components:
properties:
minValue:
type: string
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
maxLength: 9
minLength: 8
description: Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.
example: '0.019800'
maxValue:
type: string
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
maxLength: 9
minLength: 8
description: Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.
@@ -612,7 +612,7 @@ components:
amount:
type: string
maxLength: 21
- pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
description: Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).
example: '250.00'
additionalProperties: false
@@ -689,7 +689,7 @@ components:
type: string
maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
description: Taxa de juros garantida utilizada para conversão em renda. Em %
example: '0.019800'
updateIndex:
@@ -698,7 +698,7 @@ components:
type: string
maxLength: 9
minLength: 8
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
description: Percentual de reversão de excedente financeiro na concessão. Em %.
example: '0.019800'
investmentFunds:
@@ -955,7 +955,7 @@ components:
description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
minLength: 12
maxLength: 20
- pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})|(NA)$'
+ pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$'
example: 15414.622222/2222-22
detail:
type: string
@@ -1007,7 +1007,7 @@ components:
amount:
type: string
maxLength: 21
- pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
example: '0.01'
currency:
$ref: '#/components/schemas/CurrencyCode'
@@ -1022,7 +1022,7 @@ components:
amount:
type: string
maxLength: 21
- pattern: '^(\d{1,16}\.\d{2,4})|(NA)$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
example: '0.01'
currency:
$ref: '#/components/schemas/CurrencyCode'
@@ -1067,7 +1067,7 @@ components:
example: 12
percentage:
type: string
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
maxLength: 9
minLength: 8
description: Percentual de faixa de resgate.
@@ -1080,7 +1080,7 @@ components:
properties:
interestRate:
type: string
- pattern: '^(\d{1}\.\d{6})|(-1.000000)$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
description: Taxa de juros para capitalização da PMBaC
maxLength: 9
minLength: 8
From f530dee3f0bd3746cda4f6b09ed0b41787dc9892 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Andr=C3=A9=20Ferreira=20Trindade?=
<101213393+andretrindade@users.noreply.github.com>
Date: Mon, 15 May 2023 10:46:18 -0300
Subject: [PATCH 21/50] Update swagger-apis/capitalization-bonds/x.x.x.yml
Co-authored-by: Felipe Baumgartel <123478935+FelipeBaumgartel@users.noreply.github.com>
---
swagger-apis/capitalization-bonds/x.x.x.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/swagger-apis/capitalization-bonds/x.x.x.yml b/swagger-apis/capitalization-bonds/x.x.x.yml
index 20fd8b060..89adc1600 100644
--- a/swagger-apis/capitalization-bonds/x.x.x.yml
+++ b/swagger-apis/capitalization-bonds/x.x.x.yml
@@ -193,7 +193,7 @@ components:
cnpjNumber:
type: string
description: '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.'
- pattern: '(^\d{14})$|^(NA)$'
+ pattern: '^(\d{14})$|^(NA)$'
example: '13456789000112'
urlComplementaryList:
type: string
From 5b0d94b3f9b781edc65138b6b4765905fe654a2f Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Mon, 15 May 2023 10:48:54 -0300
Subject: [PATCH 22/50] feat(Capitalization Bonds): ORB-2575 - PC81 - Tipo
string aceitar NA
---
dictionary/capitalizationBondsGetProducts_vx.csv | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/dictionary/capitalizationBondsGetProducts_vx.csv b/dictionary/capitalizationBondsGetProducts_vx.csv
index 8c7eac664..e5438ac16 100644
--- a/dictionary/capitalizationBondsGetProducts_vx.csv
+++ b/dictionary/capitalizationBondsGetProducts_vx.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -16,7 +16,7 @@
";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;ACMEcap;
/data/code;code;Código único a ser definido pela sociedade.;Texto;100;Obrigatório;;;1;1;"";Não permitido;string;01234589_cap;
/data/modality;modality;"1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
From 52740fb7ec2c6c1895f04e94b033a38cd8080dac Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Mon, 15 May 2023 10:50:28 -0300
Subject: [PATCH 23/50] =?UTF-8?q?feat(Pension):=20ORB-2580-2=20-=20[PC81]?=
=?UTF-8?q?=20Previd=C3=AAncia=20-=20Tipo=20string?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
dictionary/getPensionRiskCoverages_vx.csv | 4 ++--
dictionary/getPensionSurvivalCoverages_vx.csv | 8 ++++----
swagger-apis/pension/x.x.x.yml | 2 +-
3 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/dictionary/getPensionRiskCoverages_vx.csv b/dictionary/getPensionRiskCoverages_vx.csv
index c522c1e39..b87be9e0b 100644
--- a/dictionary/getPensionRiskCoverages_vx.csv
+++ b/dictionary/getPensionRiskCoverages_vx.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -16,7 +16,7 @@
";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
diff --git a/dictionary/getPensionSurvivalCoverages_vx.csv b/dictionary/getPensionSurvivalCoverages_vx.csv
index 75d0d9915..16d961f4a 100644
--- a/dictionary/getPensionSurvivalCoverages_vx.csv
+++ b/dictionary/getPensionSurvivalCoverages_vx.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -16,7 +16,7 @@
";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;"Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;"Código único a ser definido pela sociedade.
@@ -118,7 +118,7 @@ NA";0;N;"";Não permitido;array;CARTAO_CREDITO;
/data/defferalPeriod/redemptionPaymentTerm;redemptionPaymentTerm;Prazo em dias para pagamento do resgate;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/defferalPeriod/portabilityPaymentTerm;portabilityPaymentTerm;Prazo em dias para pagamento da portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;20;
/data/defferalPeriod/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/defferalPeriod/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Nome Fantasia
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
@@ -184,7 +184,7 @@ INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;(^\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
+/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/grantPeriodBenefit/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Nome Fantasia
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
diff --git a/swagger-apis/pension/x.x.x.yml b/swagger-apis/pension/x.x.x.yml
index 92eff3676..6cca32b5e 100644
--- a/swagger-apis/pension/x.x.x.yml
+++ b/swagger-apis/pension/x.x.x.yml
@@ -380,7 +380,7 @@ components:
CnpjNumber:
type: string
description: '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.'
- pattern: '(^\d{14})$|^(NA)$'
+ pattern: '^(\d{14})$|^(NA)$'
example: '13456789000112'
SurvivalPensionDefferalPeriod:
type: object
From 5fb1f258144cc443c14db361cdf4a7ad1efca16c Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Mon, 15 May 2023 10:55:03 -0300
Subject: [PATCH 24/50] feat(Pension): ORB-2580 - PC81 - Tipo string aceitar NA
---
dictionary/getPensionRiskCoverages_vx.csv | 4 ++--
dictionary/getPensionSurvivalCoverages_vx.csv | 6 +++---
swagger-apis/pension/x.x.x.yml | 2 +-
3 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/dictionary/getPensionRiskCoverages_vx.csv b/dictionary/getPensionRiskCoverages_vx.csv
index b87be9e0b..fe06eeaac 100644
--- a/dictionary/getPensionRiskCoverages_vx.csv
+++ b/dictionary/getPensionRiskCoverages_vx.csv
@@ -48,10 +48,10 @@ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a
/data/coverages/attributes;attributes;Atributos da cobertura;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})|(NA)$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})|(NA)$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/indemnifiablePeriod;indemnifiablePeriod;"Listagem do pagamento para cada benefício:
1. Quantidade determinada de parcelas;
2. Até o fim de ciclo determinado.
diff --git a/dictionary/getPensionSurvivalCoverages_vx.csv b/dictionary/getPensionSurvivalCoverages_vx.csv
index 16d961f4a..0bf3169d2 100644
--- a/dictionary/getPensionSurvivalCoverages_vx.csv
+++ b/dictionary/getPensionSurvivalCoverages_vx.csv
@@ -76,7 +76,7 @@ NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
/data/defferalPeriod/otherMinimumPerformanceGarantees;otherMinimumPerformanceGarantees;Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.;Texto;12;Obrigatório;;;1;1;"";Não permitido;string;SELIC;
/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/minimumPremiums;minimumPremiums;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
+/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})$|^(NA)$;;0;1;"";Não permitido;string;BRL;
/data/defferalPeriod/minimumPremiums/periodicity;periodicity;;Texto;10;Opcional;;"DIARIO
SEMANAL
QUINZENAL
@@ -143,7 +143,7 @@ NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/defferalPeriod/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
-/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
+/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})$|^(NA)$;;0;1;"";Não permitido;string;BRL;
/data/grantPeriodBenefit;grantPeriodBenefit;Período de concessão do benefício;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/grantPeriodBenefit/incomeModalities;incomeModalities;;Lista;;Obrigatório;;"PAGAMENTO_UNICO
RENDA_PRAZO_CERTO
@@ -209,7 +209,7 @@ NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/grantPeriodBenefit/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
-/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})|(NA)$;;0;1;"";Não permitido;string;BRL;
+/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})$|^(NA)$;;0;1;"";Não permitido;string;BRL;
/data/costs;costs;Custos;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/costs/loadingAntecipated;loadingAntecipated;Carregamento antecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
diff --git a/swagger-apis/pension/x.x.x.yml b/swagger-apis/pension/x.x.x.yml
index 6cca32b5e..31f1757ff 100644
--- a/swagger-apis/pension/x.x.x.yml
+++ b/swagger-apis/pension/x.x.x.yml
@@ -1132,7 +1132,7 @@ components:
additionalProperties: false
CurrencyCode:
type: string
- pattern: '^([A-Z]{3})|(NA)$'
+ pattern: '^([A-Z]{3})$|^(NA)$'
maxLength: 3
description: 'Moeda referente ao valor monetário, seguindo o modelo ISO-4217.'
example: BRL
From 3e196e2ae1d42b0ad7381ecf8e368adc5e83da7e Mon Sep 17 00:00:00 2001
From: Cecilia Fernandes <115801960+CeciliaFFernandes@users.noreply.github.com>
Date: Mon, 15 May 2023 19:33:19 +0000
Subject: [PATCH 25/50] feat(Insurance): ORB-2588 - PC81 - Tipo percentual
---
dictionary/getPersonalInsurance_vx.csv | 4 ++--
swagger-apis/insurances/x.x.x.yml | 6 +++---
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/dictionary/getPersonalInsurance_vx.csv b/dictionary/getPersonalInsurance_vx.csv
index 9c869e39c..fee931cdf 100644
--- a/dictionary/getPersonalInsurance_vx.csv
+++ b/dictionary/getPersonalInsurance_vx.csv
@@ -213,7 +213,7 @@ TEMPORARIA_PRAZO_FIXO
TEMPORARIA_INTERMITENTE
NA";1;N;"";Não permitido;array;VITALICIA;
/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.019800;8
+/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;9;Opcional;^(\d{1}\.\d{6})$|^(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
IGP_M
INPC
@@ -241,7 +241,7 @@ NA";1;N;"";Não permitido;array;REPARTICAO_SIMPLES;
/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
-/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
diff --git a/swagger-apis/insurances/x.x.x.yml b/swagger-apis/insurances/x.x.x.yml
index 0a7676da2..68be952ce 100644
--- a/swagger-apis/insurances/x.x.x.yml
+++ b/swagger-apis/insurances/x.x.x.yml
@@ -197,9 +197,9 @@ components:
properties:
interestRate:
type: string
- pattern: '^\d{1}\.\d{6}$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
description: Taxa de juros para capitalização da PMBaC
- maxLength: 8
+ maxLength: 9
minLength: 8
example: '0.019800'
updateIndexes:
@@ -833,7 +833,7 @@ components:
example: 12
percentage:
type: string
- pattern: '^\d{1}\.\d{6}$'
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
maxLength: 8
minLength: 8
description: Percentual de faixa de resgate.
From b66353b40cddfaeeac2c06b36d739219811bc915 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Tue, 16 May 2023 10:02:16 -0300
Subject: [PATCH 26/50] feat(Insurance): ORB-2585 - PC81 - Tipo string aceitar
NA
---
dictionary/getPersonalInsurance_vx.csv | 24 ++++++++++++------------
swagger-apis/insurances/x.x.x.yml | 16 ++++++++--------
2 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/dictionary/getPersonalInsurance_vx.csv b/dictionary/getPersonalInsurance_vx.csv
index fee931cdf..7e054cbf6 100644
--- a/dictionary/getPersonalInsurance_vx.csv
+++ b/dictionary/getPersonalInsurance_vx.csv
@@ -3,16 +3,16 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link 'urlComplementaryList', deve ser array de objeto com a estrutura abaixo:
- 'name' com o valor contido no campo 'LegalEntityName' conforme cadastro no diretório;
- 'cnpjNumber' com o valor contido no campo CNPJ ('RegistrationNumber') correspondente a esta instituição;
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))$|^(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/society/brand;brand;Nome da marca reportada pela sociedade seguradora participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Marca;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
@@ -100,11 +100,11 @@ NA";1;N;"";Não permitido;array;;
DIARIA_OU_PARCELA
NA";1;N;"";Não permitido;array;INDENIZACAO_UNICA;
/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/indemnifiablePeriods;indemnifiablePeriods;Listagem de período indenizável para cada combinação de modalidade/cobertura do produto.;Lista;50;Obrigatório;;;1;N;"";Não permitido;array;ATE_FIM_CICLO_DETERMINADO;
/data/coverages/attributes/maximumQtyIndemnifiableInstallments;maximumQtyIndemnifiableInstallments;Caso o período indenizável seja relacionado a parcelas, listagem de número máximo de parcelas indenizáveis para cada combinação de modalidade/ cobertura do produto.;Inteiro;10;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/coverages/attributes/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
@@ -117,11 +117,11 @@ NAO_APLICA";0;1;"";Não permitido;string;MESES;
/data/coverages/attributes/deductibleDays;deductibleDays;Listagem de franquia em dias para cada combinação de modalidade/cobertura do produto.;Inteiro;10;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/coverages/attributes/differentiatedDeductibleDays;differentiatedDeductibleDays;Detalhamento da franquia em dias diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;15;
/data/coverages/attributes/deductible;deductible;Listagem de franquia em reais para cada combinação de modalidade/cobertura do produto.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/deductible/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/deductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/deductible/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/deductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/differentiatedDeductible;differentiatedDeductible;Detalhamento da franquia em reais diferentes para cada cobertura que exista alguma especificidade.
Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/coverages/attributes/differentiatedDeductible/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/differentiatedDeductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/differentiatedDeductible/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/differentiatedDeductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/excludedRisks;excludedRisks;;Lista;40;Obrigatório;;"ATO_RECONHECIMENTO_PERIGOSO
ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
OPERACOES_GUERRA
@@ -202,7 +202,7 @@ SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
OUTROS
NAO_HA";1;N;"";Não permitido;array;SORTEIO;
/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/globalCapital;globalCapital;"A considerar os seguintes domínios:
1. true
diff --git a/swagger-apis/insurances/x.x.x.yml b/swagger-apis/insurances/x.x.x.yml
index 68be952ce..77b745fbb 100644
--- a/swagger-apis/insurances/x.x.x.yml
+++ b/swagger-apis/insurances/x.x.x.yml
@@ -76,17 +76,17 @@ components:
- Ambos do tipo string;
- Ambos obrigatórios.
maxLength: 1024
- pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))$|^(NA)$'
example: 'https://empresaa1.com/companies'
additionalProperties: false
CnpjNumber:
type: string
description: '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.'
- pattern: '^\d{14}$'
+ pattern: '^(\d{14})$|^(NA)$'
example: '13456789000112'
CurrencyCode:
type: string
- pattern: '^[A-Z]{3}$'
+ pattern: '^([A-Z]{3})$|^(NA)$'
maxLength: 3
description: 'Moeda referente ao valor monetário, seguindo o modelo ISO-4217.'
example: BRL
@@ -100,7 +100,7 @@ components:
amount:
type: string
maxLength: 21
- pattern: '^\d{1,16}\.\d{2,4}$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
example: '0.01'
currency:
$ref: '#/components/schemas/CurrencyCode'
@@ -115,7 +115,7 @@ components:
amount:
type: string
maxLength: 21
- pattern: '^\d{1,16}\.\d{2,4}$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
example: '0.01'
currency:
$ref: '#/components/schemas/CurrencyCode'
@@ -151,7 +151,7 @@ components:
description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
minLength: 12
maxLength: 20
- pattern: '^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$'
+ pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$'
example: 15414.622222/2222-22
detail:
type: string
@@ -608,7 +608,7 @@ components:
amount:
type: string
maxLength: 21
- pattern: '^\d{1,16}\.\d{2,4}$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
example: '0.01'
currency:
$ref: '#/components/schemas/CurrencyCode'
@@ -623,7 +623,7 @@ components:
amount:
type: string
maxLength: 21
- pattern: '^\d{1,16}\.\d{2,4}$'
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
example: '0.01'
currency:
$ref: '#/components/schemas/CurrencyCode'
From 3aa246a81e322ab432fa786624162ff16afcf7b0 Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Tue, 16 May 2023 10:15:16 -0300
Subject: [PATCH 27/50] =?UTF-8?q?Fix=20-=20Adicionando=20nova=20vers=C3=A3?=
=?UTF-8?q?o=20pension=20-=20v1.0.0-rc3.0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
dictionary/getPensionRiskCoverages_v1.csv | 62 ++++++++-----
dictionary/getPensionSurvivalCoverages_v1.csv | 89 +++++++++++--------
.../pension/{x.x.x.yml => 1.0.0-rc3.0.yml} | 2 +-
swagger-apis/pension/index.html | 4 +-
4 files changed, 91 insertions(+), 66 deletions(-)
rename swagger-apis/pension/{x.x.x.yml => 1.0.0-rc3.0.yml} (99%)
diff --git a/dictionary/getPensionRiskCoverages_v1.csv b/dictionary/getPensionRiskCoverages_v1.csv
index 2ae496c51..fe06eeaac 100644
--- a/dictionary/getPensionRiskCoverages_v1.csv
+++ b/dictionary/getPensionRiskCoverages_v1.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -13,10 +13,10 @@
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
@@ -35,33 +35,37 @@ PENSAO_PRAZO_CERTO
PENSAO_MENORES_21
PENSAO_MENORES_24
PENSAO_CONJUGE_VITALICIA
-PENSAO_CONJUGE_TEMPORARIA";1;1;"";Não permitido;string;FUNERAL;
+PENSAO_CONJUGE_TEMPORARIA
+NA";1;1;"";Não permitido;string;FUNERAL;
/data/coverages;coverages;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/coverages/type;type;É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura.;Texto;9;Obrigatório;;"MORTE
INVALIDEZ
-OUTROS";1;1;"";Não permitido;string;MORTE;
+OUTROS
+NA";1;1;"";Não permitido;string;MORTE;
/data/coverages/typeAdditionalInfos;typeAdditionalInfos;"Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
";Lista;100;Opcional;;;0;N;"";Não permitido;array;;
/data/coverages/attributes;attributes;Atributos da cobertura;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/indemnifiablePeriod;indemnifiablePeriod;"Listagem do pagamento para cada benefício:
1. Quantidade determinada de parcelas;
2. Até o fim de ciclo determinado.
Se for pagamento único, esse campo não se aplica (retorna vazio).
";Texto;;Opcional;;"QUANTIDADE_DETERMINADA_PARCELAS
-FIM_CICLO_DETERMINADO";0;1;"";Não permitido;string;QUANTIDADE_DETERMINADA_PARCELAS;
+FIM_CICLO_DETERMINADO
+NA";0;1;"";Não permitido;string;QUANTIDADE_DETERMINADA_PARCELAS;
/data/coverages/attributes/indemnifiableDeadline;indemnifiableDeadline;Número máximo de parcelas indenizáveis. Caso seja relacionado a parcelas.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;;
/data/coverages/attributes/indemnityPaymentMethod;indemnityPaymentMethod;"Modalidade de pagamento da indenização, a considerar os domínios abaixo:
1. Único
2. Sob a forma de renda
";Texto;;Obrigatório;;"UNICO
-SOB_FORMA_RENDA";1;1;"";Não permitido;string;UNICO;
+SOB_FORMA_RENDA
+NA";1;1;"";Não permitido;string;UNICO;
/data/coverages/attributes/gracePeriod;gracePeriod;Período de carência da cobertura;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/coverages/attributes/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Opcional;;;0;1;"";Não permitido;integer;90;
/data/coverages/attributes/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Opcional;;"DIAS
@@ -76,11 +80,13 @@ DOENCAS_LESOES_PREEXISTENTES
EPIDEMIAS_PANDEMIAS
SUICIDIO
ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
-OUTROS";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
+OUTROS
+NA";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
/data/coverages/attributes/excludedRisksURL;excludedRisksURL;Campo aberto (possibilidade de incluir URL).;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/coverages/attributes/profitModality;profitModality;"Modalidade de pagamento da indenização.
";Texto;;Obrigatório;;"PAGAMENTO_UNICO
-FORMA_RENDA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;
+FORMA_RENDA
+NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;
/data/assistanceTypes;assistanceTypes;;Lista;43;Opcional;;"ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
ARQUITETO_VIRTUAL
ASSESSORIA_FINANCEIRA
@@ -136,7 +142,8 @@ SUSTENTAVEL_DESCARTE_ECOLOGICO
TELEMEDICINA
VIAGEM
VITIMA
-OUTROS";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
+OUTROS
+NA";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
/data/assistanceTypesAdditionalInfos;assistanceTypesAdditionalInfos;Lista a ser preenchida pelas participantes quando houver 'Outros' no campo 'Tipo de Assistência'.;Lista;;Opcional;;;0;N;"";Não permitido;array;;
/data/additional;additional;;Texto;;Opcional;;"SORTEIO
SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
@@ -144,16 +151,18 @@ SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
OUTROS
NAO_HA";0;1;"";Não permitido;string;SORTEIO;
/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
IGP_M
-INPC";0;N;"";Não permitido;array;IPCA;
+INPC
+NA";0;N;"";Não permitido;array;IPCA;
/data/premiumUpdateIndex;premiumUpdateIndex;Índice utilizado na atualização do prêmio/contribuição e do capital segurado/benefício;Texto;;Obrigatório;;"IPCA
IGPM
-INPC";1;1;"";Não permitido;string;IPCA;
+INPC
+NA";1;1;"";Não permitido;string;IPCA;
/data/ageAdjustment;ageAdjustment;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/ageAdjustment/criterias;criterias;;Lista;27;Obrigatório;;"APOS_PERIODO_ANOS
CADA_PERIODO_ANOS
@@ -166,12 +175,13 @@ NAO_APLICAVEL";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
3. Capitalização
";Texto;;Opcional;;"REPARTICAO_SIMPLES
REPARTICAO_CAPITAIS
-CAPITALIZACAO";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
+CAPITALIZACAO
+NA";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
/data/reclaim;reclaim;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
-/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para resgate:
@@ -210,7 +220,8 @@ PIX
TED_DOC
CONSIGNACAO_FOLHA_PAGAMENTO
PONTOS_PROGRAMA_BENEFICIO
-OUTROS";1;1;"";Não permitido;string;CARTAO_CREDITO;
+OUTROS
+NA";1;1;"";Não permitido;string;CARTAO_CREDITO;
/data/contributionPayment/contributionPaymentMethodAdditionalInfo;contributionPaymentMethodAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
[Restrição] Obrigatório quando 'contributionPaymentMethod' for igual 'OUTROS'.
@@ -230,7 +241,8 @@ ANUAL
TRIMESTRAL
SEMESTRAL
BIMESTRAL
-OUTROS";1;1;"";Não permitido;string;MENSAL;
+OUTROS
+NA";1;1;"";Não permitido;string;MENSAL;
/data/contributionPayment/contributionPeriodicityAdditionalInfo;contributionPeriodicityAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
[Restrição] Obrigatório quando 'contributionPeriodicity' for igual 'OUTROS'.
@@ -241,7 +253,8 @@ OUTROS";1;1;"";Não permitido;string;MENSAL;
1. Coletivo;
2. Individual.
";Texto;;Obrigatório;;"COLETIVO
-INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO;
+INDIVIDUAL
+NA";1;1;"";Não permitido;string;COLETIVO;
/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto contendo todos os requisitos mínimos para contratação (possibilidade de incluir URL).;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
@@ -250,4 +263,5 @@ INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO;
3. Ambas (Pessoa Natural e Jurídica)
";Texto;23;Obrigatório;;"PESSOA_NATURAL
PESSOA_JURIDICA
-PESSOA_NATURAL_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL;
+PESSOA_NATURAL_JURIDICA
+NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/dictionary/getPensionSurvivalCoverages_v1.csv b/dictionary/getPensionSurvivalCoverages_v1.csv
index 8beab0b65..0bf3169d2 100644
--- a/dictionary/getPensionSurvivalCoverages_v1.csv
+++ b/dictionary/getPensionSurvivalCoverages_v1.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -13,10 +13,10 @@
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;"Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;"Código único a ser definido pela sociedade.
@@ -25,14 +25,16 @@
1. Seguro de Pessoas
2. Previdência
";Texto;20;Obrigatório;;"SEGURO_PESSOAS
-PREVIDENCIA";1;1;"";Não permitido;string;PREVIDENCIA;
+PREVIDENCIA
+NA";1;1;"";Não permitido;string;PREVIDENCIA;
/data/modality;modality;"1. Contribuição Variável;
2. Benefício Definido.
";Texto;21;Obrigatório;;"CONTRIBUICAO_VARIAVEL
-BENEFICIO_DEFINIDO";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
+BENEFICIO_DEFINIDO
+NA";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/termsAndConditions;termsAndConditions;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/type;type;"1. PGBL
2. PRGP
@@ -59,9 +61,10 @@ VAGP
VRSA
VRI
VDR
-DEMAIS_PRODUTOS_PREVIDENCIA";0;1;"";Não permitido;string;;
+DEMAIS_PRODUTOS_PREVIDENCIA
+NA";0;1;"";Não permitido;string;;
/data/defferalPeriod;defferalPeriod;Período de Diferimento;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
2. IGP-M (FGV);
@@ -71,9 +74,9 @@ IGP_M
INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
/data/defferalPeriod/otherMinimumPerformanceGarantees;otherMinimumPerformanceGarantees;Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.;Texto;12;Obrigatório;;;1;1;"";Não permitido;string;SELIC;
-/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/minimumPremiums;minimumPremiums;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^[A-Z]{3}$;;0;1;"";Não permitido;string;BRL;
+/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})$|^(NA)$;;0;1;"";Não permitido;string;BRL;
/data/defferalPeriod/minimumPremiums/periodicity;periodicity;;Texto;10;Opcional;;"DIARIO
SEMANAL
QUINZENAL
@@ -82,8 +85,9 @@ BIMESTRAL
TRIMESTRAL
SEMESTRAL
ANUAL
-UNICO";0;1;"";Não permitido;string;MENSAL;
-/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;250.00;
+UNICO
+NA";0;1;"";Não permitido;string;MENSAL;
+/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;250.00;
/data/defferalPeriod/premiumPaymentMethods;premiumPaymentMethods;;Lista;27;Opcional;;"CARTAO_CREDITO
DEBITO_CONTA
DEBITO_CONTA_POUPANCA
@@ -94,7 +98,8 @@ REGRA_PARCEIRO
CONSIGNACAO_FOLHA_PAGAMENTO
PONTOS_PROGRAMA_BENEFICIO
TED_DOC
-OUTROS";0;N;"";Não permitido;array;CARTAO_CREDITO;
+OUTROS
+NA";0;N;"";Não permitido;array;CARTAO_CREDITO;
/data/defferalPeriod/permissionExtraordinaryContributions;permissionExtraordinaryContributions;"Se ficam permitidos aportes extraordinários. A considerar os seguintes domínios:
1. true
2. false
@@ -102,7 +107,7 @@ OUTROS";0;N;"";Não permitido;array;CARTAO_CREDITO;
/data/defferalPeriod/permissionScheduledFinancialPayments;permissionScheduledFinancialPayments;"Se ficam permitidos pagamentos financeiros programados. A considerar os seguintes domínios:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/defferalPeriod/gracePeriod;gracePeriod;Prazo de carência;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/defferalPeriod/gracePeriod/redemption;redemption;"Prazo em dias de carência para resgate Para Coletivos: Valor máximo da carência.
";Número;;Obrigatório;;;1;1;"";Não permitido;number;100;
@@ -113,31 +118,32 @@ OUTROS";0;N;"";Não permitido;array;CARTAO_CREDITO;
/data/defferalPeriod/redemptionPaymentTerm;redemptionPaymentTerm;Prazo em dias para pagamento do resgate;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/defferalPeriod/portabilityPaymentTerm;portabilityPaymentTerm;Prazo em dias para pagamento da portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;20;
/data/defferalPeriod/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/defferalPeriod/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Nome Fantasia
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
/data/defferalPeriod/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
-";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+";Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
INDIRETAMENTE
-NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
+NAO_APLICA
+NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/defferalPeriod/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
-";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.019800;8
+";Texto;9;Opcional;^(\d{1}\.\d{6})$|^(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Regra de Elegibilidade
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/defferalPeriod/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo de Contribuição
-";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
/data/defferalPeriod/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
-";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
-/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^[A-Z]{3}$;;0;1;"";Não permitido;string;BRL;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
+/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})$|^(NA)$;;0;1;"";Não permitido;string;BRL;
/data/grantPeriodBenefit;grantPeriodBenefit;Período de concessão do benefício;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/grantPeriodBenefit/incomeModalities;incomeModalities;;Lista;;Obrigatório;;"PAGAMENTO_UNICO
RENDA_PRAZO_CERTO
@@ -149,7 +155,8 @@ RENDA_VITALICIA
RENDA_VITALICIA_REVERSIVEL_BENEFICIARIO_INDICADO
RENDA_VITALICIA_CONJUGE_CONTINUIDADE_MENORES
RENDA_VITALICIA_MINIMO_GARANTIDO
-RENDA_VITALICIA_PRAZO_MINIMO_GRANTIDO";1;N;"";Não permitido;array;PAGAMENTO_UNICO;
+RENDA_VITALICIA_PRAZO_MINIMO_GRANTIDO
+NA";1;N;"";Não permitido;array;PAGAMENTO_UNICO;
/data/grantPeriodBenefit/biometricTable;biometricTable;;Lista;32;Opcional;;"AT_2000_MALE
AT_2000_FEMALE
AT_2000_MALE_FEMALE
@@ -164,8 +171,9 @@ AT_83_FEMALE
AT_83_MALE_FEMALE
BR_EMSSB_MALE
BR_EMSSB_FEMALE
-BR_EMSSB_MALE_FEMALE";0;N;"";Não permitido;array;AT_2000_MALE;
-/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+BR_EMSSB_MALE_FEMALE
+NA";0;N;"";Não permitido;array;AT_2000_MALE;
+/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
1. IPCA (IBGE);
2. IGP-M (FGV);
@@ -174,40 +182,41 @@ BR_EMSSB_MALE_FEMALE";0;N;"";Não permitido;array;AT_2000_MALE;
IGP_M
INPC
NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
-/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/grantPeriodBenefit/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Nome Fantasia
";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
/data/grantPeriodBenefit/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Administração - em %
-";Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+";Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Tipo de taxa de performance
";Texto;13;Obrigatório;;"DIRETAMENTE
INDIRETAMENTE
-NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
+NAO_APLICA
+NA";1;1;"";Não permitido;string;DIRETAMENTE;
/data/grantPeriodBenefit/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Taxa Máxima de Performance - em %
-";Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.019800;8
+";Texto;9;Opcional;^(\d{1}\.\d{6})$|^(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Regra de Elegibilidade
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/grantPeriodBenefit/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo de Contribuição
-";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
/data/grantPeriodBenefit/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- Valor Mínimo do Saldo Provisão matemática
-";Texto;21;Opcional;^\d{1,16}\.\d{2,4}$;;0;1;"";Não permitido;string;1000.00;
-/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^[A-Z]{3}$;;0;1;"";Não permitido;string;BRL;
+";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
+/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})$|^(NA)$;;0;1;"";Não permitido;string;BRL;
/data/costs;costs;Custos;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/costs/loadingAntecipated;loadingAntecipated;Carregamento antecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/costs/loadingLate;loadingLate;Carregamento postecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
1. Coletivo Averbado;
@@ -215,15 +224,17 @@ NAO_APLICA";1;1;"";Não permitido;string;DIRETAMENTE;
3. Individual.
";Texto;27;Obrigatório;;"COLETIVO_AVERBADO
COLETIVO_INSTITUIDO
-INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO_AVERBADO;
+INDIVIDUAL
+NA";1;1;"";Não permitido;string;COLETIVO_AVERBADO;
/data/minimumRequirement/participantQualified;participantQualified;"Indicação se o plano é destinado para participante qualificado. A considerar os domínios abaixo:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
1. Pessoa Natural
2. Pessoa Jurídica
";Texto;23;Obrigatório;;"PESSOA_NATURAL
-PESSOA_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL;
+PESSOA_JURIDICA
+NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/swagger-apis/pension/x.x.x.yml b/swagger-apis/pension/1.0.0-rc3.0.yml
similarity index 99%
rename from swagger-apis/pension/x.x.x.yml
rename to swagger-apis/pension/1.0.0-rc3.0.yml
index 31f1757ff..bb3621183 100644
--- a/swagger-apis/pension/x.x.x.yml
+++ b/swagger-apis/pension/1.0.0-rc3.0.yml
@@ -4,7 +4,7 @@ info:
description: |
API de Previdência do Open Finance Brasil – Fase 4.
API que retorna informações de Previdência.
- version: x.x.x
+ version: 1.0.0-rc3.0
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0'
diff --git a/swagger-apis/pension/index.html b/swagger-apis/pension/index.html
index df9552a08..36e9ddfed 100644
--- a/swagger-apis/pension/index.html
+++ b/swagger-apis/pension/index.html
@@ -47,8 +47,8 @@
const ui = SwaggerUIBundle({
urls: [ {"name": "1.0.0-rc1.0", "url": "./1.0.0-rc1.0.yml"},
{"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"},
- {"name": "x.x.x", "url": "./x.x.x.yml"}],
- "urls.primaryName": "x.x.x", // default spec
+ {"name": "1.0.0-rc3.0", "url": "./1.0.0-rc3.0.yml"}],
+ "urls.primaryName": "1.0.0-rc3.0", // default spec
dom_id: '#swagger-ui',
deepLinking: true,
supportedSubmitMethods:[],
From 924d155c65160b2fff729a72fc3b7b2832709548 Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Tue, 16 May 2023 10:21:06 -0300
Subject: [PATCH 28/50] =?UTF-8?q?Fix=20-=20Adicionando=20nova=20vers=C3=A3?=
=?UTF-8?q?o=20pension=20-=20v1.0.0-rc3.0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
...entsInvestmentIdTransactionsCurrent_v1.csv | 2 +-
...InvestmentsInvestmentIdTransactions_v1.csv | 2 +-
dictionary/getPensionRiskCoverages_vx.csv | 267 ------------------
dictionary/getPensionSurvivalCoverages_vx.csv | 240 ----------------
4 files changed, 2 insertions(+), 509 deletions(-)
delete mode 100644 dictionary/getPensionRiskCoverages_vx.csv
delete mode 100644 dictionary/getPensionSurvivalCoverages_vx.csv
diff --git a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
index 8a475089e..9873069b4 100644
--- a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
+++ b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
@@ -1,4 +1,4 @@
-data,,,,,,,,,,,,,,,,,,links,,,,meta
+data,,,,,,,,,,,,,,,,,,links,,,,meta
type,transactionType,typeAdditionalInfo,transactionDate,transactionUnitPrice,,transactionQuantity,transactionGrossValue,,incomeTax,,financialTransactionTax,,transactionNetValue,,remunerationTransactionRate,indexerPercentage,transactionId,self,first,prev,next,requestDateTime
,,,,amount,currency,,amount,currency,amount,currency,amount,currency,amount,currency,,,,,,,,
ENTRADA,COMPRA,string,2018-02-15,1000.000004,BRL,42.25,1000.04,BRL,1000.04,BRL,1000.04,BRL,1000.04,BRL,0.300000,1.100000,ABCD2126019929279212650822221989319253344,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,2021-05-21T08:30:00Z
\ No newline at end of file
diff --git a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
index a9f249090..39c5e0a48 100644
--- a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
+++ b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
@@ -1,4 +1,4 @@
-data,,,,,,,,,,,,,,,,,,links,,,,meta
+data,,,,,,,,,,,,,,,,,,links,,,,meta
type,transactionType,typeAdditionalInfo,transactionDate,transactionUnitPrice,,transactionQuantity,transactionGrossValue,,incomeTax,,financialTransactionTax,,transactionNetValue,,remunerationTransactionRate,indexerPercentage,transactionId,self,first,prev,next,requestDateTime
,,,,amount,currency,,amount,currency,amount,currency,amount,currency,amount,currency,,,,,,,,
ENTRADA,COMPRA,string,2018-02-15,1000.000004,BRL,42.25,1000.04,BRL,1000.04,BRL,1000.04,BRL,1000.04,BRL,0.300000,1.100000,ABCD2126019929279212650822221989319253344,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,2021-05-21T08:30:00Z
\ No newline at end of file
diff --git a/dictionary/getPensionRiskCoverages_vx.csv b/dictionary/getPensionRiskCoverages_vx.csv
deleted file mode 100644
index fe06eeaac..000000000
--- a/dictionary/getPensionRiskCoverages_vx.csv
+++ /dev/null
@@ -1,267 +0,0 @@
-Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
-/data;data;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
-/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
-/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
-
-- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
-
-- ‘cnpjNumber’ com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
-
-- Ambos do tipo string;
-
-- Ambos obrigatórios.
-";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
-/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
-/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
-/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
-/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
-PRESTAMISTA
-VIAGEM
-EDUCACIONAL
-DOTAL
-ACIDENTES_PESSOAIS
-VIDA
-PERDA_CERTIFICADO_HABILITACAO_VOO
-DOENCAS_GRAVES_DOENCA_TERMINAL
-DESEMPREGO_PERDA_RENDA
-EVENTOS_ALEATORIOS
-PECULIO
-PENSAO_PRAZO_CERTO
-PENSAO_MENORES_21
-PENSAO_MENORES_24
-PENSAO_CONJUGE_VITALICIA
-PENSAO_CONJUGE_TEMPORARIA
-NA";1;1;"";Não permitido;string;FUNERAL;
-/data/coverages;coverages;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/coverages/type;type;É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura.;Texto;9;Obrigatório;;"MORTE
-INVALIDEZ
-OUTROS
-NA";1;1;"";Não permitido;string;MORTE;
-/data/coverages/typeAdditionalInfos;typeAdditionalInfos;"Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
-Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
-";Lista;100;Opcional;;;0;N;"";Não permitido;array;;
-/data/coverages/attributes;attributes;Atributos da cobertura;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
-/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
-/data/coverages/attributes/indemnifiablePeriod;indemnifiablePeriod;"Listagem do pagamento para cada benefício:
- 1. Quantidade determinada de parcelas;
- 2. Até o fim de ciclo determinado.
-Se for pagamento único, esse campo não se aplica (retorna vazio).
-";Texto;;Opcional;;"QUANTIDADE_DETERMINADA_PARCELAS
-FIM_CICLO_DETERMINADO
-NA";0;1;"";Não permitido;string;QUANTIDADE_DETERMINADA_PARCELAS;
-/data/coverages/attributes/indemnifiableDeadline;indemnifiableDeadline;Número máximo de parcelas indenizáveis. Caso seja relacionado a parcelas.;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;;
-/data/coverages/attributes/indemnityPaymentMethod;indemnityPaymentMethod;"Modalidade de pagamento da indenização, a considerar os domínios abaixo:
- 1. Único
- 2. Sob a forma de renda
-";Texto;;Obrigatório;;"UNICO
-SOB_FORMA_RENDA
-NA";1;1;"";Não permitido;string;UNICO;
-/data/coverages/attributes/gracePeriod;gracePeriod;Período de carência da cobertura;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Opcional;;;0;1;"";Não permitido;integer;90;
-/data/coverages/attributes/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Opcional;;"DIAS
-MESES
-NAO_APLICA";0;1;"";Não permitido;string;MESES;
-/data/coverages/attributes/excludedRisks;excludedRisks;;Lista;40;Obrigatório;;"ATO_RECONHECIMENTO_PERIGOSO
-ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
-OPERACOES_GUERRA
-FURACOES_CICLONES_TERREMOTOS
-MATERIAL_NUCLEAR
-DOENCAS_LESOES_PREEXISTENTES
-EPIDEMIAS_PANDEMIAS
-SUICIDIO
-ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
-OUTROS
-NA";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
-/data/coverages/attributes/excludedRisksURL;excludedRisksURL;Campo aberto (possibilidade de incluir URL).;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/coverages/attributes/profitModality;profitModality;"Modalidade de pagamento da indenização.
-";Texto;;Obrigatório;;"PAGAMENTO_UNICO
-FORMA_RENDA
-NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;
-/data/assistanceTypes;assistanceTypes;;Lista;43;Opcional;;"ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
-ARQUITETO_VIRTUAL
-ASSESSORIA_FINANCEIRA
-AUTOMOVEL
-AUXILIO_NATALIDADE
-AVALIACAO_CLINICA_PREVENTIVA
-BOLSA_PROTEGIDA
-CESTA_BASICA
-CHECKUP_ODONTOLOGICO
-CLUBE_VANTAGENS_BENEFICIOS
-CONVALESCENCIA
-DECESSO
-DESCONTO_FARMACIAS_MEDICAMENTOS
-DESPESAS_FARMACEUTICAS_VIAGEM
-DIGITAL
-EDUCACIONAL
-EMPRESARIAL
-ENCANADOR
-ENTRETENIMENTO
-EQUIPAMENTOS_MEDICOS
-FIANCAS_DESPESAS_LEGAIS
-FISIOTERAPIA
-FUNERAL
-HELP_LINE
-HOSPEDAGEM_ACOMPANHANTE
-INTERRUPCAO_VIAGEM
-INVENTARIO
-MAIS_VIDA
-MAMAE_BEBE
-MEDICA_ACIDENTE_DOENCA
-MOTOCICLETA
-MULHER
-NUTRICIONISTA
-ODONTOLOGICA
-ORIENTACAO_FITNESS
-ORIENTACAO_JURIDICA
-ORIENTACAO_NUTRICIONAL
-PERSONAL_FITNESS
-ORIENTACAO_PSICOSSOCIAL_FAMILIAR
-PERDA_ROUBO_CARTAO
-PET
-PRORROGACAO_ESTADIA
-PROTECAO_DADOS
-RECOLOCACAO_PROFISSIONAL
-REDE_DESCONTO_NUTRICIONAL
-RESIDENCIAL
-RETORNO_MENORES_SEGURADO
-SAQUE_COACAO
-SAUDE_BEM_ESTAR
-SEGUNDA_OPINIAO_MEDICA
-SENIOR
-SUSTENTAVEL_DESCARTE_ECOLOGICO
-TELEMEDICINA
-VIAGEM
-VITIMA
-OUTROS
-NA";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
-/data/assistanceTypesAdditionalInfos;assistanceTypesAdditionalInfos;Lista a ser preenchida pelas participantes quando houver 'Outros' no campo 'Tipo de Assistência'.;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/additional;additional;;Texto;;Opcional;;"SORTEIO
-SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
-SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
-OUTROS
-NAO_HA";0;1;"";Não permitido;string;SORTEIO;
-/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
-/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
-IGP_M
-INPC
-NA";0;N;"";Não permitido;array;IPCA;
-/data/premiumUpdateIndex;premiumUpdateIndex;Índice utilizado na atualização do prêmio/contribuição e do capital segurado/benefício;Texto;;Obrigatório;;"IPCA
-IGPM
-INPC
-NA";1;1;"";Não permitido;string;IPCA;
-/data/ageAdjustment;ageAdjustment;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/ageAdjustment/criterias;criterias;;Lista;27;Obrigatório;;"APOS_PERIODO_ANOS
-CADA_PERIODO_ANOS
-MUDANCA_FAIXA_ETARIA
-NAO_APLICAVEL";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
-/data/ageAdjustment/frequency;frequency;Período em anos, caso critério de reenquadramento após ou a cada período em anos.;Inteiro;3;Obrigatório;;;1;1;"";Não permitido;integer;10;
-/data/financialRegimeContractType;financialRegimeContractType;"Listagem de regime financeiro para cada combinação de modalidade/cobertura do produto indicando:
- 1. Repartição simples
- 2. Repartição Capitais Cobertura
- 3. Capitalização
-";Texto;;Opcional;;"REPARTICAO_SIMPLES
-REPARTICAO_CAPITAIS
-CAPITALIZACAO
-NA";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
-/data/reclaim;reclaim;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
-/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
-/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
-/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
-/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para resgate:
-1. Dias;
-2. Meses;
-3. Não se aplica.
-";Texto;;Obrigatório;;"DIAS
-MESES
-NAO_APLICA";1;1;"";Não permitido;string;MESES;
-/data/reclaim/differenciatedPercentage;differenciatedPercentage;Campo aberto (possibilidade de incluir URL);"";1024;Opcional;;;0;1;"";Não permitido;;"https://openinsurance.com.br/aaa’
-Obs.: Exceção de cobertura ou critério definido acima será descrito aqui na URL
-Exemplo: Cobertura X: a partir de 25 meses = 100%
-";
-/data/otherGuaranteedValues;otherGuaranteedValues;"1. Saldamento
-2. Benefício Prolongado
-3. Não se aplica
-";Texto;;Obrigatório;;"SALDAMENTO
-BENEFICIO_PROLONGADO
-NAO_APLICA";1;1;"";Não permitido;string;SALDAMENTO;
-/data/contributionPayment;contributionPayment;Pagamento da contribuição.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/contributionPayment/contributionPaymentMethod;contributionPaymentMethod;"Forma de pagamento da contribuição.
- - CARTAO_CREDITO
- - DEBITO_CONTA
- - DEBITO_CONTA_POUPANCA
- - BOLETO_BANCARIO
- - PIX
- - TED_DOC
- - CONSIGNACAO_FOLHA_PAGAMENTO
- - PONTOS_PROGRAMA_BENEFICIO
- - OUTROS
-";Texto;;Obrigatório;;"CARTAO_CREDITO
-DEBITO_CONTA
-DEBITO_CONTA_POUPANCA
-BOLETO_BANCARIO
-PIX
-TED_DOC
-CONSIGNACAO_FOLHA_PAGAMENTO
-PONTOS_PROGRAMA_BENEFICIO
-OUTROS
-NA";1;1;"";Não permitido;string;CARTAO_CREDITO;
-/data/contributionPayment/contributionPaymentMethodAdditionalInfo;contributionPaymentMethodAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
-
-[Restrição] Obrigatório quando 'contributionPaymentMethod' for igual 'OUTROS'.
-";Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando 'contributionPaymentMethod' for igual 'OUTROS'.
-";Não permitido;string;Informações adicionais;
-/data/contributionPayment/contributionPeriodicity;contributionPeriodicity;"Periodicidade de pagamento da contribuição.
-- MENSAL
-- UNICA
-- ANUAL
-- TRIMESTRAL
-- SEMESTRAL
-- BIMESTRAL
-- OUTROS
-";Texto;;Obrigatório;;"MENSAL
-UNICA
-ANUAL
-TRIMESTRAL
-SEMESTRAL
-BIMESTRAL
-OUTROS
-NA";1;1;"";Não permitido;string;MENSAL;
-/data/contributionPayment/contributionPeriodicityAdditionalInfo;contributionPeriodicityAdditionalInfo;"Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
-
-[Restrição] Obrigatório quando 'contributionPeriodicity' for igual 'OUTROS'.
-";Texto;140;Condicional;[\w\W\s]*;;0;1;" Obrigatório quando 'contributionPeriodicity' for igual 'OUTROS'.
-";Não permitido;string;Informações adicionais;
-/data/minimumRequirement;minimumRequirement;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
-1. Coletivo;
-2. Individual.
-";Texto;;Obrigatório;;"COLETIVO
-INDIVIDUAL
-NA";1;1;"";Não permitido;string;COLETIVO;
-/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto contendo todos os requisitos mínimos para contratação (possibilidade de incluir URL).;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
-
- 1. Pessoa Natural
- 2. Pessoa Jurídica
- 3. Ambas (Pessoa Natural e Jurídica)
-";Texto;23;Obrigatório;;"PESSOA_NATURAL
-PESSOA_JURIDICA
-PESSOA_NATURAL_JURIDICA
-NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/dictionary/getPensionSurvivalCoverages_vx.csv b/dictionary/getPensionSurvivalCoverages_vx.csv
deleted file mode 100644
index 0bf3169d2..000000000
--- a/dictionary/getPensionSurvivalCoverages_vx.csv
+++ /dev/null
@@ -1,240 +0,0 @@
-Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
-/data;data;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
-/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
-/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
-
-- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
-
-- ‘cnpjNumber’ com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
-
-- Ambos do tipo string;
-
-- Ambos obrigatórios.
-";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
-/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
-/data/name;name;"Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
-";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
-/data/code;code;"Código único a ser definido pela sociedade.
-";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
-/data/segment;segment;"Segmento do qual se trata o produto contratado
-1. Seguro de Pessoas
-2. Previdência
-";Texto;20;Obrigatório;;"SEGURO_PESSOAS
-PREVIDENCIA
-NA";1;1;"";Não permitido;string;PREVIDENCIA;
-/data/modality;modality;"1. Contribuição Variável;
-2. Benefício Definido.
-";Texto;21;Obrigatório;;"CONTRIBUICAO_VARIAVEL
-BENEFICIO_DEFINIDO
-NA";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
-/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/termsAndConditions;termsAndConditions;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
-/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/type;type;"1. PGBL
-2. PRGP
-3. PAGP
-4. PRSA
-5. PRI
-6. PDR
-7. VGBL
-8. VRGP
-9. VAGP
-10. VRSA
-11. VRI
-12. VDR
-13. Demais produtos de Previdência.
-";Texto;27;Opcional;;"PGBL
-PRGP
-PAGP
-PRSA
-PRI
-PDR
-VGBL
-VRGP
-VAGP
-VRSA
-VRI
-VDR
-DEMAIS_PRODUTOS_PREVIDENCIA
-NA";0;1;"";Não permitido;string;;
-/data/defferalPeriod;defferalPeriod;Período de Diferimento;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/defferalPeriod/interestRate;interestRate;Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/defferalPeriod/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
-1. IPCA (IBGE);
-2. IGP-M (FGV);
-3. INPC (IBGE).
-";Texto;5;Obrigatório;;"IPCA
-IGP_M
-INPC
-NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
-/data/defferalPeriod/otherMinimumPerformanceGarantees;otherMinimumPerformanceGarantees;Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.;Texto;12;Obrigatório;;;1;1;"";Não permitido;string;SELIC;
-/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/defferalPeriod/minimumPremiums;minimumPremiums;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/minimumPremiums/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})$|^(NA)$;;0;1;"";Não permitido;string;BRL;
-/data/defferalPeriod/minimumPremiums/periodicity;periodicity;;Texto;10;Opcional;;"DIARIO
-SEMANAL
-QUINZENAL
-MENSAL
-BIMESTRAL
-TRIMESTRAL
-SEMESTRAL
-ANUAL
-UNICO
-NA";0;1;"";Não permitido;string;MENSAL;
-/data/defferalPeriod/minimumPremiums/amount;amount;Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).;Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;250.00;
-/data/defferalPeriod/premiumPaymentMethods;premiumPaymentMethods;;Lista;27;Opcional;;"CARTAO_CREDITO
-DEBITO_CONTA
-DEBITO_CONTA_POUPANCA
-BOLETO_BANCARIO
-PIX
-CARTAO_DEBITO
-REGRA_PARCEIRO
-CONSIGNACAO_FOLHA_PAGAMENTO
-PONTOS_PROGRAMA_BENEFICIO
-TED_DOC
-OUTROS
-NA";0;N;"";Não permitido;array;CARTAO_CREDITO;
-/data/defferalPeriod/permissionExtraordinaryContributions;permissionExtraordinaryContributions;"Se ficam permitidos aportes extraordinários. A considerar os seguintes domínios:
-1. true
-2. false
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
-/data/defferalPeriod/permissionScheduledFinancialPayments;permissionScheduledFinancialPayments;"Se ficam permitidos pagamentos financeiros programados. A considerar os seguintes domínios:
-1. true
-2. false
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
-/data/defferalPeriod/gracePeriod;gracePeriod;Prazo de carência;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/defferalPeriod/gracePeriod/redemption;redemption;"Prazo em dias de carência para resgate Para Coletivos: Valor máximo da carência.
-";Número;;Obrigatório;;;1;1;"";Não permitido;number;100;
-/data/defferalPeriod/gracePeriod/betweenRedemptionRequests;betweenRedemptionRequests;"Prazo em dias de carência entre pedidos de resgate Para Coletivos: Valor máximo da carência
-";Número;;Obrigatório;;;1;1;"";Não permitido;number;30;
-/data/defferalPeriod/gracePeriod/portability;portability;Prazo em dias de carência para portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;12;
-/data/defferalPeriod/gracePeriod/betweenPortabilityRequests;betweenPortabilityRequests;Prazo em dias de carência entre pedidos de portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;15;
-/data/defferalPeriod/redemptionPaymentTerm;redemptionPaymentTerm;Prazo em dias para pagamento do resgate;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;10;
-/data/defferalPeriod/portabilityPaymentTerm;portabilityPaymentTerm;Prazo em dias para pagamento da portabilidade (entre empresas diferentes).;Número;;Obrigatório;;;1;1;"";Não permitido;number;20;
-/data/defferalPeriod/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/defferalPeriod/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
-/data/defferalPeriod/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
-- Nome Fantasia
-";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
-/data/defferalPeriod/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Taxa Máxima de Administração - em %
-";Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/defferalPeriod/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Tipo de taxa de performance
-";Texto;13;Obrigatório;;"DIRETAMENTE
-INDIRETAMENTE
-NAO_APLICA
-NA";1;1;"";Não permitido;string;DIRETAMENTE;
-/data/defferalPeriod/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Taxa Máxima de Performance - em %
-";Texto;9;Opcional;^(\d{1}\.\d{6})$|^(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
-/data/defferalPeriod/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Regra de Elegibilidade
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
-/data/defferalPeriod/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Valor Mínimo de Contribuição
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
-/data/defferalPeriod/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Valor Mínimo do Saldo Provisão matemática
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
-/data/defferalPeriod/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})$|^(NA)$;;0;1;"";Não permitido;string;BRL;
-/data/grantPeriodBenefit;grantPeriodBenefit;Período de concessão do benefício;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/grantPeriodBenefit/incomeModalities;incomeModalities;;Lista;;Obrigatório;;"PAGAMENTO_UNICO
-RENDA_PRAZO_CERTO
-RENDA_TEMPORARIA
-RENDA_TEMPORARIA_REVERSIVEL
-RENDA_TEMPORARIA_MINMO_GARANTIDO
-RENDA_TEMPORARIA_REVERSIVEL_MININO_GARANTIDO
-RENDA_VITALICIA
-RENDA_VITALICIA_REVERSIVEL_BENEFICIARIO_INDICADO
-RENDA_VITALICIA_CONJUGE_CONTINUIDADE_MENORES
-RENDA_VITALICIA_MINIMO_GARANTIDO
-RENDA_VITALICIA_PRAZO_MINIMO_GRANTIDO
-NA";1;N;"";Não permitido;array;PAGAMENTO_UNICO;
-/data/grantPeriodBenefit/biometricTable;biometricTable;;Lista;32;Opcional;;"AT_2000_MALE
-AT_2000_FEMALE
-AT_2000_MALE_FEMALE
-AT_2000_MALE_SUAVIZADA_10
-AT_2000_FEMALE_SUAVIZADA_10
-AT_2000_MALE_FEMALE_SUAVIZADA_10
-AT_2000_MALE_SUAVIZADA_15
-AT_2000_FEMALE_SUAVIZADA_15
-AT_2000_MALE_FEMALE_SUAVIZADA_15
-AT_83_MALE
-AT_83_FEMALE
-AT_83_MALE_FEMALE
-BR_EMSSB_MALE
-BR_EMSSB_FEMALE
-BR_EMSSB_MALE_FEMALE
-NA";0;N;"";Não permitido;array;AT_2000_MALE;
-/data/grantPeriodBenefit/interestRate;interestRate;Taxa de juros garantida utilizada para conversão em renda. Em %;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/grantPeriodBenefit/updateIndex;updateIndex;"Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
-1. IPCA (IBGE);
-2. IGP-M (FGV);
-3. INPC (IBGE).
-";Texto;5;Obrigatório;;"IPCA
-IGP_M
-INPC
-NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
-/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/grantPeriodBenefit/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
-/data/grantPeriodBenefit/investmentFunds/name;name;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
-- Nome Fantasia
-";Texto;80;Obrigatório;;;1;1;"";Não permitido;string;EMPRESAAPREV;
-/data/grantPeriodBenefit/investmentFunds/maximumAdministrationFee;maximumAdministrationFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Taxa Máxima de Administração - em %
-";Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/grantPeriodBenefit/investmentFunds/typePerformanceFee;typePerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Tipo de taxa de performance
-";Texto;13;Obrigatório;;"DIRETAMENTE
-INDIRETAMENTE
-NAO_APLICA
-NA";1;1;"";Não permitido;string;DIRETAMENTE;
-/data/grantPeriodBenefit/investmentFunds/maximumPerformanceFee;maximumPerformanceFee;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Taxa Máxima de Performance - em %
-";Texto;9;Opcional;^(\d{1}\.\d{6})$|^(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
-/data/grantPeriodBenefit/investmentFunds/eligibilityRule;eligibilityRule;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Regra de Elegibilidade
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
-/data/grantPeriodBenefit/investmentFunds/minimumContributionAmount;minimumContributionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Valor Mínimo de Contribuição
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
-/data/grantPeriodBenefit/investmentFunds/minimumMathematicalProvisionAmount;minimumMathematicalProvisionAmount;"Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
- - Valor Mínimo do Saldo Provisão matemática
-";Texto;21;Opcional;^(\d{1,16}\.\d{2,4})$|^(NA)$;;0;1;"";Não permitido;string;1000.00;
-/data/grantPeriodBenefit/investmentFunds/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Opcional;^([A-Z]{3})$|^(NA)$;;0;1;"";Não permitido;string;BRL;
-/data/costs;costs;Custos;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingAntecipated;loadingAntecipated;Carregamento antecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingAntecipated/minValue;minValue;Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingAntecipated/maxValue;maxValue;Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingLate;loadingLate;Carregamento postecipado.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/costs/loadingLate/minValue;minValue;Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/costs/loadingLate/maxValue;maxValue;Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
-1. Coletivo Averbado;
-2. Coletivo instituído;
-3. Individual.
-";Texto;27;Obrigatório;;"COLETIVO_AVERBADO
-COLETIVO_INSTITUIDO
-INDIVIDUAL
-NA";1;1;"";Não permitido;string;COLETIVO_AVERBADO;
-/data/minimumRequirement/participantQualified;participantQualified;"Indicação se o plano é destinado para participante qualificado. A considerar os domínios abaixo:
-1. true
-2. false
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
-/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
-
- 1. Pessoa Natural
- 2. Pessoa Jurídica
-";Texto;23;Obrigatório;;"PESSOA_NATURAL
-PESSOA_JURIDICA
-NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
From 56263c1d2069214d909173f4affb85cb4c4b520c Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Tue, 16 May 2023 10:30:53 -0300
Subject: [PATCH 29/50] =?UTF-8?q?fix(Pension):=20PC81=20-=20descri=C3=A7?=
=?UTF-8?q?=C3=A3o=20enums?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
dictionary/getPensionRiskCoverages_v1.csv | 9 ++++++++-
dictionary/getPensionSurvivalCoverages_v1.csv | 5 +++++
swagger-apis/pension/1.0.0-rc3.0.yml | 16 +++++++++++++++-
3 files changed, 28 insertions(+), 2 deletions(-)
diff --git a/dictionary/getPensionRiskCoverages_v1.csv b/dictionary/getPensionRiskCoverages_v1.csv
index fe06eeaac..4f1108c8a 100644
--- a/dictionary/getPensionRiskCoverages_v1.csv
+++ b/dictionary/getPensionRiskCoverages_v1.csv
@@ -19,7 +19,7 @@
/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
-/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
+/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
- NA
;Texto;33;Obrigatório;;"FUNERAL
PRESTAMISTA
VIAGEM
EDUCACIONAL
@@ -55,6 +55,7 @@ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a
/data/coverages/attributes/indemnifiablePeriod;indemnifiablePeriod;"Listagem do pagamento para cada benefício:
1. Quantidade determinada de parcelas;
2. Até o fim de ciclo determinado.
+ 3. NA
Se for pagamento único, esse campo não se aplica (retorna vazio).
";Texto;;Opcional;;"QUANTIDADE_DETERMINADA_PARCELAS
FIM_CICLO_DETERMINADO
@@ -63,6 +64,7 @@ NA";0;1;"";Não permitido;string;QUANTIDADE_DETERMINADA_PARCELAS;
/data/coverages/attributes/indemnityPaymentMethod;indemnityPaymentMethod;"Modalidade de pagamento da indenização, a considerar os domínios abaixo:
1. Único
2. Sob a forma de renda
+ 3. NA
";Texto;;Obrigatório;;"UNICO
SOB_FORMA_RENDA
NA";1;1;"";Não permitido;string;UNICO;
@@ -173,6 +175,7 @@ NAO_APLICAVEL";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
1. Repartição simples
2. Repartição Capitais Cobertura
3. Capitalização
+ 4. NA
";Texto;;Opcional;;"REPARTICAO_SIMPLES
REPARTICAO_CAPITAIS
CAPITALIZACAO
@@ -212,6 +215,7 @@ NAO_APLICA";1;1;"";Não permitido;string;SALDAMENTO;
- CONSIGNACAO_FOLHA_PAGAMENTO
- PONTOS_PROGRAMA_BENEFICIO
- OUTROS
+ - NA
";Texto;;Obrigatório;;"CARTAO_CREDITO
DEBITO_CONTA
DEBITO_CONTA_POUPANCA
@@ -235,6 +239,7 @@ NA";1;1;"";Não permitido;string;CARTAO_CREDITO;
- SEMESTRAL
- BIMESTRAL
- OUTROS
+- NA
";Texto;;Obrigatório;;"MENSAL
UNICA
ANUAL
@@ -252,6 +257,7 @@ NA";1;1;"";Não permitido;string;MENSAL;
/data/minimumRequirement/contractType;contractType;"O tipo de serviço contratado. A considerar os domínios abaixo:
1. Coletivo;
2. Individual.
+3. NA
";Texto;;Obrigatório;;"COLETIVO
INDIVIDUAL
NA";1;1;"";Não permitido;string;COLETIVO;
@@ -261,6 +267,7 @@ NA";1;1;"";Não permitido;string;COLETIVO;
1. Pessoa Natural
2. Pessoa Jurídica
3. Ambas (Pessoa Natural e Jurídica)
+ 4. NA
";Texto;23;Obrigatório;;"PESSOA_NATURAL
PESSOA_JURIDICA
PESSOA_NATURAL_JURIDICA
diff --git a/dictionary/getPensionSurvivalCoverages_v1.csv b/dictionary/getPensionSurvivalCoverages_v1.csv
index 0bf3169d2..1e98330a5 100644
--- a/dictionary/getPensionSurvivalCoverages_v1.csv
+++ b/dictionary/getPensionSurvivalCoverages_v1.csv
@@ -24,11 +24,13 @@
/data/segment;segment;"Segmento do qual se trata o produto contratado
1. Seguro de Pessoas
2. Previdência
+3. NA
";Texto;20;Obrigatório;;"SEGURO_PESSOAS
PREVIDENCIA
NA";1;1;"";Não permitido;string;PREVIDENCIA;
/data/modality;modality;"1. Contribuição Variável;
2. Benefício Definido.
+3. NA
";Texto;21;Obrigatório;;"CONTRIBUICAO_VARIAVEL
BENEFICIO_DEFINIDO
NA";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
@@ -49,6 +51,7 @@ NA";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
11. VRI
12. VDR
13. Demais produtos de Previdência.
+14. NA
";Texto;27;Opcional;;"PGBL
PRGP
PAGP
@@ -222,6 +225,7 @@ NA";1;1;"";Não permitido;string;DIRETAMENTE;
1. Coletivo Averbado;
2. Coletivo instituído;
3. Individual.
+4. NA
";Texto;27;Obrigatório;;"COLETIVO_AVERBADO
COLETIVO_INSTITUIDO
INDIVIDUAL
@@ -235,6 +239,7 @@ NA";1;1;"";Não permitido;string;COLETIVO_AVERBADO;
1. Pessoa Natural
2. Pessoa Jurídica
+ 3. NA
";Texto;23;Obrigatório;;"PESSOA_NATURAL
PESSOA_JURIDICA
NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/swagger-apis/pension/1.0.0-rc3.0.yml b/swagger-apis/pension/1.0.0-rc3.0.yml
index bb3621183..c036bf5b4 100644
--- a/swagger-apis/pension/1.0.0-rc3.0.yml
+++ b/swagger-apis/pension/1.0.0-rc3.0.yml
@@ -172,6 +172,7 @@ components:
1. Pessoa Natural
2. Pessoa Jurídica
3. Ambas (Pessoa Natural e Jurídica)
+ 4. NA
maxLength: 23
enum:
- PESSOA_NATURAL
@@ -231,6 +232,7 @@ components:
Segmento do qual se trata o produto contratado
1. Seguro de Pessoas
2. Previdência
+ 3. NA
maxLength: 20
enum:
- SEGURO_PESSOAS
@@ -242,6 +244,7 @@ components:
description: |
1. Contribuição Variável;
2. Benefício Definido.
+ 3. NA
maxLength: 21
enum:
- CONTRIBUICAO_VARIAVEL
@@ -363,6 +366,7 @@ components:
1. Coletivo Averbado;
2. Coletivo instituído;
3. Individual.
+ 4. NA
example: COLETIVO_AVERBADO
participantQualified:
type: boolean
@@ -484,6 +488,7 @@ components:
11. VRI
12. VDR
13. Demais produtos de Previdência.
+ 14. NA
maxLength: 27
enum:
- PGBL
@@ -644,6 +649,7 @@ components:
9. Renda Vitalícia Reversível ao Cônjuge com Continuidade de Menores
10. Renda Vitalícia com o Mínimo Garantido;
11. Renda Vitalícia com Prazo mínimo garantido.
+ 12. NA
enum:
- PAGAMENTO_UNICO
- RENDA_PRAZO_CERTO
@@ -805,6 +811,7 @@ components:
Listagem do pagamento para cada benefício:
1. Quantidade determinada de parcelas;
2. Até o fim de ciclo determinado.
+ 3. NA
Se for pagamento único, esse campo não se aplica (retorna vazio).
enum:
- QUANTIDADE_DETERMINADA_PARCELAS
@@ -818,6 +825,7 @@ components:
1. Pessoa Natural
2. Pessoa Jurídica
+ 3. NA
maxLength: 23
enum:
- PESSOA_NATURAL
@@ -826,7 +834,7 @@ components:
example: PESSOA_NATURAL
EnumProductModality:
type: string
- description: - Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
+ description: - Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
- NA
maxLength: 33
enum:
- FUNERAL
@@ -1039,6 +1047,7 @@ components:
O tipo de serviço contratado. A considerar os domínios abaixo:
1. Coletivo;
2. Individual.
+ 3. NA
enum:
- COLETIVO
- INDIVIDUAL
@@ -1094,6 +1103,7 @@ components:
1. IPCA (IBGE)
2. IGP-M (FGV)
3. INPC (IBGE)
+ 4. NA
enum:
- IPCA
- IGP_M
@@ -1253,6 +1263,7 @@ components:
1. Repartição simples
2. Repartição Capitais Cobertura
3. Capitalização
+ 4. NA
example: REPARTICAO_SIMPLES
enum:
- REPARTICAO_SIMPLES
@@ -1289,6 +1300,7 @@ components:
- CONSIGNACAO_FOLHA_PAGAMENTO
- PONTOS_PROGRAMA_BENEFICIO
- OUTROS
+ - NA
enum:
- CARTAO_CREDITO
- DEBITO_CONTA
@@ -1321,6 +1333,7 @@ components:
- SEMESTRAL
- BIMESTRAL
- OUTROS
+ - NA
enum:
- MENSAL
- UNICA
@@ -1346,6 +1359,7 @@ components:
Modalidade de pagamento da indenização, a considerar os domínios abaixo:
1. Único
2. Sob a forma de renda
+ 3. NA
enum:
- UNICO
- SOB_FORMA_RENDA
From cff2c5fa9f43dd2838ddcbb241a2b913d3d539d4 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Tue, 16 May 2023 11:22:12 -0300
Subject: [PATCH 30/50] feat(Capitalization Bonds): ORB-2610 - PC81 -
Versionamento
---
.../capitalizationBondsGetProducts_v1.csv | 60 +++---
.../capitalizationBondsGetProducts_vx.csv | 195 ------------------
.../{x.x.x.yml => 1.0.0-rc3.0.yml} | 2 +-
swagger-apis/capitalization-bonds/index.html | 4 +-
4 files changed, 37 insertions(+), 224 deletions(-)
delete mode 100644 dictionary/capitalizationBondsGetProducts_vx.csv
rename swagger-apis/capitalization-bonds/{x.x.x.yml => 1.0.0-rc3.0.yml} (99%)
diff --git a/dictionary/capitalizationBondsGetProducts_v1.csv b/dictionary/capitalizationBondsGetProducts_v1.csv
index e28beb520..e5438ac16 100644
--- a/dictionary/capitalizationBondsGetProducts_v1.csv
+++ b/dictionary/capitalizationBondsGetProducts_v1.csv
@@ -3,7 +3,7 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
@@ -13,10 +13,10 @@
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;ACMEcap;
/data/code;code;Código único a ser definido pela sociedade.;Texto;100;Obrigatório;;;1;1;"";Não permitido;string;01234589_cap;
/data/modality;modality;"1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
@@ -30,33 +30,36 @@ INSTRUMENTO_GARANTIA
COMPRA_PROGRAMADA
POPULAR
INCENTIVO
-FILANTROPIA_PREMIAVEL";1;1;"";Não permitido;string;TRADICIONAL;7
+FILANTROPIA_PREMIAVEL
+NA";1;1;"";Não permitido;string;TRADICIONAL;7
/data/costType;costType;"Pagamento efetuado ao subscritor à sociedade de capitalização para aquisição do título de capitalização, podendo ser única, periódica ou mensal.
1. Pagamento Único
2. Pagamento Mensal
3. Pagamento Periódico
";Texto;19;Obrigatório;;"PAGAMENTO_UNICO
PAGAMENTO_MENSAL
-PAGAMENTO_PERIODICO";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
+PAGAMENTO_PERIODICO
+NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
/data/termsAndConditions;termsAndConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/quotas;quotas;Informações relativas às taxas da Quotas praticadas para cada Parcela;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/quotas/quota;quota;Número da parcela.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/validity;validity;Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.;Inteiro;3;Opcional;;;0;1;"";Não permitido;integer;48;
/data/serieSize;serieSize;Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;5000000;
/data/capitalizationPeriod;capitalizationPeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
";Texto;37;Obrigatório;;"IPCA
IGPM
INPC
TR
INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
-OUTROS";1;1;"";Não permitido;string;IPCA;
+OUTROS
+NA";1;1;"";Não permitido;string;IPCA;
/data/capitalizationPeriod/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
/data/capitalizationPeriod/contributionAmount;contributionAmount;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/capitalizationPeriod/contributionAmount/periodicity;periodicity;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
@@ -81,28 +84,29 @@ TRIMESTRAL
QUADRIMESTRAL
SEMESTRAL
ANUAL
-OUTROS";1;1;"";Não permitido;string;UNICO;
+OUTROS
+NA";1;1;"";Não permitido;string;UNICO;
/data/capitalizationPeriod/contributionAmount/periodicityAdditionalInfo;periodicityAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
/data/capitalizationPeriod/contributionAmount/minimum;minimum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
-";Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;1.2222;
+";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;1.2222;
/data/capitalizationPeriod/contributionAmount/maximum;maximum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
-";Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;1.2222;
+";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;1.2222;
/data/capitalizationPeriod/contributionAmount/allowedValue;allowedValue;"Condicional: Quando modalidade for diferente de 'TRADICIONAL'
Lista com os valores permitidos de contribuição ao plano.
";Número;;Obrigatório;;;1;1;"";Não permitido;number;5000;
/data/capitalizationPeriod/earlyRedemptions;earlyRedemptions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/capitalizationPeriod/earlyRedemptions/quota;quota;Parcela relativa ao Resgate Antecipado;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
-/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/gracePeriodRedemption;gracePeriodRedemption;Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;48;
/data/latePayment;latePayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/latePayment/suspensionMonths;suspensionMonths;Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
/data/latePayment/periodExtensionOption;periodExtensionOption;"Alteração do prazo de vigência original, pela suspensão (não aplicável a pagamento único). A considerar os seguintes domínios:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/contributionPayment;contributionPayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/contributionPayment/paymentMethod;paymentMethod;"Meio de Pagamento utilizado para pagamento da contribuição. A considerar os domínios abaixo:
1. Cartão de Crédito
@@ -122,7 +126,8 @@ BOLETO_BANCARIO
PIX
CONSIGNACAO_FOLHA_PAGAMENTO
PAGAMENTO_PONTOS
-OUTROS";1;1;"";Não permitido;string;CARTAO_CREDITO;
+OUTROS
+NA";1;1;"";Não permitido;string;CARTAO_CREDITO;
/data/contributionPayment/paymentMethodAdditionalInfo;paymentMethodAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
/data/contributionPayment/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
";Texto;37;Obrigatório;;"IPCA
@@ -130,10 +135,11 @@ IGPM
INPC
TR
INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
-OUTROS";1;1;"";Não permitido;string;IPCA;
+OUTROS
+NA";1;1;"";Não permitido;string;IPCA;
/data/contributionPayment/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
-/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
-/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/draws;draws;Informações relativas aos Sorteios;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/draws/timeInterval;timeInterval;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
- UNICO
@@ -157,21 +163,22 @@ TRIMESTRAL
QUADRIMESTRAL
SEMESTRAL
ANUAL
-OUTROS";1;1;"";Não permitido;string;UNICO;
+OUTROS
+NA";1;1;"";Não permitido;string;UNICO;
/data/draws/timeIntervalAdditionalInfo;timeIntervalAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;5;
/data/draws/quantity;quantity;Número da quantidade de sorteios previstos ao longo da vigência.;Número;5;Obrigatório;;;1;1;"";Não permitido;number;10000;
/data/draws/prizeMultiplier;prizeMultiplier;Valor dos sorteios representado por múltiplo do valor de contribuição. Por exemplo: 5 vezes valor da contribuição;Número;6;Obrigatório;;;1;1;"";Não permitido;number;5;
/data/draws/earlySettlementRaffle;earlySettlementRaffle;"Modelo de sorteio que acarreta, ao título contemplado, o seu resgate total obrigatório (Resolução Normativa 384/20). Conforme os domínios:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/draws/mandatoryContemplation;mandatoryContemplation;"Possibilidade de realização de sorteio com previsão de que o título sorteado seja obrigatoriamente um título comercializado,
desde que atingidos os requisitos definidos nas condições gerais do plano. Conforme os domínios:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/draws/ruleDescription;ruleDescription;Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.;Texto;200;Opcional;;;0;1;"";Não permitido;string;Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.;
-/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
/data/minimumRequirementDetails;minimumRequirementDetails;"Campo aberto (possibilidade de incluir URL).
Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
@@ -184,4 +191,5 @@ tamanho. p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_g
3. Ambas (Pessoa Natural e Jurídica)
";Texto;23;Obrigatório;;"PESSOA_NATURAL
PESSOA_JURIDICA
-PESSOA_NATURAL_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL;
+PESSOA_NATURAL_JURIDICA
+NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/dictionary/capitalizationBondsGetProducts_vx.csv b/dictionary/capitalizationBondsGetProducts_vx.csv
deleted file mode 100644
index e5438ac16..000000000
--- a/dictionary/capitalizationBondsGetProducts_vx.csv
+++ /dev/null
@@ -1,195 +0,0 @@
-Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
-/data;data;Conjunto de informações do Título de Capitalização;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
-/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
-/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
-
-- ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
-
-- 'cnpjNumber' com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
-
-- Ambos do tipo string;
-
-- Ambos obrigatórios.
-";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
-/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
-/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;ACMEcap;
-/data/code;code;Código único a ser definido pela sociedade.;Texto;100;Obrigatório;;;1;1;"";Não permitido;string;01234589_cap;
-/data/modality;modality;"1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
-2. Instrumento de Garantia: A modalidade tem por objetivo propiciar que a provisão matemática para capitalização do título de capitalização seja utilizada para assegurar o cumprimento de obrigação assumida em contrato principal pelo titular perante terceiro. (Res CNSP 384/20)
-3. Compra Programada: A modalidade compra programada garante o valor de resgate em moeda corrente nacional, sendo disponibilizada ao assim desejar e sem qualquer outro custo, pelo recebimento do bem e/ou serviço referenciado no subsidiado por acordos comerciais celebrados com indústrias, atacadistas, empresas comerciais ou prestadores de serviço. (Res CNSP 384/20)
-4. Popular: A modalidade popular tem por objetivo propiciar a capitalização da contribuição e a participação do titular em sorteios, sem que haja devolução integral do valor pago. (Res CNSP 384/20)
-5. Incentivo: A modalidade incentivo tem por objetivo a vinculação a um evento promocional de caráter comercial instituído pelo subscritor para alavancar a venda de seu(s) produto(s) ou serviços ou para fidelizar seus clientes. (Res CNSP 384/20)
-6. Filantropia Premiável: A modalidade filantropia premiável é destinada ao subscritor interessado em contribuir com entidades beneficentes de assistências sociais, certificadas nos termos da legislação vigente, e participar de sorteio(s). (Res CNSP 384/20)
-";Texto;24;Obrigatório;;"TRADICIONAL
-INSTRUMENTO_GARANTIA
-COMPRA_PROGRAMADA
-POPULAR
-INCENTIVO
-FILANTROPIA_PREMIAVEL
-NA";1;1;"";Não permitido;string;TRADICIONAL;7
-/data/costType;costType;"Pagamento efetuado ao subscritor à sociedade de capitalização para aquisição do título de capitalização, podendo ser única, periódica ou mensal.
-1. Pagamento Único
-2. Pagamento Mensal
-3. Pagamento Periódico
-";Texto;19;Obrigatório;;"PAGAMENTO_UNICO
-PAGAMENTO_MENSAL
-PAGAMENTO_PERIODICO
-NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
-/data/termsAndConditions;termsAndConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
-/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/quotas;quotas;Informações relativas às taxas da Quotas praticadas para cada Parcela;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/quotas/quota;quota;Número da parcela.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/validity;validity;Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.;Inteiro;3;Opcional;;;0;1;"";Não permitido;integer;48;
-/data/serieSize;serieSize;Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;5000000;
-/data/capitalizationPeriod;capitalizationPeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/capitalizationPeriod/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
-";Texto;37;Obrigatório;;"IPCA
-IGPM
-INPC
-TR
-INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
-OUTROS
-NA";1;1;"";Não permitido;string;IPCA;
-/data/capitalizationPeriod/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
-/data/capitalizationPeriod/contributionAmount;contributionAmount;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/capitalizationPeriod/contributionAmount/periodicity;periodicity;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
- 1. Único
- 2. Diário
- 3. Semanal
- 4. Quinzenal
- 5. Mensal
- 6. Bimestral
- 7. Trimestral
- 8. Quadrimestral
- 9. Semestral
- 10. Anual
- 11. Outros
-";Texto;13;Obrigatório;;"UNICO
-DIARIO
-SEMANAL
-QUINZENAL
-MENSAL
-BIMESTRAL
-TRIMESTRAL
-QUADRIMESTRAL
-SEMESTRAL
-ANUAL
-OUTROS
-NA";1;1;"";Não permitido;string;UNICO;
-/data/capitalizationPeriod/contributionAmount/periodicityAdditionalInfo;periodicityAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
-/data/capitalizationPeriod/contributionAmount/minimum;minimum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
-Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
-";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;1.2222;
-/data/capitalizationPeriod/contributionAmount/maximum;maximum;"Condicional: Quando modalidade for igual 'TRADICIONAL'
-Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
-";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;1.2222;
-/data/capitalizationPeriod/contributionAmount/allowedValue;allowedValue;"Condicional: Quando modalidade for diferente de 'TRADICIONAL'
-Lista com os valores permitidos de contribuição ao plano.
-";Número;;Obrigatório;;;1;1;"";Não permitido;number;5000;
-/data/capitalizationPeriod/earlyRedemptions;earlyRedemptions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/capitalizationPeriod/earlyRedemptions/quota;quota;Parcela relativa ao Resgate Antecipado;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/capitalizationPeriod/gracePeriodRedemption;gracePeriodRedemption;Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;48;
-/data/latePayment;latePayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/latePayment/suspensionMonths;suspensionMonths;Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/latePayment/periodExtensionOption;periodExtensionOption;"Alteração do prazo de vigência original, pela suspensão (não aplicável a pagamento único). A considerar os seguintes domínios:
-1. true
-2. false
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
-/data/contributionPayment;contributionPayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/contributionPayment/paymentMethod;paymentMethod;"Meio de Pagamento utilizado para pagamento da contribuição. A considerar os domínios abaixo:
- 1. Cartão de Crédito
- 2. Cartão de Débito
- 3. Débito em conta corrente
- 4. Débito em conta poupança
- 5. Boleto bancário
- 6. PIX
- 7. Consignação em Folha de Pagamento
- 8. Pontos de Programas de Benefício
- 9. Outros
-";Texto;27;Obrigatório;;"CARTAO_CREDITO
-CARTAO_DEBITO
-DEBITO_CONTA_CORRENTE
-DEBITO_CONTA_POUPANCA
-BOLETO_BANCARIO
-PIX
-CONSIGNACAO_FOLHA_PAGAMENTO
-PAGAMENTO_PONTOS
-OUTROS
-NA";1;1;"";Não permitido;string;CARTAO_CREDITO;
-/data/contributionPayment/paymentMethodAdditionalInfo;paymentMethodAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
-/data/contributionPayment/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
-";Texto;37;Obrigatório;;"IPCA
-IGPM
-INPC
-TR
-INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
-OUTROS
-NA";1;1;"";Não permitido;string;IPCA;
-/data/contributionPayment/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
-/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/draws;draws;Informações relativas aos Sorteios;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/draws/timeInterval;timeInterval;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
- - UNICO
- - DIÁRIO
- - SEMANAL
- - QUINZENAL
- - MENSAL
- - BIMESTRAL
- - TRIMESTRAL
- - QUADRIMESTRAL
- - SEMESTRAL
- - ANUAL
- - OUTROS
-";Texto;13;Obrigatório;;"UNICO
-DIÁRIO
-SEMANAL
-QUINZENAL
-MENSAL
-BIMESTRAL
-TRIMESTRAL
-QUADRIMESTRAL
-SEMESTRAL
-ANUAL
-OUTROS
-NA";1;1;"";Não permitido;string;UNICO;
-/data/draws/timeIntervalAdditionalInfo;timeIntervalAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;5;
-/data/draws/quantity;quantity;Número da quantidade de sorteios previstos ao longo da vigência.;Número;5;Obrigatório;;;1;1;"";Não permitido;number;10000;
-/data/draws/prizeMultiplier;prizeMultiplier;Valor dos sorteios representado por múltiplo do valor de contribuição. Por exemplo: 5 vezes valor da contribuição;Número;6;Obrigatório;;;1;1;"";Não permitido;number;5;
-/data/draws/earlySettlementRaffle;earlySettlementRaffle;"Modelo de sorteio que acarreta, ao título contemplado, o seu resgate total obrigatório (Resolução Normativa 384/20). Conforme os domínios:
- 1. true
- 2. false
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
-/data/draws/mandatoryContemplation;mandatoryContemplation;"Possibilidade de realização de sorteio com previsão de que o título sorteado seja obrigatoriamente um título comercializado,
-desde que atingidos os requisitos definidos nas condições gerais do plano. Conforme os domínios:
- 1. true
- 2. false
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
-/data/draws/ruleDescription;ruleDescription;Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.;Texto;200;Opcional;;;0;1;"";Não permitido;string;Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.;
-/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
-/data/minimumRequirementDetails;minimumRequirementDetails;"Campo aberto (possibilidade de incluir URL).
-Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
-tamanho. p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.’
-";Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
-/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
-
- 1. Pessoa Natural
- 2. Pessoa Jurídica
- 3. Ambas (Pessoa Natural e Jurídica)
-";Texto;23;Obrigatório;;"PESSOA_NATURAL
-PESSOA_JURIDICA
-PESSOA_NATURAL_JURIDICA
-NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/swagger-apis/capitalization-bonds/x.x.x.yml b/swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml
similarity index 99%
rename from swagger-apis/capitalization-bonds/x.x.x.yml
rename to swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml
index 89adc1600..053ad9e66 100644
--- a/swagger-apis/capitalization-bonds/x.x.x.yml
+++ b/swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml
@@ -3,7 +3,7 @@ info:
title: API Capitalization-bonds - Open Finance Brasil
description: |
As APIs descritas neste documento é referente a API de Capitalização da fase OpenInsurance do Open Finance Brasil.
- version: x.x.x
+ version: 1.0.0-rc3.0
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0'
diff --git a/swagger-apis/capitalization-bonds/index.html b/swagger-apis/capitalization-bonds/index.html
index 3d8062e9f..007952ef1 100644
--- a/swagger-apis/capitalization-bonds/index.html
+++ b/swagger-apis/capitalization-bonds/index.html
@@ -47,8 +47,8 @@
const ui = SwaggerUIBundle({
urls: [ {"name": "1.0.0-rc1.0", "url": "./1.0.0-rc1.0.yml"},
{"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"},
- {"name": "x.x.x", "url": "./x.x.x.yml"}],
- "urls.primaryName": "x.x.x", // default spec
+ {"name": "1.0.0-rc3.0", "url": "./1.0.0-rc3.0.yml"}],
+ "urls.primaryName": "1.0.0-rc3.0", // default spec
dom_id: '#swagger-ui',
deepLinking: true,
supportedSubmitMethods:[],
From 4b0d1ac3f26efa78b5374485a6c8f5ebb154b799 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Tue, 16 May 2023 11:28:11 -0300
Subject: [PATCH 31/50] feat(Insurances): ORB-2611 - PC81 - Versionamento
---
dictionary/getPersonalInsurance_v1.csv | 88 +++--
dictionary/getPersonalInsurance_vx.csv | 316 ------------------
.../insurances/{x.x.x.yml => 1.0.0-rc3.0.yml} | 2 +-
swagger-apis/insurances/index.html | 4 +-
4 files changed, 56 insertions(+), 354 deletions(-)
delete mode 100644 dictionary/getPersonalInsurance_vx.csv
rename swagger-apis/insurances/{x.x.x.yml => 1.0.0-rc3.0.yml} (99%)
diff --git a/dictionary/getPersonalInsurance_v1.csv b/dictionary/getPersonalInsurance_v1.csv
index e2e2f2d6d..7e054cbf6 100644
--- a/dictionary/getPersonalInsurance_v1.csv
+++ b/dictionary/getPersonalInsurance_v1.csv
@@ -3,21 +3,22 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link 'urlComplementaryList', deve ser array de objeto com a estrutura abaixo:
- 'name' com o valor contido no campo 'LegalEntityName' conforme cadastro no diretório;
- 'cnpjNumber' com o valor contido no campo CNPJ ('RegistrationNumber') correspondente a esta instituição;
- Ambos do tipo string;
- Ambos obrigatórios.
-";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
+";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))$|^(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
+/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/society/brand;brand;Nome da marca reportada pela sociedade seguradora participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Marca;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
/data/category;category;"Indicar a categoria do Produto:
- Tradicional
- Microsseguro
";Texto;12;Opcional;;"TRADICIONAL
-MICROSSEGURO";0;1;"";Não permitido;string;TRADICIONAL;
+MICROSSEGURO
+NA";0;1;"";Não permitido;string;TRADICIONAL;
/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
PRESTAMISTA
VIAGEM
@@ -34,7 +35,8 @@ PENSAO_PRAZO_CERTO
PENSAO_MENORES_21
PENSAO_MENORES_24
PENSAO_CONJUGE_VITALICIA
-PENSAO_CONJUGE_TEMPORARIA";1;1;"";Não permitido;string;FUNERAL;
+PENSAO_CONJUGE_TEMPORARIA
+NA";1;1;"";Não permitido;string;FUNERAL;
/data/coverages;coverages;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/coverages/type;type;É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura ;Texto;62;Obrigatório;;"ADIANTAMENTO_DOENCA_ESTAGIO_TERMINAL
AUXILIO_CESTA_BASICA
@@ -84,22 +86,25 @@ TRANSLADO_CORPO
VERBA_RESCISORIA
DOENCA_GRAVE
TRANSLADO_MEDICO
-OUTROS";1;1;"";Não permitido;string;INVALIDEZ_PERMANENTE_TOTAL_PARCIAL;
+OUTROS
+NA";1;1;"";Não permitido;string;INVALIDEZ_PERMANENTE_TOTAL_PARCIAL;
/data/coverages/typeAdditionalInfos;typeAdditionalInfos;"Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
";Lista;100;Opcional;;;0;N;"";Não permitido;array;;
/data/coverages/attributes;attributes;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/coverages/attributes/indemnityPaymentMethods;indemnityPaymentMethods;Listagem da forma de pagamento da indenização para cada combinação de modalidade/cobertura do produto.;Lista;42;Obrigatório;;"PAGAMENTO_CAPITAL_SEGURADO_VALOR_MONETARIO
REEMBOLSO_DESPESAS
-PRESTACAO_SERVICOS";1;N;"";Não permitido;array;;
+PRESTACAO_SERVICOS
+NA";1;N;"";Não permitido;array;;
/data/coverages/attributes/indemnityPaymentFrequencies;indemnityPaymentFrequencies;Listagem de tipos de frequência de pagamento de indenização para cada combinação de modalidade/cobertura do produto.;Lista;17;Obrigatório;;"INDENIZACAO_UNICA
-DIARIA_OU_PARCELA";1;N;"";Não permitido;array;INDENIZACAO_UNICA;
+DIARIA_OU_PARCELA
+NA";1;N;"";Não permitido;array;INDENIZACAO_UNICA;
/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/indemnifiablePeriods;indemnifiablePeriods;Listagem de período indenizável para cada combinação de modalidade/cobertura do produto.;Lista;50;Obrigatório;;;1;N;"";Não permitido;array;ATE_FIM_CICLO_DETERMINADO;
/data/coverages/attributes/maximumQtyIndemnifiableInstallments;maximumQtyIndemnifiableInstallments;Caso o período indenizável seja relacionado a parcelas, listagem de número máximo de parcelas indenizáveis para cada combinação de modalidade/ cobertura do produto.;Inteiro;10;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/coverages/attributes/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
@@ -112,11 +117,11 @@ NAO_APLICA";0;1;"";Não permitido;string;MESES;
/data/coverages/attributes/deductibleDays;deductibleDays;Listagem de franquia em dias para cada combinação de modalidade/cobertura do produto.;Inteiro;10;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/coverages/attributes/differentiatedDeductibleDays;differentiatedDeductibleDays;Detalhamento da franquia em dias diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;15;
/data/coverages/attributes/deductible;deductible;Listagem de franquia em reais para cada combinação de modalidade/cobertura do produto.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/deductible/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/deductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/deductible/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/deductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/differentiatedDeductible;differentiatedDeductible;Detalhamento da franquia em reais diferentes para cada cobertura que exista alguma especificidade.
Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/coverages/attributes/differentiatedDeductible/amount;amount;;Texto;21;Obrigatório;^\d{1,16}\.\d{2,4}$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/differentiatedDeductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^[A-Z]{3}$;;1;1;"";Não permitido;string;BRL;
+/data/coverages/attributes/differentiatedDeductible/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
+/data/coverages/attributes/differentiatedDeductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/excludedRisks;excludedRisks;;Lista;40;Obrigatório;;"ATO_RECONHECIMENTO_PERIGOSO
ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
OPERACOES_GUERRA
@@ -126,12 +131,13 @@ DOENCAS_LESOES_PREEXISTENTES
EPIDEMIAS_PANDEMIAS
SUICIDIO
ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
-OUTROS";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
+OUTROS
+NA";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
/data/coverages/attributes/excludedRisksURL;excludedRisksURL;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/coverages/attributes/allowApartPurchase;allowApartPurchase;"Indicar se a cobertura pode ser contratada isoladamente ou não:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;;
/data/assistanceTypes;assistanceTypes;;Lista;43;Opcional;;"ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
ARQUITETO_VIRTUAL
ASSESSORIA_FINANCEIRA
@@ -187,7 +193,8 @@ SUSTENTAVEL_DESCARTE_ECOLOGICO
TELEMEDICINA
VIAGEM
VITIMA
-OUTROS";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
+OUTROS
+NA";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
/data/assistanceTypesAdditionalInfos;assistanceTypesAdditionalInfos;Lista a ser preenchido pelas participantes quando houver ‘Outros’ no campo ‘Tipo de Assistência’;Lista;;Opcional;;;0;N;"";Não permitido;array;;
/data/additionals;additionals;;Lista;44;Obrigatório;;"SORTEIO
SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
@@ -195,27 +202,31 @@ SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
OUTROS
NAO_HA";1;N;"";Não permitido;array;SORTEIO;
/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/globalCapital;globalCapital;"A considerar os seguintes domínios:
1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/terms;terms;;Lista;23;Obrigatório;;"VITALICIA
TEMPORARIA_PRAZO_FIXO
-TEMPORARIA_INTERMITENTE";1;N;"";Não permitido;array;VITALICIA;
+TEMPORARIA_INTERMITENTE
+NA";1;N;"";Não permitido;array;VITALICIA;
/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;8;Opcional;^\d{1}\.\d{6}$;;0;1;"";Não permitido;string;0.019800;8
+/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;9;Opcional;^(\d{1}\.\d{6})$|^(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
IGP_M
-INPC";0;N;"";Não permitido;array;IPCA;
+INPC
+NA";0;N;"";Não permitido;array;IPCA;
/data/benefitRecalculation;benefitRecalculation;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/benefitRecalculation/criterias;criterias;;Lista;;Obrigatório;;"INDICE
VINCULADO_SALDO_DEVEDOR
-VARIAVEL_ACORDO_CRITERIO_ESPECIFICO";1;N;"";Não permitido;array;;
+VARIAVEL_ACORDO_CRITERIO_ESPECIFICO
+NA";1;N;"";Não permitido;array;;
/data/benefitRecalculation/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
IGP_M
-INPC";0;N;"";Não permitido;array;IPCA;
+INPC
+NA";0;N;"";Não permitido;array;IPCA;
/data/ageAdjustment;ageAdjustment;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/ageAdjustment/criterias;criterias;;Lista;27;Obrigatório;;"APOS_PERIODO_ANOS
CADA_PERIODO_ANOS
@@ -224,12 +235,13 @@ NAO_APLICAVEL";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
/data/ageAdjustment/frequency;frequency;Período em anos, caso critério de reenquadramento após ou a cada período em anos.;Inteiro;3;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/financialRegimes;financialRegimes;;Lista;19;Obrigatório;;"REPARTICAO_SIMPLES
REPARTICAO_CAPITAIS
-CAPITALIZACAO";1;N;"";Não permitido;array;REPARTICAO_SIMPLES;
+CAPITALIZACAO
+NA";1;N;"";Não permitido;array;REPARTICAO_SIMPLES;
/data/reclaim;reclaim;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
-/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^\d{1}\.\d{6}$;;1;1;"";Não permitido;string;0.019800;8
+/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
@@ -245,14 +257,15 @@ BENEFICIO_PROLONGADO
NAO_APLICA";0;N;"";Não permitido;array;SALDAMENTO;
/data/allowPortability;allowPortability;"1. true
2. false
-";Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;;
+";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;;
/data/portabilityGraceTime;portabilityGraceTime;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/portabilityGraceTime/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
/data/portabilityGraceTime/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
MESES
NAO_APLICA";1;1;"";Não permitido;string;MESES;
/data/indemnityPaymentMethods;indemnityPaymentMethods;;Lista;18;Obrigatório;;"UNICO
-SOB_FORMA_RENDA";1;N;"";Não permitido;array;UNICO;
+SOB_FORMA_RENDA
+NA";1;N;"";Não permitido;array;UNICO;
/data/indemnityPaymentIncomes;indemnityPaymentIncomes;;Lista;38;Opcional;;"CERTA
TEMPORARIA
TEMPORARIA_REVERSIVEL
@@ -261,7 +274,8 @@ TEMPORARIA_REVERSIVEL_MINIMO_GARANTIDO
VITALICIA
VITALICIA_REVERSIVEL
VITALICIA_MINIMO_GARANTIDO
-VITALICIA_REVERSIVEL_MINIMO_GARANTIDO";0;N;"";Não permitido;array;CERTA;
+VITALICIA_REVERSIVEL_MINIMO_GARANTIDO
+NA";0;N;"";Não permitido;array;CERTA;
/data/premiumPayment;premiumPayment;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/premiumPayment/paymentMethods;paymentMethods;;Lista;27;Obrigatório;;"CARTAO_CREDITO
CARTAO_DEBITO
@@ -271,7 +285,8 @@ BOLETO_BANCARIO
PIX
CONSIGNACAO_FOLHA_PAGAMENTO
PONTOS_PROGRAMA_BENEFICIO
-REGRA_PARCEIRO";1;N;"";Não permitido;array;CARTAO_CREDITO;
+REGRA_PARCEIRO
+NA";1;N;"";Não permitido;array;CARTAO_CREDITO;
/data/premiumPayment/frequencies;frequencies;;Lista;10;Obrigatório;;"DIARIA
MENSAL
UNICA
@@ -279,14 +294,16 @@ ANUAL
TRIMESTRAL
SEMESTRAL
FRACIONADO
-OUTRA";1;N;"";Não permitido;array;DIARIA;
+OUTRA
+NA";1;N;"";Não permitido;array;DIARIA;
/data/premiumPayment/contributionTax;contributionTax;Distribuição de frequência relativa aos valores referentes às taxas cobradas, nos termos do Anexo III.;Texto;500;Opcional;;;0;1;"";Não permitido;string;;
/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/minimumRequirement/contractType;contractType;"A considerar os domínios abaixo:
1. Coletivo;
2. Individual
";Texto;10;Obrigatório;;"COLETIVO
-INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO;
+INDIVIDUAL
+NA";1;1;"";Não permitido;string;COLETIVO;
/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
@@ -295,4 +312,5 @@ INDIVIDUAL";1;1;"";Não permitido;string;COLETIVO;
3. Ambas (Pessoa Natural e Jurídica)
";Texto;23;Obrigatório;;"PESSOA_NATURAL
PESSOA_JURIDICA
-PESSOA_NATURAL_JURIDICA";1;1;"";Não permitido;string;PESSOA_NATURAL;
+PESSOA_NATURAL_JURIDICA
+NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/dictionary/getPersonalInsurance_vx.csv b/dictionary/getPersonalInsurance_vx.csv
deleted file mode 100644
index 7e054cbf6..000000000
--- a/dictionary/getPersonalInsurance_vx.csv
+++ /dev/null
@@ -1,316 +0,0 @@
-Xpath;Nome;Definição;Tipo de Dado;Tamanho;Mandatoriedade;Formato;Domínio;Mínimo de Ocorrências;Máximo de Ocorrências;Restrições;Nulidade;Tipo de Dado Json;Exemplo;Tamanho mínimo
-/data;data;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
-/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
-/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link 'urlComplementaryList', deve ser array de objeto com a estrutura abaixo:
-- 'name' com o valor contido no campo 'LegalEntityName' conforme cadastro no diretório;
-- 'cnpjNumber' com o valor contido no campo CNPJ ('RegistrationNumber') correspondente a esta instituição;
-- Ambos do tipo string;
-- Ambos obrigatórios.
-";Texto;1024;Opcional;^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))$|^(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
-/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
-/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
-/data/society/brand;brand;Nome da marca reportada pela sociedade seguradora participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Marca;
-/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
-/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
-/data/category;category;"Indicar a categoria do Produto:
- Tradicional
- Microsseguro
";Texto;12;Opcional;;"TRADICIONAL
-MICROSSEGURO
-NA";0;1;"";Não permitido;string;TRADICIONAL;
-/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
-PRESTAMISTA
-VIAGEM
-EDUCACIONAL
-DOTAL
-ACIDENTES_PESSOAIS
-VIDA
-PERDA_CERTIFICADO_HABILITACAO_VOO
-DOENCAS_GRAVES_DOENCA_TERMINAL
-DESEMPREGO_PERDA_RENDA
-EVENTOS_ALEATORIOS
-PECULIO
-PENSAO_PRAZO_CERTO
-PENSAO_MENORES_21
-PENSAO_MENORES_24
-PENSAO_CONJUGE_VITALICIA
-PENSAO_CONJUGE_TEMPORARIA
-NA";1;1;"";Não permitido;string;FUNERAL;
-/data/coverages;coverages;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/coverages/type;type;É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura ;Texto;62;Obrigatório;;"ADIANTAMENTO_DOENCA_ESTAGIO_TERMINAL
-AUXILIO_CESTA_BASICA
-AUXILIO_FINANCEIRO_IMEDIATO
-CANCELAMENTO_VIAGEM
-CIRURGIA
-COBERTURA_HERNIA
-COBERTURA_LER_DORT
-CUIDADOS_PROLONGADOS_ACIDENTE
-DESEMPREGO_PERDA_RENDA
-DESPESAS_EXTRA_INVALIDEZ_PERMANENTE_TOTAL_PARCIAL_ACIDENTE_DEI
-DESPESAS_EXTRA_MORTE_DEM
-DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS
-DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS_BRASIL
-DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS_EXTERIOR
-DIARIA_INCAPACIDADE_TOTAL_TEMPORARIA
-DIARIA_INTERNACAO_HOSPITALAR
-INTERNACAO_HOSPITALAR
-DIARIAS_INCAPACIDADE_PECUNIARIA_DIP
-DOENCA_CONGENITA_FILHOS_DCF
-FRATURA_OSSEA
-DOENCAS_TROPICAIS
-INCAPACIDADE_TOTAL_OU_TEMPORARIA
-INVALIDEZ_PERMANENTE_TOTAL_PARCIAL
-INVALIDEZ_TOTAL_ACIDENTE
-INVALIDEZ_PARCIAL_ACIDENTE
-INVALIDEZ_FUNCIONAL_PERMANENTE_DOENCA
-INVALIDEZ_LABORATIVA_DOENCA
-MORTE
-MORTE_ACIDENTAL
-MORTE_CONJUGE
-MORTE_FILHOS
-MORTE_ADIATAMENTO_DOENCA_ESTAGIO_TERMINAL
-PAGAMENTO_ANTECIPADO_ESPECIAL_DOENCA_PROFISSIONAL_PAED
-PERDA_AUTONOMIA_PESSOAL
-PERDA_INVOLUNTARIA_EMPREGO
-QUEIMADURA_GRAVE
-REGRESSO_ANTECIPADO_SANITARIO
-RENDA_INCAPACIDADE_TEMPORARIA
-RESCISAO_CONTRATUAL_CASO_MORTE_RCM
-RESCISAO_TRABALHISTA
-SERVICO_AUXILIO_FUNERAL
-SOBREVIVENCIA
-TRANSPLANTE_ORGAOS
-TRASLADO
-TRANSLADO_CORPO
-VERBA_RESCISORIA
-DOENCA_GRAVE
-TRANSLADO_MEDICO
-OUTROS
-NA";1;1;"";Não permitido;string;INVALIDEZ_PERMANENTE_TOTAL_PARCIAL;
-/data/coverages/typeAdditionalInfos;typeAdditionalInfos;"Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
-Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
-";Lista;100;Opcional;;;0;N;"";Não permitido;array;;
-/data/coverages/attributes;attributes;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/coverages/attributes/indemnityPaymentMethods;indemnityPaymentMethods;Listagem da forma de pagamento da indenização para cada combinação de modalidade/cobertura do produto.;Lista;42;Obrigatório;;"PAGAMENTO_CAPITAL_SEGURADO_VALOR_MONETARIO
-REEMBOLSO_DESPESAS
-PRESTACAO_SERVICOS
-NA";1;N;"";Não permitido;array;;
-/data/coverages/attributes/indemnityPaymentFrequencies;indemnityPaymentFrequencies;Listagem de tipos de frequência de pagamento de indenização para cada combinação de modalidade/cobertura do produto.;Lista;17;Obrigatório;;"INDENIZACAO_UNICA
-DIARIA_OU_PARCELA
-NA";1;N;"";Não permitido;array;INDENIZACAO_UNICA;
-/data/coverages/attributes/minValue;minValue;Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/minValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/minValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
-/data/coverages/attributes/maxValue;maxValue;Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/maxValue/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
-/data/coverages/attributes/indemnifiablePeriods;indemnifiablePeriods;Listagem de período indenizável para cada combinação de modalidade/cobertura do produto.;Lista;50;Obrigatório;;;1;N;"";Não permitido;array;ATE_FIM_CICLO_DETERMINADO;
-/data/coverages/attributes/maximumQtyIndemnifiableInstallments;maximumQtyIndemnifiableInstallments;Caso o período indenizável seja relacionado a parcelas, listagem de número máximo de parcelas indenizáveis para cada combinação de modalidade/ cobertura do produto.;Inteiro;10;Obrigatório;;;1;1;"";Não permitido;integer;10;
-/data/coverages/attributes/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Opcional;;;0;1;"";Não permitido;integer;90;
-/data/coverages/attributes/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Opcional;;"DIAS
-MESES
-NAO_APLICA";0;1;"";Não permitido;string;MESES;
-/data/coverages/attributes/gracePeriod/details;details;;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Descrições adicionais do período de carência;
-/data/coverages/attributes/differentiatedGracePeriod;differentiatedGracePeriod;Campo aberto para detalhamento de período de carência diferenciado, se houver.;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;90 DIAS;
-/data/coverages/attributes/deductibleDays;deductibleDays;Listagem de franquia em dias para cada combinação de modalidade/cobertura do produto.;Inteiro;10;Obrigatório;;;1;1;"";Não permitido;integer;10;
-/data/coverages/attributes/differentiatedDeductibleDays;differentiatedDeductibleDays;Detalhamento da franquia em dias diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;15;
-/data/coverages/attributes/deductible;deductible;Listagem de franquia em reais para cada combinação de modalidade/cobertura do produto.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/coverages/attributes/deductible/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/deductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
-/data/coverages/attributes/differentiatedDeductible;differentiatedDeductible;Detalhamento da franquia em reais diferentes para cada cobertura que exista alguma especificidade.
Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/coverages/attributes/differentiatedDeductible/amount;amount;;Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;0.01;
-/data/coverages/attributes/differentiatedDeductible/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
-/data/coverages/attributes/excludedRisks;excludedRisks;;Lista;40;Obrigatório;;"ATO_RECONHECIMENTO_PERIGOSO
-ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
-OPERACOES_GUERRA
-FURACOES_CICLONES_TERREMOTOS
-MATERIAL_NUCLEAR
-DOENCAS_LESOES_PREEXISTENTES
-EPIDEMIAS_PANDEMIAS
-SUICIDIO
-ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
-OUTROS
-NA";1;N;"";Não permitido;array;ATO_RECONHECIMENTO_PERIGOSO;
-/data/coverages/attributes/excludedRisksURL;excludedRisksURL;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/coverages/attributes/allowApartPurchase;allowApartPurchase;"Indicar se a cobertura pode ser contratada isoladamente ou não:
- 1. true
- 2. false
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;;
-/data/assistanceTypes;assistanceTypes;;Lista;43;Opcional;;"ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
-ARQUITETO_VIRTUAL
-ASSESSORIA_FINANCEIRA
-AUTOMOVEL
-AUXILIO_NATALIDADE
-AVALIACAO_CLINICA_PREVENTIVA
-BOLSA_PROTEGIDA
-CESTA_BASICA
-CHECKUP_ODONTOLOGICO
-CLUBE_VANTAGENS_BENEFICIOS
-CONVALESCENCIA
-DECESSO
-DESCONTO_FARMACIAS_MEDICAMENTOS
-DESPESAS_FARMACEUTICAS_VIAGEM
-DIGITAL
-EDUCACIONAL
-EMPRESARIAL
-ENCANADOR
-ENTRETENIMENTO
-EQUIPAMENTOS_MEDICOS
-FIANCAS_DESPESAS_LEGAIS
-FISIOTERAPIA
-FUNERAL
-HELP_LINE
-HOSPEDAGEM_ACOMPANHANTE
-INTERRUPCAO_VIAGEM
-INVENTARIO
-MAIS_VIDA
-MAMAE_BEBE
-MEDICA_ACIDENTE_DOENCA
-MOTOCICLETA
-MULHER
-NUTRICIONISTA
-ODONTOLOGICA
-ORIENTACAO_FITNESS
-ORIENTACAO_JURIDICA
-ORIENTACAO_NUTRICIONAL
-PERSONAL_FITNESS
-ORIENTACAO_PSICOSSOCIAL_FAMILIAR
-PERDA_ROUBO_CARTAO
-PET
-PRORROGACAO_ESTADIA
-PROTECAO_DADOS
-RECOLOCACAO_PROFISSIONAL
-REDE_DESCONTO_NUTRICIONAL
-RESIDENCIAL
-RETORNO_MENORES_SEGURADO
-SAQUE_COACAO
-SAUDE_BEM_ESTAR
-SEGUNDA_OPINIAO_MEDICA
-SENIOR
-SUSTENTAVEL_DESCARTE_ECOLOGICO
-TELEMEDICINA
-VIAGEM
-VITIMA
-OUTROS
-NA";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
-/data/assistanceTypesAdditionalInfos;assistanceTypesAdditionalInfos;Lista a ser preenchido pelas participantes quando houver ‘Outros’ no campo ‘Tipo de Assistência’;Lista;;Opcional;;;0;N;"";Não permitido;array;;
-/data/additionals;additionals;;Lista;44;Obrigatório;;"SORTEIO
-SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
-SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
-OUTROS
-NAO_HA";1;N;"";Não permitido;array;SORTEIO;
-/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
-/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/globalCapital;globalCapital;"A considerar os seguintes domínios:
- 1. true
- 2. false
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
-/data/terms;terms;;Lista;23;Obrigatório;;"VITALICIA
-TEMPORARIA_PRAZO_FIXO
-TEMPORARIA_INTERMITENTE
-NA";1;N;"";Não permitido;array;VITALICIA;
-/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;9;Opcional;^(\d{1}\.\d{6})$|^(-1.000000)$;;0;1;"";Não permitido;string;0.019800;8
-/data/pmbacRemuneration/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
-IGP_M
-INPC
-NA";0;N;"";Não permitido;array;IPCA;
-/data/benefitRecalculation;benefitRecalculation;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/benefitRecalculation/criterias;criterias;;Lista;;Obrigatório;;"INDICE
-VINCULADO_SALDO_DEVEDOR
-VARIAVEL_ACORDO_CRITERIO_ESPECIFICO
-NA";1;N;"";Não permitido;array;;
-/data/benefitRecalculation/updateIndexes;updateIndexes;;Lista;;Opcional;;"IPCA
-IGP_M
-INPC
-NA";0;N;"";Não permitido;array;IPCA;
-/data/ageAdjustment;ageAdjustment;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/ageAdjustment/criterias;criterias;;Lista;27;Obrigatório;;"APOS_PERIODO_ANOS
-CADA_PERIODO_ANOS
-MUDANCA_FAIXA_ETARIA
-NAO_APLICAVEL";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
-/data/ageAdjustment/frequency;frequency;Período em anos, caso critério de reenquadramento após ou a cada período em anos.;Inteiro;3;Obrigatório;;;1;1;"";Não permitido;integer;10;
-/data/financialRegimes;financialRegimes;;Lista;19;Obrigatório;;"REPARTICAO_SIMPLES
-REPARTICAO_CAPITAIS
-CAPITALIZACAO
-NA";1;N;"";Não permitido;array;REPARTICAO_SIMPLES;
-/data/reclaim;reclaim;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
-/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
-/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
-/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
-/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
-MESES
-NAO_APLICA";1;1;"";Não permitido;string;MESES;
-/data/reclaim/gracePeriod/details;details;;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Descrições adicionais do período de carência;
-/data/reclaim/differenciatedPercentage;differenciatedPercentage;Campo aberto (possibilidade de incluir URL);"";1024;Opcional;;;0;1;"";Não permitido;;"https://openinsurance.com.br/aaa’
-Obs.: Exceção de cobertura ou critério definido acima será descrito aqui na URL
-Exemplo: Cobertura X: a partir de 25 meses = 100%
-";
-/data/otherGuaranteedValues;otherGuaranteedValues;;Lista;20;Opcional;;"SALDAMENTO
-BENEFICIO_PROLONGADO
-NAO_APLICA";0;N;"";Não permitido;array;SALDAMENTO;
-/data/allowPortability;allowPortability;"1. true
-2. false
-";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;;
-/data/portabilityGraceTime;portabilityGraceTime;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/portabilityGraceTime/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
-/data/portabilityGraceTime/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
-MESES
-NAO_APLICA";1;1;"";Não permitido;string;MESES;
-/data/indemnityPaymentMethods;indemnityPaymentMethods;;Lista;18;Obrigatório;;"UNICO
-SOB_FORMA_RENDA
-NA";1;N;"";Não permitido;array;UNICO;
-/data/indemnityPaymentIncomes;indemnityPaymentIncomes;;Lista;38;Opcional;;"CERTA
-TEMPORARIA
-TEMPORARIA_REVERSIVEL
-TEMPORARIO_MINIMO_GARANTIDO
-TEMPORARIA_REVERSIVEL_MINIMO_GARANTIDO
-VITALICIA
-VITALICIA_REVERSIVEL
-VITALICIA_MINIMO_GARANTIDO
-VITALICIA_REVERSIVEL_MINIMO_GARANTIDO
-NA";0;N;"";Não permitido;array;CERTA;
-/data/premiumPayment;premiumPayment;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/premiumPayment/paymentMethods;paymentMethods;;Lista;27;Obrigatório;;"CARTAO_CREDITO
-CARTAO_DEBITO
-DEBITO_CONTA_CORRENTE
-DEBITO_CONTA_POUPANCA
-BOLETO_BANCARIO
-PIX
-CONSIGNACAO_FOLHA_PAGAMENTO
-PONTOS_PROGRAMA_BENEFICIO
-REGRA_PARCEIRO
-NA";1;N;"";Não permitido;array;CARTAO_CREDITO;
-/data/premiumPayment/frequencies;frequencies;;Lista;10;Obrigatório;;"DIARIA
-MENSAL
-UNICA
-ANUAL
-TRIMESTRAL
-SEMESTRAL
-FRACIONADO
-OUTRA
-NA";1;N;"";Não permitido;array;DIARIA;
-/data/premiumPayment/contributionTax;contributionTax;Distribuição de frequência relativa aos valores referentes às taxas cobradas, nos termos do Anexo III.;Texto;500;Opcional;;;0;1;"";Não permitido;string;;
-/data/minimumRequirement;minimumRequirement;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
-/data/minimumRequirement/contractType;contractType;"A considerar os domínios abaixo:
- 1. Coletivo;
- 2. Individual
-";Texto;10;Obrigatório;;"COLETIVO
-INDIVIDUAL
-NA";1;1;"";Não permitido;string;COLETIVO;
-/data/minimumRequirement/contractingMinRequirement;contractingMinRequirement;Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/targetAudience;targetAudience;"A considerar os domínios abaixo:
-
- 1. Pessoa Natural
- 2. Pessoa Jurídica
- 3. Ambas (Pessoa Natural e Jurídica)
-";Texto;23;Obrigatório;;"PESSOA_NATURAL
-PESSOA_JURIDICA
-PESSOA_NATURAL_JURIDICA
-NA";1;1;"";Não permitido;string;PESSOA_NATURAL;
diff --git a/swagger-apis/insurances/x.x.x.yml b/swagger-apis/insurances/1.0.0-rc3.0.yml
similarity index 99%
rename from swagger-apis/insurances/x.x.x.yml
rename to swagger-apis/insurances/1.0.0-rc3.0.yml
index 77b745fbb..eba47bb6a 100644
--- a/swagger-apis/insurances/x.x.x.yml
+++ b/swagger-apis/insurances/1.0.0-rc3.0.yml
@@ -3,7 +3,7 @@ info:
title: API Seguros - Open Finance Brasil
description: |
As APIs descritas neste documento são referentes a API de Seguros da fase OpenInsurance do Open Finance Brasil.
- version: x.x.x
+ version: 1.0.0-rc3.0
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0'
diff --git a/swagger-apis/insurances/index.html b/swagger-apis/insurances/index.html
index df9552a08..36e9ddfed 100644
--- a/swagger-apis/insurances/index.html
+++ b/swagger-apis/insurances/index.html
@@ -47,8 +47,8 @@
const ui = SwaggerUIBundle({
urls: [ {"name": "1.0.0-rc1.0", "url": "./1.0.0-rc1.0.yml"},
{"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"},
- {"name": "x.x.x", "url": "./x.x.x.yml"}],
- "urls.primaryName": "x.x.x", // default spec
+ {"name": "1.0.0-rc3.0", "url": "./1.0.0-rc3.0.yml"}],
+ "urls.primaryName": "1.0.0-rc3.0", // default spec
dom_id: '#swagger-ui',
deepLinking: true,
supportedSubmitMethods:[],
From 7dd0d696afdf23916f1599dbb87971166f4a6418 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Tue, 16 May 2023 11:37:01 -0300
Subject: [PATCH 32/50] =?UTF-8?q?fix(Capitalization=20Bonds):=20PC81=20-?=
=?UTF-8?q?=20descri=C3=A7=C3=A3o=20enums?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml b/swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml
index 053ad9e66..46b530680 100644
--- a/swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml
+++ b/swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml
@@ -164,6 +164,7 @@ components:
1. Pessoa Natural
2. Pessoa Jurídica
3. Ambas (Pessoa Natural e Jurídica)
+ 4. NA
maxLength: 23
enum:
- PESSOA_NATURAL
@@ -220,6 +221,7 @@ components:
4. Popular: A modalidade popular tem por objetivo propiciar a capitalização da contribuição e a participação do titular em sorteios, sem que haja devolução integral do valor pago. (Res CNSP 384/20)
5. Incentivo: A modalidade incentivo tem por objetivo a vinculação a um evento promocional de caráter comercial instituído pelo subscritor para alavancar a venda de seu(s) produto(s) ou serviços ou para fidelizar seus clientes. (Res CNSP 384/20)
6. Filantropia Premiável: A modalidade filantropia premiável é destinada ao subscritor interessado em contribuir com entidades beneficentes de assistências sociais, certificadas nos termos da legislação vigente, e participar de sorteio(s). (Res CNSP 384/20)
+ 7. NA
minLength: 7
maxLength: 24
enum:
@@ -238,6 +240,7 @@ components:
1. Pagamento Único
2. Pagamento Mensal
3. Pagamento Periódico
+ 4. NA
minLength: 15
maxLength: 19
enum:
@@ -409,6 +412,7 @@ components:
9. Semestral
10. Anual
11. Outros
+ 12. NA
maxLength: 13
enum:
- UNICO
@@ -518,6 +522,7 @@ components:
7. Consignação em Folha de Pagamento
8. Pontos de Programas de Benefício
9. Outros
+ 10. NA
CapitalizationBondsProductPrizeDraw:
type: object
required:
@@ -541,6 +546,7 @@ components:
- SEMESTRAL
- ANUAL
- OUTROS
+ - NA
maxLength: 13
enum:
- UNICO
From 3747216f253d3b6800eb119cfd22fe3eac4d10b3 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Tue, 16 May 2023 11:39:23 -0300
Subject: [PATCH 33/50] =?UTF-8?q?fix(Insurances):=20PC81=20-=20descri?=
=?UTF-8?q?=C3=A7=C3=A3o=20enums?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
swagger-apis/insurances/1.0.0-rc3.0.yml | 14 +++++++++++---
1 file changed, 11 insertions(+), 3 deletions(-)
diff --git a/swagger-apis/insurances/1.0.0-rc3.0.yml b/swagger-apis/insurances/1.0.0-rc3.0.yml
index eba47bb6a..fe320ee10 100644
--- a/swagger-apis/insurances/1.0.0-rc3.0.yml
+++ b/swagger-apis/insurances/1.0.0-rc3.0.yml
@@ -161,7 +161,7 @@ components:
additionalProperties: false
EnumProductModality:
type: string
- description: - Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
+ description: - Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
- NA
maxLength: 33
enum:
- FUNERAL
@@ -243,6 +243,7 @@ components:
1. Repartição simples
2. Repartição Capitais Cobertura
3. Capitalização
+ 4. NA
maxLength: 19
example: REPARTICAO_SIMPLES
enum:
@@ -267,6 +268,7 @@ components:
1. IPCA (IBGE)
2. IGP-M (FGV)
3. INPC (IBGE)
+ 4. NA
enum:
- IPCA
- IGP_M
@@ -339,7 +341,7 @@ components:
example: '0001'
category:
type: string
- description: Indicar a categoria do Produto:
- Tradicional
- Microsseguro
+ description: Indicar a categoria do Produto:
- Tradicional
- Microsseguro
- NA
maxLength: 12
enum:
- TRADICIONAL
@@ -453,7 +455,7 @@ components:
type: array
items:
type: string
- description: Define o prazo do plano contratado
- Vitalícia
- Temporária - prazo fixo
- Temporária – intermitente
+ description: Define o prazo do plano contratado
- Vitalícia
- Temporária - prazo fixo
- Temporária – intermitente
- NA
maxLength: 23
enum:
- VITALICIA
@@ -504,6 +506,7 @@ components:
1. Pessoa Natural
2. Pessoa Jurídica
3. Ambas (Pessoa Natural e Jurídica)
+ 4. NA
maxLength: 23
enum:
- PESSOA_NATURAL
@@ -688,6 +691,7 @@ components:
Modalidade de pagamento da indenização, a considerar os domínios abaixo:
1. Único
2. Sob a forma de renda
+ 3. NA
maxLength: 18
enum:
- UNICO
@@ -707,6 +711,7 @@ components:
7. Vitalícia reversível
8. Vitalícia com o mínimo garantido
9. Vitalícia reversível como mínimo garantido
+ 10. NA
maxLength: 38
enum:
- CERTA
@@ -753,6 +758,7 @@ components:
6. Semestral
7. Fracionado
8. Outra
+ 9. NA
maxLength: 10
enum:
- DIARIA
@@ -908,6 +914,7 @@ components:
7. Consignação em Folha de Pagamento
8. Pontos de Programa de Benefício
9. Regra de Parceiro
+ 10. NA
maxLength: 27
enum:
- CARTAO_CREDITO
@@ -927,6 +934,7 @@ components:
A considerar os domínios abaixo:
1. Coletivo;
2. Individual
+ 3. NA
maxLength: 10
enum:
- COLETIVO
From 81d7c0f6d84d52d805e833ad35389855f6cf8ad7 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Tue, 16 May 2023 11:40:23 -0300
Subject: [PATCH 34/50] fix(Capitalization Bonds): PC81 - dicionario dados
---
dictionary/capitalizationBondsGetProducts_v1.csv | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/dictionary/capitalizationBondsGetProducts_v1.csv b/dictionary/capitalizationBondsGetProducts_v1.csv
index e5438ac16..09feba701 100644
--- a/dictionary/capitalizationBondsGetProducts_v1.csv
+++ b/dictionary/capitalizationBondsGetProducts_v1.csv
@@ -25,6 +25,7 @@
4. Popular: A modalidade popular tem por objetivo propiciar a capitalização da contribuição e a participação do titular em sorteios, sem que haja devolução integral do valor pago. (Res CNSP 384/20)
5. Incentivo: A modalidade incentivo tem por objetivo a vinculação a um evento promocional de caráter comercial instituído pelo subscritor para alavancar a venda de seu(s) produto(s) ou serviços ou para fidelizar seus clientes. (Res CNSP 384/20)
6. Filantropia Premiável: A modalidade filantropia premiável é destinada ao subscritor interessado em contribuir com entidades beneficentes de assistências sociais, certificadas nos termos da legislação vigente, e participar de sorteio(s). (Res CNSP 384/20)
+7. NA
";Texto;24;Obrigatório;;"TRADICIONAL
INSTRUMENTO_GARANTIA
COMPRA_PROGRAMADA
@@ -36,6 +37,7 @@ NA";1;1;"";Não permitido;string;TRADICIONAL;7
1. Pagamento Único
2. Pagamento Mensal
3. Pagamento Periódico
+4. NA
";Texto;19;Obrigatório;;"PAGAMENTO_UNICO
PAGAMENTO_MENSAL
PAGAMENTO_PERIODICO
@@ -74,6 +76,7 @@ NA";1;1;"";Não permitido;string;IPCA;
9. Semestral
10. Anual
11. Outros
+ 12. NA
";Texto;13;Obrigatório;;"UNICO
DIARIO
SEMANAL
@@ -118,6 +121,7 @@ Lista com os valores permitidos de contribuição ao plano.
7. Consignação em Folha de Pagamento
8. Pontos de Programas de Benefício
9. Outros
+ 10. NA
";Texto;27;Obrigatório;;"CARTAO_CREDITO
CARTAO_DEBITO
DEBITO_CONTA_CORRENTE
@@ -153,6 +157,7 @@ NA";1;1;"";Não permitido;string;IPCA;
- SEMESTRAL
- ANUAL
- OUTROS
+ - NA
";Texto;13;Obrigatório;;"UNICO
DIÁRIO
SEMANAL
@@ -189,6 +194,7 @@ tamanho. p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_g
1. Pessoa Natural
2. Pessoa Jurídica
3. Ambas (Pessoa Natural e Jurídica)
+ 4. NA
";Texto;23;Obrigatório;;"PESSOA_NATURAL
PESSOA_JURIDICA
PESSOA_NATURAL_JURIDICA
From f6caa282079a4d9d69243dde0065c9152c6e3d2c Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Tue, 16 May 2023 11:40:52 -0300
Subject: [PATCH 35/50] fix(Insurances): PC81 - dicionario dados
---
dictionary/getPersonalInsurance_v1.csv | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/dictionary/getPersonalInsurance_v1.csv b/dictionary/getPersonalInsurance_v1.csv
index 7e054cbf6..293a75df5 100644
--- a/dictionary/getPersonalInsurance_v1.csv
+++ b/dictionary/getPersonalInsurance_v1.csv
@@ -16,10 +16,10 @@
/data/society/brand;brand;Nome da marca reportada pela sociedade seguradora participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Marca;
/data/name;name;Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Produto A;
/data/code;code;Código único a ser definido pela sociedade.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;0001;
-/data/category;category;"Indicar a categoria do Produto:
- Tradicional
- Microsseguro
";Texto;12;Opcional;;"TRADICIONAL
+/data/category;category;"Indicar a categoria do Produto:
- Tradicional
- Microsseguro
- NA
";Texto;12;Opcional;;"TRADICIONAL
MICROSSEGURO
NA";0;1;"";Não permitido;string;TRADICIONAL;
-/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
;Texto;33;Obrigatório;;"FUNERAL
+/data/modality;modality;- Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
- NA
;Texto;33;Obrigatório;;"FUNERAL
PRESTAMISTA
VIAGEM
EDUCACIONAL
@@ -301,6 +301,7 @@ NA";1;N;"";Não permitido;array;DIARIA;
/data/minimumRequirement/contractType;contractType;"A considerar os domínios abaixo:
1. Coletivo;
2. Individual
+ 3. NA
";Texto;10;Obrigatório;;"COLETIVO
INDIVIDUAL
NA";1;1;"";Não permitido;string;COLETIVO;
@@ -310,6 +311,7 @@ NA";1;1;"";Não permitido;string;COLETIVO;
1. Pessoa Natural
2. Pessoa Jurídica
3. Ambas (Pessoa Natural e Jurídica)
+ 4. NA
";Texto;23;Obrigatório;;"PESSOA_NATURAL
PESSOA_JURIDICA
PESSOA_NATURAL_JURIDICA
From a9383039c8c5c0e9d271ba8e670f6ee688a0042a Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Wed, 17 May 2023 10:50:09 -0300
Subject: [PATCH 36/50] fix(Pension): ORB-2617 - PC81 - String - Ajustes
---
dictionary/getPensionRiskCoverages_v1.csv | 2 +-
dictionary/getPensionSurvivalCoverages_v1.csv | 2 +-
swagger-apis/pension/1.0.0-rc3.0.yml | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/dictionary/getPensionRiskCoverages_v1.csv b/dictionary/getPensionRiskCoverages_v1.csv
index 4f1108c8a..aa6d06de0 100644
--- a/dictionary/getPensionRiskCoverages_v1.csv
+++ b/dictionary/getPensionRiskCoverages_v1.csv
@@ -153,7 +153,7 @@ SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
OUTROS
NAO_HA";0;1;"";Não permitido;string;SORTEIO;
/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;2
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/pmbacRemuneration;pmbacRemuneration;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/pmbacRemuneration/interestRate;interestRate;Taxa de juros para capitalização da PMBaC;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
diff --git a/dictionary/getPensionSurvivalCoverages_v1.csv b/dictionary/getPensionSurvivalCoverages_v1.csv
index 1e98330a5..0415ef9e3 100644
--- a/dictionary/getPensionSurvivalCoverages_v1.csv
+++ b/dictionary/getPensionSurvivalCoverages_v1.csv
@@ -36,7 +36,7 @@ BENEFICIO_DEFINIDO
NA";1;1;"";Não permitido;string;BENEFICIO_DEFINIDO;
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL);Texto;1024;Opcional;;;0;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/termsAndConditions;termsAndConditions;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;2
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/type;type;"1. PGBL
2. PRGP
diff --git a/swagger-apis/pension/1.0.0-rc3.0.yml b/swagger-apis/pension/1.0.0-rc3.0.yml
index c036bf5b4..9fe5b19fd 100644
--- a/swagger-apis/pension/1.0.0-rc3.0.yml
+++ b/swagger-apis/pension/1.0.0-rc3.0.yml
@@ -961,7 +961,7 @@ components:
susepProcessNumber:
type: string
description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
- minLength: 12
+ minLength: 2
maxLength: 20
pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$'
example: 15414.622222/2222-22
From 74e09215eea1a13229b025a28a7e7bad224b5c38 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Wed, 17 May 2023 10:52:13 -0300
Subject: [PATCH 37/50] fix(Pension): ORB-2618 - PC81 - Enum - Ajuste
---
dictionary/getPensionRiskCoverages_v1.csv | 1 +
swagger-apis/pension/1.0.0-rc3.0.yml | 1 +
2 files changed, 2 insertions(+)
diff --git a/dictionary/getPensionRiskCoverages_v1.csv b/dictionary/getPensionRiskCoverages_v1.csv
index aa6d06de0..3b819e52d 100644
--- a/dictionary/getPensionRiskCoverages_v1.csv
+++ b/dictionary/getPensionRiskCoverages_v1.csv
@@ -56,6 +56,7 @@ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a
1. Quantidade determinada de parcelas;
2. Até o fim de ciclo determinado.
3. NA
+
Se for pagamento único, esse campo não se aplica (retorna vazio).
";Texto;;Opcional;;"QUANTIDADE_DETERMINADA_PARCELAS
FIM_CICLO_DETERMINADO
diff --git a/swagger-apis/pension/1.0.0-rc3.0.yml b/swagger-apis/pension/1.0.0-rc3.0.yml
index 9fe5b19fd..a7e9e6768 100644
--- a/swagger-apis/pension/1.0.0-rc3.0.yml
+++ b/swagger-apis/pension/1.0.0-rc3.0.yml
@@ -812,6 +812,7 @@ components:
1. Quantidade determinada de parcelas;
2. Até o fim de ciclo determinado.
3. NA
+
Se for pagamento único, esse campo não se aplica (retorna vazio).
enum:
- QUANTIDADE_DETERMINADA_PARCELAS
From 589c6280afb9e4014deeaad1078ab3010dae09de Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Wed, 17 May 2023 13:16:22 -0300
Subject: [PATCH 38/50] =?UTF-8?q?fix=20-=20Removendo=20vers=C3=A3o=201.0.0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
swagger-apis/capitalization-bonds/1.0.0.yml | 813 --------------------
1 file changed, 813 deletions(-)
delete mode 100644 swagger-apis/capitalization-bonds/1.0.0.yml
diff --git a/swagger-apis/capitalization-bonds/1.0.0.yml b/swagger-apis/capitalization-bonds/1.0.0.yml
deleted file mode 100644
index f2c20db09..000000000
--- a/swagger-apis/capitalization-bonds/1.0.0.yml
+++ /dev/null
@@ -1,813 +0,0 @@
-openapi: 3.0.0
-info:
- title: API Capitalization-bonds - Open Finance Brasil
- description: |
- As APIs descritas neste documento é referente a API de Capitalização da fase OpenInsurance do Open Finance Brasil.
- version: 1.0.0-rc2.0
- license:
- name: Apache 2.0
- url: 'https://www.apache.org/licenses/LICENSE-2.0'
- contact:
- name: Governança do Open Finance Brasil – Especificações
- email: gt-interfaces@openbankingbr.org
- url: 'https://openbanking-brasil.github.io/areadesenvolvedor/'
-servers:
- - url: 'https://api.banco.com.br/open-banking/opendata-capitalization/v1'
- description: Servidor de Produção
- - url: 'https://apih.banco.com.br/open-banking/opendata-capitalization/v1'
- description: Servidor de Homologação
-tags:
- - name: Capitalization Bonds
- description: Operações para consulta das informações de Titulos de Capitalização
-paths:
- /bonds:
- get:
- tags:
- - Capitalization Bonds
- summary: Conjunto de informações dos Títulos de Capitalização de uma instituição
- operationId: capitalizationBondsGetProducts
- description: Método para obter a lista de todos os títulos de Capitalização de uma instituição
- parameters:
- - $ref: '#/components/parameters/page'
- - $ref: '#/components/parameters/pageSize'
- responses:
- '200':
- $ref: '#/components/responses/OKResponseCapitalizationBondsProductsList'
- '400':
- $ref: '#/components/responses/BadRequest'
- '404':
- $ref: '#/components/responses/NotFound'
- '405':
- $ref: '#/components/responses/MethodNotAllowed'
- '429':
- $ref: '#/components/responses/TooManyRequests'
- '500':
- $ref: '#/components/responses/InternalServerError'
- '529':
- $ref: '#/components/responses/SiteIsOverloaded'
-components:
- schemas:
- CapitalizationBondsProductIdentificationData:
- type: object
- required:
- - participant
- - society
- - name
- - code
- - modality
- - costType
- - termsAndConditions
- - quotas
- - capitalizationPeriod
- - latePayment
- - contributionPayment
- - finalRedemptionRate
- - redemptionPercentageEndTerm
- - draws
- - additionalInfo
- - targetAudience
- properties:
- participant:
- $ref: '#/components/schemas/Participant'
- society:
- type: object
- description: Conjunto de informações relativas à seguradora do produto de open insurance
- required:
- - name
- - cnpjNumber
- properties:
- name:
- type: string
- description: Nome da Sociedade Seguradora.
- maxLength: 80
- example: Society A1
- cnpjNumber:
- $ref: '#/components/schemas/Participant/properties/cnpjNumber'
- additionalProperties: false
- name:
- type: string
- description: 'Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.'
- maxLength: 80
- example: ACMEcap
- code:
- type: string
- description: Código único a ser definido pela sociedade.
- maxLength: 100
- example: 01234589_cap
- modality:
- $ref: '#/components/schemas/EnumCapitalizationBondsProductModality'
- costType:
- $ref: '#/components/schemas/EnumCapitalizationBondsProductCostType'
- termsAndConditions:
- $ref: '#/components/schemas/TermsAndConditions'
- quotas:
- type: array
- description: Informações relativas às taxas da Quotas praticadas para cada Parcela
- minItems: 1
- items:
- $ref: '#/components/schemas/CapitalizationBondsProductQuota'
- validity:
- type: integer
- format: int32
- description: Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.
- maxLength: 3
- example: 48
- serieSize:
- type: integer
- description: 'Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.'
- maxLength: 10
- example: 5000000
- capitalizationPeriod:
- $ref: '#/components/schemas/CapitalizationBondsProductCapitalizationPeriod'
- latePayment:
- $ref: '#/components/schemas/LatePayment'
- contributionPayment:
- $ref: '#/components/schemas/ContributionPayment'
- redemptionPercentageEndTerm:
- type: string
- description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
- maxLength: 8
- minLength: 8
- pattern: '^\d{1}\.\d{6}$'
- example: '0.019800'
- finalRedemptionRate:
- type: string
- description: Valor percentual (%) de resgate final permitido.
- pattern: '^\d{1}\.\d{6}$'
- maxLength: 8
- minLength: 8
- example: '0.019800'
- draws:
- type: array
- description: Informações relativas aos Sorteios
- minItems: 1
- items:
- $ref: '#/components/schemas/CapitalizationBondsProductPrizeDraw'
- additionalInfo:
- type: string
- description: 'Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.'
- maxLength: 1024
- example: 'https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais'
- minimumRequirementDetails:
- type: string
- description: |
- Campo aberto (possibilidade de incluir URL).
- Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
- tamanho. p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.’
- maxLength: 1024
- example: 'https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais'
- targetAudience:
- type: string
- description: |
- A considerar os domínios abaixo:
-
- 1. Pessoa Natural
- 2. Pessoa Jurídica
- 3. Ambas (Pessoa Natural e Jurídica)
- maxLength: 23
- enum:
- - PESSOA_NATURAL
- - PESSOA_JURIDICA
- - PESSOA_NATURAL_JURIDICA
- example: PESSOA_NATURAL
- additionalProperties: false
- Participant:
- type: object
- description: Conjunto de informações relativas ao participante do produto de Open Finance
- required:
- - brand
- - name
- - cnpjNumber
- properties:
- brand:
- type: string
- description: 'Nome da marca reportada pelo participante do Open Finance. 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.'
- maxLength: 80
- example: Organização
- name:
- type: string
- description: Nome do participante do Open Finance.
- maxLength: 80
- example: Organização A1
- cnpjNumber:
- type: string
- description: '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.'
- pattern: '^\d{14}$'
- example: '13456789000112'
- urlComplementaryList:
- type: string
- description: |
- Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
-
- - ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
-
- - 'cnpjNumber' com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
-
- - Ambos do tipo string;
-
- - Ambos obrigatórios.
- maxLength: 1024
- pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
- example: 'https://empresaa1.com/companies'
- additionalProperties: false
- EnumCapitalizationBondsProductModality:
- type: string
- description: |
- 1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
- 2. Instrumento de Garantia: A modalidade tem por objetivo propiciar que a provisão matemática para capitalização do título de capitalização seja utilizada para assegurar o cumprimento de obrigação assumida em contrato principal pelo titular perante terceiro. (Res CNSP 384/20)
- 3. Compra Programada: A modalidade compra programada garante o valor de resgate em moeda corrente nacional, sendo disponibilizada ao assim desejar e sem qualquer outro custo, pelo recebimento do bem e/ou serviço referenciado no subsidiado por acordos comerciais celebrados com indústrias, atacadistas, empresas comerciais ou prestadores de serviço. (Res CNSP 384/20)
- 4. Popular: A modalidade popular tem por objetivo propiciar a capitalização da contribuição e a participação do titular em sorteios, sem que haja devolução integral do valor pago. (Res CNSP 384/20)
- 5. Incentivo: A modalidade incentivo tem por objetivo a vinculação a um evento promocional de caráter comercial instituído pelo subscritor para alavancar a venda de seu(s) produto(s) ou serviços ou para fidelizar seus clientes. (Res CNSP 384/20)
- 6. Filantropia Premiável: A modalidade filantropia premiável é destinada ao subscritor interessado em contribuir com entidades beneficentes de assistências sociais, certificadas nos termos da legislação vigente, e participar de sorteio(s). (Res CNSP 384/20)
- minLength: 7
- maxLength: 24
- enum:
- - TRADICIONAL
- - INSTRUMENTO_GARANTIA
- - COMPRA_PROGRAMADA
- - POPULAR
- - INCENTIVO
- - FILANTROPIA_PREMIAVEL
- example: TRADICIONAL
- EnumCapitalizationBondsProductCostType:
- type: string
- description: |
- Pagamento efetuado ao subscritor à sociedade de capitalização para aquisição do título de capitalização, podendo ser única, periódica ou mensal.
- 1. Pagamento Único
- 2. Pagamento Mensal
- 3. Pagamento Periódico
- minLength: 15
- maxLength: 19
- enum:
- - PAGAMENTO_UNICO
- - PAGAMENTO_MENSAL
- - PAGAMENTO_PERIODICO
- example: PAGAMENTO_UNICO
- TermsAndConditions:
- type: object
- required:
- - susepProcessNumber
- - detail
- properties:
- susepProcessNumber:
- type: string
- description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
- minLength: 12
- maxLength: 20
- pattern: '^\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2}$'
- example: 15414.622222/2222-22
- detail:
- type: string
- description: 'Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL)'
- maxLength: 1024
- example: 'https://openinsurance.com.br/aaa'
- additionalProperties: false
- CapitalizationBondsProductQuota:
- type: object
- required:
- - quota
- - capitalizationQuota
- - raffleQuota
- - chargingQuota
- properties:
- quota:
- type: number
- format: integer
- description: Número da parcela.
- maxLength: 3
- example: 10
- capitalizationQuota:
- type: string
- description: Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).
- maxLength: 8
- minLength: 8
- pattern: '^\d{1}\.\d{6}$'
- example: '0.019800'
- raffleQuota:
- type: string
- description: 'Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).'
- maxLength: 8
- minLength: 8
- pattern: '^\d{1}\.\d{6}$'
- example: '0.019800'
- chargingQuota:
- type: string
- description: 'Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).'
- maxLength: 8
- minLength: 8
- pattern: '^\d{1}\.\d{6}$'
- example: '0.019800'
- additionalProperties: false
- CapitalizationBondsProductCapitalizationPeriod:
- type: object
- required:
- - interestRate
- - updateIndex
- - contributionAmount
- - earlyRedemptions
- - redemptionPercentageEndTerm
- - gracePeriodRedemption
- properties:
- interestRate:
- type: string
- pattern: '^\d{1}\.\d{6}$'
- description: 'Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).'
- maxLength: 8
- minLength: 8
- example: '0.019800'
- updateIndex:
- $ref: '#/components/schemas/CapitalizationBondsProductUpdateIndex'
- updateIndexAdditionalInfo:
- type: string
- description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
- maxLength: 200
- example: ''
- contributionAmount:
- type: array
- items:
- $ref: '#/components/schemas/CapitalizationPeriodContributionAmount'
- minItems: 1
- earlyRedemptions:
- minItems: 1
- type: array
- items:
- type: object
- required:
- - quota
- - rate
- properties:
- quota:
- type: number
- format: integer
- description: Parcela relativa ao Resgate Antecipado
- maxLength: 3
- example: 10
- rate:
- type: string
- description: Taxa relativa ao Resgate Antecipado
- maxLength: 8
- minLength: 8
- pattern: '^\d{1}\.\d{6}$'
- example: '0.019800'
- additionalProperties: false
- redemptionPercentageEndTerm:
- type: string
- description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
- maxLength: 8
- minLength: 8
- pattern: '^\d{1}\.\d{6}$'
- example: '0.019800'
- gracePeriodRedemption:
- type: number
- format: integer
- description: 'Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.'
- maxLength: 3
- example: 48
- additionalProperties: false
- CapitalizationBondsProductUpdateIndex:
- type: string
- maxLength: 37
- enum:
- - IPCA
- - IGPM
- - INPC
- - TR
- - INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
- - OUTROS
- example: IPCA
- description: |
- Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
- CapitalizationPeriodContributionAmount:
- type: object
- description: |
- Corresponde ao pagamento efetuado pelo subscritor à sociedade de capitalização para a aquisição do título de capitalização, podendo ser única, periódica ou mensal (Resolução CNSP 384/20). Valores em reais (R$). Esclarecimentos adicionais SUSEP.
- Na modalidade Tradicional, informar a faixa de valor mínimo e máximo em R$ de contribuição ao plano.
- Para as demais modalidades, informar a lista com os valores permitidos de contribuição ao plano.
- Em todas as situações indicar para qual periodicidade de pagamento se aplicam os valores: pagamento mensal, pagamento único ou periódico.
- required:
- - periodicity
- - minimum
- - maximum
- - allowedValue
- properties:
- periodicity:
- type: string
- description: |
- Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
- 1. Único
- 2. Diário
- 3. Semanal
- 4. Quinzenal
- 5. Mensal
- 6. Bimestral
- 7. Trimestral
- 8. Quadrimestral
- 9. Semestral
- 10. Anual
- 11. Outros
- maxLength: 13
- enum:
- - UNICO
- - DIARIO
- - SEMANAL
- - QUINZENAL
- - MENSAL
- - BIMESTRAL
- - TRIMESTRAL
- - QUADRIMESTRAL
- - SEMESTRAL
- - ANUAL
- - OUTROS
- example: UNICO
- periodicityAdditionalInfo:
- type: string
- description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
- maxLength: 200
- example: ''
- minimum:
- type: string
- pattern: '^\d{1,16}\.\d{2,4}$'
- description: |
- Condicional: Quando modalidade for igual 'TRADICIONAL'
- Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
- maxLength: 21
- example: '1.2222'
- maximum:
- type: string
- pattern: '^\d{1,16}\.\d{2,4}$'
- description: |
- Condicional: Quando modalidade for igual 'TRADICIONAL'
- Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
- maxLength: 21
- example: '1.2222'
- allowedValue:
- type: number
- format: double
- description: |
- Condicional: Quando modalidade for diferente de 'TRADICIONAL'
- Lista com os valores permitidos de contribuição ao plano.
- example: 5000
- additionalProperties: false
- LatePayment:
- type: object
- required:
- - suspensionMonths
- - periodExtensionOption
- properties:
- suspensionMonths:
- type: number
- description: 'Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).'
- maxLength: 3
- example: 10
- periodExtensionOption:
- type: boolean
- description: |
- Alteração do prazo de vigência original, pela suspensão (não aplicável a pagamento único). A considerar os seguintes domínios:
- 1. true
- 2. false
- example: true
- additionalProperties: false
- ContributionPayment:
- type: object
- required:
- - paymentMethod
- - updateIndex
- properties:
- paymentMethod:
- $ref: '#/components/schemas/CapitalizationBondsProductPaymentMethod'
- paymentMethodAdditionalInfo:
- type: string
- description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
- maxLength: 200
- example: ''
- updateIndex:
- $ref: '#/components/schemas/CapitalizationBondsProductUpdateIndex'
- updateIndexAdditionalInfo:
- type: string
- description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
- maxLength: 200
- example: ''
- additionalProperties: false
- CapitalizationBondsProductPaymentMethod:
- type: string
- maxLength: 27
- enum:
- - CARTAO_CREDITO
- - CARTAO_DEBITO
- - DEBITO_CONTA_CORRENTE
- - DEBITO_CONTA_POUPANCA
- - BOLETO_BANCARIO
- - PIX
- - CONSIGNACAO_FOLHA_PAGAMENTO
- - PAGAMENTO_PONTOS
- - OUTROS
- example: CARTAO_CREDITO
- description: |
- Meio de Pagamento utilizado para pagamento da contribuição. A considerar os domínios abaixo:
- 1. Cartão de Crédito
- 2. Cartão de Débito
- 3. Débito em conta corrente
- 4. Débito em conta poupança
- 5. Boleto bancário
- 6. PIX
- 7. Consignação em Folha de Pagamento
- 8. Pontos de Programas de Benefício
- 9. Outros
- CapitalizationBondsProductPrizeDraw:
- type: object
- required:
- - timeInterval
- - quantity
- - prizeMultiplier
- - earlySettlementRaffle
- - mandatoryContemplation
- - minimumContemplationProbability
- properties:
- timeInterval:
- type: string
- description: |
- Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
- - UNICO
- - DIÁRIO
- - SEMANAL
- - QUINZENAL
- - MENSAL
- - BIMESTRAL
- - TRIMESTRAL
- - QUADRIMESTRAL
- - SEMESTRAL
- - ANUAL
- - OUTROS
- maxLength: 13
- enum:
- - UNICO
- - DIÁRIO
- - SEMANAL
- - QUINZENAL
- - MENSAL
- - BIMESTRAL
- - TRIMESTRAL
- - QUADRIMESTRAL
- - SEMESTRAL
- - ANUAL
- - OUTROS
- example: UNICO
- timeIntervalAdditionalInfo:
- type: string
- description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
- maxLength: 200
- example: '5'
- quantity:
- type: number
- format: integer
- description: Número da quantidade de sorteios previstos ao longo da vigência.
- maxLength: 5
- example: 10000
- prizeMultiplier:
- type: number
- format: integer
- description: 'Valor dos sorteios representado por múltiplo do valor de contribuição. Por exemplo: 5 vezes valor da contribuição'
- maxLength: 6
- example: 5
- earlySettlementRaffle:
- description: |
- Modelo de sorteio que acarreta, ao título contemplado, o seu resgate total obrigatório (Resolução Normativa 384/20). Conforme os domínios:
- 1. true
- 2. false
- type: boolean
- example: true
- mandatoryContemplation:
- type: boolean
- description: |
- Possibilidade de realização de sorteio com previsão de que o título sorteado seja obrigatoriamente um título comercializado,
- desde que atingidos os requisitos definidos nas condições gerais do plano. Conforme os domínios:
- 1. true
- 2. false
- example: true
- ruleDescription:
- type: string
- description: 'Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.'
- maxLength: 200
- example: Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.
- minimumContemplationProbability:
- type: string
- pattern: '^\d{1}\.\d{6}$'
- description: 'Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).'
- maxLength: 8
- minLength: 8
- example: '0.019800'
- additionalProperties: false
- Links:
- type: object
- description: Referências para outros recusos da API requisitada.
- required:
- - self
- properties:
- self:
- type: string
- format: uri
- maxLength: 2000
- description: URI completo que gerou a resposta atual.
- example: 'https://api.banco.com.br/open-banking/api/v1/resource'
- pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
- first:
- type: string
- format: uri
- maxLength: 2000
- description: URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
- example: 'https://api.banco.com.br/open-banking/api/v1/resource'
- pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
- prev:
- type: string
- format: uri
- maxLength: 2000
- description: "URI da página anterior dessa lista de resultados. Restrição - \tObrigatório quando não for a primeira página da resposta"
- example: 'https://api.banco.com.br/open-banking/api/v1/resource'
- pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
- next:
- type: string
- format: uri
- maxLength: 2000
- description: URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
- example: 'https://api.banco.com.br/open-banking/api/v1/resource'
- pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
- last:
- type: string
- format: uri
- maxLength: 2000
- description: URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
- example: 'https://api.banco.com.br/open-banking/api/v1/resource'
- pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
- additionalProperties: false
- OpenDataMeta:
- type: object
- description: Meta informações referente à API requisitada.
- required:
- - totalRecords
- - totalPages
- properties:
- totalRecords:
- type: integer
- format: int32
- description: Número total de registros no resultado
- example: 1
- totalPages:
- type: integer
- format: int32
- description: Número total de páginas no resultado
- example: 1
- additionalProperties: false
- parameters:
- 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
- maximum: 2147483647
- 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
- responses:
- OKResponseCapitalizationBondsProductsList:
- description: Dados de título(s) de capitalização obtidos com sucesso.
- content:
- application/json:
- schema:
- type: object
- required:
- - data
- - links
- - meta
- properties:
- data:
- type: array
- description: Conjunto de informações do Título de Capitalização
- items:
- $ref: '#/components/schemas/CapitalizationBondsProductIdentificationData'
- minItems: 1
- links:
- $ref: '#/components/schemas/Links'
- meta:
- $ref: '#/components/schemas/OpenDataMeta'
- additionalProperties: false
- 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/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
- InternalServerError:
- description: Ocorreu um erro no gateway da API ou no microsserviço
- content:
- application/json; charset=utf-8:
- schema:
- $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
- MethodNotAllowed:
- description: O consumidor tentou acessar o recurso com um método não suportado
- content:
- application/json; charset=utf-8:
- schema:
- $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
- NotFound:
- description: O recurso solicitado não existe ou não foi implementado
- content:
- application/json; charset=utf-8:
- schema:
- 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
- pattern: '[\w\W\s]*'
- maxLength: 255
- detail:
- description: Descrição legível por humanos deste erro específico
- type: string
- pattern: '[\w\W\s]*'
- maxLength: 2048
- additionalProperties: false
- meta:
- $ref: '#/components/schemas/OpenDataMeta'
- additionalProperties: false
- TooManyRequests:
- description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite de requisições concorrentes foi atingido.'
- content:
- application/json; charset=utf-8:
- schema:
- $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
- SiteIsOverloaded:
- description: 'O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento.'
- content:
- application/json; charset=utf-8:
- schema:
- 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
- pattern: '[\w\W\s]*'
- maxLength: 255
- detail:
- description: Descrição legível por humanos deste erro específico
- type: string
- pattern: '[\w\W\s]*'
- maxLength: 2048
- meta:
- type: object
- description: Meta informações referente à API requisitada.
- required:
- - requestDateTime
- properties:
- requestDateTime:
- description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.'
- type: string
- maxLength: 20
- format: date-time
- example: '2021-05-21T08:30:00Z'
From 1dda7a067a81b220c75ad1deec9475dea0db037d Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Thu, 18 May 2023 11:45:25 -0300
Subject: [PATCH 39/50] fix - corrigindo branch
---
.../capitalizationBondsGetProducts_v1.csv | 35 +------------------
1 file changed, 1 insertion(+), 34 deletions(-)
diff --git a/dictionary/capitalizationBondsGetProducts_v1.csv b/dictionary/capitalizationBondsGetProducts_v1.csv
index 7b93d316e..09feba701 100644
--- a/dictionary/capitalizationBondsGetProducts_v1.csv
+++ b/dictionary/capitalizationBondsGetProducts_v1.csv
@@ -3,7 +3,6 @@
/data/participant;participant;Conjunto de informações relativas ao participante do produto de Open Finance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/participant/brand;brand;Nome da marca reportada pelo participante do Open Finance. 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.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização;
/data/participant/name;name;Nome do participante do Open Finance.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Organização A1;
-<<<<<<< HEAD
/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
/data/participant/urlComplementaryList;urlComplementaryList;"Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
@@ -15,10 +14,6 @@
- Ambos obrigatórios.
";Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|(NA)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
-=======
-/data/participant/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;13456789000112;
-/data/participant/urlComplementaryList;urlComplementaryList;;Texto;1024;Opcional;^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$;;0;1;"";Não permitido;string;https://empresaa1.com/companies;
->>>>>>> release-capitalization-bonds-20230518
/data/society;society;Conjunto de informações relativas à seguradora do produto de open insurance;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/society/name;name;Nome da Sociedade Seguradora.;Texto;80;Obrigatório;;;1;1;"";Não permitido;string;Society A1;
/data/society/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
@@ -48,7 +43,6 @@ PAGAMENTO_MENSAL
PAGAMENTO_PERIODICO
NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
/data/termsAndConditions;termsAndConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-<<<<<<< HEAD
/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/quotas;quotas;Informações relativas às taxas da Quotas praticadas para cada Parcela;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
@@ -60,19 +54,6 @@ NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
/data/serieSize;serieSize;Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;5000000;
/data/capitalizationPeriod;capitalizationPeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-=======
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^\d{5}\.\d{6}/\d{4}-\d{2}$;;1;1;"";Não permitido;string;15414.622222/2222-22;
-/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
-/data/quotas;quotas;Informações relativas às taxas da Quotas praticadas para cada Parcela;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/quotas/quota;quota;Número da parcela.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-/data/quotas/capitalizationQuota;capitalizationQuota;Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^[0-1]\.\d{6}$;;1;1;"";Não permitido;string;0.000010;
-/data/quotas/raffleQuota;raffleQuota;Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^[0-1]\.\d{6}$;;1;1;"";Não permitido;string;0.000010;
-/data/quotas/chargingQuota;chargingQuota;Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).;Texto;8;Obrigatório;^[0-1]\.\d{6}$;;1;1;"";Não permitido;string;0.000010;
-/data/validity;validity;Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.;Inteiro;3;Opcional;;;0;1;"";Não permitido;integer;48;
-/data/serieSize;serieSize;Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.;Inteiro;10;Opcional;;;0;1;"";Não permitido;integer;5000000;
-/data/capitalizationPeriod;capitalizationPeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/capitalizationPeriod/interestRate;interestRate;Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).;Texto;8;Obrigatório;^[0-1]\.[\d]{6}$;;1;1;"";Não permitido;string;0.251231;
->>>>>>> release-capitalization-bonds-20230518
/data/capitalizationPeriod/updateIndex;updateIndex;"Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
";Texto;37;Obrigatório;;"IPCA
IGPM
@@ -117,16 +98,11 @@ Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade
";Texto;21;Obrigatório;^(\d{1,16}\.\d{2,4})$|^(NA)$;;1;1;"";Não permitido;string;1.2222;
/data/capitalizationPeriod/contributionAmount/allowedValue;allowedValue;"Condicional: Quando modalidade for diferente de 'TRADICIONAL'
Lista com os valores permitidos de contribuição ao plano.
-";Número;8;Obrigatório;;;1;1;"";Não permitido;number;5000;
+";Número;;Obrigatório;;;1;1;"";Não permitido;number;5000;
/data/capitalizationPeriod/earlyRedemptions;earlyRedemptions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/capitalizationPeriod/earlyRedemptions/quota;quota;Parcela relativa ao Resgate Antecipado;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
-<<<<<<< HEAD
/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-=======
-/data/capitalizationPeriod/earlyRedemptions/rate;rate;Taxa relativa ao Resgate Antecipado;Número;9;Obrigatório;;;1;1;"";Não permitido;number;10.000001;
-/data/capitalizationPeriod/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;7;Obrigatório;^[0-1]\.\d{5}$;;1;1;"";Não permitido;string;1.00002;
->>>>>>> release-capitalization-bonds-20230518
/data/capitalizationPeriod/gracePeriodRedemption;gracePeriodRedemption;Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;48;
/data/latePayment;latePayment;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/latePayment/suspensionMonths;suspensionMonths;Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
@@ -166,13 +142,8 @@ INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
OUTROS
NA";1;1;"";Não permitido;string;IPCA;
/data/contributionPayment/updateIndexAdditionalInfo;updateIndexAdditionalInfo;Restrição: Campo obrigatório para complementar a informação quando selecionada a opção 'OUTROS';Texto;200;Opcional;;;0;1;"";Não permitido;string;"";
-<<<<<<< HEAD
/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-=======
-/data/redemptionPercentageEndTerm;redemptionPercentageEndTerm;Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.;Texto;7;Obrigatório;^[0-1]\.\d{5}$;;1;1;"";Não permitido;string;1.00002;
-/data/finalRedemptionRate;finalRedemptionRate;Valor percentual (%) de resgate final permitido.;Texto;4;Obrigatório;^[0-9]\.\d{2}$;;1;1;"";Não permitido;string;1.51;
->>>>>>> release-capitalization-bonds-20230518
/data/draws;draws;Informações relativas aos Sorteios;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/draws/timeInterval;timeInterval;"Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
- UNICO
@@ -212,11 +183,7 @@ desde que atingidos os requisitos definidos nas condições gerais do plano. Con
2. false
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;true;
/data/draws/ruleDescription;ruleDescription;Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.;Texto;200;Opcional;;;0;1;"";Não permitido;string;Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.;
-<<<<<<< HEAD
/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
-=======
-/data/draws/minimumContemplationProbability;minimumContemplationProbability;Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).;Texto;8;Obrigatório;^[0-1]\.\d{6}$;;1;1;"";Não permitido;string;0.000002;
->>>>>>> release-capitalization-bonds-20230518
/data/additionalInfo;additionalInfo;Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.;Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais;
/data/minimumRequirementDetails;minimumRequirementDetails;"Campo aberto (possibilidade de incluir URL).
Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
From 728e6cdf1e69169f27d7794640030c7a361f2f3f Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Thu, 18 May 2023 11:48:59 -0300
Subject: [PATCH 40/50] fix - ajustando arquivos csv
---
...dIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv | 2 +-
...ditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
index 8a475089e..9873069b4 100644
--- a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
+++ b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactionsCurrent_v1.csv
@@ -1,4 +1,4 @@
-data,,,,,,,,,,,,,,,,,,links,,,,meta
+data,,,,,,,,,,,,,,,,,,links,,,,meta
type,transactionType,typeAdditionalInfo,transactionDate,transactionUnitPrice,,transactionQuantity,transactionGrossValue,,incomeTax,,financialTransactionTax,,transactionNetValue,,remunerationTransactionRate,indexerPercentage,transactionId,self,first,prev,next,requestDateTime
,,,,amount,currency,,amount,currency,amount,currency,amount,currency,amount,currency,,,,,,,,
ENTRADA,COMPRA,string,2018-02-15,1000.000004,BRL,42.25,1000.04,BRL,1000.04,BRL,1000.04,BRL,1000.04,BRL,0.300000,1.100000,ABCD2126019929279212650822221989319253344,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,2021-05-21T08:30:00Z
\ No newline at end of file
diff --git a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
index a9f249090..39c5e0a48 100644
--- a/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
+++ b/dictionary/example/examples_creditFixedIncomesGetInvestmentsInvestmentIdTransactions_v1.csv
@@ -1,4 +1,4 @@
-data,,,,,,,,,,,,,,,,,,links,,,,meta
+data,,,,,,,,,,,,,,,,,,links,,,,meta
type,transactionType,typeAdditionalInfo,transactionDate,transactionUnitPrice,,transactionQuantity,transactionGrossValue,,incomeTax,,financialTransactionTax,,transactionNetValue,,remunerationTransactionRate,indexerPercentage,transactionId,self,first,prev,next,requestDateTime
,,,,amount,currency,,amount,currency,amount,currency,amount,currency,amount,currency,,,,,,,,
ENTRADA,COMPRA,string,2018-02-15,1000.000004,BRL,42.25,1000.04,BRL,1000.04,BRL,1000.04,BRL,1000.04,BRL,0.300000,1.100000,ABCD2126019929279212650822221989319253344,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,https://api.banco.com.br/open-banking/api/v1/resource,2021-05-21T08:30:00Z
\ No newline at end of file
From dc8a15f361b1eeee78cae5744489acc19428f9f7 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 19 May 2023 13:53:07 -0300
Subject: [PATCH 41/50] =?UTF-8?q?feat(Pension):=20ORB-2633=20-=20PC84=20-?=
=?UTF-8?q?=20indemnifiablePeriods=20-=20Descri=C3=A7=C3=A3o=20-=20Ajuste?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
dictionary/getPensionRiskCoverages_v1.csv | 6 +++---
swagger-apis/pension/1.0.0-rc3.0.yml | 6 +++---
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/dictionary/getPensionRiskCoverages_v1.csv b/dictionary/getPensionRiskCoverages_v1.csv
index 3b819e52d..8f1dced45 100644
--- a/dictionary/getPensionRiskCoverages_v1.csv
+++ b/dictionary/getPensionRiskCoverages_v1.csv
@@ -54,10 +54,10 @@ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a
/data/coverages/attributes/maxValue/currency;currency;Moeda referente ao valor monetário, seguindo o modelo ISO-4217.;Texto;3;Obrigatório;^([A-Z]{3})$|^(NA)$;;1;1;"";Não permitido;string;BRL;
/data/coverages/attributes/indemnifiablePeriod;indemnifiablePeriod;"Listagem do pagamento para cada benefício:
1. Quantidade determinada de parcelas;
- 2. Até o fim de ciclo determinado.
- 3. NA
+ 2. Até o fim de ciclo determinado;
+ 3. NA.
-Se for pagamento único, esse campo não se aplica (retorna vazio).
+Observação: Se for pagamento único, este campo não deve ser informado.
";Texto;;Opcional;;"QUANTIDADE_DETERMINADA_PARCELAS
FIM_CICLO_DETERMINADO
NA";0;1;"";Não permitido;string;QUANTIDADE_DETERMINADA_PARCELAS;
diff --git a/swagger-apis/pension/1.0.0-rc3.0.yml b/swagger-apis/pension/1.0.0-rc3.0.yml
index a7e9e6768..3fce039a5 100644
--- a/swagger-apis/pension/1.0.0-rc3.0.yml
+++ b/swagger-apis/pension/1.0.0-rc3.0.yml
@@ -810,10 +810,10 @@ components:
description: |
Listagem do pagamento para cada benefício:
1. Quantidade determinada de parcelas;
- 2. Até o fim de ciclo determinado.
- 3. NA
+ 2. Até o fim de ciclo determinado;
+ 3. NA.
- Se for pagamento único, esse campo não se aplica (retorna vazio).
+ Observação: Se for pagamento único, este campo não deve ser informado.
enum:
- QUANTIDADE_DETERMINADA_PARCELAS
- FIM_CICLO_DETERMINADO
From 392e8a847288e5febf4ca2bc6fa60743b62d5275 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 19 May 2023 15:58:22 -0300
Subject: [PATCH 42/50] fix(Insurances): ORB-2638 - PC81 - String - Ajuste
---
dictionary/getPersonalInsurance_v1.csv | 2 +-
swagger-apis/insurances/1.0.0-rc3.0.yml | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/dictionary/getPersonalInsurance_v1.csv b/dictionary/getPersonalInsurance_v1.csv
index 293a75df5..82a503a4b 100644
--- a/dictionary/getPersonalInsurance_v1.csv
+++ b/dictionary/getPersonalInsurance_v1.csv
@@ -202,7 +202,7 @@ SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
OUTROS
NAO_HA";1;N;"";Não permitido;array;SORTEIO;
/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;2
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/globalCapital;globalCapital;"A considerar os seguintes domínios:
1. true
diff --git a/swagger-apis/insurances/1.0.0-rc3.0.yml b/swagger-apis/insurances/1.0.0-rc3.0.yml
index fe320ee10..4009d30f4 100644
--- a/swagger-apis/insurances/1.0.0-rc3.0.yml
+++ b/swagger-apis/insurances/1.0.0-rc3.0.yml
@@ -149,7 +149,7 @@ components:
susepProcessNumber:
type: string
description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
- minLength: 12
+ minLength: 2
maxLength: 20
pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$'
example: 15414.622222/2222-22
From d7f3d575bf077766e578145ab076ebf55380de9e Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Fri, 19 May 2023 15:59:50 -0300
Subject: [PATCH 43/50] fix(Insurances): ORB-2639 - PC81 - Percentuais - Ajuste
---
dictionary/getPersonalInsurance_v1.csv | 2 +-
swagger-apis/insurances/1.0.0-rc3.0.yml | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/dictionary/getPersonalInsurance_v1.csv b/dictionary/getPersonalInsurance_v1.csv
index 82a503a4b..515bc21d5 100644
--- a/dictionary/getPersonalInsurance_v1.csv
+++ b/dictionary/getPersonalInsurance_v1.csv
@@ -241,7 +241,7 @@ NA";1;N;"";Não permitido;array;REPARTICAO_SIMPLES;
/data/reclaim/table;table;;Lista;;Opcional;;;1;N;"";Não permitido;array;;
/data/reclaim/table/initialMonthRange;initialMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;1;
/data/reclaim/table/finalMonthRange;finalMonthRange;;Inteiro;2;Obrigatório;;;1;1;"";Não permitido;integer;12;
-/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;8;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
+/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
diff --git a/swagger-apis/insurances/1.0.0-rc3.0.yml b/swagger-apis/insurances/1.0.0-rc3.0.yml
index 4009d30f4..7e189a94a 100644
--- a/swagger-apis/insurances/1.0.0-rc3.0.yml
+++ b/swagger-apis/insurances/1.0.0-rc3.0.yml
@@ -840,7 +840,7 @@ components:
percentage:
type: string
pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
- maxLength: 8
+ maxLength: 9
minLength: 8
description: Percentual de faixa de resgate.
example: '0.019800'
From e4d0ec187b043a24a6f511b8146fd32149b37cc1 Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Mon, 22 May 2023 10:53:23 -0300
Subject: [PATCH 44/50] =?UTF-8?q?feat(Pension):=20ORB-2646=20-=20PC81=20-?=
=?UTF-8?q?=20Inclus=C3=B5es=20de=20NA=20em=20ENUM?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
dictionary/getPensionRiskCoverages_v1.csv | 19 +++++++++++++------
dictionary/getPensionSurvivalCoverages_v1.csv | 10 ++++++++--
swagger-apis/pension/1.0.0-rc3.0.yml | 13 ++++++++++++-
3 files changed, 33 insertions(+), 9 deletions(-)
diff --git a/dictionary/getPensionRiskCoverages_v1.csv b/dictionary/getPensionRiskCoverages_v1.csv
index 8f1dced45..073c16474 100644
--- a/dictionary/getPensionRiskCoverages_v1.csv
+++ b/dictionary/getPensionRiskCoverages_v1.csv
@@ -71,9 +71,10 @@ SOB_FORMA_RENDA
NA";1;1;"";Não permitido;string;UNICO;
/data/coverages/attributes/gracePeriod;gracePeriod;Período de carência da cobertura;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/coverages/attributes/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Opcional;;;0;1;"";Não permitido;integer;90;
-/data/coverages/attributes/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Opcional;;"DIAS
+/data/coverages/attributes/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
- NA
";Texto;10;Opcional;;"DIAS
MESES
-NAO_APLICA";0;1;"";Não permitido;string;MESES;
+NAO_APLICA
+NA";0;1;"";Não permitido;string;MESES;
/data/coverages/attributes/excludedRisks;excludedRisks;;Lista;40;Obrigatório;;"ATO_RECONHECIMENTO_PERIGOSO
ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
OPERACOES_GUERRA
@@ -152,7 +153,8 @@ NA";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
OUTROS
-NAO_HA";0;1;"";Não permitido;string;SORTEIO;
+NAO_HA
+NA";0;1;"";Não permitido;string;SORTEIO;
/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;2
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
@@ -170,7 +172,8 @@ NA";1;1;"";Não permitido;string;IPCA;
/data/ageAdjustment/criterias;criterias;;Lista;27;Obrigatório;;"APOS_PERIODO_ANOS
CADA_PERIODO_ANOS
MUDANCA_FAIXA_ETARIA
-NAO_APLICAVEL";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
+NAO_APLICAVEL
+NA";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
/data/ageAdjustment/frequency;frequency;Período em anos, caso critério de reenquadramento após ou a cada período em anos.;Inteiro;3;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/financialRegimeContractType;financialRegimeContractType;"Listagem de regime financeiro para cada combinação de modalidade/cobertura do produto indicando:
1. Repartição simples
@@ -192,9 +195,11 @@ NA";0;1;"";Não permitido;string;REPARTICAO_SIMPLES;
1. Dias;
2. Meses;
3. Não se aplica.
+4. NA
";Texto;;Obrigatório;;"DIAS
MESES
-NAO_APLICA";1;1;"";Não permitido;string;MESES;
+NAO_APLICA
+NA";1;1;"";Não permitido;string;MESES;
/data/reclaim/differenciatedPercentage;differenciatedPercentage;Campo aberto (possibilidade de incluir URL);"";1024;Opcional;;;0;1;"";Não permitido;;"https://openinsurance.com.br/aaa’
Obs.: Exceção de cobertura ou critério definido acima será descrito aqui na URL
Exemplo: Cobertura X: a partir de 25 meses = 100%
@@ -202,9 +207,11 @@ Exemplo: Cobertura X: a partir de 25 meses = 100%
/data/otherGuaranteedValues;otherGuaranteedValues;"1. Saldamento
2. Benefício Prolongado
3. Não se aplica
+4. NA
";Texto;;Obrigatório;;"SALDAMENTO
BENEFICIO_PROLONGADO
-NAO_APLICA";1;1;"";Não permitido;string;SALDAMENTO;
+NAO_APLICA
+NA";1;1;"";Não permitido;string;SALDAMENTO;
/data/contributionPayment;contributionPayment;Pagamento da contribuição.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/contributionPayment/contributionPaymentMethod;contributionPaymentMethod;"Forma de pagamento da contribuição.
- CARTAO_CREDITO
diff --git a/dictionary/getPensionSurvivalCoverages_v1.csv b/dictionary/getPensionSurvivalCoverages_v1.csv
index 0415ef9e3..8dd504717 100644
--- a/dictionary/getPensionSurvivalCoverages_v1.csv
+++ b/dictionary/getPensionSurvivalCoverages_v1.csv
@@ -72,10 +72,13 @@ NA";0;1;"";Não permitido;string;;
1. IPCA (IBGE);
2. IGP-M (FGV);
3. INPC (IBGE).
+4. Não se aplica
+5. NA
";Texto;5;Obrigatório;;"IPCA
IGP_M
INPC
-NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
+NAO_SE_APLICA
+NA";1;1;"";Não permitido;string;IPCA;
/data/defferalPeriod/otherMinimumPerformanceGarantees;otherMinimumPerformanceGarantees;Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.;Texto;12;Obrigatório;;;1;1;"";Não permitido;string;SELIC;
/data/defferalPeriod/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/defferalPeriod/minimumPremiums;minimumPremiums;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
@@ -181,10 +184,13 @@ NA";0;N;"";Não permitido;array;AT_2000_MALE;
1. IPCA (IBGE);
2. IGP-M (FGV);
3. INPC (IBGE).
+4. Não se aplica
+5. NA
";Texto;5;Obrigatório;;"IPCA
IGP_M
INPC
-NAO_SE_APLICA";1;1;"";Não permitido;string;IPCA;
+NAO_SE_APLICA
+NA";1;1;"";Não permitido;string;IPCA;
/data/grantPeriodBenefit/reversalFinancialResults;reversalFinancialResults;Percentual de reversão de excedente financeiro na concessão. Em %.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/grantPeriodBenefit/investmentFunds;investmentFunds;;Lista;;Opcional;;;0;N;"";Não permitido;array;;
/data/grantPeriodBenefit/investmentFunds/cnpjNumber;cnpjNumber;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.;Texto;;Obrigatório;^(\d{14})$|^(NA)$;;1;1;"";Não permitido;string;13456789000112;
diff --git a/swagger-apis/pension/1.0.0-rc3.0.yml b/swagger-apis/pension/1.0.0-rc3.0.yml
index 3fce039a5..879c8e494 100644
--- a/swagger-apis/pension/1.0.0-rc3.0.yml
+++ b/swagger-apis/pension/1.0.0-rc3.0.yml
@@ -980,11 +980,14 @@ components:
1. IPCA (IBGE);
2. IGP-M (FGV);
3. INPC (IBGE).
+ 4. Não se aplica
+ 5. NA
enum:
- IPCA
- IGP_M
- INPC
- NAO_SE_APLICA
+ - NA
example: IPCA
RiskPensionReclaim:
type: object
@@ -1128,6 +1131,7 @@ components:
2. A cada período em anos
3. Por mudança de faixa etária
4. Não aplicável
+ 5. NA
maxLength: 27
example: APOS_PERIODO_ANOS
enum:
@@ -1135,6 +1139,7 @@ components:
- CADA_PERIODO_ANOS
- MUDANCA_FAIXA_ETARIA
- NAO_APLICAVEL
+ - NA
frequency:
type: integer
description: 'Período em anos, caso critério de reenquadramento após ou a cada período em anos.'
@@ -1235,15 +1240,17 @@ components:
- SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
- OUTROS
- NAO_HA
+ - NA
example: SORTEIO
EnumGracePeriodUnit:
type: string
- description: Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
+ description: Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
- NA
maxLength: 10
enum:
- DIAS
- MESES
- NAO_APLICA
+ - NA
example: MESES
RiskPensionEnumGracePeriodUnit:
type: string
@@ -1252,10 +1259,12 @@ components:
1. Dias;
2. Meses;
3. Não se aplica.
+ 4. NA
enum:
- DIAS
- MESES
- NAO_APLICA
+ - NA
example: MESES
RiskPensionEnumFinancialRegime:
type: string
@@ -1372,10 +1381,12 @@ components:
1. Saldamento
2. Benefício Prolongado
3. Não se aplica
+ 4. NA
enum:
- SALDAMENTO
- BENEFICIO_PROLONGADO
- NAO_APLICA
+ - NA
example: SALDAMENTO
RiskPensionEnumProfitModality:
type: string
From 083f7030a2776ef5f234ad68824546e85ff7482a Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Mon, 22 May 2023 10:57:08 -0300
Subject: [PATCH 45/50] =?UTF-8?q?feat(Insurances):=20ORB-2645=20-=20PC81?=
=?UTF-8?q?=20-=20Inclus=C3=B5es=20de=20NA=20em=20ENUM?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
dictionary/getPersonalInsurance_v1.csv | 24 +++++++++++++++---------
swagger-apis/insurances/1.0.0-rc3.0.yml | 8 +++++++-
2 files changed, 22 insertions(+), 10 deletions(-)
diff --git a/dictionary/getPersonalInsurance_v1.csv b/dictionary/getPersonalInsurance_v1.csv
index 515bc21d5..af8a692ce 100644
--- a/dictionary/getPersonalInsurance_v1.csv
+++ b/dictionary/getPersonalInsurance_v1.csv
@@ -109,9 +109,10 @@ NA";1;N;"";Não permitido;array;INDENIZACAO_UNICA;
/data/coverages/attributes/maximumQtyIndemnifiableInstallments;maximumQtyIndemnifiableInstallments;Caso o período indenizável seja relacionado a parcelas, listagem de número máximo de parcelas indenizáveis para cada combinação de modalidade/ cobertura do produto.;Inteiro;10;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/coverages/attributes/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/coverages/attributes/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Opcional;;;0;1;"";Não permitido;integer;90;
-/data/coverages/attributes/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Opcional;;"DIAS
+/data/coverages/attributes/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
- NA
";Texto;10;Opcional;;"DIAS
MESES
-NAO_APLICA";0;1;"";Não permitido;string;MESES;
+NAO_APLICA
+NA";0;1;"";Não permitido;string;MESES;
/data/coverages/attributes/gracePeriod/details;details;;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Descrições adicionais do período de carência;
/data/coverages/attributes/differentiatedGracePeriod;differentiatedGracePeriod;Campo aberto para detalhamento de período de carência diferenciado, se houver.;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;90 DIAS;
/data/coverages/attributes/deductibleDays;deductibleDays;Listagem de franquia em dias para cada combinação de modalidade/cobertura do produto.;Inteiro;10;Obrigatório;;;1;1;"";Não permitido;integer;10;
@@ -200,7 +201,8 @@ NA";0;N;"";Não permitido;array;ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA;
SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
OUTROS
-NAO_HA";1;N;"";Não permitido;array;SORTEIO;
+NAO_HA
+NA";1;N;"";Não permitido;array;SORTEIO;
/data/termsAndConditions;termsAndConditions;;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;2
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
@@ -231,7 +233,8 @@ NA";0;N;"";Não permitido;array;IPCA;
/data/ageAdjustment/criterias;criterias;;Lista;27;Obrigatório;;"APOS_PERIODO_ANOS
CADA_PERIODO_ANOS
MUDANCA_FAIXA_ETARIA
-NAO_APLICAVEL";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
+NAO_APLICAVEL
+NA";1;N;"";Não permitido;array;APOS_PERIODO_ANOS;
/data/ageAdjustment/frequency;frequency;Período em anos, caso critério de reenquadramento após ou a cada período em anos.;Inteiro;3;Obrigatório;;;1;1;"";Não permitido;integer;10;
/data/financialRegimes;financialRegimes;;Lista;19;Obrigatório;;"REPARTICAO_SIMPLES
REPARTICAO_CAPITAIS
@@ -244,9 +247,10 @@ NA";1;N;"";Não permitido;array;REPARTICAO_SIMPLES;
/data/reclaim/table/percentage;percentage;Percentual de faixa de resgate.;Texto;9;Obrigatório;^(\d{1}\.\d{6})$|^(-1.000000)$;;1;1;"";Não permitido;string;0.019800;8
/data/reclaim/gracePeriod;gracePeriod;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
/data/reclaim/gracePeriod/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
-/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
+/data/reclaim/gracePeriod/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
- NA
";Texto;10;Obrigatório;;"DIAS
MESES
-NAO_APLICA";1;1;"";Não permitido;string;MESES;
+NAO_APLICA
+NA";1;1;"";Não permitido;string;MESES;
/data/reclaim/gracePeriod/details;details;;Texto;500;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Descrições adicionais do período de carência;
/data/reclaim/differenciatedPercentage;differenciatedPercentage;Campo aberto (possibilidade de incluir URL);"";1024;Opcional;;;0;1;"";Não permitido;;"https://openinsurance.com.br/aaa’
Obs.: Exceção de cobertura ou critério definido acima será descrito aqui na URL
@@ -254,15 +258,17 @@ Exemplo: Cobertura X: a partir de 25 meses = 100%
";
/data/otherGuaranteedValues;otherGuaranteedValues;;Lista;20;Opcional;;"SALDAMENTO
BENEFICIO_PROLONGADO
-NAO_APLICA";0;N;"";Não permitido;array;SALDAMENTO;
+NAO_APLICA
+NA";0;N;"";Não permitido;array;SALDAMENTO;
/data/allowPortability;allowPortability;"1. true
2. false
";Booleano;;Opcional;;;0;1;"";Não permitido;boolean;;
/data/portabilityGraceTime;portabilityGraceTime;;Objeto;;Opcional;;;0;1;"";Não permitido;object;;
/data/portabilityGraceTime/amount;amount;Informar o prazo de carência;Inteiro;;Obrigatório;;;1;1;"";Não permitido;integer;90;
-/data/portabilityGraceTime/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
";Texto;10;Obrigatório;;"DIAS
+/data/portabilityGraceTime/unit;unit;"Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
- NA
";Texto;10;Obrigatório;;"DIAS
MESES
-NAO_APLICA";1;1;"";Não permitido;string;MESES;
+NAO_APLICA
+NA";1;1;"";Não permitido;string;MESES;
/data/indemnityPaymentMethods;indemnityPaymentMethods;;Lista;18;Obrigatório;;"UNICO
SOB_FORMA_RENDA
NA";1;N;"";Não permitido;array;UNICO;
diff --git a/swagger-apis/insurances/1.0.0-rc3.0.yml b/swagger-apis/insurances/1.0.0-rc3.0.yml
index 7e189a94a..c56ad112e 100644
--- a/swagger-apis/insurances/1.0.0-rc3.0.yml
+++ b/swagger-apis/insurances/1.0.0-rc3.0.yml
@@ -185,12 +185,13 @@ components:
example: FUNERAL
EnumGracePeriodUnit:
type: string
- description: Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
+ description: Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
- NA
maxLength: 10
enum:
- DIAS
- MESES
- NAO_APLICA
+ - NA
example: MESES
InsurancePensionEnumPmbacRemuneration:
type: object
@@ -223,6 +224,7 @@ components:
2. A cada período em anos
3. Por mudança de faixa etária
4. Não aplicável
+ 5. NA
maxLength: 27
example: APOS_PERIODO_ANOS
enum:
@@ -230,6 +232,7 @@ components:
- CADA_PERIODO_ANOS
- MUDANCA_FAIXA_ETARIA
- NAO_APLICAVEL
+ - NA
frequency:
type: integer
description: 'Período em anos, caso critério de reenquadramento após ou a cada período em anos.'
@@ -438,6 +441,7 @@ components:
- SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
- OUTROS
- NAO_HA
+ - NA
example: SORTEIO
termsAndConditions:
type: array
@@ -679,11 +683,13 @@ components:
1. Saldamento
2. Benefício Prolongado
3. Não se aplica
+ 4. NA
maxLength: 20
enum:
- SALDAMENTO
- BENEFICIO_PROLONGADO
- NAO_APLICA
+ - NA
example: SALDAMENTO
EnumPersonalInsuranceIndemnityPaymentMethod:
type: string
From 6254e6479f8c891a0a04c854963f41a8a2d9aa0c Mon Sep 17 00:00:00 2001
From: FelipeBaumgartel
Date: Mon, 22 May 2023 14:20:48 -0300
Subject: [PATCH 46/50] fix(Capitalization Bonds): ORB-2642 - PC81 - String -
Ajuste
---
dictionary/capitalizationBondsGetProducts_v1.csv | 2 +-
swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/dictionary/capitalizationBondsGetProducts_v1.csv b/dictionary/capitalizationBondsGetProducts_v1.csv
index 09feba701..3c63637dd 100644
--- a/dictionary/capitalizationBondsGetProducts_v1.csv
+++ b/dictionary/capitalizationBondsGetProducts_v1.csv
@@ -43,7 +43,7 @@ PAGAMENTO_MENSAL
PAGAMENTO_PERIODICO
NA";1;1;"";Não permitido;string;PAGAMENTO_UNICO;15
/data/termsAndConditions;termsAndConditions;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
-/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;12
+/data/termsAndConditions/susepProcessNumber;susepProcessNumber;"Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.";Texto;20;Obrigatório;^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$;;1;1;"";Não permitido;string;15414.622222/2222-22;2
/data/termsAndConditions/detail;detail;Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL);Texto;1024;Obrigatório;;;1;1;"";Não permitido;string;https://openinsurance.com.br/aaa;
/data/quotas;quotas;Informações relativas às taxas da Quotas praticadas para cada Parcela;Lista;;Obrigatório;;;1;N;"";Não permitido;array;;
/data/quotas/quota;quota;Número da parcela.;Número;3;Obrigatório;;;1;1;"";Não permitido;number;10;
diff --git a/swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml b/swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml
index 46b530680..904bd5631 100644
--- a/swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml
+++ b/swagger-apis/capitalization-bonds/1.0.0-rc3.0.yml
@@ -258,7 +258,7 @@ components:
susepProcessNumber:
type: string
description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
- minLength: 12
+ minLength: 2
maxLength: 20
pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$'
example: 15414.622222/2222-22
From e3c59f0e1cfea9e4f22beb07b053faf320e8e26f Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Tue, 23 May 2023 13:56:20 -0300
Subject: [PATCH 47/50] =?UTF-8?q?fix=20-=20Nova=20vers=C3=A3o=20Capitaliza?=
=?UTF-8?q?=C3=A7=C3=A3o=20-=201.0.0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
swagger-apis/capitalization-bonds/1.0.0.yml | 823 +++++++++++++++++++
swagger-apis/capitalization-bonds/index.html | 5 +-
2 files changed, 826 insertions(+), 2 deletions(-)
create mode 100644 swagger-apis/capitalization-bonds/1.0.0.yml
diff --git a/swagger-apis/capitalization-bonds/1.0.0.yml b/swagger-apis/capitalization-bonds/1.0.0.yml
new file mode 100644
index 000000000..904bd5631
--- /dev/null
+++ b/swagger-apis/capitalization-bonds/1.0.0.yml
@@ -0,0 +1,823 @@
+openapi: 3.0.0
+info:
+ title: API Capitalization-bonds - Open Finance Brasil
+ description: |
+ As APIs descritas neste documento é referente a API de Capitalização da fase OpenInsurance do Open Finance Brasil.
+ version: 1.0.0-rc3.0
+ license:
+ name: Apache 2.0
+ url: 'https://www.apache.org/licenses/LICENSE-2.0'
+ contact:
+ name: Governança do Open Finance Brasil – Especificações
+ email: gt-interfaces@openbankingbr.org
+ url: 'https://openbanking-brasil.github.io/areadesenvolvedor/'
+servers:
+ - url: 'https://api.banco.com.br/open-banking/opendata-capitalization/v1'
+ description: Servidor de Produção
+ - url: 'https://apih.banco.com.br/open-banking/opendata-capitalization/v1'
+ description: Servidor de Homologação
+tags:
+ - name: Capitalization Bonds
+ description: Operações para consulta das informações de Titulos de Capitalização
+paths:
+ /bonds:
+ get:
+ tags:
+ - Capitalization Bonds
+ summary: Conjunto de informações dos Títulos de Capitalização de uma instituição
+ operationId: capitalizationBondsGetProducts
+ description: Método para obter a lista de todos os títulos de Capitalização de uma instituição
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/pageSize'
+ responses:
+ '200':
+ $ref: '#/components/responses/OKResponseCapitalizationBondsProductsList'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '405':
+ $ref: '#/components/responses/MethodNotAllowed'
+ '429':
+ $ref: '#/components/responses/TooManyRequests'
+ '500':
+ $ref: '#/components/responses/InternalServerError'
+ '529':
+ $ref: '#/components/responses/SiteIsOverloaded'
+components:
+ schemas:
+ CapitalizationBondsProductIdentificationData:
+ type: object
+ required:
+ - participant
+ - society
+ - name
+ - code
+ - modality
+ - costType
+ - termsAndConditions
+ - quotas
+ - capitalizationPeriod
+ - latePayment
+ - contributionPayment
+ - finalRedemptionRate
+ - redemptionPercentageEndTerm
+ - draws
+ - additionalInfo
+ - targetAudience
+ properties:
+ participant:
+ $ref: '#/components/schemas/Participant'
+ society:
+ type: object
+ description: Conjunto de informações relativas à seguradora do produto de open insurance
+ required:
+ - name
+ - cnpjNumber
+ properties:
+ name:
+ type: string
+ description: Nome da Sociedade Seguradora.
+ maxLength: 80
+ example: Society A1
+ cnpjNumber:
+ $ref: '#/components/schemas/Participant/properties/cnpjNumber'
+ additionalProperties: false
+ name:
+ type: string
+ description: 'Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.'
+ maxLength: 80
+ example: ACMEcap
+ code:
+ type: string
+ description: Código único a ser definido pela sociedade.
+ maxLength: 100
+ example: 01234589_cap
+ modality:
+ $ref: '#/components/schemas/EnumCapitalizationBondsProductModality'
+ costType:
+ $ref: '#/components/schemas/EnumCapitalizationBondsProductCostType'
+ termsAndConditions:
+ $ref: '#/components/schemas/TermsAndConditions'
+ quotas:
+ type: array
+ description: Informações relativas às taxas da Quotas praticadas para cada Parcela
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/CapitalizationBondsProductQuota'
+ validity:
+ type: integer
+ format: int32
+ description: Período entre a data de início e a data final para constituição do capital a ser pago ao(s) titular(es) do direito de resgate. Prazo de vigência do título de capitalização em meses (Resolução CNSP 384/20). Em meses.
+ maxLength: 3
+ example: 48
+ serieSize:
+ type: integer
+ description: 'Os títulos de capitalização que prevejam sorteio devem ser estruturados em séries, ou seja, em sequências ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.'
+ maxLength: 10
+ example: 5000000
+ capitalizationPeriod:
+ $ref: '#/components/schemas/CapitalizationBondsProductCapitalizationPeriod'
+ latePayment:
+ $ref: '#/components/schemas/LatePayment'
+ contributionPayment:
+ $ref: '#/components/schemas/ContributionPayment'
+ redemptionPercentageEndTerm:
+ type: string
+ description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
+ maxLength: 9
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ example: '0.019800'
+ finalRedemptionRate:
+ type: string
+ description: Valor percentual (%) de resgate final permitido.
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ maxLength: 9
+ minLength: 8
+ example: '0.019800'
+ draws:
+ type: array
+ description: Informações relativas aos Sorteios
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/CapitalizationBondsProductPrizeDraw'
+ additionalInfo:
+ type: string
+ description: 'Campo aberto (possibilidade de incluir URL) Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024). tamanho p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.'
+ maxLength: 1024
+ example: 'https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais'
+ minimumRequirementDetails:
+ type: string
+ description: |
+ Campo aberto (possibilidade de incluir URL).
+ Observação: As URLs são limitadas a 2048 caracteres mas, para o contexto do Open Insurance , foi adotado a metade deste tamanho (1024).
+ tamanho. p.ex. ‘https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.’
+ maxLength: 1024
+ example: 'https://ACME.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais'
+ targetAudience:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. Ambas (Pessoa Natural e Jurídica)
+ 4. NA
+ maxLength: 23
+ enum:
+ - PESSOA_NATURAL
+ - PESSOA_JURIDICA
+ - PESSOA_NATURAL_JURIDICA
+ - NA
+ example: PESSOA_NATURAL
+ additionalProperties: false
+ Participant:
+ type: object
+ description: Conjunto de informações relativas ao participante do produto de Open Finance
+ required:
+ - brand
+ - name
+ - cnpjNumber
+ properties:
+ brand:
+ type: string
+ description: 'Nome da marca reportada pelo participante do Open Finance. 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.'
+ maxLength: 80
+ example: Organização
+ name:
+ type: string
+ description: Nome do participante do Open Finance.
+ maxLength: 80
+ example: Organização A1
+ cnpjNumber:
+ type: string
+ description: '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.'
+ pattern: '^(\d{14})$|^(NA)$'
+ example: '13456789000112'
+ urlComplementaryList:
+ type: string
+ description: |
+ Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
+
+ - ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
+
+ - 'cnpjNumber' com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
+
+ - Ambos do tipo string;
+
+ - Ambos obrigatórios.
+ maxLength: 1024
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)|(NA)$'
+ example: 'https://empresaa1.com/companies'
+ additionalProperties: false
+ EnumCapitalizationBondsProductModality:
+ type: string
+ description: |
+ 1. Tradicional: A modalidade tradicional tem por objetivo restituir ao titular, ao final do prazo de vigência, no mínimo, o valor total das contribuições efetuadas pelo subscritor, desde que todas as contribuições previstas tenham sido realizadas nas datas programadas. (Res CNSP 384/20)
+ 2. Instrumento de Garantia: A modalidade tem por objetivo propiciar que a provisão matemática para capitalização do título de capitalização seja utilizada para assegurar o cumprimento de obrigação assumida em contrato principal pelo titular perante terceiro. (Res CNSP 384/20)
+ 3. Compra Programada: A modalidade compra programada garante o valor de resgate em moeda corrente nacional, sendo disponibilizada ao assim desejar e sem qualquer outro custo, pelo recebimento do bem e/ou serviço referenciado no subsidiado por acordos comerciais celebrados com indústrias, atacadistas, empresas comerciais ou prestadores de serviço. (Res CNSP 384/20)
+ 4. Popular: A modalidade popular tem por objetivo propiciar a capitalização da contribuição e a participação do titular em sorteios, sem que haja devolução integral do valor pago. (Res CNSP 384/20)
+ 5. Incentivo: A modalidade incentivo tem por objetivo a vinculação a um evento promocional de caráter comercial instituído pelo subscritor para alavancar a venda de seu(s) produto(s) ou serviços ou para fidelizar seus clientes. (Res CNSP 384/20)
+ 6. Filantropia Premiável: A modalidade filantropia premiável é destinada ao subscritor interessado em contribuir com entidades beneficentes de assistências sociais, certificadas nos termos da legislação vigente, e participar de sorteio(s). (Res CNSP 384/20)
+ 7. NA
+ minLength: 7
+ maxLength: 24
+ enum:
+ - TRADICIONAL
+ - INSTRUMENTO_GARANTIA
+ - COMPRA_PROGRAMADA
+ - POPULAR
+ - INCENTIVO
+ - FILANTROPIA_PREMIAVEL
+ - NA
+ example: TRADICIONAL
+ EnumCapitalizationBondsProductCostType:
+ type: string
+ description: |
+ Pagamento efetuado ao subscritor à sociedade de capitalização para aquisição do título de capitalização, podendo ser única, periódica ou mensal.
+ 1. Pagamento Único
+ 2. Pagamento Mensal
+ 3. Pagamento Periódico
+ 4. NA
+ minLength: 15
+ maxLength: 19
+ enum:
+ - PAGAMENTO_UNICO
+ - PAGAMENTO_MENSAL
+ - PAGAMENTO_PERIODICO
+ - NA
+ example: PAGAMENTO_UNICO
+ TermsAndConditions:
+ type: object
+ required:
+ - susepProcessNumber
+ - detail
+ properties:
+ susepProcessNumber:
+ type: string
+ description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
+ minLength: 2
+ maxLength: 20
+ pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$'
+ example: 15414.622222/2222-22
+ detail:
+ type: string
+ description: 'Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL)'
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ CapitalizationBondsProductQuota:
+ type: object
+ required:
+ - quota
+ - capitalizationQuota
+ - raffleQuota
+ - chargingQuota
+ properties:
+ quota:
+ type: number
+ format: integer
+ description: Número da parcela.
+ maxLength: 3
+ example: 10
+ capitalizationQuota:
+ type: string
+ description: Percentual da contribuição destinado à constituição de capital referente ao direito de resgate. (Resolução CNSP 384/20) Em porcentagem(%).
+ maxLength: 9
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ example: '0.019800'
+ raffleQuota:
+ type: string
+ description: 'Percentual da contribuição destinado a custear os sorteios, se previstos no plano. (Resolução CNSP 384/20) Em porcentagem(%).'
+ maxLength: 9
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ example: '0.019800'
+ chargingQuota:
+ type: string
+ description: 'Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relativas ao custeio da contemplação obrigatória e da distribuição de bônus. (Resolução CNSP 384/20) Em porcentagem(%).'
+ maxLength: 9
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ example: '0.019800'
+ additionalProperties: false
+ CapitalizationBondsProductCapitalizationPeriod:
+ type: object
+ required:
+ - interestRate
+ - updateIndex
+ - contributionAmount
+ - earlyRedemptions
+ - redemptionPercentageEndTerm
+ - gracePeriodRedemption
+ properties:
+ interestRate:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ description: 'Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m.).'
+ maxLength: 9
+ minLength: 8
+ example: '0.019800'
+ updateIndex:
+ $ref: '#/components/schemas/CapitalizationBondsProductUpdateIndex'
+ updateIndexAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ contributionAmount:
+ type: array
+ items:
+ $ref: '#/components/schemas/CapitalizationPeriodContributionAmount'
+ minItems: 1
+ earlyRedemptions:
+ minItems: 1
+ type: array
+ items:
+ type: object
+ required:
+ - quota
+ - rate
+ properties:
+ quota:
+ type: number
+ format: integer
+ description: Parcela relativa ao Resgate Antecipado
+ maxLength: 3
+ example: 10
+ rate:
+ type: string
+ description: Taxa relativa ao Resgate Antecipado
+ maxLength: 9
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ example: '0.019800'
+ additionalProperties: false
+ redemptionPercentageEndTerm:
+ type: string
+ description: 'Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.'
+ maxLength: 9
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ example: '0.019800'
+ gracePeriodRedemption:
+ type: number
+ format: integer
+ description: 'Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.'
+ maxLength: 3
+ example: 48
+ additionalProperties: false
+ CapitalizationBondsProductUpdateIndex:
+ type: string
+ maxLength: 37
+ enum:
+ - IPCA
+ - IGPM
+ - INPC
+ - TR
+ - INDICE_REMUNERACAO_DEPOSITOS_POUPANCA
+ - OUTROS
+ - NA
+ example: IPCA
+ description: |
+ Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência) (não aplicável a pagamento único).
+ CapitalizationPeriodContributionAmount:
+ type: object
+ description: |
+ Corresponde ao pagamento efetuado pelo subscritor à sociedade de capitalização para a aquisição do título de capitalização, podendo ser única, periódica ou mensal (Resolução CNSP 384/20). Valores em reais (R$). Esclarecimentos adicionais SUSEP.
+ Na modalidade Tradicional, informar a faixa de valor mínimo e máximo em R$ de contribuição ao plano.
+ Para as demais modalidades, informar a lista com os valores permitidos de contribuição ao plano.
+ Em todas as situações indicar para qual periodicidade de pagamento se aplicam os valores: pagamento mensal, pagamento único ou periódico.
+ required:
+ - periodicity
+ - minimum
+ - maximum
+ - allowedValue
+ properties:
+ periodicity:
+ type: string
+ description: |
+ Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
+ 1. Único
+ 2. Diário
+ 3. Semanal
+ 4. Quinzenal
+ 5. Mensal
+ 6. Bimestral
+ 7. Trimestral
+ 8. Quadrimestral
+ 9. Semestral
+ 10. Anual
+ 11. Outros
+ 12. NA
+ maxLength: 13
+ enum:
+ - UNICO
+ - DIARIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - QUADRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - OUTROS
+ - NA
+ example: UNICO
+ periodicityAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ minimum:
+ type: string
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ description: |
+ Condicional: Quando modalidade for igual 'TRADICIONAL'
+ Valor mínimo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
+ maxLength: 21
+ example: '1.2222'
+ maximum:
+ type: string
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ description: |
+ Condicional: Quando modalidade for igual 'TRADICIONAL'
+ Valor máximo correspondente ao pagamento efetuado pelo subscritor à sociedade de capitalização.
+ maxLength: 21
+ example: '1.2222'
+ allowedValue:
+ type: number
+ format: double
+ description: |
+ Condicional: Quando modalidade for diferente de 'TRADICIONAL'
+ Lista com os valores permitidos de contribuição ao plano.
+ example: 5000
+ additionalProperties: false
+ LatePayment:
+ type: object
+ required:
+ - suspensionMonths
+ properties:
+ suspensionMonths:
+ type: number
+ description: 'Conforme manual SUSEP: Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).'
+ maxLength: 3
+ example: 10
+ periodExtensionOption:
+ type: boolean
+ description: |
+ Alteração do prazo de vigência original, pela suspensão (não aplicável a pagamento único). A considerar os seguintes domínios:
+ 1. true
+ 2. false
+ example: true
+ additionalProperties: false
+ ContributionPayment:
+ type: object
+ required:
+ - paymentMethod
+ - updateIndex
+ properties:
+ paymentMethod:
+ $ref: '#/components/schemas/CapitalizationBondsProductPaymentMethod'
+ paymentMethodAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ updateIndex:
+ $ref: '#/components/schemas/CapitalizationBondsProductUpdateIndex'
+ updateIndexAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: ''
+ additionalProperties: false
+ CapitalizationBondsProductPaymentMethod:
+ type: string
+ maxLength: 27
+ enum:
+ - CARTAO_CREDITO
+ - CARTAO_DEBITO
+ - DEBITO_CONTA_CORRENTE
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PAGAMENTO_PONTOS
+ - OUTROS
+ - NA
+ example: CARTAO_CREDITO
+ description: |
+ Meio de Pagamento utilizado para pagamento da contribuição. A considerar os domínios abaixo:
+ 1. Cartão de Crédito
+ 2. Cartão de Débito
+ 3. Débito em conta corrente
+ 4. Débito em conta poupança
+ 5. Boleto bancário
+ 6. PIX
+ 7. Consignação em Folha de Pagamento
+ 8. Pontos de Programas de Benefício
+ 9. Outros
+ 10. NA
+ CapitalizationBondsProductPrizeDraw:
+ type: object
+ required:
+ - timeInterval
+ - quantity
+ - prizeMultiplier
+ - minimumContemplationProbability
+ properties:
+ timeInterval:
+ type: string
+ description: |
+ Intervalo de tempo regular previsto entre os sorteios. Conforme os domínios:
+ - UNICO
+ - DIÁRIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - QUADRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - OUTROS
+ - NA
+ maxLength: 13
+ enum:
+ - UNICO
+ - DIÁRIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - QUADRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - OUTROS
+ - NA
+ example: UNICO
+ timeIntervalAdditionalInfo:
+ type: string
+ description: 'Restrição: Campo obrigatório para complementar a informação quando selecionada a opção ''OUTROS'''
+ maxLength: 200
+ example: '5'
+ quantity:
+ type: number
+ format: integer
+ description: Número da quantidade de sorteios previstos ao longo da vigência.
+ maxLength: 5
+ example: 10000
+ prizeMultiplier:
+ type: number
+ format: integer
+ description: 'Valor dos sorteios representado por múltiplo do valor de contribuição. Por exemplo: 5 vezes valor da contribuição'
+ maxLength: 6
+ example: 5
+ earlySettlementRaffle:
+ description: |
+ Modelo de sorteio que acarreta, ao título contemplado, o seu resgate total obrigatório (Resolução Normativa 384/20). Conforme os domínios:
+ 1. true
+ 2. false
+ type: boolean
+ example: true
+ mandatoryContemplation:
+ type: boolean
+ description: |
+ Possibilidade de realização de sorteio com previsão de que o título sorteado seja obrigatoriamente um título comercializado,
+ desde que atingidos os requisitos definidos nas condições gerais do plano. Conforme os domínios:
+ 1. true
+ 2. false
+ example: true
+ ruleDescription:
+ type: string
+ description: 'Campo aberto para complementar a regra dos sorteios do produto, a ser feita para cada participante.'
+ maxLength: 200
+ example: Sorteios próprios às terças-feiras Toda quarta-feira sorteios através da loteria federal.
+ minimumContemplationProbability:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ description: 'Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).'
+ maxLength: 9
+ minLength: 8
+ example: '0.019800'
+ additionalProperties: false
+ Links:
+ type: object
+ description: Referências para outros recusos da API requisitada.
+ required:
+ - self
+ properties:
+ self:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI completo que gerou a resposta atual.
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ first:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ prev:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: "URI da página anterior dessa lista de resultados. Restrição - \tObrigatório quando não for a primeira página da resposta"
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ next:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ last:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ additionalProperties: false
+ OpenDataMeta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - totalRecords
+ - totalPages
+ properties:
+ totalRecords:
+ type: integer
+ format: int32
+ description: Número total de registros no resultado
+ example: 1
+ totalPages:
+ type: integer
+ format: int32
+ description: Número total de páginas no resultado
+ example: 1
+ additionalProperties: false
+ parameters:
+ 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
+ maximum: 2147483647
+ 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
+ responses:
+ OKResponseCapitalizationBondsProductsList:
+ description: Dados de título(s) de capitalização obtidos com sucesso.
+ content:
+ application/json:
+ schema:
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ properties:
+ data:
+ type: array
+ description: Conjunto de informações do Título de Capitalização
+ items:
+ $ref: '#/components/schemas/CapitalizationBondsProductIdentificationData'
+ minItems: 1
+ links:
+ $ref: '#/components/schemas/Links'
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ 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/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ InternalServerError:
+ description: Ocorreu um erro no gateway da API ou no microsserviço
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ MethodNotAllowed:
+ description: O consumidor tentou acessar o recurso com um método não suportado
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ NotFound:
+ description: O recurso solicitado não existe ou não foi implementado
+ content:
+ application/json; charset=utf-8:
+ schema:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ additionalProperties: false
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ TooManyRequests:
+ description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite de requisições concorrentes foi atingido.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/responses/NotFound/content/application~1json%3B%20charset%3Dutf-8/schema'
+ SiteIsOverloaded:
+ description: 'O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ meta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - requestDateTime
+ properties:
+ requestDateTime:
+ description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.'
+ type: string
+ maxLength: 20
+ format: date-time
+ example: '2021-05-21T08:30:00Z'
diff --git a/swagger-apis/capitalization-bonds/index.html b/swagger-apis/capitalization-bonds/index.html
index 007952ef1..e5a2fecea 100644
--- a/swagger-apis/capitalization-bonds/index.html
+++ b/swagger-apis/capitalization-bonds/index.html
@@ -47,8 +47,9 @@
const ui = SwaggerUIBundle({
urls: [ {"name": "1.0.0-rc1.0", "url": "./1.0.0-rc1.0.yml"},
{"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"},
- {"name": "1.0.0-rc3.0", "url": "./1.0.0-rc3.0.yml"}],
- "urls.primaryName": "1.0.0-rc3.0", // default spec
+ {"name": "1.0.0-rc3.0", "url": "./1.0.0-rc3.0.yml"},
+ {"name": "1.0.0", "url": "./1.0.0.yml"}],
+ "urls.primaryName": "1.0.0", // default spec
dom_id: '#swagger-ui',
deepLinking: true,
supportedSubmitMethods:[],
From 9836a9d0942451b6e2a3326de423f3f07d6a28e0 Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Tue, 23 May 2023 13:59:08 -0300
Subject: [PATCH 48/50] =?UTF-8?q?fix=20-=20Nova=20vers=C3=A3o=20insurances?=
=?UTF-8?q?=20-=201.0.0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
swagger-apis/insurances/1.0.0.yml | 1211 ++++++++++++++++++++++++++++
swagger-apis/insurances/index.html | 5 +-
2 files changed, 1214 insertions(+), 2 deletions(-)
create mode 100644 swagger-apis/insurances/1.0.0.yml
diff --git a/swagger-apis/insurances/1.0.0.yml b/swagger-apis/insurances/1.0.0.yml
new file mode 100644
index 000000000..f459dcf89
--- /dev/null
+++ b/swagger-apis/insurances/1.0.0.yml
@@ -0,0 +1,1211 @@
+openapi: 3.0.0
+info:
+ title: API Seguros - Open Finance Brasil
+ description: |
+ As APIs descritas neste documento são referentes a API de Seguros da fase OpenInsurance do Open Finance Brasil.
+ version: 1.0.0
+ license:
+ name: Apache 2.0
+ url: 'https://www.apache.org/licenses/LICENSE-2.0'
+ contact:
+ name: Governança do Open Finance Brasil – Especificações
+ email: gt-interfaces@openbankingbr.org
+ url: 'https://openbanking-brasil.github.io/areadesenvolvedor/'
+servers:
+ - url: 'https://api.banco.com.br/open-banking/opendata-insurance/v1'
+ description: Servidor de Produção
+ - url: 'https://apih.banco.com.br/open-banking/opendata-insurance/v1'
+ description: Servidor de Homologação
+tags:
+ - name: Seguros
+ description: 'Operações para consulta de informações de seguros automotivos, residenciais e pessoais'
+paths:
+ /personals:
+ get:
+ tags:
+ - Seguros
+ summary: Conjunto de informações referentes a seguros pessoais de uma instituição
+ operationId: getPersonalInsurance
+ description: Método para obter a lista de todos os seguros pessoais de uma instituição
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/pageSize'
+ responses:
+ '200':
+ $ref: '#/components/responses/OKResponsePersonalInsuranceList'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '405':
+ $ref: '#/components/responses/MethodNotAllowed'
+ '429':
+ $ref: '#/components/responses/TooManyRequests'
+ '500':
+ $ref: '#/components/responses/InternalServerError'
+ '529':
+ $ref: '#/components/responses/SiteIsOverloaded'
+components:
+ schemas:
+ Participant:
+ type: object
+ description: Conjunto de informações relativas ao participante do produto de Open Finance
+ required:
+ - brand
+ - name
+ - cnpjNumber
+ properties:
+ brand:
+ type: string
+ description: 'Nome da marca reportada pelo participante do Open Finance. 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.'
+ maxLength: 80
+ example: Organização
+ name:
+ type: string
+ description: Nome do participante do Open Finance.
+ maxLength: 80
+ example: Organização A1
+ cnpjNumber:
+ $ref: '#/components/schemas/CnpjNumber'
+ urlComplementaryList:
+ type: string
+ description: |
+ Espera-se que valor de retorno, após acesso ao link 'urlComplementaryList', deve ser array de objeto com a estrutura abaixo:
+ - 'name' com o valor contido no campo 'LegalEntityName' conforme cadastro no diretório;
+ - 'cnpjNumber' com o valor contido no campo CNPJ ('RegistrationNumber') correspondente a esta instituição;
+ - Ambos do tipo string;
+ - Ambos obrigatórios.
+ maxLength: 1024
+ pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))$|^(NA)$'
+ example: 'https://empresaa1.com/companies'
+ additionalProperties: false
+ CnpjNumber:
+ type: string
+ description: '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.'
+ pattern: '^(\d{14})$|^(NA)$'
+ example: '13456789000112'
+ CurrencyCode:
+ type: string
+ pattern: '^([A-Z]{3})$|^(NA)$'
+ maxLength: 3
+ description: 'Moeda referente ao valor monetário, seguindo o modelo ISO-4217.'
+ example: BRL
+ InsurancePensionMinValue:
+ type: object
+ required:
+ - amount
+ - currency
+ description: 'Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.'
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ InsurancePensionMaxValue:
+ type: object
+ required:
+ - amount
+ - currency
+ description: 'Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.'
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ GracePeriod:
+ type: object
+ required:
+ - amount
+ - unit
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: Informar o prazo de carência
+ example: 90
+ maximum: 9999999999
+ unit:
+ $ref: '#/components/schemas/EnumGracePeriodUnit'
+ details:
+ type: string
+ maxLength: 500
+ pattern: '[\w\W\s]*'
+ example: Descrições adicionais do período de carência
+ additionalProperties: false
+ TermsAndConditionsItem:
+ type: object
+ required:
+ - susepProcessNumber
+ - detail
+ properties:
+ susepProcessNumber:
+ type: string
+ description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
+ minLength: 2
+ maxLength: 20
+ pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$'
+ example: 15414.622222/2222-22
+ detail:
+ type: string
+ description: 'Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL)'
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ EnumProductModality:
+ type: string
+ description: - Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
- NA
+ maxLength: 33
+ enum:
+ - FUNERAL
+ - PRESTAMISTA
+ - VIAGEM
+ - EDUCACIONAL
+ - DOTAL
+ - ACIDENTES_PESSOAIS
+ - VIDA
+ - PERDA_CERTIFICADO_HABILITACAO_VOO
+ - DOENCAS_GRAVES_DOENCA_TERMINAL
+ - DESEMPREGO_PERDA_RENDA
+ - EVENTOS_ALEATORIOS
+ - PECULIO
+ - PENSAO_PRAZO_CERTO
+ - PENSAO_MENORES_21
+ - PENSAO_MENORES_24
+ - PENSAO_CONJUGE_VITALICIA
+ - PENSAO_CONJUGE_TEMPORARIA
+ - NA
+ example: FUNERAL
+ EnumGracePeriodUnit:
+ type: string
+ description: Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
- NA
+ maxLength: 10
+ enum:
+ - DIAS
+ - MESES
+ - NAO_APLICA
+ - NA
+ example: MESES
+ InsurancePensionEnumPmbacRemuneration:
+ type: object
+ properties:
+ interestRate:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ description: Taxa de juros para capitalização da PMBaC
+ maxLength: 9
+ minLength: 8
+ example: '0.019800'
+ updateIndexes:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumPersonalUpdateIndex'
+ additionalProperties: false
+ AgeAdjustment:
+ type: object
+ required:
+ - criterias
+ - frequency
+ properties:
+ criterias:
+ type: array
+ items:
+ type: string
+ description: |
+ Critério escolhido para reenquadramento etário
+ 1. Após período em anos
+ 2. A cada período em anos
+ 3. Por mudança de faixa etária
+ 4. Não aplicável
+ 5. NA
+ maxLength: 27
+ example: APOS_PERIODO_ANOS
+ enum:
+ - APOS_PERIODO_ANOS
+ - CADA_PERIODO_ANOS
+ - MUDANCA_FAIXA_ETARIA
+ - NAO_APLICAVEL
+ - NA
+ frequency:
+ type: integer
+ description: 'Período em anos, caso critério de reenquadramento após ou a cada período em anos.'
+ maxLength: 3
+ example: 10
+ additionalProperties: false
+ InsurancePensionEnumFinancialRegime:
+ type: string
+ description: |
+ Listagem de regime financeiro para cada combinação de modalidade/cobertura do produto indicando:
+ 1. Repartição simples
+ 2. Repartição Capitais Cobertura
+ 3. Capitalização
+ 4. NA
+ maxLength: 19
+ example: REPARTICAO_SIMPLES
+ enum:
+ - REPARTICAO_SIMPLES
+ - REPARTICAO_CAPITAIS
+ - CAPITALIZACAO
+ - NA
+ EnumInsurancePersonalBenefitRecalculationUpdateIndex:
+ type: string
+ description: |
+ Índice utilizado na atualização do prêmio/contribuição e do capital segurado/ benefício, caso critério de atualização por meio de índice
+ enum:
+ - IPCA
+ - IGP_M
+ - INPC
+ - NA
+ example: IPCA
+ EnumPersonalUpdateIndex:
+ type: string
+ description: |
+ Índice utilizado na atualização da PMBaC:
+ 1. IPCA (IBGE)
+ 2. IGP-M (FGV)
+ 3. INPC (IBGE)
+ 4. NA
+ enum:
+ - IPCA
+ - IGP_M
+ - INPC
+ - NA
+ example: IPCA
+ OpenDataMeta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - totalRecords
+ - totalPages
+ properties:
+ totalRecords:
+ type: integer
+ format: int32
+ description: Número total de registros no resultado
+ example: 1
+ totalPages:
+ type: integer
+ format: int32
+ description: Número total de páginas no resultado
+ example: 1
+ additionalProperties: false
+ OKResponsePersonalInsuranceList:
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/PersonalInsuranceData'
+ links:
+ $ref: '#/components/schemas/Links'
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ PersonalInsuranceData:
+ type: object
+ required:
+ - participant
+ - society
+ - name
+ - code
+ - modality
+ - coverages
+ - additionals
+ - termsAndConditions
+ - terms
+ - financialRegimes
+ - indemnityPaymentMethods
+ - targetAudience
+ properties:
+ participant:
+ $ref: '#/components/schemas/Participant'
+ society:
+ $ref: '#/components/schemas/PersonalInsuranceSociety'
+ name:
+ type: string
+ description: 'Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.'
+ maxLength: 80
+ example: Produto A
+ code:
+ type: string
+ description: Código único a ser definido pela sociedade.
+ maxLength: 80
+ example: '0001'
+ category:
+ type: string
+ description: Indicar a categoria do Produto:
- Tradicional
- Microsseguro
- NA
+ maxLength: 12
+ enum:
+ - TRADICIONAL
+ - MICROSSEGURO
+ - NA
+ example: TRADICIONAL
+ modality:
+ $ref: '#/components/schemas/EnumProductModality'
+ coverages:
+ type: array
+ items:
+ $ref: '#/components/schemas/PersonalCoverageItem'
+ minItems: 1
+ assistanceTypes:
+ type: array
+ items:
+ type: string
+ description: 'Lista padronizada de tipo de assistências ofertadas vinculadas ao produto. Por exemplo, Funeral, Bicicleta, Assistência PET – Tabela padrão a ser consolidada com retorno das empresas com a relação de assistências, permitindo um campo ‘Outros’ para assistências não contempladas na tabela padronizada.'
+ maxLength: 43
+ enum:
+ - ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
+ - ARQUITETO_VIRTUAL
+ - ASSESSORIA_FINANCEIRA
+ - AUTOMOVEL
+ - AUXILIO_NATALIDADE
+ - AVALIACAO_CLINICA_PREVENTIVA
+ - BOLSA_PROTEGIDA
+ - CESTA_BASICA
+ - CHECKUP_ODONTOLOGICO
+ - CLUBE_VANTAGENS_BENEFICIOS
+ - CONVALESCENCIA
+ - DECESSO
+ - DESCONTO_FARMACIAS_MEDICAMENTOS
+ - DESPESAS_FARMACEUTICAS_VIAGEM
+ - DIGITAL
+ - EDUCACIONAL
+ - EMPRESARIAL
+ - ENCANADOR
+ - ENTRETENIMENTO
+ - EQUIPAMENTOS_MEDICOS
+ - FIANCAS_DESPESAS_LEGAIS
+ - FISIOTERAPIA
+ - FUNERAL
+ - HELP_LINE
+ - HOSPEDAGEM_ACOMPANHANTE
+ - INTERRUPCAO_VIAGEM
+ - INVENTARIO
+ - MAIS_VIDA
+ - MAMAE_BEBE
+ - MEDICA_ACIDENTE_DOENCA
+ - MOTOCICLETA
+ - MULHER
+ - NUTRICIONISTA
+ - ODONTOLOGICA
+ - ORIENTACAO_FITNESS
+ - ORIENTACAO_JURIDICA
+ - ORIENTACAO_NUTRICIONAL
+ - PERSONAL_FITNESS
+ - ORIENTACAO_PSICOSSOCIAL_FAMILIAR
+ - PERDA_ROUBO_CARTAO
+ - PET
+ - PRORROGACAO_ESTADIA
+ - PROTECAO_DADOS
+ - RECOLOCACAO_PROFISSIONAL
+ - REDE_DESCONTO_NUTRICIONAL
+ - RESIDENCIAL
+ - RETORNO_MENORES_SEGURADO
+ - SAQUE_COACAO
+ - SAUDE_BEM_ESTAR
+ - SEGUNDA_OPINIAO_MEDICA
+ - SENIOR
+ - SUSTENTAVEL_DESCARTE_ECOLOGICO
+ - TELEMEDICINA
+ - VIAGEM
+ - VITIMA
+ - OUTROS
+ - NA
+ example: ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
+ assistanceTypesAdditionalInfos:
+ description: Lista a ser preenchido pelas participantes quando houver ‘Outros’ no campo ‘Tipo de Assistência’
+ type: array
+ items:
+ type: string
+ example:
+ - Assistance additional info.
+ additionals:
+ type: array
+ items:
+ type: string
+ maxLength: 44
+ enum:
+ - SORTEIO
+ - SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
+ - SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
+ - OUTROS
+ - NAO_HA
+ - NA
+ example: SORTEIO
+ termsAndConditions:
+ type: array
+ items:
+ $ref: '#/components/schemas/TermsAndConditionsItem'
+ minItems: 1
+ globalCapital:
+ type: boolean
+ description: |
+ A considerar os seguintes domínios:
+ 1. true
+ 2. false
+ example: true
+ terms:
+ type: array
+ items:
+ type: string
+ description: Define o prazo do plano contratado
- Vitalícia
- Temporária - prazo fixo
- Temporária – intermitente
- NA
+ maxLength: 23
+ enum:
+ - VITALICIA
+ - TEMPORARIA_PRAZO_FIXO
+ - TEMPORARIA_INTERMITENTE
+ - NA
+ example: VITALICIA
+ pmbacRemuneration:
+ $ref: '#/components/schemas/InsurancePensionEnumPmbacRemuneration'
+ benefitRecalculation:
+ $ref: '#/components/schemas/BenefitRecalculation'
+ ageAdjustment:
+ $ref: '#/components/schemas/AgeAdjustment'
+ financialRegimes:
+ type: array
+ items:
+ $ref: '#/components/schemas/InsurancePensionEnumFinancialRegime'
+ reclaim:
+ $ref: '#/components/schemas/PersonalInsuranceReclaim'
+ otherGuaranteedValues:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumPersonalInsuranceOtherGuaranteedValues'
+ allowPortability:
+ type: boolean
+ description: |
+ 1. true
+ 2. false
+ portabilityGraceTime:
+ $ref: '#/components/schemas/PersonalInsurancePortabilityGraceTime'
+ indemnityPaymentMethods:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumPersonalInsuranceIndemnityPaymentMethod'
+ indemnityPaymentIncomes:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumPersonalInsuranceIndemnityPaymentIncome'
+ premiumPayment:
+ $ref: '#/components/schemas/PersonalInsurancePremiumPayment'
+ minimumRequirement:
+ $ref: '#/components/schemas/PersonalInsuranceMinimumRequirement'
+ targetAudience:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. Ambas (Pessoa Natural e Jurídica)
+ 4. NA
+ maxLength: 23
+ enum:
+ - PESSOA_NATURAL
+ - PESSOA_JURIDICA
+ - PESSOA_NATURAL_JURIDICA
+ - NA
+ example: PESSOA_NATURAL
+ additionalProperties: false
+ PersonalCoverageItem:
+ type: object
+ required:
+ - type
+ properties:
+ type:
+ $ref: '#/components/schemas/EnumInsurancePersonalCoverageTypePersonal'
+ typeAdditionalInfos:
+ type: array
+ description: |
+ Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
+ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
+ items:
+ type: string
+ maxLength: 100
+ example:
+ - Detalhar os serviços
+ - benefícios
+ - outros
+ attributes:
+ $ref: '#/components/schemas/PersonalCoverageItemAttributes'
+ additionalProperties: false
+ PersonalCoverageItemAttributes:
+ type: object
+ required:
+ - indemnityPaymentMethods
+ - indemnityPaymentFrequencies
+ - minValue
+ - maxValue
+ - indemnifiablePeriods
+ - maximumQtyIndemnifiableInstallments
+ - gracePeriod
+ - deductibleDays
+ - deductible
+ - excludedRisks
+ properties:
+ indemnityPaymentMethods:
+ description: Listagem da forma de pagamento da indenização para cada combinação de modalidade/cobertura do produto.
+ type: array
+ items:
+ type: string
+ enum:
+ - PAGAMENTO_CAPITAL_SEGURADO_VALOR_MONETARIO
+ - REEMBOLSO_DESPESAS
+ - PRESTACAO_SERVICOS
+ - NA
+ maxLength: 42
+ indemnityPaymentFrequencies:
+ description: Listagem de tipos de frequência de pagamento de indenização para cada combinação de modalidade/cobertura do produto.
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumPersonalIndemnityPaymentFrequencyType'
+ minValue:
+ $ref: '#/components/schemas/InsurancePensionMinValue'
+ maxValue:
+ $ref: '#/components/schemas/InsurancePensionMaxValue'
+ indemnifiablePeriods:
+ description: Listagem de período indenizável para cada combinação de modalidade/cobertura do produto.
+ type: array
+ items:
+ type: string
+ maxLength: 50
+ example: ATE_FIM_CICLO_DETERMINADO
+ maximumQtyIndemnifiableInstallments:
+ type: integer
+ description: 'Caso o período indenizável seja relacionado a parcelas, listagem de número máximo de parcelas indenizáveis para cada combinação de modalidade/ cobertura do produto.'
+ maxLength: 10
+ example: 10
+ gracePeriod:
+ $ref: '#/components/schemas/PersonalInsuranceGracePeriod'
+ differentiatedGracePeriod:
+ type: string
+ description: 'Campo aberto para detalhamento de período de carência diferenciado, se houver.'
+ maxLength: 500
+ pattern: '[\w\W\s]*'
+ example: 90 DIAS
+ deductibleDays:
+ type: integer
+ description: Listagem de franquia em dias para cada combinação de modalidade/cobertura do produto.
+ maxLength: 10
+ example: 10
+ differentiatedDeductibleDays:
+ type: integer
+ description: 'Detalhamento da franquia em dias diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.'
+ maxLength: 10
+ example: 15
+ deductible:
+ type: object
+ required:
+ - amount
+ - currency
+ description: Listagem de franquia em reais para cada combinação de modalidade/cobertura do produto.
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ differentiatedDeductible:
+ type: object
+ required:
+ - amount
+ - currency
+ description: 'Detalhamento da franquia em reais diferentes para cada cobertura que exista alguma especificidade.
Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.'
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ excludedRisks:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumExcludedRisks'
+ excludedRisksURL:
+ type: string
+ description: Campo aberto (possibilidade de incluir URL)
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ allowApartPurchase:
+ type: boolean
+ description: |
+ Indicar se a cobertura pode ser contratada isoladamente ou não:
+ 1. true
+ 2. false
+ additionalProperties: false
+ EnumPersonalIndemnityPaymentFrequencyType:
+ type: string
+ description: ''
+ maxLength: 17
+ enum:
+ - INDENIZACAO_UNICA
+ - DIARIA_OU_PARCELA
+ - NA
+ example: INDENIZACAO_UNICA
+ EnumExcludedRisks:
+ type: string
+ description: Listagem para indicar quais serão o(s) risco(s) excluído(s) aplicável(is) à(s) cobertura(s).
+ maxLength: 40
+ enum:
+ - ATO_RECONHECIMENTO_PERIGOSO
+ - ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
+ - OPERACOES_GUERRA
+ - FURACOES_CICLONES_TERREMOTOS
+ - MATERIAL_NUCLEAR
+ - DOENCAS_LESOES_PREEXISTENTES
+ - EPIDEMIAS_PANDEMIAS
+ - SUICIDIO
+ - ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
+ - OUTROS
+ - NA
+ example: ATO_RECONHECIMENTO_PERIGOSO
+ EnumPersonalInsuranceOtherGuaranteedValues:
+ type: string
+ description: |
+ 1. Saldamento
+ 2. Benefício Prolongado
+ 3. Não se aplica
+ 4. NA
+ maxLength: 20
+ enum:
+ - SALDAMENTO
+ - BENEFICIO_PROLONGADO
+ - NAO_APLICA
+ - NA
+ example: SALDAMENTO
+ EnumPersonalInsuranceIndemnityPaymentMethod:
+ type: string
+ description: |
+ Modalidade de pagamento da indenização, a considerar os domínios abaixo:
+ 1. Único
+ 2. Sob a forma de renda
+ 3. NA
+ maxLength: 18
+ enum:
+ - UNICO
+ - SOB_FORMA_RENDA
+ - NA
+ example: UNICO
+ EnumPersonalInsuranceIndemnityPaymentIncome:
+ type: string
+ description: |
+ Tipo de renda ou pensão, caso modalidade de pagamento de indenização seja sob a forma de renda:
+ 1. Certa
+ 2. Temporária
+ 3. Temporária reversível
+ 4. Temporário com mínimo garantido
+ 5. Temporária reversível com mínimo garantido
+ 6. Vitalícia
+ 7. Vitalícia reversível
+ 8. Vitalícia com o mínimo garantido
+ 9. Vitalícia reversível como mínimo garantido
+ 10. NA
+ maxLength: 38
+ enum:
+ - CERTA
+ - TEMPORARIA
+ - TEMPORARIA_REVERSIVEL
+ - TEMPORARIO_MINIMO_GARANTIDO
+ - TEMPORARIA_REVERSIVEL_MINIMO_GARANTIDO
+ - VITALICIA
+ - VITALICIA_REVERSIVEL
+ - VITALICIA_MINIMO_GARANTIDO
+ - VITALICIA_REVERSIVEL_MINIMO_GARANTIDO
+ - NA
+ example: CERTA
+ PersonalInsurancePremiumPayment:
+ type: object
+ required:
+ - paymentMethods
+ - frequencies
+ properties:
+ paymentMethods:
+ type: array
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/EnumPremiumPaymentMethodTypePersonal'
+ frequencies:
+ type: array
+ minItems: 1
+ items:
+ $ref: '#/components/schemas/EnumPersonalInsurancePremiumPaymentFrequency'
+ contributionTax:
+ type: string
+ description: 'Distribuição de frequência relativa aos valores referentes às taxas cobradas, nos termos do Anexo III.'
+ maxLength: 500
+ additionalProperties: false
+ EnumPersonalInsurancePremiumPaymentFrequency:
+ type: string
+ description: |
+ Periodicidade de pagamento do prêmio:
+ 1. Diária
+ 2. Mensal
+ 3. Única
+ 4. Anual
+ 5. Trimestral
+ 6. Semestral
+ 7. Fracionado
+ 8. Outra
+ 9. NA
+ maxLength: 10
+ enum:
+ - DIARIA
+ - MENSAL
+ - UNICA
+ - ANUAL
+ - TRIMESTRAL
+ - SEMESTRAL
+ - FRACIONADO
+ - OUTRA
+ - NA
+ example: DIARIA
+ PersonalInsuranceMinimumRequirement:
+ type: object
+ required:
+ - contractType
+ - contractingMinRequirement
+ properties:
+ contractType:
+ $ref: '#/components/schemas/EnumContractTypePersonal'
+ contractingMinRequirement:
+ type: string
+ description: Campo aberto (possibilidade de incluir URL)
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ PersonalInsuranceGracePeriod:
+ type: object
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: Informar o prazo de carência
+ example: 90
+ maximum: 9999999999
+ unit:
+ $ref: '#/components/schemas/EnumGracePeriodUnit'
+ details:
+ type: string
+ maxLength: 500
+ pattern: '[\w\W\s]*'
+ example: Descrições adicionais do período de carência
+ additionalProperties: false
+ PersonalInsuranceReclaim:
+ type: object
+ required:
+ - gracePeriod
+ properties:
+ table:
+ type: array
+ items:
+ $ref: '#/components/schemas/PersonalInsuranceReclaimTableItem'
+ minItems: 1
+ gracePeriod:
+ $ref: '#/components/schemas/GracePeriod'
+ differenciatedPercentage:
+ description: Campo aberto (possibilidade de incluir URL)
+ example: |
+ https://openinsurance.com.br/aaa’
+ Obs.: Exceção de cobertura ou critério definido acima será descrito aqui na URL
+ Exemplo: Cobertura X: a partir de 25 meses = 100%
+ maxLength: 1024
+ additionalProperties: false
+ PersonalInsuranceReclaimTableItem:
+ type: object
+ required:
+ - initialMonthRange
+ - finalMonthRange
+ - percentage
+ properties:
+ initialMonthRange:
+ type: integer
+ maxLength: 2
+ example: 1
+ finalMonthRange:
+ type: integer
+ maxLength: 2
+ example: 12
+ percentage:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ maxLength: 9
+ minLength: 8
+ description: Percentual de faixa de resgate.
+ example: '0.019800'
+ additionalProperties: false
+ EnumInsurancePersonalCoverageTypePersonal:
+ type: string
+ description: 'É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura '
+ maxLength: 62
+ enum:
+ - ADIANTAMENTO_DOENCA_ESTAGIO_TERMINAL
+ - AUXILIO_CESTA_BASICA
+ - AUXILIO_FINANCEIRO_IMEDIATO
+ - CANCELAMENTO_VIAGEM
+ - CIRURGIA
+ - COBERTURA_HERNIA
+ - COBERTURA_LER_DORT
+ - CUIDADOS_PROLONGADOS_ACIDENTE
+ - DESEMPREGO_PERDA_RENDA
+ - DESPESAS_EXTRA_INVALIDEZ_PERMANENTE_TOTAL_PARCIAL_ACIDENTE_DEI
+ - DESPESAS_EXTRA_MORTE_DEM
+ - DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS
+ - DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS_BRASIL
+ - DESPESAS_MEDICAS_HOSPITALARES_ODONTOLOGICAS_EXTERIOR
+ - DIARIA_INCAPACIDADE_TOTAL_TEMPORARIA
+ - DIARIA_INTERNACAO_HOSPITALAR
+ - INTERNACAO_HOSPITALAR
+ - DIARIAS_INCAPACIDADE_PECUNIARIA_DIP
+ - DOENCA_CONGENITA_FILHOS_DCF
+ - FRATURA_OSSEA
+ - DOENCAS_TROPICAIS
+ - INCAPACIDADE_TOTAL_OU_TEMPORARIA
+ - INVALIDEZ_PERMANENTE_TOTAL_PARCIAL
+ - INVALIDEZ_TOTAL_ACIDENTE
+ - INVALIDEZ_PARCIAL_ACIDENTE
+ - INVALIDEZ_FUNCIONAL_PERMANENTE_DOENCA
+ - INVALIDEZ_LABORATIVA_DOENCA
+ - MORTE
+ - MORTE_ACIDENTAL
+ - MORTE_CONJUGE
+ - MORTE_FILHOS
+ - MORTE_ADIATAMENTO_DOENCA_ESTAGIO_TERMINAL
+ - PAGAMENTO_ANTECIPADO_ESPECIAL_DOENCA_PROFISSIONAL_PAED
+ - PERDA_AUTONOMIA_PESSOAL
+ - PERDA_INVOLUNTARIA_EMPREGO
+ - QUEIMADURA_GRAVE
+ - REGRESSO_ANTECIPADO_SANITARIO
+ - RENDA_INCAPACIDADE_TEMPORARIA
+ - RESCISAO_CONTRATUAL_CASO_MORTE_RCM
+ - RESCISAO_TRABALHISTA
+ - SERVICO_AUXILIO_FUNERAL
+ - SOBREVIVENCIA
+ - TRANSPLANTE_ORGAOS
+ - TRASLADO
+ - TRANSLADO_CORPO
+ - VERBA_RESCISORIA
+ - DOENCA_GRAVE
+ - TRANSLADO_MEDICO
+ - OUTROS
+ - NA
+ example: INVALIDEZ_PERMANENTE_TOTAL_PARCIAL
+ EnumPremiumPaymentMethodTypePersonal:
+ type: string
+ description: |
+ Meio de pagamento escolhido pelo segurado. A considerar os domínios abaixo:
+ 1. Cartão de Crédito
+ 2. Cartão de Débito
+ 3. Débito em conta corrente
+ 4. Débito em conta poupança
+ 5. Boleto bancário
+ 6. PIX
+ 7. Consignação em Folha de Pagamento
+ 8. Pontos de Programa de Benefício
+ 9. Regra de Parceiro
+ 10. NA
+ maxLength: 27
+ enum:
+ - CARTAO_CREDITO
+ - CARTAO_DEBITO
+ - DEBITO_CONTA_CORRENTE
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PONTOS_PROGRAMA_BENEFICIO
+ - REGRA_PARCEIRO
+ - NA
+ example: CARTAO_CREDITO
+ EnumContractTypePersonal:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+ 1. Coletivo;
+ 2. Individual
+ 3. NA
+ maxLength: 10
+ enum:
+ - COLETIVO
+ - INDIVIDUAL
+ - NA
+ example: COLETIVO
+ PersonalInsuranceSociety:
+ type: object
+ description: Conjunto de informações relativas à seguradora do produto de open insurance
+ required:
+ - name
+ - cnpjNumber
+ - brand
+ properties:
+ name:
+ type: string
+ description: Nome da Sociedade Seguradora.
+ maxLength: 80
+ example: Society A1
+ cnpjNumber:
+ $ref: '#/components/schemas/CnpjNumber'
+ brand:
+ type: string
+ description: 'Nome da marca reportada pela sociedade seguradora participante do Open Finance. 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.'
+ maxLength: 80
+ example: Marca
+ additionalProperties: false
+ PersonalInsurancePortabilityGraceTime:
+ type: object
+ required:
+ - amount
+ - unit
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: Informar o prazo de carência
+ example: 90
+ maximum: 9999999999
+ unit:
+ $ref: '#/components/schemas/EnumGracePeriodUnit'
+ additionalProperties: false
+ BenefitRecalculation:
+ type: object
+ required:
+ - criterias
+ properties:
+ criterias:
+ type: array
+ items:
+ type: string
+ enum:
+ - INDICE
+ - VINCULADO_SALDO_DEVEDOR
+ - VARIAVEL_ACORDO_CRITERIO_ESPECIFICO
+ - NA
+ updateIndexes:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumInsurancePersonalBenefitRecalculationUpdateIndex'
+ additionalProperties: false
+ Links:
+ type: object
+ description: Referências para outros recusos da API requisitada.
+ required:
+ - self
+ properties:
+ self:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI completo que gerou a resposta atual.
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ first:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ prev:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: "URI da página anterior dessa lista de resultados. Restrição - \tObrigatório quando não for a primeira página da resposta"
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ next:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ last:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ additionalProperties: false
+ Meta:
+ type: object
+ description: Meta informações referente a API requisitada.
+ required:
+ - totalRecords
+ - totalPages
+ - requestDateTime
+ properties:
+ totalRecords:
+ type: integer
+ format: int32
+ description: Número total de registros no resultado
+ example: 1
+ totalPages:
+ type: integer
+ format: int32
+ description: Número total de páginas no resultado
+ example: 1
+ requestDateTime:
+ description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.'
+ type: string
+ maxLength: 20
+ format: date-time
+ example: '2021-05-21T08:30:00Z'
+ additionalProperties: false
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ additionalProperties: false
+ meta:
+ $ref: '#/components/schemas/Meta'
+ additionalProperties: false
+ parameters:
+ 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
+ maximum: 2147483647
+ 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
+ responses:
+ OKResponsePersonalInsuranceList:
+ description: Dados de seguro(s) pessoais obtidos com sucesso.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OKResponsePersonalInsuranceList'
+ 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'
+ 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'
+ 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 de requisições concorrentes foi atingido.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/schemas/ResponseError'
+ SiteIsOverloaded:
+ description: 'O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ meta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - requestDateTime
+ properties:
+ requestDateTime:
+ description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.'
+ type: string
+ maxLength: 20
+ format: date-time
+ example: '2021-05-21T08:30:00Z'
diff --git a/swagger-apis/insurances/index.html b/swagger-apis/insurances/index.html
index 36e9ddfed..f9b97cb8e 100644
--- a/swagger-apis/insurances/index.html
+++ b/swagger-apis/insurances/index.html
@@ -47,8 +47,9 @@
const ui = SwaggerUIBundle({
urls: [ {"name": "1.0.0-rc1.0", "url": "./1.0.0-rc1.0.yml"},
{"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"},
- {"name": "1.0.0-rc3.0", "url": "./1.0.0-rc3.0.yml"}],
- "urls.primaryName": "1.0.0-rc3.0", // default spec
+ {"name": "1.0.0-rc3.0", "url": "./1.0.0-rc3.0.yml"},
+ {"name": "1.0.0", "url": "./1.0.0.yml"}],
+ "urls.primaryName": "1.0.0", // default spec
dom_id: '#swagger-ui',
deepLinking: true,
supportedSubmitMethods:[],
From 78e014258d13a3b4ccb4a1d9c246e29a8b128eff Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Tue, 23 May 2023 14:00:01 -0300
Subject: [PATCH 49/50] =?UTF-8?q?fix=20-=20Nova=20vers=C3=A3o=20Captalizat?=
=?UTF-8?q?ion=20-=201.0.0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
swagger-apis/capitalization-bonds/1.0.0.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/swagger-apis/capitalization-bonds/1.0.0.yml b/swagger-apis/capitalization-bonds/1.0.0.yml
index 904bd5631..7a5dbf6a6 100644
--- a/swagger-apis/capitalization-bonds/1.0.0.yml
+++ b/swagger-apis/capitalization-bonds/1.0.0.yml
@@ -3,7 +3,7 @@ info:
title: API Capitalization-bonds - Open Finance Brasil
description: |
As APIs descritas neste documento é referente a API de Capitalização da fase OpenInsurance do Open Finance Brasil.
- version: 1.0.0-rc3.0
+ version: 1.0.0
license:
name: Apache 2.0
url: 'https://www.apache.org/licenses/LICENSE-2.0'
From f69fc27ea30dfedda406a41fe5c84c8f18bc008b Mon Sep 17 00:00:00 2001
From: Andre Ferreira Trindade
Date: Tue, 23 May 2023 14:01:24 -0300
Subject: [PATCH 50/50] =?UTF-8?q?Fix=20-=20Nova=20vers=C3=A3o=20-=20Pensio?=
=?UTF-8?q?n=20-=201.0.0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
swagger-apis/pension/1.0.0.yml | 1567 +++++++++++++++++++++++++++++++
swagger-apis/pension/index.html | 5 +-
2 files changed, 1570 insertions(+), 2 deletions(-)
create mode 100644 swagger-apis/pension/1.0.0.yml
diff --git a/swagger-apis/pension/1.0.0.yml b/swagger-apis/pension/1.0.0.yml
new file mode 100644
index 000000000..11cd05ce9
--- /dev/null
+++ b/swagger-apis/pension/1.0.0.yml
@@ -0,0 +1,1567 @@
+openapi: 3.0.0
+info:
+ title: API Pension - Open Finance Brasil
+ description: |
+ API de Previdência do Open Finance Brasil – Fase 4.
+ API que retorna informações de Previdência.
+ version: 1.0.0
+ license:
+ name: Apache 2.0
+ url: 'https://www.apache.org/licenses/LICENSE-2.0'
+ contact:
+ name: Governança do Open Finance Brasil – Especificações
+ email: gt-interfaces@openbankingbr.org
+ url: 'https://openbanking-brasil.github.io/areadesenvolvedor/'
+servers:
+ - url: 'https://api.banco.com.br/open-banking/opendata-pension/v1'
+ description: Servidor de Produção
+ - url: 'https://apih.banco.com.br/open-banking/opendata-pension/v1'
+ description: Servidor de Homologação
+tags:
+ - name: Risk Coverages
+ description: Operações relacionadas à Previdência com Coberturas de Risco.
+ - name: Survival Coverages
+ description: Operações relacionadas à Previdência com Coberturas de Sobrevivência.
+paths:
+ /risk-coverages:
+ get:
+ tags:
+ - Risk Coverages
+ summary: Informações de Previdência com Cobertura de Riscos.
+ operationId: getPensionRiskCoverages
+ description: Método para obter informações de Previdência de Cobertura de Riscos.
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/pageSize'
+ responses:
+ '200':
+ $ref: '#/components/responses/OKResponseRiskCoveragePension'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '405':
+ $ref: '#/components/responses/MethodNotAllowed'
+ '429':
+ $ref: '#/components/responses/TooManyRequests'
+ '500':
+ $ref: '#/components/responses/InternalServerError'
+ '529':
+ $ref: '#/components/responses/SiteIsOverloaded'
+ /survival-coverages:
+ get:
+ tags:
+ - Survival Coverages
+ summary: Informações de Previdência com Cobertura de Sobrevivência.
+ operationId: getPensionSurvivalCoverages
+ description: Método para obter informações de Previdência de Cobertura de Sobrevivência.
+ parameters:
+ - $ref: '#/components/parameters/page'
+ - $ref: '#/components/parameters/pageSize'
+ responses:
+ '200':
+ $ref: '#/components/responses/OKResponseSurvivorCoveragePension'
+ '400':
+ $ref: '#/components/responses/BadRequest'
+ '404':
+ $ref: '#/components/responses/NotFound'
+ '405':
+ $ref: '#/components/responses/MethodNotAllowed'
+ '429':
+ $ref: '#/components/responses/TooManyRequests'
+ '500':
+ $ref: '#/components/responses/InternalServerError'
+ '529':
+ $ref: '#/components/responses/SiteIsOverloaded'
+components:
+ schemas:
+ OKResponseRiskCoveragePension:
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/GetRiskPensionContractData'
+ links:
+ $ref: '#/components/schemas/Links'
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ GetRiskPensionContractData:
+ type: object
+ required:
+ - participant
+ - society
+ - name
+ - code
+ - modality
+ - coverages
+ - termsAndConditions
+ - premiumUpdateIndex
+ - otherGuaranteedValues
+ - contributionPayment
+ - minimumRequirement
+ - targetAudience
+ properties:
+ participant:
+ $ref: '#/components/schemas/PensionParticipant'
+ society:
+ $ref: '#/components/schemas/PensionSociety'
+ name:
+ type: string
+ maxLength: 80
+ description: 'Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.'
+ example: Produto A
+ code:
+ type: string
+ maxLength: 80
+ description: Código único a ser definido pela sociedade.
+ example: '0001'
+ modality:
+ $ref: '#/components/schemas/EnumProductModality'
+ coverages:
+ type: array
+ items:
+ $ref: '#/components/schemas/Coverage'
+ assistanceTypes:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumAssistanceType'
+ example:
+ - PET
+ - FUNERAL
+ assistanceTypesAdditionalInfos:
+ type: array
+ items:
+ type: string
+ description: Lista a ser preenchida pelas participantes quando houver 'Outros' no campo 'Tipo de Assistência'.
+ example:
+ - Assistance additional info.
+ additional:
+ $ref: '#/components/schemas/EnumAdditional'
+ termsAndConditions:
+ type: array
+ items:
+ $ref: '#/components/schemas/TermsAndConditions'
+ minItems: 1
+ pmbacRemuneration:
+ $ref: '#/components/schemas/RiskPensionEnumPmbacRemuneration'
+ premiumUpdateIndex:
+ $ref: '#/components/schemas/RiskPensionEnumPremiumUpdateIndex'
+ ageAdjustment:
+ $ref: '#/components/schemas/AgeAdjustment'
+ financialRegimeContractType:
+ $ref: '#/components/schemas/RiskPensionEnumFinancialRegime'
+ reclaim:
+ $ref: '#/components/schemas/RiskPensionReclaim'
+ otherGuaranteedValues:
+ $ref: '#/components/schemas/RiskPensionEnumOtherGuaranteedValues'
+ contributionPayment:
+ $ref: '#/components/schemas/RiskPensionEnumContributionPayment'
+ minimumRequirement:
+ $ref: '#/components/schemas/RiskPensionMinimumRequirement'
+ targetAudience:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. Ambas (Pessoa Natural e Jurídica)
+ 4. NA
+ maxLength: 23
+ enum:
+ - PESSOA_NATURAL
+ - PESSOA_JURIDICA
+ - PESSOA_NATURAL_JURIDICA
+ - NA
+ example: PESSOA_NATURAL
+ additionalProperties: false
+ OKResponseSurvivalCoveragePension:
+ type: object
+ required:
+ - data
+ - links
+ - meta
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/GetSurvivalPensionContractData'
+ links:
+ $ref: '#/components/schemas/Links'
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ GetSurvivalPensionContractData:
+ type: object
+ required:
+ - participant
+ - name
+ - code
+ - segment
+ - modality
+ - defferalPeriod
+ - grantPeriodBenefit
+ - costs
+ - targetAudience
+ properties:
+ participant:
+ $ref: '#/components/schemas/PensionParticipant'
+ society:
+ $ref: '#/components/schemas/PensionSociety'
+ name:
+ type: string
+ maxLength: 80
+ description: |
+ Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
+ example: Produto A
+ code:
+ type: string
+ maxLength: 80
+ description: |
+ Código único a ser definido pela sociedade.
+ example: '0001'
+ segment:
+ type: string
+ description: |
+ Segmento do qual se trata o produto contratado
+ 1. Seguro de Pessoas
+ 2. Previdência
+ 3. NA
+ maxLength: 20
+ enum:
+ - SEGURO_PESSOAS
+ - PREVIDENCIA
+ - NA
+ example: PREVIDENCIA
+ modality:
+ type: string
+ description: |
+ 1. Contribuição Variável;
+ 2. Benefício Definido.
+ 3. NA
+ maxLength: 21
+ enum:
+ - CONTRIBUICAO_VARIAVEL
+ - BENEFICIO_DEFINIDO
+ - NA
+ example: BENEFICIO_DEFINIDO
+ additionalInfo:
+ type: string
+ description: Campo aberto (possibilidade de incluir URL)
+ example: 'https://openinsurance.com.br/aaa'
+ maxLength: 1024
+ termsAndConditions:
+ type: array
+ items:
+ $ref: '#/components/schemas/TermsAndConditions'
+ minItems: 1
+ type:
+ $ref: '#/components/schemas/SurvivalPensionType'
+ defferalPeriod:
+ $ref: '#/components/schemas/SurvivalPensionDefferalPeriod'
+ grantPeriodBenefit:
+ $ref: '#/components/schemas/SurvivalPensionGrantPeriodBenefit'
+ costs:
+ $ref: '#/components/schemas/SurvivalPensionCosts'
+ minimumRequirement:
+ $ref: '#/components/schemas/SurvivalPensionMinimumRequirements'
+ targetAudience:
+ $ref: '#/components/schemas/SurvivalPensionEnumTargetAudience'
+ additionalProperties: false
+ SurvivalPensionInvestmentFund:
+ type: object
+ description: Fundos de Investimento (por fundo).
+ required:
+ - cnpjNumber
+ - name
+ - maximumAdministrationFee
+ - typePerformanceFee
+ properties:
+ cnpjNumber:
+ $ref: '#/components/schemas/CnpjNumber'
+ name:
+ type: string
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Nome Fantasia
+ maxLength: 80
+ example: EMPRESAAPREV
+ maximumAdministrationFee:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Taxa Máxima de Administração - em %
+ example: '0.019800'
+ maxLength: 9
+ minLength: 8
+ typePerformanceFee:
+ type: string
+ enum:
+ - DIRETAMENTE
+ - INDIRETAMENTE
+ - NAO_APLICA
+ - NA
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Tipo de taxa de performance
+ example: DIRETAMENTE
+ maxLength: 13
+ maximumPerformanceFee:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Taxa Máxima de Performance - em %
+ maxLength: 9
+ minLength: 8
+ example: '0.019800'
+ eligibilityRule:
+ type: boolean
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Regra de Elegibilidade
+ example: true
+ minimumContributionAmount:
+ type: string
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Valor Mínimo de Contribuição
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ example: '1000.00'
+ maxLength: 21
+ minimumMathematicalProvisionAmount:
+ type: string
+ description: |
+ Lista com as informações do(s) Fundo(s) de Investimento(s) disponíveis para o período de diferimento/acumulação, contemplando:
+ - Valor Mínimo do Saldo Provisão matemática
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ example: '1000.00'
+ maxLength: 21
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ SurvivalPensionMinimumRequirements:
+ type: object
+ required:
+ - contractType
+ - contractingMinRequirement
+ properties:
+ contractType:
+ type: string
+ maxLength: 27
+ enum:
+ - COLETIVO_AVERBADO
+ - COLETIVO_INSTITUIDO
+ - INDIVIDUAL
+ - NA
+ description: |
+ O tipo de serviço contratado. A considerar os domínios abaixo:
+ 1. Coletivo Averbado;
+ 2. Coletivo instituído;
+ 3. Individual.
+ 4. NA
+ example: COLETIVO_AVERBADO
+ participantQualified:
+ type: boolean
+ description: |
+ Indicação se o plano é destinado para participante qualificado. A considerar os domínios abaixo:
+ 1. true
+ 2. false
+ example: true
+ contractingMinRequirement:
+ type: string
+ maxLength: 1024
+ description: Campo aberto (possibilidade de incluir URL)
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ CnpjNumber:
+ type: string
+ description: '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.'
+ pattern: '^(\d{14})$|^(NA)$'
+ example: '13456789000112'
+ SurvivalPensionDefferalPeriod:
+ type: object
+ description: Período de Diferimento
+ required:
+ - interestRate
+ - updateIndex
+ - otherMinimumPerformanceGarantees
+ - reversalFinancialResults
+ - redemptionPaymentTerm
+ - portabilityPaymentTerm
+ properties:
+ interestRate:
+ type: string
+ maxLength: 9
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ description: Taxa de juros mensal garantida que remunera o plano durante a fase de diferimento/acumulação.
+ example: '0.019800'
+ updateIndex:
+ $ref: '#/components/schemas/UpdateIndex'
+ otherMinimumPerformanceGarantees:
+ type: string
+ description: 'Para produtos do tipo PDR e VDR, indicação do índice de ampla divulgação utilizados como garantia mínima de desempenho.'
+ example: SELIC
+ maxLength: 12
+ reversalFinancialResults:
+ type: string
+ maxLength: 9
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ description: Percentual de reversão de excedente financeiro na concessão. Em %.
+ example: '0.019800'
+ minimumPremiums:
+ type: array
+ items:
+ $ref: '#/components/schemas/SurvivalPensionMinimumPremium'
+ premiumPaymentMethods:
+ type: array
+ items:
+ type: string
+ maxLength: 27
+ enum:
+ - CARTAO_CREDITO
+ - DEBITO_CONTA
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - CARTAO_DEBITO
+ - REGRA_PARCEIRO
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PONTOS_PROGRAMA_BENEFICIO
+ - TED_DOC
+ - OUTROS
+ - NA
+ example: CARTAO_CREDITO
+ permissionExtraordinaryContributions:
+ description: |
+ Se ficam permitidos aportes extraordinários. A considerar os seguintes domínios:
+ 1. true
+ 2. false
+ type: boolean
+ example: true
+ permissionScheduledFinancialPayments:
+ description: |
+ Se ficam permitidos pagamentos financeiros programados. A considerar os seguintes domínios:
+ 1. true
+ 2. false
+ type: boolean
+ example: true
+ gracePeriod:
+ $ref: '#/components/schemas/SurvivalPensionGracePeriod'
+ redemptionPaymentTerm:
+ type: integer
+ description: Prazo em dias para pagamento do resgate
+ maximum: 9999
+ example: 10
+ portabilityPaymentTerm:
+ type: number
+ description: Prazo em dias para pagamento da portabilidade (entre empresas diferentes).
+ example: 20
+ maximum: 9999
+ investmentFunds:
+ type: array
+ items:
+ $ref: '#/components/schemas/SurvivalPensionInvestmentFund'
+ additionalProperties: false
+ SurvivalPensionType:
+ type: string
+ description: |
+ 1. PGBL
+ 2. PRGP
+ 3. PAGP
+ 4. PRSA
+ 5. PRI
+ 6. PDR
+ 7. VGBL
+ 8. VRGP
+ 9. VAGP
+ 10. VRSA
+ 11. VRI
+ 12. VDR
+ 13. Demais produtos de Previdência.
+ 14. NA
+ maxLength: 27
+ enum:
+ - PGBL
+ - PRGP
+ - PAGP
+ - PRSA
+ - PRI
+ - PDR
+ - VGBL
+ - VRGP
+ - VAGP
+ - VRSA
+ - VRI
+ - VDR
+ - DEMAIS_PRODUTOS_PREVIDENCIA
+ - NA
+ SurvivalPensionGracePeriod:
+ type: object
+ description: Prazo de carência
+ required:
+ - redemption
+ - betweenRedemptionRequests
+ - portability
+ - betweenPortabilityRequests
+ properties:
+ redemption:
+ type: number
+ description: |
+ Prazo em dias de carência para resgate Para Coletivos: Valor máximo da carência.
+ example: 100
+ maximum: 9999
+ betweenRedemptionRequests:
+ type: number
+ description: |
+ Prazo em dias de carência entre pedidos de resgate Para Coletivos: Valor máximo da carência
+ example: 30
+ maximum: 9999
+ portability:
+ type: number
+ description: Prazo em dias de carência para portabilidade (entre empresas diferentes).
+ example: 12
+ maximum: 9999
+ betweenPortabilityRequests:
+ type: number
+ description: Prazo em dias de carência entre pedidos de portabilidade (entre empresas diferentes).
+ example: 15
+ maximum: 9999
+ additionalProperties: false
+ SurvivalPensionCosts:
+ type: object
+ description: Custos
+ required:
+ - loadingAntecipated
+ - loadingLate
+ properties:
+ loadingAntecipated:
+ $ref: '#/components/schemas/SurvivalPensionLoadingAntecipated'
+ loadingLate:
+ $ref: '#/components/schemas/SurvivalPensionLoadingLate'
+ additionalProperties: false
+ SurvivalPensionLoadingAntecipated:
+ type: object
+ description: Carregamento antecipado.
+ required:
+ - minValue
+ - maxValue
+ properties:
+ minValue:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ maxLength: 9
+ minLength: 8
+ description: Percentual mínimo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.
+ example: '0.019800'
+ maxValue:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ maxLength: 9
+ minLength: 8
+ description: Percentual máximo de carregamento cobrada quando do pagamento do prêmio/ contribuição. Em %.
+ example: '0.019800'
+ additionalProperties: false
+ SurvivalPensionLoadingLate:
+ type: object
+ description: Carregamento postecipado.
+ required:
+ - minValue
+ - maxValue
+ properties:
+ minValue:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ maxLength: 9
+ minLength: 8
+ description: Percentual mínimo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.
+ example: '0.019800'
+ maxValue:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ maxLength: 9
+ minLength: 8
+ description: Percentual máximo de taxa de carregamento cobrado quando da efetivação de resgate ou portabilidade.
+ example: '0.019800'
+ additionalProperties: false
+ SurvivalPensionMinimumPremium:
+ type: object
+ description: Valor mínimo de prêmio/contribuição
+ properties:
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ periodicity:
+ type: string
+ maxLength: 10
+ example: MENSAL
+ enum:
+ - DIARIO
+ - SEMANAL
+ - QUINZENAL
+ - MENSAL
+ - BIMESTRAL
+ - TRIMESTRAL
+ - SEMESTRAL
+ - ANUAL
+ - UNICO
+ - NA
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ description: Valor mínimo em R$ de prêmio/ contribuição aceita pela sociedade ao plano (identificar valor mensal e/ou aporte único).
+ example: '250.00'
+ additionalProperties: false
+ SurvivalPensionGrantPeriodBenefit:
+ type: object
+ description: Período de concessão do benefício
+ required:
+ - incomeModalities
+ - interestRate
+ - updateIndex
+ - reversalFinancialResults
+ properties:
+ incomeModalities:
+ type: array
+ minItems: 1
+ items:
+ type: string
+ description: |
+ Modalidades de renda disponíveis para contratação.
+ A considerar os seguintes domínios:
+ 1. Pagamento Único
+ 2. Renda por Prazo Certo;
+ 3. Renda Temporária;
+ 4. Renda Temporária Reversível;
+ 5. Renda Temporária com mínimo garantido;
+ 6. Renda Temporária Reversível com Mínimo Garantido;
+ 7. Renda Vitalícia;
+ 8. Renda Vitalícia Reversível ao Beneficiário Indicado
+ 9. Renda Vitalícia Reversível ao Cônjuge com Continuidade de Menores
+ 10. Renda Vitalícia com o Mínimo Garantido;
+ 11. Renda Vitalícia com Prazo mínimo garantido.
+ 12. NA
+ enum:
+ - PAGAMENTO_UNICO
+ - RENDA_PRAZO_CERTO
+ - RENDA_TEMPORARIA
+ - RENDA_TEMPORARIA_REVERSIVEL
+ - RENDA_TEMPORARIA_MINMO_GARANTIDO
+ - RENDA_TEMPORARIA_REVERSIVEL_MININO_GARANTIDO
+ - RENDA_VITALICIA
+ - RENDA_VITALICIA_REVERSIVEL_BENEFICIARIO_INDICADO
+ - RENDA_VITALICIA_CONJUGE_CONTINUIDADE_MENORES
+ - RENDA_VITALICIA_MINIMO_GARANTIDO
+ - RENDA_VITALICIA_PRAZO_MINIMO_GRANTIDO
+ - NA
+ example: PAGAMENTO_UNICO
+ biometricTable:
+ type: array
+ minItems: 0
+ items:
+ type: string
+ maxLength: 32
+ description: |
+ Tábua biométrica utilizada como parâmetro para conversão em renda atuarial que deve observar a relação discriminada de coberturas, conforme Tabela II.2 do Anexo II.
+ Deverá ser informada a tábua biométrica aplicável à modalidade de renda padrão do plano.
+ enum:
+ - AT_2000_MALE
+ - AT_2000_FEMALE
+ - AT_2000_MALE_FEMALE
+ - AT_2000_MALE_SUAVIZADA_10
+ - AT_2000_FEMALE_SUAVIZADA_10
+ - AT_2000_MALE_FEMALE_SUAVIZADA_10
+ - AT_2000_MALE_SUAVIZADA_15
+ - AT_2000_FEMALE_SUAVIZADA_15
+ - AT_2000_MALE_FEMALE_SUAVIZADA_15
+ - AT_83_MALE
+ - AT_83_FEMALE
+ - AT_83_MALE_FEMALE
+ - BR_EMSSB_MALE
+ - BR_EMSSB_FEMALE
+ - BR_EMSSB_MALE_FEMALE
+ - NA
+ example: AT_2000_MALE
+ interestRate:
+ type: string
+ maxLength: 9
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ description: Taxa de juros garantida utilizada para conversão em renda. Em %
+ example: '0.019800'
+ updateIndex:
+ $ref: '#/components/schemas/UpdateIndex'
+ reversalFinancialResults:
+ type: string
+ maxLength: 9
+ minLength: 8
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ description: Percentual de reversão de excedente financeiro na concessão. Em %.
+ example: '0.019800'
+ investmentFunds:
+ type: array
+ items:
+ $ref: '#/components/schemas/SurvivalPensionInvestmentFund'
+ additionalProperties: false
+ Links:
+ type: object
+ description: Referências para outros recusos da API requisitada.
+ required:
+ - self
+ properties:
+ self:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI completo que gerou a resposta atual.
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ first:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da primeira página que originou essa lista de resultados. Restrição - Obrigatório quando não for a primeira página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ prev:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: "URI da página anterior dessa lista de resultados. Restrição - \tObrigatório quando não for a primeira página da resposta"
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ next:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da próxima página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ last:
+ type: string
+ format: uri
+ maxLength: 2000
+ description: URI da última página dessa lista de resultados. Restrição - Obrigatório quando não for a última página da resposta
+ example: 'https://api.banco.com.br/open-banking/api/v1/resource'
+ pattern: '^(https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$'
+ additionalProperties: false
+ PensionParticipant:
+ type: object
+ description: Conjunto de informações relativas ao participante do produto de Open Finance
+ required:
+ - brand
+ - name
+ - cnpjNumber
+ properties:
+ brand:
+ type: string
+ description: 'Nome da marca reportada pelo participante do Open Finance. 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.'
+ maxLength: 80
+ example: Organização
+ name:
+ type: string
+ description: Nome do participante do Open Finance.
+ maxLength: 80
+ example: Organização A1
+ cnpjNumber:
+ $ref: '#/components/schemas/CnpjNumber'
+ urlComplementaryList:
+ description: |
+ Espera-se que valor de retorno, após acesso ao link ‘urlComplementaryList’, deve ser array de objeto com a estrutura abaixo:
+
+ - ‘name’ com o valor contido no campo ‘LegalEntityName’ conforme cadastro no diretório;
+
+ - ‘cnpjNumber’ com o valor contido no campo CNPJ (‘RegistrationNumber’) correspondente a esta instituição;
+
+ - Ambos do tipo string;
+
+ - Ambos obrigatórios.
+ type: string
+ maxLength: 1024
+ pattern: '^((https?:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*))|(NA)$'
+ example: 'https://empresaa1.com/companies'
+ additionalProperties: false
+ PensionSociety:
+ type: object
+ description: Conjunto de informações relativas à seguradora do produto de open insurance
+ required:
+ - name
+ - cnpjNumber
+ properties:
+ name:
+ type: string
+ description: Nome da Sociedade Seguradora.
+ maxLength: 80
+ example: Society A1
+ cnpjNumber:
+ $ref: '#/components/schemas/CnpjNumber'
+ additionalProperties: false
+ RiskPensionEnumIndemnifiablePeriodType:
+ type: string
+ description: |
+ Listagem do pagamento para cada benefício:
+ 1. Quantidade determinada de parcelas;
+ 2. Até o fim de ciclo determinado;
+ 3. NA.
+
+ Observação: Se for pagamento único, este campo não deve ser informado.
+ enum:
+ - QUANTIDADE_DETERMINADA_PARCELAS
+ - FIM_CICLO_DETERMINADO
+ - NA
+ example: QUANTIDADE_DETERMINADA_PARCELAS
+ SurvivalPensionEnumTargetAudience:
+ type: string
+ description: |
+ A considerar os domínios abaixo:
+
+ 1. Pessoa Natural
+ 2. Pessoa Jurídica
+ 3. NA
+ maxLength: 23
+ enum:
+ - PESSOA_NATURAL
+ - PESSOA_JURIDICA
+ - NA
+ example: PESSOA_NATURAL
+ EnumProductModality:
+ type: string
+ description: - Funeral
- Prestamista (exceto Habitacional e Rural)
- Viagem
- Educacional
- Dotal (Misto e Puro)
- Acidentes Pessoais
- Vida
- Perda do Certificado de Habilitação de Voo – PCHV
- Doenças Graves ou Doença Terminal
- Desemprego/ Perda de Renda
- Eventos Aleatórios
- Pecúlio
- Pensão prazo certo
- Pensão menores 21 anos
- Pensão menores 24 anos
- Pensão cônjuge vitalícia
- Pensão cônjuge temporária
- NA
+ maxLength: 33
+ enum:
+ - FUNERAL
+ - PRESTAMISTA
+ - VIAGEM
+ - EDUCACIONAL
+ - DOTAL
+ - ACIDENTES_PESSOAIS
+ - VIDA
+ - PERDA_CERTIFICADO_HABILITACAO_VOO
+ - DOENCAS_GRAVES_DOENCA_TERMINAL
+ - DESEMPREGO_PERDA_RENDA
+ - EVENTOS_ALEATORIOS
+ - PECULIO
+ - PENSAO_PRAZO_CERTO
+ - PENSAO_MENORES_21
+ - PENSAO_MENORES_24
+ - PENSAO_CONJUGE_VITALICIA
+ - PENSAO_CONJUGE_TEMPORARIA
+ - NA
+ example: FUNERAL
+ Coverage:
+ type: object
+ required:
+ - type
+ properties:
+ type:
+ $ref: '#/components/schemas/EnumRiskPensionCoverageType'
+ typeAdditionalInfos:
+ type: array
+ description: |
+ Lista de textos para complementar informação relativa ao campo type, quando for selecionada a opção 'OUTROS'.
+ Restrição: Campo de preenchimento obrigatório se 'type' estiver preenchida a opção 'OUTROS'
+ items:
+ type: string
+ maxLength: 100
+ example:
+ - Detalhar os serviços
+ - benefícios
+ - outros
+ attributes:
+ $ref: '#/components/schemas/CoverageAttributes'
+ additionalProperties: false
+ EnumRiskPensionCoverageType:
+ type: string
+ description: 'É o conjunto dos riscos cobertos elencados na apólice. (RESOLUÇÃO CNSP Nº 341/2016). Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela Tipo de Cobertura.'
+ maxLength: 9
+ enum:
+ - MORTE
+ - INVALIDEZ
+ - OUTROS
+ - NA
+ example: MORTE
+ CoverageAttributes:
+ type: object
+ description: Atributos da cobertura
+ required:
+ - minValue
+ - maxValue
+ - indemnifiableDeadline
+ - indemnityPaymentMethod
+ - gracePeriod
+ - excludedRisks
+ - excludedRisksURL
+ - profitModality
+ properties:
+ minValue:
+ $ref: '#/components/schemas/InsurancePensionMinValue'
+ maxValue:
+ $ref: '#/components/schemas/InsurancePensionMaxValue'
+ indemnifiablePeriod:
+ $ref: '#/components/schemas/RiskPensionEnumIndemnifiablePeriodType'
+ indemnifiableDeadline:
+ type: integer
+ description: Número máximo de parcelas indenizáveis. Caso seja relacionado a parcelas.
+ indemnityPaymentMethod:
+ $ref: '#/components/schemas/RiskPensionEnumIndemnityPaymentMethod'
+ gracePeriod:
+ type: object
+ description: Período de carência da cobertura
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: Informar o prazo de carência
+ example: 90
+ maximum: 9999999999
+ unit:
+ $ref: '#/components/schemas/EnumGracePeriodUnit'
+ additionalProperties: false
+ excludedRisks:
+ type: array
+ items:
+ $ref: '#/components/schemas/EnumExcludedRisks'
+ excludedRisksURL:
+ type: string
+ maxLength: 1024
+ description: Campo aberto (possibilidade de incluir URL).
+ example: 'https://openinsurance.com.br/aaa'
+ profitModality:
+ $ref: '#/components/schemas/RiskPensionEnumProfitModality'
+ additionalProperties: false
+ RiskPensionGracePeriod:
+ type: object
+ required:
+ - amount
+ - unit
+ properties:
+ amount:
+ type: integer
+ format: int64
+ description: Informar o prazo de carência
+ example: 90
+ maximum: 9999999999
+ unit:
+ $ref: '#/components/schemas/RiskPensionEnumGracePeriodUnit'
+ additionalProperties: false
+ TermsAndConditions:
+ type: object
+ required:
+ - susepProcessNumber
+ - detail
+ properties:
+ susepProcessNumber:
+ type: string
+ description: 'Sequência numérica utilizada para consulta dos processos eletrônicos na SUSEP, com caracteres especiais, conforme campo de consulta no site da SUSEP (XXXXX.XXXXXX/XXXX-XX)
Observação: Mascaras da SUSEP – Serão permitidos todas as máscaras de Produtos. Limitar pelos códigos das Máscaras.'
+ minLength: 2
+ maxLength: 20
+ pattern: '^(\d{5}\.\d{6}\/\d{4}-\d{2}$|^\d{2}\.\d{6}\/\d{2}-\d{2}$|^\d{3}-\d{5}\/\d{2}$|^\d{5}\.\d{6}\/\d{2}-\d{2})$|^(NA)$'
+ example: 15414.622222/2222-22
+ detail:
+ type: string
+ description: 'Representam as Condições Gerais, Condições Especiais e Condições ou Cláusulas Particulares de um mesmo produto. (Circular SUSEP 321/06). Campo aberto (possibilidade de incluir URL)'
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ UpdateIndex:
+ type: string
+ maxLength: 5
+ description: |
+ Índice utilizado na atualização do prêmio e do capital segurado, caso critério de atualização por meio de índice:
+ 1. IPCA (IBGE);
+ 2. IGP-M (FGV);
+ 3. INPC (IBGE).
+ 4. Não se aplica
+ 5. NA
+ enum:
+ - IPCA
+ - IGP_M
+ - INPC
+ - NAO_SE_APLICA
+ - NA
+ example: IPCA
+ RiskPensionReclaim:
+ type: object
+ required:
+ - gracePeriod
+ properties:
+ table:
+ type: array
+ items:
+ $ref: '#/components/schemas/RiskPensionReclaimTableItem'
+ minItems: 1
+ gracePeriod:
+ $ref: '#/components/schemas/RiskPensionGracePeriod'
+ differenciatedPercentage:
+ description: Campo aberto (possibilidade de incluir URL)
+ example: |
+ https://openinsurance.com.br/aaa’
+ Obs.: Exceção de cobertura ou critério definido acima será descrito aqui na URL
+ Exemplo: Cobertura X: a partir de 25 meses = 100%
+ maxLength: 1024
+ additionalProperties: false
+ InsurancePensionMinValue:
+ type: object
+ required:
+ - amount
+ - currency
+ description: 'Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.'
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ InsurancePensionMaxValue:
+ type: object
+ required:
+ - amount
+ - currency
+ description: 'Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto.
Conforme moeda.'
+ properties:
+ amount:
+ type: string
+ maxLength: 21
+ pattern: '^(\d{1,16}\.\d{2,4})$|^(NA)$'
+ example: '0.01'
+ currency:
+ $ref: '#/components/schemas/CurrencyCode'
+ additionalProperties: false
+ RiskPensionMinimumRequirement:
+ type: object
+ required:
+ - contractType
+ - contractingMinRequirement
+ properties:
+ contractType:
+ type: string
+ description: |
+ O tipo de serviço contratado. A considerar os domínios abaixo:
+ 1. Coletivo;
+ 2. Individual.
+ 3. NA
+ enum:
+ - COLETIVO
+ - INDIVIDUAL
+ - NA
+ example: COLETIVO
+ contractingMinRequirement:
+ type: string
+ description: Campo aberto contendo todos os requisitos mínimos para contratação (possibilidade de incluir URL).
+ maxLength: 1024
+ example: 'https://openinsurance.com.br/aaa'
+ additionalProperties: false
+ RiskPensionReclaimTableItem:
+ type: object
+ required:
+ - initialMonthRange
+ - finalMonthRange
+ - percentage
+ properties:
+ initialMonthRange:
+ type: integer
+ maxLength: 2
+ example: 1
+ finalMonthRange:
+ type: integer
+ maxLength: 2
+ example: 12
+ percentage:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ maxLength: 9
+ minLength: 8
+ description: Percentual de faixa de resgate.
+ example: '0.019800'
+ additionalProperties: false
+ RiskPensionEnumPmbacRemuneration:
+ type: object
+ required:
+ - interestRate
+ properties:
+ interestRate:
+ type: string
+ pattern: '^(\d{1}\.\d{6})$|^(-1.000000)$'
+ description: Taxa de juros para capitalização da PMBaC
+ maxLength: 9
+ minLength: 8
+ example: '0.019800'
+ updateIndexes:
+ type: array
+ items:
+ type: string
+ description: |
+ Índice utilizado na atualização da PMBaC:
+ 1. IPCA (IBGE)
+ 2. IGP-M (FGV)
+ 3. INPC (IBGE)
+ 4. NA
+ enum:
+ - IPCA
+ - IGP_M
+ - INPC
+ - NA
+ example: IPCA
+ additionalProperties: false
+ AgeAdjustment:
+ type: object
+ required:
+ - criterias
+ - frequency
+ properties:
+ criterias:
+ type: array
+ items:
+ type: string
+ description: |
+ Critério escolhido para reenquadramento etário
+ 1. Após período em anos
+ 2. A cada período em anos
+ 3. Por mudança de faixa etária
+ 4. Não aplicável
+ 5. NA
+ maxLength: 27
+ example: APOS_PERIODO_ANOS
+ enum:
+ - APOS_PERIODO_ANOS
+ - CADA_PERIODO_ANOS
+ - MUDANCA_FAIXA_ETARIA
+ - NAO_APLICAVEL
+ - NA
+ frequency:
+ type: integer
+ description: 'Período em anos, caso critério de reenquadramento após ou a cada período em anos.'
+ maxLength: 3
+ example: 10
+ additionalProperties: false
+ CurrencyCode:
+ type: string
+ pattern: '^([A-Z]{3})$|^(NA)$'
+ maxLength: 3
+ description: 'Moeda referente ao valor monetário, seguindo o modelo ISO-4217.'
+ example: BRL
+ EnumExcludedRisks:
+ type: string
+ description: Listagem para indicar quais serão o(s) risco(s) excluído(s) aplicável(is) à(s) cobertura(s).
+ maxLength: 40
+ enum:
+ - ATO_RECONHECIMENTO_PERIGOSO
+ - ATO_ILICITO_DOLOSO_PRATICADO_SEGURADO
+ - OPERACOES_GUERRA
+ - FURACOES_CICLONES_TERREMOTOS
+ - MATERIAL_NUCLEAR
+ - DOENCAS_LESOES_PREEXISTENTES
+ - EPIDEMIAS_PANDEMIAS
+ - SUICIDIO
+ - ATO_ILICITO_DOLOSO_PRATICADO_CONTROLADOR
+ - OUTROS
+ - NA
+ example: ATO_RECONHECIMENTO_PERIGOSO
+ EnumAssistanceType:
+ type: string
+ description: 'Lista padronizada de tipo de assistências ofertadas vinculadas ao produto. Por exemplo, Funeral, Bicicleta, Assistência PET – Tabela padrão a ser consolidada com retorno das empresas com a relação de assistências, permitindo um campo ‘Outros’ para assistências não contempladas na tabela padronizada.'
+ maxLength: 43
+ enum:
+ - ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
+ - ARQUITETO_VIRTUAL
+ - ASSESSORIA_FINANCEIRA
+ - AUTOMOVEL
+ - AUXILIO_NATALIDADE
+ - AVALIACAO_CLINICA_PREVENTIVA
+ - BOLSA_PROTEGIDA
+ - CESTA_BASICA
+ - CHECKUP_ODONTOLOGICO
+ - CLUBE_VANTAGENS_BENEFICIOS
+ - CONVALESCENCIA
+ - DECESSO
+ - DESCONTO_FARMACIAS_MEDICAMENTOS
+ - DESPESAS_FARMACEUTICAS_VIAGEM
+ - DIGITAL
+ - EDUCACIONAL
+ - EMPRESARIAL
+ - ENCANADOR
+ - ENTRETENIMENTO
+ - EQUIPAMENTOS_MEDICOS
+ - FIANCAS_DESPESAS_LEGAIS
+ - FISIOTERAPIA
+ - FUNERAL
+ - HELP_LINE
+ - HOSPEDAGEM_ACOMPANHANTE
+ - INTERRUPCAO_VIAGEM
+ - INVENTARIO
+ - MAIS_VIDA
+ - MAMAE_BEBE
+ - MEDICA_ACIDENTE_DOENCA
+ - MOTOCICLETA
+ - MULHER
+ - NUTRICIONISTA
+ - ODONTOLOGICA
+ - ORIENTACAO_FITNESS
+ - ORIENTACAO_JURIDICA
+ - ORIENTACAO_NUTRICIONAL
+ - PERSONAL_FITNESS
+ - ORIENTACAO_PSICOSSOCIAL_FAMILIAR
+ - PERDA_ROUBO_CARTAO
+ - PET
+ - PRORROGACAO_ESTADIA
+ - PROTECAO_DADOS
+ - RECOLOCACAO_PROFISSIONAL
+ - REDE_DESCONTO_NUTRICIONAL
+ - RESIDENCIAL
+ - RETORNO_MENORES_SEGURADO
+ - SAQUE_COACAO
+ - SAUDE_BEM_ESTAR
+ - SEGUNDA_OPINIAO_MEDICA
+ - SENIOR
+ - SUSTENTAVEL_DESCARTE_ECOLOGICO
+ - TELEMEDICINA
+ - VIAGEM
+ - VITIMA
+ - OUTROS
+ - NA
+ example: ACOMPANHANTE_CASO_HOSPITALIZACAO_PROLONGADA
+ EnumAdditional:
+ type: string
+ enum:
+ - SORTEIO
+ - SERVICOS_ASSISTENCIAS_COMPLEMENTARES_PAGO
+ - SERVICOS_ASSISTENCIA_COMPLEMENTARES_GRATUITO
+ - OUTROS
+ - NAO_HA
+ - NA
+ example: SORTEIO
+ EnumGracePeriodUnit:
+ type: string
+ description: Informar o critério de carência para a cobertura:
- Dias
- Meses
- Não se aplica
- NA
+ maxLength: 10
+ enum:
+ - DIAS
+ - MESES
+ - NAO_APLICA
+ - NA
+ example: MESES
+ RiskPensionEnumGracePeriodUnit:
+ type: string
+ description: |
+ Informar o critério de carência para resgate:
+ 1. Dias;
+ 2. Meses;
+ 3. Não se aplica.
+ 4. NA
+ enum:
+ - DIAS
+ - MESES
+ - NAO_APLICA
+ - NA
+ example: MESES
+ RiskPensionEnumFinancialRegime:
+ type: string
+ description: |
+ Listagem de regime financeiro para cada combinação de modalidade/cobertura do produto indicando:
+ 1. Repartição simples
+ 2. Repartição Capitais Cobertura
+ 3. Capitalização
+ 4. NA
+ example: REPARTICAO_SIMPLES
+ enum:
+ - REPARTICAO_SIMPLES
+ - REPARTICAO_CAPITAIS
+ - CAPITALIZACAO
+ - NA
+ RiskPensionEnumPremiumUpdateIndex:
+ type: string
+ description: Índice utilizado na atualização do prêmio/contribuição e do capital segurado/benefício
+ enum:
+ - IPCA
+ - IGPM
+ - INPC
+ - NA
+ example: IPCA
+ RiskPensionEnumContributionPayment:
+ type: object
+ description: Pagamento da contribuição.
+ required:
+ - contributionPaymentMethod
+ - contributionPeriodicity
+ properties:
+ contributionPaymentMethod:
+ type: string
+ example: CARTAO_CREDITO
+ description: |
+ Forma de pagamento da contribuição.
+ - CARTAO_CREDITO
+ - DEBITO_CONTA
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - TED_DOC
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PONTOS_PROGRAMA_BENEFICIO
+ - OUTROS
+ - NA
+ enum:
+ - CARTAO_CREDITO
+ - DEBITO_CONTA
+ - DEBITO_CONTA_POUPANCA
+ - BOLETO_BANCARIO
+ - PIX
+ - TED_DOC
+ - CONSIGNACAO_FOLHA_PAGAMENTO
+ - PONTOS_PROGRAMA_BENEFICIO
+ - OUTROS
+ - NA
+ contributionPaymentMethodAdditionalInfo:
+ type: string
+ pattern: '[\w\W\s]*'
+ example: Informações adicionais
+ maxLength: 140
+ description: |
+ Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
+
+ [Restrição] Obrigatório quando 'contributionPaymentMethod' for igual 'OUTROS'.
+ contributionPeriodicity:
+ type: string
+ example: MENSAL
+ description: |
+ Periodicidade de pagamento da contribuição.
+ - MENSAL
+ - UNICA
+ - ANUAL
+ - TRIMESTRAL
+ - SEMESTRAL
+ - BIMESTRAL
+ - OUTROS
+ - NA
+ enum:
+ - MENSAL
+ - UNICA
+ - ANUAL
+ - TRIMESTRAL
+ - SEMESTRAL
+ - BIMESTRAL
+ - OUTROS
+ - NA
+ contributionPeriodicityAdditionalInfo:
+ type: string
+ pattern: '[\w\W\s]*'
+ example: Informações adicionais
+ maxLength: 140
+ description: |
+ Campo livre para preenchimento das informações adicionais referente ao contributionPaymentMethod.
+
+ [Restrição] Obrigatório quando 'contributionPeriodicity' for igual 'OUTROS'.
+ additionalProperties: false
+ RiskPensionEnumIndemnityPaymentMethod:
+ type: string
+ description: |
+ Modalidade de pagamento da indenização, a considerar os domínios abaixo:
+ 1. Único
+ 2. Sob a forma de renda
+ 3. NA
+ enum:
+ - UNICO
+ - SOB_FORMA_RENDA
+ - NA
+ example: UNICO
+ RiskPensionEnumOtherGuaranteedValues:
+ type: string
+ description: |
+ 1. Saldamento
+ 2. Benefício Prolongado
+ 3. Não se aplica
+ 4. NA
+ enum:
+ - SALDAMENTO
+ - BENEFICIO_PROLONGADO
+ - NAO_APLICA
+ - NA
+ example: SALDAMENTO
+ RiskPensionEnumProfitModality:
+ type: string
+ description: |
+ Modalidade de pagamento da indenização.
+ enum:
+ - PAGAMENTO_UNICO
+ - FORMA_RENDA
+ - NA
+ example: PAGAMENTO_UNICO
+ ResponseErrorMetaSingle:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ meta:
+ $ref: '#/components/schemas/MetaOnlyRequestDateTime'
+ MetaOnlyRequestDateTime:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - requestDateTime
+ properties:
+ requestDateTime:
+ description: "Data e hora da consulta, conforme especificação RFC-3339, formato UTC."
+ type: string
+ maxLength: 20
+ format: date-time
+ example: "2021-05-21T08:30:00Z"
+ OpenDataResponseError:
+ 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
+ pattern: '[\w\W\s]*'
+ maxLength: 255
+ detail:
+ description: Descrição legível por humanos deste erro específico
+ type: string
+ pattern: '[\w\W\s]*'
+ maxLength: 2048
+ additionalProperties: false
+ meta:
+ $ref: '#/components/schemas/OpenDataMeta'
+ additionalProperties: false
+ OpenDataMeta:
+ type: object
+ description: Meta informações referente à API requisitada.
+ required:
+ - totalRecords
+ - totalPages
+ properties:
+ totalRecords:
+ type: integer
+ format: int32
+ description: Número total de registros no resultado
+ example: 1
+ totalPages:
+ type: integer
+ format: int32
+ description: Número total de páginas no resultado
+ example: 1
+ additionalProperties: false
+ parameters:
+ 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
+ maximum: 2147483647
+ 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
+ responses:
+ OKResponseRiskCoveragePension:
+ description: Dados de previdência de risco obtidos com sucesso da instituição.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OKResponseRiskCoveragePension'
+ OKResponseSurvivorCoveragePension:
+ description: Dados de previdência de sobrevivência obtidos com sucesso da instituição.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OKResponseSurvivalCoveragePension'
+ 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/OpenDataResponseError'
+ NotFound:
+ description: O recurso solicitado não existe ou não foi implementado
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/schemas/OpenDataResponseError'
+ 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/OpenDataResponseError'
+ TooManyRequests:
+ description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite de requisições concorrentes foi atingido.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/schemas/OpenDataResponseError'
+ InternalServerError:
+ description: Ocorreu um erro no gateway da API ou no microsserviço
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/schemas/OpenDataResponseError'
+ SiteIsOverloaded:
+ description: 'O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento.'
+ content:
+ application/json; charset=utf-8:
+ schema:
+ $ref: '#/components/schemas/ResponseErrorMetaSingle'
diff --git a/swagger-apis/pension/index.html b/swagger-apis/pension/index.html
index 36e9ddfed..f9b97cb8e 100644
--- a/swagger-apis/pension/index.html
+++ b/swagger-apis/pension/index.html
@@ -47,8 +47,9 @@
const ui = SwaggerUIBundle({
urls: [ {"name": "1.0.0-rc1.0", "url": "./1.0.0-rc1.0.yml"},
{"name": "1.0.0-rc2.0", "url": "./1.0.0-rc2.0.yml"},
- {"name": "1.0.0-rc3.0", "url": "./1.0.0-rc3.0.yml"}],
- "urls.primaryName": "1.0.0-rc3.0", // default spec
+ {"name": "1.0.0-rc3.0", "url": "./1.0.0-rc3.0.yml"},
+ {"name": "1.0.0", "url": "./1.0.0.yml"}],
+ "urls.primaryName": "1.0.0", // default spec
dom_id: '#swagger-ui',
deepLinking: true,
supportedSubmitMethods:[],