Know Your Customer UI

Know Your Customer (KYC) UI is a simple user interface built on top of our Add Documents API.

Updates

We have a better version of our UI products in the works. For a better user experience, we recommend building out your own UI.

You can play with the demo right here: Business KYC | Personal KYC. All sandbox test documents would work.

Steps to deploying the KYC UI are the following:

1. Issue Public Key

At your backend, where you have stored client_id and client_secret securely, issue a public key with scope CLIENT|CONTROLS.

2. Issue OAuth Key

Issue an OAuth Key for the user, with scopes USER|GET and USER|PATCH.

3. Test the UI

Next step is to go to the KYC UI and see if everything is rendering appropriately.

Link (for sandbox): https://uat-uiaas.synapsefi.com/kyc
Link (for production): https://uiaas.synapsefi.com/kyc

GET Params needed in the URL

GET Param
Note

oauth_key

OAuth key of the user who needs to add new documents

public_key

Your public key

Android webviews

If you are rendering this component inside an Android webview, please make sure that you have DOM storage enabled settings.setDomStorageEnabled(true);

GET Params on redirect

GET Params returned on success_uri:

GET Param
Note

user_id

Synapse ID of the user

GET Params returned on failure_uri:

GET Param
Note

error_code

Error code from Errors Section

http_code

HTTP code from Errors Section

message

Reason for failure

user_id

Synapse ID of the user

Customizing the UI

You can customize the following things on the UI

Field
Comment

Color Palette

You can update the color with any hex value. By default it uses our colors.

Logo

Any landscape logo (recommended: 1388 × 367 pixels). By default it uses our logo.

Success URI

Once login is successful where should we redirect the user

Failure URI

If login fails or user wants to abandon the login, where should we redirect the user

If you wish to change any of these fields, please go to Client Manager on the dashboard to do so. (FAQ on how to get to the Client Manager).

Know Your Customer UI


Know Your Customer (KYC) UI is a simple user interface built on top of our Add Documents API.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.