Guia de operação do diretório central

1. Introdução

O Open Insurance, ou Sistema de Seguros Aberto, é a possibilidade de consumidores de produtos e serviços de seguros, previdência complementar aberta e capitalização permitirem o compartilhamento de suas informações entre diferentes sociedades autorizadas/credenciadas pela SUSEP de forma segura, ágil, precisa e conveniente. Para entregar esses benefícios ao consumidor, o Open Insurance operacionaliza e padroniza o compartilhamento de dados e serviços por meio de abertura e integração de sistemas, com privacidade e segurança. Acesse o site oficial da SUSEP

Antes de Começar

Esse guia tem como objetivo demonstrar, de forma prática, a operação do Diretório Central do Open Insurance Brasil. Além disso, ele é complementar a outras documentações disponibilizadas pela governança e não faz parte do escopo quaisquer detalhamentos relacionados à experiência do usuário e desenvolvedor, definições de segurança e especificação de APIs. Todas as funcionalidades estão disponíveis em sandbox e podem ser testadas em: Open Insurance Brasil Sandbox Unexpected Error . Procedimentos em produção pendentes serão disponibilizados assim que possível. As ações aqui apresentadas podem ser realizadas tanto por administradores quanto por contatos técnicos primários e secundários. Para ilustrar este guia e tentar deixar as situações de uso mais palpáveis, foram criadas instituições e telas fictícias.

  • As instituições e marcas não são reais.

  • As telas desenvolvidas, os softwares e sites são meramente ilustrativos, para que seja possível ver um exemplo de como os requisitos e as recomendações podem ser aplicados em situações de uso real.

  • Nomenclaturas e imagens ilustrativas estão descritas na língua inglesa, devido sua ampla abrangência e por conter terminologia técnica que, em algumas situações, não dispõe de tradução literal. O ajuste do idioma no Diretório fica a critério do usuário, podendo ser ajustado a qualquer momento.

Tipos de Usuários

Neste exemplo, mostramos as diversas possibilidades suportadas de atribuições de função para um usuário cadastrado no Diretório.

 

 

 

 

 

 

buttons

Administrativo

Usuários com poderes de administração no Diretório, podendo realizar todas ações.

buttons

Operação

Usuários com permissão em ferramentas específicas no Diretório.

Plataforma

Usuários para gestão e operação das plataformas do ecossistema, como o Service Desk, Portal, Plataforma de Resolução de Disputas e Plataforma Centralizada (Ressarcimento).

Relação Organização vs. Marcas

Neste exemplo, mostramos as diversas possibilidades suportadas para se realizar cadastros de organizações no Diretório. Assim, uma organização pode ser cadastrada de forma independente ou pertencente a um conglomerado. Já as marcas são uma forma mais amigável, democrática e fácil para identificação das instituições participantes. Uma Marca de um conglomerado pode estar correlacionada a mais de uma Instituição Participante, assim como uma Instituição Participante pode estar correlacionada a mais de uma marca.

Importante: a Marca cadastrada no diretório será a mesma apresentada para escolha do usuário na Jornada de Compartilhamento de Dados e Iniciação de Pagamentos. As Instituições Participantes (ou organizações) também serão apresentadas em tela, apenas em caráter informativo. Para maiores detalhes, consulte o Guia de Experiência do Usuário.

 

Pontos de atenção no cadastramento de marca/authorisation server

  • Uma marca é representada por um Authorisation Server e o mesmo sempre deve ser cadastrado associado a uma organização.

  • O vinculo entre uma organização master (mãe) e uma organização que pertence ao conglomerado é realizado via preenchimento do campo Parent Organization Reference ID no cadastro da organização filha, informando o CNPJ da organização mãe (caso seja necessário ajuste, favor entrar em contato via Service Desk em https://servicedesk.opinbrasil.com.br/servicePortal).

  • Quando a estrutura for de um conglomerado (uma organização master e uma ou mais organizações relacionadas) é recomendado o cadastro da marca na instituição mãe, caso as filhas venham a utilizar somente a mesma marca e arquitetura de autenticação. Importante ressaltar que, caso não seja cadastrada uma marca exclusiva para o organização filha, a mesma irá herdar a(s) marca(s) da organização mãe.

  • Caso uma marca pertença a uma organização filha, o cadastro deve ser exclusivamente realizado na filha.

  • Caso a mesma marca pertença a mais de uma organização, deve ser realizado um cadastro de Authorisation Servers para cada uma das organizações. É recomendado que as configurações dos Authorisation Servers sejam iguais, principalmente o campo Customer Friendly Server Name (marca).

  • Quando for necessário cadastrar uma marca exclusiva para uma organização filha, ela deixa de herdar a(s) marca(s) da organização mãe. Caso uma filha tenha que estar relacionada a uma marca exclusiva e também a da mãe, é necessário cadastrar a marca da mãe na filha.

 

Alternativas para atualização da marca

 

 

 

 

API Participants

Prefira por consumir dados da API Participants. Ela permite que o conteúdo seja fornecido ao usuário através de um servidor mais próximo, acelerando a distribuição e melhorando a experiência de consumo.

Webhook do Diretório

Inscreva-se no webhook do Diretório para receber os eventos de notificação das principais atualizações, como alteração de cadastro, atualização de marca, entre outros.

Cache local

Alguns participantes optam pela utilização de estruturas de cache local. Assim, recomenda-se a revalidação diária dos dados, de modo a mantê-los íntegros e com a versão mais recente possível.

 

 

 

 

Importante! Caso a instituição queira utilizar alguma chave forte, recomendamos utilizar o AuthorisationServerID. Os campos Customer Friendly Server Name e Description são especialmente suscetíveis a atualizações pelas organizações e não devem ser utilizados para esse fim.

 

Cadastramento Fase 1 x Fase 2

  • Se o cadastramento do Authorisation Server na Fase 1 já foi realizado com uma marca válida para a Fase 2, é necessário cadastrar os recursos de Fase 2 no mesmo Authorisation Server, mantendo o Customer Friendly Server Name (marca) da Fase 1.

  • Se o cadastramento do Authorisation Server na Fase 1 não foi realizado com uma marca válida para a Fase 2: é necessário atualizar o Customer Friendly Server Name (marca) para a Fase 2 e cadastrar os recursos de Fase 2 no mesmo.

  • Os recursos da Fase 1 devem estar declarados em pelo menos um Authorisation Server do participante válido para a Fase 2.

  • Após esse processo, caso a instituição venha a ter Authorisation Servers / marcas oferecendo recursos exclusivos de fase 2, recomenda-se a criação de novos registros sem os recursos de Fase 1.

2. Registrando um usuário no diretório

Para acessar o Diretório de participantes você precisa estar registrado com um usuário válido. Esta seção descreve as etapas necessárias para realizar o registro de um novo usuário.

ETAPA 1: Registrando um usuário no Diretório

Requisitos

  1. No navegador, digite a URL de acordo com o ambiente a ser acessado:

    Sandbox: Open Insurance Brasil Sandbox Unexpected Error

    Produção: Open Insurance Brasil Unexpected Error

  2. Clique no link Register

3. Na tela Register for an account, preencha os campos do formulário.

 

4. Clique no botão Register

Nota: E-mails sociais não são permitidos. Você deve utilizar um endereço de e-mail válido da instituição. O cadastro pode ser realizado por qualquer colaborador da organização, identificado aqui como um Iniciador de Cadastro, podendo esse ser tanto um contato administrativo quanto técnico da instituição.

Nome do campo

Descrição

Exemplo

Nome do campo

Descrição

Exemplo

First Name

Deve ser preenchido com o primeiro nome do usuário.

Maria

Family Name

Deve ser preenchido com o sobrenome do usuário.

Gomes

E-mail Address

Deve ser informado um endereço de e-mail corporativo.

maria.gomes@semicredi.com.br

Phone Number

Informar o número de telefone de contato do usuário.

+55 11 900000000

Password

Definir uma senha que deve conter entre 8 e 24 caracteres com letras maiúsculas, minúsculas, números e ao menos um carácter especial.

<senha_secreta>

Confirm Password

Repetir a mesma senha informada no campo anterior.

<senha_secreta>

National ID (CPF)

Informar o número de registro do Cadastro de Pessoa Física (CPF).

999999999-00

Do you possess an e-signature certificate?

O seletor deve estar assinalado caso o usuário possua um eCPF

 

ETAPA 2: Verificando os dados informados

Requisitos

  1. Nesta etapa, o Diretório irá enviar uma senha de uso único (OTP), que será encaminhada ao endereço de e-mail e número de telefone informado na etapa anterior.

  2. No e-mail recebido, selecione, copie e cole o código OTP no campo EMAIL VERIFICATION CODE.

  3. Na mensagem SMS recebida no telefone celular, copie o código OTP e informe no campo PHONE NUMBER VERIFICATION CODE.

  4. Clique no botão Verify.

Nota: Caso você não tenha recebido o e-mail com o código de confirmação, verifique sua caixa de SPAM e as políticas de bloqueio de mensagens. O envio das mensagens poderá sofrer algum atraso. Contudo, se o problema persistir, clique no botão Resend OTP para reenvio das mensagens.

ETAPA 3: Confirmando o progresso de registro

Requisitos

  1. Nesta etapa, faça o download de um aplicativo de autenticação de sua preferência. É possível utilizar o Google Authenticator, Microsoft Authenticator, LastPass Authenticator, 1Password entre outros.

  2. Digitalize o QR Code que aparece na página e no aplicativo de autenticação. Copie e cole a senha de uso único (OTP).

  3. Clique no botão Sign-In.

ETAPA 4: Confirmação da assinatura eletrônica

Requisitos

  1. Nesta etapa, será enviado um e-mail contendo um link para análise e assinatura do Termo de Aceite.

  2. Selecione e copie o código de acesso apresentado na janela Upload e-signature confirmation.

  3. Na mensagem recebida na caixa de entrada em nome da DocuSign, clique no link ANALISAR DOCUMENTO. Ao clicar, você será redirecionado para o website da DocuSign.

  4. No navegador, cole o valor copiado no passo 2 no campo Código de acesso.

  5. Clique no botão Validar.

ETAPA 5: Análise e confirmação do Termo de Aceite

Requisitos

  1. Nesta etapa, no website da DocuSign, clique no botão Continuar.

  2. Role o documento para baixo e, na página seguinte, clique no ícone Rubricar. No final das páginas, clique no ícone Assinar.

  3. Clique no botão Concluir.

  4. Na janela "Salvar uma cópia do seu documento", você pode se inscrever para obter uma conta DocuSign gratuita e assinar todos os seus documentos eletronicamente. Nesta janela, também é possível clicar no ícone Fazer Download e baixar uma cópia do documento assinado.

  5. Clique no botão Submeter. Ao clicar no botão Submeter, você aceita os Termos e Condições e reconhece que seus dados serão utilizados conforme descrito na Política de Privacidade da DocuSign.

  6. Na caixa de entrada, você receberá um e-mail enviado pela DocuSign contendo uma cópia do documento Termo de Aceite assinado eletronicamente.

  7. Retorne ao Diretório e, na janela Upload esignature confirmation, clique no botão Check status. Se todas as etapas anteriores forem validadas com sucesso, você será automaticamente redirecionado à página inicial do Diretório.

3. Acessando uma Organisation

Esta seção descreve as etapas necessárias para exibir detalhes de uma organização.

ETAPA 1: Exibindo detalhes de uma organização

Requisitos

  1. No Diretório, localize e selecione a sua organização.

  2. Revise as informações previamente cadastradas.

Nota: Os cadastrados foram realizados de forma antecipada a partir de informações fornecidas junto a SUSEP. É fundamental que as organizações verifiquem as informações cadastradas. Caso exista alguma divergência, entre em contato pelo e-mail secretariado@opinbrasil.com.br .

Nome do campo

Descrição

Exemplo

Nome do campo

Descrição

Exemplo

Status

Define o estado atual do cadastro, se está ativo ou não.

Active

Organisation Name

Deve ser informado o nome da organização.

Seg. Semicredi S.A.

Registration Number-CNPJ

Deve ser informado o número de Cadastro Nacional da Pessoa Jurídica (CNPJ) da organização.

22.222.222/0002-22

Date of Creation

Data de criação do registro de cadastro da organização.

2021-01-07T11:13:08.531Z

Company Registrar

 

Cadastro Nacional da Pessoa Jurídica

Organisation ID

Identificador da organização. Esta informação será gerada automaticamente.

cdc674fd-b019-5110-af5d-0268ed8227371

Parent Organisation Reference ID

Deve ser informado o número de Cadastro Nacional da Pessoa Jurídica (CNPJ) da organização mãe para casos em que seja necessária a constituição de um conglomerado. A seção de Cadastramento de conglomerados ilustra este cenário em mais detalhes.

11.111.111/0001-11

Legal Name

Deve ser informado o nome legal de cadastro da instituição.

Seguradora Semicredi S.A.

Address Line 1

Deve ser informado o logradouro da organização.

Rua ABC 123

Address Line 2

Deve ser informado o logradouro da organização.

Cidades Monções

City

Deve ser informada a cidade da organização.

São Paulo, SP

Country

Deve ser informado o país da organização.

BR

Cadastramento de Conglomerado

No diretório de participantes há o conceito de conglomerado. Assim, uma organização mãe poderá ser referenciada em um cadastro de uma organização filha atribuindo-se o CNPJ da organização mãe no campo PARENT ORGANISATION REFERENCE ID da organização filha.

Importante: se a sua organização faz parte de um conglomerado, é fundamental referenciar as organizações filhas com a organização mãe.

4. Cadastrando contatos

Após o onboarding da instituição e do representante da mesma, é necessário realizar o cadastro da equipe de contatos de notificação no Diretório Central. Esses contatos são para possíveis comunicações entre os participantes e a estrutura central.

ETAPA 1: Cadastrando um novo contato

Requisitos

  1. No Diretório, localize e selecione a sua organização.

  2. Selecione o menu Contacts e clique no botão New Contact.

  3. Na janela New Contact preencha os campos do formulário. A tabela a seguir apresenta cada um dos campos em mais detalhes.

  4. Clique no botão Save.

Nota: Os usuários de notificação não possuem ações dentro do Diretório e nas demais plataformas do perímetro central.

Nome do campo

Descrição

Exemplo

Nome do campo

Descrição

Exemplo

Contact Type*

Tipo do contato (Business/Negócio, Technical/Técnico, Billing/Cobrança, Incident/Incidente e Security/Segurança).

Incident

Department

Deve ser informado o departamento do contato.

Operações de TI

First Name

Deve ser informado o primeiro nome do contato.

Maria

Last Name

Deve ser informado o sobrenome do contato.

Gomes

E-mail*

O endereço de e-mail do contato.

maria.gomes@semicredi.com.br

Phone Number*

Deve ser informado o número de telefone do contato.

+55 51 900000000

Additional Information

Deve ser informado o e-mail para o grupo de notificação do contato.

openinsurance@semicredi.com.br

PGP Public Key

Deve ser preenchido com uma chave alfanumérica para comunicação de dados de incidentes de segurança entre instituições.

Como esta chave tem extensão muito grande para adicionar como exemplo, segue link para documentações para documentações que definem a chave PGP (RFC 488).

Address Line 1

Deve ser informado o endereço (Rua, Avenida ou Alameda).

Rua ABC 123

Address Line 2

Deve ser informado o bairro.

Cidades Monções

City

Deve ser informado a cidade de domicílio.

São Paulo

Post Code

Deve ser informado o código portal.

99.999-99

Country

Deve ser informado o país de domicílio.

Brasil

(*) Campo obrigatório

DETALHAMENTO DOS TIPOS DE CONTATO

Nome do campo

Descrição

Nome do campo

Descrição

Business/Negócio

Contato responsável pela gestão de negócio do Open Insurance na instituição.

Technical/Técnico

Contato para tratativa de problemas técnicos de performance, disponibilidade e em relação a APIs de forma geral.

Billing/Cobrança

Contato responsável pela cobrança dos custos da estrutura central do Open Insurance Brasil.

Incident/Incidente

Contato responsável pelo atendimento de incidentes relacionados ao Open Insurance na instituição.

Security/Segurança

Contato para tratativas relacionadas a problemas de caráter de segurança como DCR, certificados, entre outros.

Nota: É de inteira responsabilidade da instituição manter os contatos sempre atualizados para que a comunicação entre as instituições participantes não seja prejudicada.

5. Cadastrando reivindicações de domínio de autoridade

Esta seção explica as etapas para cadastrar reivindicações de domínio de autoridade.

ETAPA 1: Cadastrando uma nova reivindicação de domínio

Requisitos

  1. No Diretório, localize e selecione a sua organização.

  2. Selecione o menu Authority Domain Claims e clique no botão New Domain Claim.

  3. Na janela New Authority Domain Claim preencha os campos do formulário. A seguir serão apresentados maiores detalhes sobre os campos.

  4. Clique no botão Save.

Nome do campo

Descrição

Exemplo

Nome do campo

Descrição

Exemplo

Authority Name*

Informe o nome da autoridade.

Seguradora Semicredi

Authorisation Domain Name*

Informe o nome de domínio de autorização.

Open Insurance Brasil

Authority ID

Exibe o identificador de autoridade única. Esta informação será gerada automaticamente.

5360d5bf-5024-47cd-bd18-daab08df38ba

Registration ID

ID de registro de reivindicação de domínio exclusivo. Não é necessário preencher esta informação.

CNPJ-OIB

(*) Campo obrigatório

6. Cadastrando reivindicações autoridade

Esta seção explica as etapas para cadastrar reivindicações de autoridade e como adicionar usuários com suas respectivas funções que serão desempenhadas pela organização dentro do Open Insurance.

Nome da modalidade no diretório

Descrição

Nome da modalidade no diretório

Descrição

DADOS

Instituição transmissora e/ou receptora de dados é a instituição que sendo:

  • Transmissora de dados: instituição participante que compartilha os dados com a instituição receptora;

  • Receptora de dados: instituição participante que apresenta solicitação de compartilhamento à instituição transmissora para recepção dos dados.

Nota: As modalidades assumidas pelos participantes no âmbito do Open Insurance são auto declaratórias e podem ser exercidas simultaneamente. Contudo, tais modalidades deverão estar em conformidade com o modelo de negócio do participante e estarão sujeitas à verificação pela fiscalização da SUSEP, especialmente com relação ao cumprimento do princípio da reciprocidade no compartilhamento de dados no Open Insurance Brasil.

ETAPA 1: Cadastrando uma nova reivindicação de função

Requisitos

  1. Necessário realizar a seção "Cadastrando reivindicações de domínio de autoridade".

  2. No Diretório, localize e selecione a sua organização.

  3. Selecione o menu Authority Domain Role Claims e clique no botão New Role Claim.

  4. Na janela New Authority Domain Role Claim preencha os campos do formulário. A seguir serão apresentados os campos em mais detalhes.

  5. Clique no botão Save.

Nome do campo

Descrição

Exemplo

Nome do campo

Descrição

Exemplo

Authority Name*

Selecione o nome da autoridade.

Seguradora Semicredi

Authorisation Domain Name*

Selecione o nome de domínio de autorização.

Open Insurance Brasil

Role*

Selecione a modalidade (função).

 

Unique Technical Identifier

Selecione o identificador técnico único.

 

Registration ID*

Deve ser informado o número de registro único [ISPB-OBBFUNÇÃO]. Substitua o [ISPB] pelos primeiros 8 dígitos do seu CNPJ e o [FUNÇÃO] pela sigla da função que você está inserindo.

12345678-OBB-DADOS

(*) Campo obrigatório

ETAPA 2: Cadastrando um usuário de domínio de autorização

Requisitos

  1. Necessário ter realizado o cadastro de uma nova reivindicação de domínio.

  2. No Diretório, localize e selecione a sua organização.

  3. Selecione o menu Authority Domain Role Claims. será carregado um submenu na parte superior esquerda. Então, clique no link Authorisation Domain User.

  4. Na janela, clique no botão New Authorisation Domain User.

  5. Na janela New Authorisation Domain User, preencha os campos do formulário.

  6. Clique no botão Save.

Nome do campo

Descrição

Exemplo

Nome do campo

Descrição

Exemplo

Domain Name

É apresentado o domínio de autorização para o qual esta reivindicação de domínio está mapeada.

Open Insurance Brasil

Authorisation Domain Role

É apresentada a função mapeada para o domínio de autorização.

DADOS

System*

Selecione o sistema de contato: Directory, Service Desk, Dispute Resolution, Portal ou Centralized Platform. Para obter mais detalhes, verifique em "Sistemas e Funções de um usuário/contato".

Directory

Contact Role*

Selecione o papel assumido pelo contato. Para obter mais detalhes, verifique em "Sistemas e Funções de um usuário/contato".

PBC

E-mail*

Deve ser informado o endereço de e-mail corporativo do contato.

maria.gomes@semicredi.com.br

(*) Campo obrigatório

Sistemas e funções de um usuário/contato

Notas

  • Os perfis para os sistemas Directory, Service Desk e Dispute Resolution são obrigatórios.

  • Para obter mais detalhes dos poderes do usuário verifique a tabela "Modelo de Segurança".

  • Podem existir quantos contatos primários e secundários a instituição achar necessário.

  • Contatos primários podem acessar o Diretório e adicionar contatos secundários. Já os Contatos secundários não conseguem acessar o Diretório e, consequentemente, não conseguem adicionar novos usuários secundários.

  • A implementação dos poderes de acesso de contatos primários e secundários dependem e podem variar de plataforma.

7. Cadastrando servidores de autorização (authorisation servers)

Durante a jornada de consentimento do usuário, os receptores exibirão a marca e o servidor de autorização que está sendo solicitado o acesso aos dados do usuário. Esta seção descreve as etapas necessárias para cadastrar as marcas e os servidores de autorização da organização.

ETAPA 1: Criando um novo servidor de autorização

Requisitos

  1. No Diretório, localize e selecione a sua organização.

  2. Selecione o menu Authorisation Servers. No canto superior esquerdo será carregado um submenu. Para cadastrar um novo Authorisation Server clique no botão New Authorisation Server localizado no lado direito da tela.

  3. Na janela New Authorisation Server, preencha os campos do formulário. A seguir serão apresentados cada um dos campos em mais detalhes. Atenção 1: Tendo em vista a ausência de análise de impacto para o ecossistema da retirada de um Authorisation Server, recomenda-se que os(as) responsáveis por consentimentos não sejam retirados do diretório até a expiração/revogação dos consentimentos pelos quais é responsável. Atenção 2: Caso a instituição queira utilizar alguma chave forte, recomendamos utilizar o AuthorisationServerID. Os campos Customer Friendly Server Name e Description são especialmente suscetíveis a atualizações pelas organizações e não devem ser utilizados para esse fim.

Nome do campo

Descrição

Exemplo

Nome do campo

Descrição

Exemplo

Customer Friendly Server Name*

Deve ser definido o valor da marca que será exibido no receptor. Apresentar seu nome por inteiro, sem abreviações, de forma a ser reconhecido pelo cliente e aderente a interfaces menores.

  • Limite de caracteres: 40 (padrão do campo)

Para mais informações sobre marca, consulte o Guia de Experiência de Usuário.

Semicredi

OpenID
Discovery
Document URI*

O URI para a localização do documento de descoberta OpenID.

https://www.semicredi.com.br/.well-known/openidconfiguration

Payload Signing
Certificate URI*

O URI para a localização do certificado de assinatura.

https://www.semicredi.com.br/jwks

(*) Campo obrigatório

Nome do campo

Descrição

Exemplo

Nome do campo

Descrição

Exemplo

Customer Friendly Logo URI*

Deve ser definida a URI para o logotipo da marca. Para obter mais detalhes sobre formato, dimensão e peso máximo do arquivo consulte o Guia de Experiencia Fase 2.

https://wwww.semicredi.com.br/logo.svg

Developer Portal URI

O URI do portal do desenvolvedor.

https://developers.semicredi.com.br

Terms Of Service URI

A URI de localização do documento de termos e serviços da organização.

https://wwww.semicredi.com.br/tos.html

Notification Webhook Endpoint

Endpoint do Webhook de notificação. A seção Configurando Eventos de Notificação no Diretório descreve esta configuração em mais detalhes.

https://webhook.site/9d84a827-c200-4170-b0f8-f830170037bb

Description*

Esse é um texto de marcação onde deverá ser descrita a marca, trazendo informações adicionais para que o cidadão não tenha dúvidas sobre a escolha feita.

  1. Limite de caracteres: 256 (padrão do campo).

  2. Não deve ser permitido que a descrição traga links.

  3. Orientações sobre o que pode conter:

  • Texto institucional de apresentação.

  • Desde quanto atua.

  • Diferenciais de atuação.

  • Canais de atendimento.

“A instituição Semicredi atua desde 1999 sendo uma das maiores seguradoras do Brasil, seja na web ou pelo App oferecemos produtos para sua família, empresa, carro e casa.”

Nota: O campo Customer Friendly Logo URI é o que a receptora deverá utilizar para apresentar a logomarca da transmissora.

(*) Campo obrigatório

Detalhamento do Logotipo

O logotipo das instituições participantes deverá ser aplicado no Portal do Cidadão e também poderá ser aplicado no redirecionamento entre instituições durante a Jornada de Compartilhamento de Dados. Por isso foram deliberadas práticas para uso e disponibilização:

  • Utilizar preferencialmente logotipo prioritário, que os clientes reconheçam nos canais.

  • Versão reduzida do logo, símbolo ou favicon de site.

  • Enviar arquivo SVG contendo a área de proteção do logo da instituição para garantir a leitura e o espaçamento correto.

  • Formato de envio:

 SVG
 Dimensão mínima: 512px x 512px
 Sem sombra

  • Peso máximo do arquivo: 1 mega.

ETAPA 2: Cadastrando certificação de segurança no servidor

Requisitos

  1. No Diretório, localize e selecione a sua organização.

  2. Selecione o menu Authorisation Servers. Depois selecione o servidor de autorização que deseja. Após selecionar, vá no submenu do lado superior esquerdo e clique em Server Certifications.

  3. Dentro dessa área, para cadastrar uma nova certificação, clique no botão Add New Certification localizado no lado direito da tela.

  4. Na janela New certification preencha os campos do formulário. A seguir serão apresentados os campos em mais detalhes.

As informações da certificação do Authorisation Server são referentes à certificação FAPI obtida através da OpenID Foundation. Dentro do site é possível encontrar uma tabela Open Insurance Brazil (Based on FAPI 1 Advanced Final) que contém as informações que devem ser refletidas no formulário para adição da certificação de segurança.

Nome do campo

Descrição

Exemplo

Nome do campo

Descrição

Exemplo

Certification
type*

O tipo de certificação que foi efetuada com a OpenID Foundation – Deve ser adicionado ao menos uma certificação Redirect (FAPI) e uma DCR.

Redirect
DCR
CIBA – certificação ainda não disponível

Certification
type variant*

As variantes dependem do tipo de certificação escolhida.

Dentro da tabela da OpenID Foundation, cada coluna representa as possíveis variações nas certificações.
Para a certificação DCR, a instituição deve avaliar se certificou utilizando APIs de Dados do consumidor – Unsigned, ou de Pagamentos - Signed.

Profile
version*

A versão da certificação selecionado – Campo livre, apenas para controle da própria instituição.

1

Certification
payload*

O URI que aponta para o arquivo hospedado pela OpenID Foundation com o pacote de certificação. Formato zip.

https://openid.net/wordpresscontent/uploads/2021/08/BR-OB_Adv._OP_MTLSexemplo.zip

Start date of certification*

A data de certificação inicial – é a mesma data que consta na tabela da OpenID Foundation. Formato dd/mm/yyyy

09/05/2022

(*) Campo obrigatório

8. Cadastrando recursos de uma API (endpoints)

Esta seção explica as etapas para cadastrar os endpoints de recursos de uma API.

Cadastramento de Recursos

Para cada uma das famílias de APIs devem ser adicionados todos os endpoints disponíveis. Segue abaixo um exemplo de disponibilização do cadastramento de recursos:

Nota: Na Fase 2 o padrão de cadastramento continua como na Fase 1. Seguem, aqui, alguns pontos de atenção:

  • Na API de consentimento é necessário apenas o cadastramento de uma entrada para o GET e o DELETE;

  • A API de customers foi dividida em duas famílias para facilitar o consumos pelos receptores. Customers-business onde é cadastrado os Endpoints PJ e customers-personal onde será cadastrado os endpoints PF. Cabendo aqui o cadastramento conforme a disponibilização do produto pela instituição;

Tabela Exemplo Recursos Fase 1

Observação: a tabela acima não é exaustiva, ou seja, não contém todas as APIs da Fase 1 para o Open Insurance Brasil.

Tabela Exemplo Recursos Fase 2

Observação: a tabela acima não é exaustiva, ou seja, não contém todas as APIs da Fase 2 para o Open Insurance Brasil.

ETAPA 1: Cadastrando um novo recurso de uma API

Requisitos

  1. No Diretório, localize e selecione a sua organização.

  2. Selecione o menu Authorisation Servers e clique no link do servidor de autorização na qual se deseja cadastrar os recursos.

  3. No canto superior esquerdo da página clique em API Resources.

  4. Na página que será carregada, clique no botão New API Resources para abrir a janela New API Resource.

  5. Na janela New API Resource, clique na caixa de seleção API Family Type e selecione uma das opções disponíveis.

  6. No campo ao lado, em Version especifique o valor apropriado utilizando versionamento semântico (major.minor.patch, exemplo: 1.0.7)

  7. No campo Certification URI é necessário informar a URI onde se encontra a localização do certificado publicado no GitHub. Este preenchimento é obrigatório para famílias de APIs a partir da Fase 2.

  8. Clique no botão Save.

    Nota: No ambiente de Sandbox do Diretório, caso não exista uma certificação, é possível incluir um endereço para testes: https://openinsurance-brasil.github.io/teste.zip

  9. De volta à tela API Resources, informe URI principal no campo API Discovery Endpoints e, em seguida, pressione a tecla Enter.

  10. Para cada uma das famílias de APIs repita os passos 4 a 8.

Nota: Todos os endpoints deverão ser preenchidos, incluindo os respectivos recursos. Para obter mais detalhes sobre o padrão do endpoints e versão consulte o Portal do Desenvolvedor do Open Insurance

9. Cadastrando declarações de software (software statements)

Aqui apresentamos a configuração necessária para criar uma nova declaração de software no Diretório.

ETAPA 1: Criando uma nova declaração de software

Requisitos

  1. No Diretório, localize e selecione a sua organização.

  2. Selecione o menu Software Statements e clique no botão New Software Statement.

  3. Na janela New Software Statement preencha os campos do formulário. A seguir serão apresentados cada um dos campos em mais detalhes.

Nome do campo