Get a Token - Onboarding
Onboarding Token
Last updated
Onboarding Token
Last updated
To start the SDK, whatever is the platform, you will need a token.
It will be delivered by the ShareID API service and will be available for one and only one onboarding process.
You'll note that ShareID API is always waiting for your parameters as JSON using the http header:
Here's the description of the json input document:
Parameter | Mandatory | Type / default | Note |
---|---|---|---|
* Your credentials are your responsibility. You must never enter them in hard copy in your application.
In response, you'll also get a json document:
The applicant_id
uniquely identifies the user in our system. You should keep track of this value in order to fetch the result later. If you're using a callback, the applicant_id
will also be send to your server (check here result on the callback).
business_hash*
yes
string
This is a string provided by your contact @ShareID
api_key*
yes
string
This is a string provided by your contact @ShareID
customer_data
yes
object / {}
This data is for your own usage. You can set here any data related to your users or your CRM for example.
methods
no
array of string
Your business may use doc and/or face methods to onboard a user.
callback
no
url / null
This url will be called with the onboarding result (please check here also)
callback_with_document_capture
no
boolean / false
Setting this parameter to true will give you access to the the images crops in the onboarding result (please check here also)
advanced_verification
no
boolean / false
By default, ShareID uses one challenge. To require more, set advanced_verification to true. Note that this will also extend the onboarding and analysis time.