Onboarding Form

Introduction

This document describes the steps to take in order to embed the BTC Direct onboarding form widget in another website. It is aimed at developers that will implement this functionality.

Implementing the widget

In order to enable the widget in your website, the following script needs to be embedded. This script loads the widget from the BTC Direct CDN (Content Delivery Network) and initializes it automatically.

<script lang="js">
    (function (btc, d, i, r, e, c, t) {
        btc[r] = btc[r] || function() {
            (btc[r].q = btc[r].q || []).push(arguments)
        };
        c = d.createElement(i);
        c.id = r; c.src = e; c.async = true;
        c.type = 'module'; c.dataset.btcdirect = '';
        t = d.getElementsByTagName(i)[0];
        t.parentNode.insertBefore(c, t);
    })(window, document, 'script', 'btcdirect',
        'https://cdn.btcdirect.eu/onboarding/onboarding.js'
    );

    btcdirect('init', { token: 'API_KEY' });
</script>

If a valid key is provided, and the styling is added, it will result in the following:

Optional init call parameters

The init call, as described in Getting Started, can contain several key-value pairs to fine-tune the widget. The different options are described below.

Key	Type	Description	Default
returnUrl	string	The url that the user is redirected to after completing the onboarding process.	https://btcdirect.eu
userIdentifier	string	The identifier with which the user can automatically login after account creation. If no identifier is provided, one will be created by the widget.	Created by the widget

All widgets support selector, debug, locale and theme.

Additional calls to the widget

The widget accepts several calls to it with which additional information can be provided. These can be added to the script tag that loads the widget.

Locale

This call sets the locale for the application. This determines the way monetary values are displayed. For example 0 Euro’s in the EN-GB locale is displayed as “€0.00” whereas the NL-NL locale results in “€ 0,00”.

btcdirect('locale', { locale: 'en-GB' });