To get a session_id you need to create an appon Synaps Manager. Once you selected your service type, you will have to go in your "integration" tab and copy your Api-Key.
The Api-Key MUST NOT be stored in your frontend. You have to store it on your server and never on the client side. The only thing that should be exposed to the user is the session_id.
To create a session_id, you have to call the API related to the service you chose. For instance, if you chose Identity service, go to Identity > Sessions in the documentation.
Once you initliazed your session_id, you will have to init the SDK with your session_id and a session_service.
session_service must be replaced either by workflow or corporate
workflow - for know your customer
corporate - for know your business
By default, the SDK type is set to modal which means that need to implement the Verify with Synaps button to your page to make it work. However, you can set the type to embed, simply by passing it as an option while you declare the SynapsClient.
Synaps Web SDK (javascript) lets you know when the user has finished the workflow.
Flow finished
On completed onboarding, Synaps will trigger a callback.
1
Synaps.on('finish',()=>{
2
// Do something
3
});
Copied!
5. Customization
Custom colors
We give you the possibility to customize your workflow with your colors. You can set a primary color and a secondary color, it will create a verification flow tailored to your compliance needs and your brand.
To add primary and secondary colors, simply add colors with primary and secondary inside without the hashtag '#'.
With the code above, you will be able to execute the following easily. It will see synaps-identity-btn as the element to bind and once you will click on the button, it will shows the modal.
You can set a predefined language for your user. Synaps already take advantage of browser language to display the relevant language to the end-user but if your user has set up a language option to your website, you can definitely pass it as an option.
1
Synaps.init({
2
lang:"fr"// fr, en,
3
})
Copied!
Custom tiers
As explained before in the documentation, tiers is a simply way to divide your workflow into small pieces. It is very useful when you offer different features based on the verification level of your customer.
Tier System on WeStart
To create your own tier, check out the step-by-step guide