Generate Link
Generate Link
POST
https://vx-be.idresponse.com/link/generate
This endpoint allows you generate a direct link to an iFrame instance and send the user an email if desired.
Request Body
Name | Type | Description |
---|---|---|
options* | object | The object where you place certain options |
send_email* | boolean | Set to true if you want the link to be sent via an email |
Sample Request Body
You must provide a valid token when making this API call. So, make sure you retrieve your token first and then set it here.
Responses
Description | Value |
action | PASS - the link was generated ERROR - the link was not generated (see below for all error types |
detail | A description of the action result |
link | The URL value to provide the end user |
email_sent | Will be set to true or false |
error_message | The overall error message |
error_description | A description of the error that occurred |
Last updated