Generate Onboarding URL
Generates an unique URL for the desired onboarding,
Introduction
Generates an unique URL for desired onboarding, most of the values come from the previously created Session Token, most configurations that you might want attached to the generated URL such as configurationId
or ย redirectionUrl
must be send the previous Start onboarding step.
Check the fetch onboarding url API endpoint for a full reference of the endpoint's inputs and output.
Requirements
X-Incode-Hardware-Id
header is required with it's value set to yourSession Tokenapi-version
header is required and must be set to 1.0clientId
field in the query params. Provide yourclientId
Sample code
curl --location 'https://demo-api.incodesmile.com/0/omni/onboarding-url' \
--header 'Content-Type: application/json' \
--header 'api-version: 1.0' \
--header 'X-Incode-Hardware-Id: <TOKEN>' \
const axios = require('axios');
const params = new URLSearchParams({ clientId: <<clientId> });
const config = {
url: 'https://demo-api.incodesmile.com/0/omni/onboarding-url',
headers: {
'Content-Type': 'application/json',
'api-version': '1.0',
'X-Incode-Hardware-Id': <TOKEN>,
}
};
axios(config).then(function (response) {
const url = response.data.url;
console.log(url);
}).catch(function (error) {
console.log(error);
});
Updated 4 months ago
Whatโs Next