Configuração de Inicialização do Hosted Widget (OFDA)

Com o Hosted Connect Widget (OFDA) da Belvo, você pode configurar quais links criar e as informações que deseja mostrar no widget. Isso inclui:

tipo de links a serem criados (access_mode)
identificador adicional para o link (external_id)
quais países exibir (country_codes)
instituições a serem exibidas (institutions)
tipos de instituições a serem exibidos (institution_types)
idioma do widget (locale)
desativar o diálogo de saída (show_close_dialog)
desativar a pesquisa de saída (show_abandon_survey)

Defina o tipo de link criado

Você pode definir o tipo de link que deseja que o widget crie. Você pode escolher criar links recurrent ou single. Por padrão, o access_mode é definido como recurrent.

Instruções

Para definir qual tipo de link criar, basta adicionar single ou recurrent à chave access_mode.

Access Mode

https://widget.belvo.io/
    ?access_token={access_code}
    &access_mode=single

Leia mais sobre nossos diferentes tipos de links aqui: diferença entre link single e recurrent.

Adicionar um identificador adicional para o link

Você pode adicionar um identificador adicional para ser associado ao link no banco de dados da Belvo. Para mais informações, veja nosso artigo sobre criação de Links.

O external_id que você fornecer:

deve ser um ID único para cada usuário no seu banco de dados.
deve ter pelo menos três caracteres.
pode ser composto apenas por letras, números, hífens (-) e underscores (_).
não pode conter nenhuma informação pessoalmente identificável sobre o usuário (email, nome, número de telefone, número de cartão de crédito, etc.).

Informação pessoalmente identificável com `external_id`

Se você usar qualquer informação pessoalmente identificável no seu external_id, a Belvo definirá o external_id como null. Assim, você não poderá filtrar seus links por esse external_id.

Instruções

Para definir qual tipo de link criar, basta adicionar um ID único à chave external_id.

External ID

https://widget.belvo.io/
	?access_token={access_code}
    &external_id=HJLSI-897809

Defina quais países exibir

Você pode definir de quais países os usuários podem selecionar instituições. Por padrão, o widget exibe todos os países suportados. Os países suportados são:

BR para 🇧🇷 Brasil

Instruções
Para definir qual país exibir, basta adicionar BR (somente letras maiúsculas) à chave country_codes.

Country Code

https://widget.belvo.io/
    ?access_token={access_code}
    &country_codes=BR

Selecione uma ou mais instituições para exibir

Você pode optar por iniciar o widget já na página de login de uma instituição específica ou exibir apenas instituições selecionadas. Por padrão, o widget exibe todas as instituições suportadas.

Instruções
Para definir uma ou mais instituições para exibir no widget, basta adicioná-las à chave institutions.

Exibição de Instituições

## Para exibir apenas uma instituição:
https://widget.belvo.io/
    ?access_token={access_code}
    &institutions=ofbancodobrasil_br_retail

## Para exibir mais de uma instituição:
https://widget.belvo.io/
    ?access_token={access_code}
    &institutions=ofbancodobrasil_br_retail,ofitau_br_retail

Se a combinação de institutions, institution_types e locale resultar em apenas uma instituição disponível para o usuário, então o widget exibe diretamente a página de login para essa instituição

Defina quais tipos de instituições exibir

Você pode escolher quais tipos de instituições mostrar no widget. Por padrão, o widget exibe todos os tipos de instituições suportados.

Escolha um ou mais dos seguintes tipos de instituições:

business para bancos empresariais (como Bradesco Business)
retail para bancos de varejo (como Santander Retail)

Instruções
Para definir quais instituições exibir no widget, basta adicionar um ou mais ao parâmetro institution_types.

Institution Types

https://widget.belvo.io/
    ?access_token={access_code}
    &institution_types=retail,business

Defina quais instituições exibir com base nos recursos do Belvo

Você pode escolher quais instituições exibir no widget com base nos recursos da API do Belvo que a instituição suporta.

Por exemplo, se você quiser exibir apenas instituições que suportam o recurso de portfólios de Investimento, você precisa usar este parâmetro. Por padrão, o widget exibe todas as instituições (exceto instituições de employment como o IMSS).

O widget avalia os recursos que você fornece como uma expressão AND. Por exemplo, se você adicionar ACCOUNTS e OWNERS ao parâmetro resources, então o widget exibirá apenas instituições que suportam tanto ACCOUNTS e OWNERS

Instruções
Para definir quais instituições exibir no widget com base nos recursos suportados, basta adicionar um ou mais recursos à chave resources.

Resources

https://widget.belvo.io/
    ?access_token={access_code}
    &resources=ACCOUNTS,OWNERS

Você pode escolher qual idioma o widget deve exibir. Por padrão, o widget é mostrado em Espanhol (ES).

Escolha um dos seguintes idiomas para o widget:

pt para 🇧🇷Português Brasileiro

Instruções
Para definir o idioma do widget, basta adicionar pt (somente letras minúsculas) à chave locale.

Locale

https://widget.belvo.io/
    ?access_token={access_code}
    &locale=pt

Desativar o diálogo de saída

Por padrão, quando o usuário tenta sair do widget, o Belvo exibe uma mensagem "tem certeza de que deseja sair do processo". No entanto, você pode desativar essa mensagem.

Instruções
Para desativar a mensagem de saída, basta adicionar false à chave show_close_dialog:

Close Dialog

https://widget.belvo.io/
    ?access_token={access_code}
    &show_close_dialog=false

Desativar a pesquisa de saída

Por padrão, quando o usuário sai do widget, o Belvo exibe uma pesquisa perguntando por que o usuário decidiu não continuar conectando sua conta. No entanto, você pode desativar essa pesquisa.

Instruções
Para desativar a pesquisa de saída, basta adicionar false à chave show_abandon_survey:

Exit Survey

https://widget.belvo.io/
    ?access_token={access_code}
    &show_abandon_survey=false