20/10/2025 Release Notes

20/10/2025 Release Notes

Release Notes 20/10/2025 do projeto Open Insurance Brasil

Publicação de versão Developing das APIs da fase 2

Publicação de versão Developing das APIs da fase 3

Publicação de versão Developing de API´s Fase 2

 

Acceptance And Branches Abroad - v2.0.0

Campo

Ajuste

Data da Certificação

Deductible/description

Ajuste do maxLength do campo, para 500 caracteres.

02/02/2026 até 03/04/2026

InsuranceAcceptanceAndBranchesAbroadClaim/denialJustificationDescription

Ajuste do maxLength do campo, para 500 caracteres.

02/02/2026 até 03/04/2026

InsuranceAcceptanceAndBranchesAbroadInsuredObject/typeAdditionalInfo

Ajuste do maxLength do campo, para 500 caracteres.

02/02/2026 até 03/04/2026

Intermediary/address

Alteração estrutural do campo Address:
Address:
        type: object
        description: 'dados do endereço'
        required:

  • flagPostCode

  • address

 

        properties:
          flagPostCode:
            type: string
            description: Indica se o endereço será nacional ou internacional
            enum:

  • NACIONAL

  • INTERNACIONAL

 

          address:
            description: endereço completo
            oneOf:

  • $ref: '#/components/schemas/NationalAddress'

  • $ref: '#/components/schemas/InternationalAddress'

02/02/2026 até 03/04/2026

InternationalAddress

Adicionar schema InternationalAddress:
InternationalAddress:
      type: object
      required:

  • type

  • name

  • number

  • townName

  • countrySubDivision

  • postCode

  • countryCode

 

      properties:
        type:
          type: string
          description: 'Tipo do logradouro'
          enum:[AEROPORTO, ALAMEDA, AREA, AVENIDA, CAMPO, CHACARA, COLONIA, CONDOMINIO, CONJUNTO, DISTRITO, ESPLANADA, ESTACAO, ESTRADA, FAZENDA, FEIRA, JARDIM, LADEIRA, LAGO, LAGOA, LARGO, LOTEAMENTO, NUCLEO, PARQUE, PASSARELA, PATIO, PRACA, QUADRA, RECANTO, RESIDENCIAL, RODOVIA, RUA, SETOR, SITIO, TRAVESSA, TRECHO, TREVO, VALE, VEREDA, VIA, VIADUTO, VIELA, VILA]
        name:
          type: string
          description: 'Nome do logradouro'
        number:
          type: string
          description: 'Número do logradouro'
          maxLength: 6
          pattern: '^[0-9]{1,6}$'
        addressComplementaryInfo:
          type: string
          maxLength: 30
          example: Fundos
          description: 'Alguns logradouros ainda necessitam ser especificados por meio de complemento.'
        district:
          type: string
          maxLength: 50
          example: 'Centro'
          description: 'Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas'
        townName:
          type: string
          maxLength: 50
          pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
          example: Marília
          description: |
                  Designação da cidade ou município no qual o endereço está localizado.
        countrySubDivision:
          type: string
          maxLength: 50
          pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
          example: New York
          description: |
                  Designação do estado no qual o endereço está localizado.
        postCode:
          type: string
          maxLength: 11
          example: '17500001A'
          description: |
                  Código de Endereçamento Postal: Composto por um conjunto numérico ou alfanumérico.
        countryCode:
          $ref: '#/components/schemas/EnumCountryCode'

02/02/2026 até 03/04/2026

NationalAddress

Adicionar schema NationalAddress:
NationalAddress:
      type: object
      required:

  • type

  • name

  • number

  • townName

  • countrySubDivision

  • postCode

 

      properties:
        type:
          type: string
          description: 'Tipo do logradouro'
          enum: [AEROPORTO, ALAMEDA, AREA, AVENIDA, CAMPO, CHACARA, COLONIA, CONDOMINIO, CONJUNTO, DISTRITO, ESPLANADA, ESTACAO, ESTRADA, FAZENDA, FEIRA, JARDIM, LADEIRA, LAGO, LAGOA, LARGO, LOTEAMENTO, NUCLEO, PARQUE, PASSARELA, PATIO, PRACA, QUADRA, RECANTO, RESIDENCIAL, RODOVIA, RUA, SETOR, SITIO, TRAVESSA, TRECHO, TREVO, VALE, VEREDA, VIA, VIADUTO, VIELA, VILA]
        name:
          type: string
          description: 'Nome do logradouro'
        number:
          type: string
          description: 'Número do logradouro'
          maxLength: 6
          pattern: '^[0-9]{1,6}$'
        addressComplementaryInfo:
          type: string
          maxLength: 30
          example: Fundos
          description: 'Alguns logradouros ainda necessitam ser especificados por meio de complemento.'
        districtName:
          type: string
          maxLength: 50
          example: 'Centro'
          description: 'Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas'
        townName:
          type: string
          maxLength: 50
          pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
          example: Marília
          description: |
                  Localidade: O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado.
        ibgeTownCode:
          type: string
          pattern: '^\d{7}$|^NA$'
          maxLength: 7
          example: "1750000"
          description: |
            Código IBGE do município
        countrySubDivision:
          $ref: '#/components/schemas/EnumCountrySubDivision'
        postCode:
          type: string
          pattern: '^\d{8}$|^NA$'
          maxLength: 8
          example: '17500001'
          description: |
                  Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios. p.ex. '01311000'. Condicional ao preenchimento do FlagPostCode ser igual a "Nacional".
    

02/02/2026 até 03/04/2026

Payment/tellerIdOthers

Ajuste do maxLength do campo, para 500 caracteres.

02/02/2026 até 03/04/2026

PersonalInfo/address

Alteração estrutural do campo Address:
Address:
        type: object
        description: 'dados do endereço'
        required:

  • flagPostCode

  • address

 

        properties:
          flagPostCode:
            type: string
            description: Indica se o endereço será nacional ou internacional
            enum:

  • NACIONAL

  • INTERNACIONAL

 

          address:
            description: endereço completo
            oneOf:

  • $ref: '#/components/schemas/NationalAddress'

  • $ref: '#/components/schemas/InternationalAddress'

02/02/2026 até 03/04/2026

PrincipalInfo/address

Alteração estrutural do campo Address:
Address:
        type: object
        description: 'dados do endereço'
        required:

  • flagPostCode

  • address

 

        properties:
          flagPostCode:
            type: string
            description: Indica se o endereço será nacional ou internacional
            enum:

  • NACIONAL

  • INTERNACIONAL

 

          address:
            description: endereço completo
            oneOf:

  • $ref: '#/components/schemas/NationalAddress'

  • $ref: '#/components/schemas/InternationalAddress'

02/02/2026 até 03/04/2026

ResponseInsuranceAcceptanceAndBranchesAbroad/data/companies/cnpjNumber

Alteração do pattern para "[A-Z0-9]{12}\d{2}" conforme normativo da Receita Federal,  para comportar novo formato de CNPJ

02/02/2026 até 03/04/2026

schemas/xFapiInteractionId

Alterar o pattern do campo para "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"

02/02/2026 até 03/04/2026

parameters/xFapiInteractionId

Alterar o pattern do campo para "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"

02/02/2026 até 03/04/2026

personalInfo/birthDate

Remoção da obrigatoriedade. Tornar campo condicional à "1 - CPF ou 99 - Outros"

02/02/2026 até 03/04/2026

POS/description

Remoção da obrigatoriedade.

02/02/2026 até 03/04/2026

Auto - v2.0.0

Campo

Ajuste

Data da Certificação

frequentDestinationPostCode

Alterar o pattern do campo para: ^\d{8}$|^NA$

06/04/2026 até 05/06/2026

InsuranceAutoClaim/denialJustificationDescription

Ajuste do maxLength do campo, para 500 caracteres.

06/04/2026 até 05/06/2026

InsuranceAutoDeductible/description

Ajuste do maxLength do campo, para 500 caracteres.

06/04/2026 até 05/06/2026

InsuranceAutoInsuredObject/typeAdditionalInfo

Ajuste do maxLength do campo, para 500 caracteres.

06/04/2026 até 05/06/2026

InsuranceAutoPOS/description

Ajuste do maxLength do campo, para 500 caracteres.

06/04/2026 até 05/06/2026

Intermediary/address

Alteração estrutural do campo Address:
Address:
        type: object
        description: 'dados do endereço'
        required:

  • flagPostCode

  • address

 

        properties:
          flagPostCode:
            type: string
            description: Indica se o endereço será nacional ou internacional
            enum:

  • NACIONAL

  • INTERNACIONAL

 

          address:
            description: endereço completo
            oneOf:

  • $ref: '#/components/schemas/NationalAddress'

  • $ref: '#/components/schemas/InternationalAddress'

06/04/2026 até 05/06/2026

InternationalAddress

Adicionar schema InternationalAddress:
InternationalAddress:
      type: object
      required:

  • type

  • name

  • number

  • townName

  • countrySubDivision

  • postCode

  • countryCode

 

      properties:
        type:
          type: string
          description: 'Tipo do logradouro'
          enum:[AEROPORTO, ALAMEDA, AREA, AVENIDA, CAMPO, CHACARA, COLONIA, CONDOMINIO, CONJUNTO, DISTRITO, ESPLANADA, ESTACAO, ESTRADA, FAZENDA, FEIRA, JARDIM, LADEIRA, LAGO, LAGOA, LARGO, LOTEAMENTO, NUCLEO, PARQUE, PASSARELA, PATIO, PRACA, QUADRA, RECANTO, RESIDENCIAL, RODOVIA, RUA, SETOR, SITIO, TRAVESSA, TRECHO, TREVO, VALE, VEREDA, VIA, VIADUTO, VIELA, VILA]
        name:
          type: string
          description: 'Nome do logradouro'
        number:
          type: string
          description: 'Número do logradouro'
          maxLength: 6
          pattern: '^[0-9]{1,6}$'
        addressComplementaryInfo:
          type: string
          maxLength: 30
          example: Fundos
          description: 'Alguns logradouros ainda necessitam ser especificados por meio de complemento.'
        district:
          type: string
          maxLength: 50
          example: 'Centro'
          description: 'Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas'
        townName:
          type: string
          maxLength: 50
          pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
          example: Marília
          description: |
                  Designação da cidade ou município no qual o endereço está localizado.
        countrySubDivision:
          type: string
          maxLength: 50
          pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
          example: New York
          description: |
                  Designação do estado no qual o endereço está localizado.
        postCode:
          type: string
          maxLength: 11
          example: '17500001A'
          description: |
                  Código de Endereçamento Postal: Composto por um conjunto numérico ou alfanumérico.
        countryCode:
          $ref: '#/components/schemas/EnumCountryCode'

06/04/2026 até 05/06/2026

NationalAddress

Adicionar schema NationalAddress:
NationalAddress:
      type: object
      required:

  • type

  • name

  • number

  • townName

  • countrySubDivision

  • postCode

 

      properties:
        type:
          type: string
          description: 'Tipo do logradouro'
          enum: [AEROPORTO, ALAMEDA, AREA, AVENIDA, CAMPO, CHACARA, COLONIA, CONDOMINIO, CONJUNTO, DISTRITO, ESPLANADA, ESTACAO, ESTRADA, FAZENDA, FEIRA, JARDIM, LADEIRA, LAGO, LAGOA, LARGO, LOTEAMENTO, NUCLEO, PARQUE, PASSARELA, PATIO, PRACA, QUADRA, RECANTO, RESIDENCIAL, RODOVIA, RUA, SETOR, SITIO, TRAVESSA, TRECHO, TREVO, VALE, VEREDA, VIA, VIADUTO, VIELA, VILA]
        name:
          type: string
          description: 'Nome do logradouro'
        number:
          type: string
          description: 'Número do logradouro'
          maxLength: 6
          pattern: '^[0-9]{1,6}$'
        addressComplementaryInfo:
          type: string
          maxLength: 30
          example: Fundos
          description: 'Alguns logradouros ainda necessitam ser especificados por meio de complemento.'
        districtName:
          type: string
          maxLength: 50
          example: 'Centro'
          description: 'Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas'
        townName:
          type: string
          maxLength: 50
          pattern: '^[A-Za-z\sáâãéêíïóôõúçÁÂÃÉÍÏÓÔÕÚÇ]+$'
          example: Marília
          description: |
                  Localidade: O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado.
        ibgeTownCode:
          type: string
          pattern: '^\d{7}$|^NA$'          maxLength: 7          example: "1750000"          description: |            Código IBGE do município        countrySubDivision:          $ref: '#/components/schemas/EnumCountrySubDivision'        postCode:          type: string          pattern: '^\d{8}$|^NA$'          maxLength: 8          example: '17500001'          description: |                  Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios. p.ex. '01311000'. Condicional ao preenchimento do FlagPostCode ser igual a "Nacional".