Introduction
This WebApp endpoint is used to enroll a new user.
The data needed from your organization to enroll a user is:
Data | Description |
---|---|
Name | The name of the person which needs to be enrolled (could be left empty). |
User ID | The ID from your own CRM which will be mapped with our own user id and is mandatory. |
URL Callback | This URL Callback is needed to redirect the user to a POST request with the result information once the flow is completed. |
Options | This is an object with all optional fields:
|
Function Callback | The Function Callback is needed when using iframe and want to manage the results and flow without a redirect to a URL. |
The Function Callback should only be used when using iframes and is not needed when using redirect flow.
There cannot be a Function Callback and a URL Callback at the same time, otherwise sdk will fail and return an error.
To send data to your own backend you must handle it in the Function Callback if not using URL Callback.
The callback URL will be called with a result
boolean value on the body to denote a successful or unsuccessful enroll. If result
is false, an array of strings called errors
will be returned with the errors that occured.
You can use our Callback Parser library to get the response data parsed and validated, see more details here: Callback Parser library