openapi: 3.0.0 info: title: APIs Open Data do Open Insurance Brasil description: API de informações de dados do produto Financa Locaticia. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.. version: 1.0.0 contact: url: 'https://http://novosite.susep.gov.br' servers: - url: 'https://api.organizacao.com.br/open-insurance/products-services/v1' description: Servidor de Producao - url: 'https://api.organizacao.com.br/open-insurance/products-services/v1' description: Servidor de Homologacao tags: - name: "Financa Locaticia" paths: /rent-guarantee/: get: tags: - RentGuarantee summary: Obtem a lista dos produtos do tipo RentGuarantee description: "Obtem a lista dos produtos do tipo RentGuarantee" operationId: "getRentGuarantee" parameters: - $ref: "#/components/parameters/cache-Control" - $ref: "#/components/parameters/content-Security-Policy" - $ref: "#/components/parameters/content-Type" - $ref: "#/components/parameters/strict-Transport-Security" - $ref: "#/components/parameters/x-Content-Type-Options" - $ref: "#/components/parameters/x-Frame-Options" - $ref: "#/components/parameters/page" - $ref: "#/components/parameters/pageSize" responses: '200': description: Dados dos produtos de RentGuarantee content: application/json: schema: $ref: '#/components/schemas/ResponseRentGuaranteeList' '204': $ref: '#/components/responses/NoContent' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '405': $ref: '#/components/responses/MethodNotAllowed' '406': $ref: '#/components/responses/NotAcceptable' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' default: description: Dados dos produtos de API de informações de dados do produto Financa Locaticia. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados. content: application/json: schema: $ref: '#/components/schemas/ResponseRentGuaranteeList' components: schemas: ResponseRentGuaranteeList: type: object required: - data - links - meta properties: data: type: object required: - brand properties: brand: $ref: '#/components/schemas/RentGuaranteeBrand' links: $ref: '#/components/schemas/Links' meta: $ref: '#/components/schemas/Meta' RentGuaranteeBrand: type: object description: Organizacao controladora do grupo. required: - name - companies properties: name: type: string description: Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes. maxLength: 80 example: ACME Group Seguros companies: $ref: '#/components/schemas/RentGuaranteeCompany' RentGuaranteeCompany: type: array items: description: Informações referente a sociedade a qual a marca pertence. required: - name - cnpjNumber - products properties: name: type: string description: Nome da sociedade pertencente à marca. maxLength: 80 example: ACME Seguros cnpjNumber: type: string description: CNPJ da sociedade pertencente à marca. maxLength: 14 example: "12345678901234" products: $ref: '#/components/schemas/RentGuaranteeProduct' RentGuaranteeProduct: type: array description: Lista de produtos de uma empresa. items: type: object required: - name - code - coverages - traits - allowApartPurchase - assistanceServices - validity - premiumPayment - termsAndConditions - minimumRequirements properties: name: type: string description: Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade. maxLength: 80 example: Produto de Seguro code: type: string description: Código único a ser definido pela sociedade. maxLength: 100 example: "01234589-0" coverages: type: array items: type: object required: - coverage - coverageDescription - coverageAttributes properties: coverage: type: array items: type: string maxLength: 32 description: Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.10 do Anexo II." enum: [ NAO_PAGAMENTO_DE_13_ALUGUEL, DANOS_A_MOVEIS, DANOS_AO_IMOVEL, MULTA_POR_RESCISAO_CONTRATUAL, NAO_PAGAMENTO_DE_ALUGUEL, NAO_PAGAMENTO_DE_CONDOMINIO, NAO_PAGAMENTO_DE_CONTA_DE_AGUA, NAO_PAGAMENTO_DE_CONTA_DE_GAS, NAO_PAGAMENTO_DE_CONTA_DE_LUZ, NAO_PAGAMENTO_DE_ENCARGOS_LEGAIS, NAO_PAGAMENTO_DE_IPTU, PINTURA_DO_IMOVEL_INTERNA, PINTURA_DO_IMOVEL_EXTERNA, OUTRAS] coverageDescription: type: string maxLength: 3000 description: Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos coverageAttributes: $ref: '#/components/schemas/RentGuaranteeCoverageAttributes' allowApartPurchase: type: boolean description: Indicação se a cobertura permite contratação separada (por cobertura selecionada). example: true traits: type: boolean description: Indicação se o produto é classificado como destinado para cobertura de grandes riscos, sendo tal classificação de acordo com regulamentação específica example: true assistanceServices: $ref: '#/components/schemas/RentGuaranteeAssistanceServices' customerServices: type: array description: Rede de atendimento do seguro contratado. A considerar os domínios abaixo items: type: string maxLength: 17 example: LIVRE ESCOLHA enum: [REDE_REFERENCIADA , LIVRE_ESCOLHA] validity: $ref: '#/components/schemas/RentGuaranteeValidity' premiumPayment: $ref: '#/components/schemas/RentGuaranteePremiumPayment' termsAndConditions: $ref: '#/components/schemas/RentGuaranteeTerms' minimumRequirements: $ref: '#/components/schemas/RentGuaranteeMinimumRequirements' RentGuaranteeValidity: type: object required: - term properties: term: type: string maxLength: 23 example: ANUAL enum: [ANUAL, ANUAL_INTERMITENTE , PLURIANUAL, PLURIANUAL_INTERMITENTE, MENSAL, MENSAL_INTERMITENTE, DIARIO, DIARIO_INTERMITENTE, OUTROS] termOthers: type: string description: Campo livre para descrição por cada participante ao selecionar o domínio “Outros” no campo Prazo (acima). maxLength: 100 RentGuaranteePremiumPayment: type: array items: type: object required: - paymentMethod - paymentType properties: paymentMethod: type: string description: Metodo de pagamento maxLength: 33 enum: [CARTAO_DE_CREDITO, CARTAO_DE_DEBITO, DEBITO_EM_CONTA_CORRENTE, DEBITO_EM_CONTA_POUPANCA, BOLETO_BANCARIO, PIX, CONSIGNACAO_EM_FOLHA_DE_PAGAMENTO, PONTOS_DE_PROGRAMA_DE_BENEFICIO, OUTROS] paymentDetail: type: string maxLength: 100 description: Campo livre para descrição por cada participante ao selecionar o domínio “Outros” no campo Meio de pagamento (acima) paymentType: type: array description: Forma de pagamento items: type: string maxLength: 9 example: A_VISTA enum: [A_VISTA, PARCELADO] premiumRates: description: Distribuição de frequência relativa aos valores referentes às taxas cobradas, nos termos do Anexo III type: string maxLength: 1024 RentGuaranteeTerms: type: object description: Informações dos termos e condições conforme número do processo SUSEP. required: - definition properties: susepProcessNumber: type: string description: Número do processo SUSEP. maxLength: 20 example: 15414.622222/2222-22 definition: type: string description: Campo aberto (possibilidade de incluir uma url). maxLength: 1024 example: https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf RentGuaranteeAssistanceServices: type: array description: Agrupamento dos serviços de assistências disponíveis vinculado ao produto. items: type: object required: - assistanceServices properties: assistanceServices: type: boolean description: Indicação se o produto possui serviços de assistências complementares. example: true assistanceServicesPackage: type: array items: description: Para efeitos de comparabilidade considerar agrupamentos de serviços em 4 categorias example: ATE_10_SERVICOS enum: [ATE_10_SERVICOS, ATE_20_SERVICOS , ACIMA_20_SERVICOS, CUSTOMIZAVEL] complementaryAssistanceServicesDetail: type: string description: Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência maxLength: 1000 example: reboque pane seca chargeTypeSignaling: type: array items: description: Indicação se o pacote de assistência é gratuito ou contratado/pago. example: GRATUITO enum: [GRATUITO, PAGO] RentGuaranteeMinimumRequirements: type: object description: Requisitos mínimos. required: - contractType - minimumRequirementDetails - targetAudiences properties: contractType: type: array items: type: string maxLength: 10 enum: [COLETIVO, INDIVIDUAL] minimumRequirementDetails: type: string maxLength: 1024 description: Campo aberto contendo todos os requisitos mínimos para contratação (possibilidade de incluir URL). targetAudiences: type: array maxLength: 30 items: type: string example: PESSOA_NATURAL enum: [PESSOA_NATURAL, PESSOA_JURIDICA] RentGuaranteeCoverageAttributes: type: object description: Informações de cobertura do Seguro. required: - insuredParticipation properties: insuredParticipation: type: array description: "Indicação se a participação do segurado (por cobertura selecionada) é por:" items: type: string maxLength: 13 example: FRANQUIA enum: [FRANQUIA, POS, NAO_SE_APLICA, OUTROS] insuredParticipationOthers: type: string maxLength: 100 insuredParticipationDescription: type: string maxLength: 1024 description: Lista com descrição referente ao campo “Participação do Segurado” para cada cobertura." maxLMI: type: string maxLength: 1024 description: Lista com valor de LMI aceito pela sociedade para cada cobertura Links: type: object properties: self: type: string description: URL da página atualmente requisitada example: 'https://api.organizacao.com.br/open-insurance/products-services/v1' first: type: string description: URL da primeira página de registros example: 'https://api.organizacao.com.br/open-insurance/products-services/v1' prev: type: string description: URL da página anterior de registros example: 'https://api.organizacao.com.br/open-insurance/products-services/v1' next: type: string description: URL da próxima página de registros example: 'https://api.organizacao.com.br/open-insurance/products-services/v1' last: type: string description: URL da última página de registros example: 'https://api.organizacao.com.br/open-insurance/products-services/v1' Meta: type: object properties: totalRecords: type: integer description: Total de registros encontrados example: 10 totalPages: type: integer description: Total de páginas para os registros encontrados example: 1 required: - totalRecords - totalPages ResponseError: type: object required: - errors properties: errors: type: array minItems: 1 maxItems: 13 items: type: object required: - code - title - detail properties: code: description: Código de erro específico do endpoint type: string pattern: '[\w\W\s]*' maxLength: 255 title: description: Título legível por humanos deste erro específico type: string maxLength: 255 detail: description: Descrição legível por humanos deste erro específico type: string maxLength: 2048 requestDateTime: description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.' type: string maxLength: 2048 format: date-time example: '2021-08-20T08:30:00Z' 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 pageSize: name: page-size in: query description: Quantidade total de registros por páginas. schema: type: integer default: 10 minimum: 1 cache-Control: name: cache-control in: header description: Controle de cache para evitar que informações confidenciais sejam armazenadas em cache. required: true schema: type: string pattern: '[\w\W\s]*' content-Security-Policy: name: Content-Security-Policy in: header description: Campo para proteção contra ataques clickjack do estilo - drag and drop. schema: type: string pattern: '[\w\W\s]*' content-Type: name: content-Type in: header description: Especificar o tipo de conteúdo da resposta. schema: type: string pattern: '[\w\W\s]*' strict-Transport-Security: name: Strict-Transport-Security in: header description: Campo para exigir conexões por HTTPS e proteger contra certificados falsificados. schema: type: string pattern: '[\w\W\s]*' x-Content-Type-Options: name: X-Content-Type-Options in: header description: Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada. schema: type: string pattern: '[\w\W\s]*' x-Frame-Options: name: X-Frame-Options in: header description: Campo indica se o navegador deve ou não renderizar um frame. schema: type: string pattern: '[\w\W\s]*' securitySchemes: OpenId: type: openIdConnect openIdConnectUrl: 'https://auth.mockbank.poc.raidiam.io/.well-known/openid-configuration' OAuth2Security: type: oauth2 description: Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados. flows: authorizationCode: authorizationUrl: 'https://authserver.example/authorization' tokenUrl: 'https://authserver.example/token' scopes: financings: Escopo necessário para acesso à API. O controle dos endpoints específicos é feito via permissions. responses: NoContent: description: 'O recurso solicitado não existe ou não foi localizado.' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ResponseError' BadRequest: description: 'A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL.' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ResponseError' Forbidden: description: O token tem escopo incorreto ou uma política de segurança foi violada content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ResponseError' InternalServerError: description: Ocorreu um erro no gateway da API ou no microsserviço content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ResponseError' MethodNotAllowed: description: O consumidor tentou acessar o recurso com um método não suportado content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ResponseError' NotAcceptable: description: A solicitação continha um cabeçalho Accept diferente dos tipos de mídia permitidos ou um conjunto de caracteres diferente de UTF-8 content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ResponseError' NotFound: description: O recurso solicitado não existe ou não foi implementado content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ResponseError' TooManyRequests: description: 'A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ResponseError' Unauthorized: description: Cabeçalho de autenticação ausente/inválido ou token inválido content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ResponseError'