post https://sandbox.treeforttech.com/api/client/get-link-info
This endpoint can be used to retrieve the required link for the client to begin the ID verification process. Using this endpoint, the client will not receive the link to begin the ID verification process automatically - the link must be provided to the client using an alternative method (e.g., embedded into a custom email, SMS, etc.). Note: calling this endpoint will expire any previous active ID verification links for this client.
Response Schema
| Attribute | Type | Description |
|---|---|---|
| statusCode | Integer | Standard HTTP response code. Status codes are outlined in the Errors section of this API reference. |
| message | String | A human-readable message providing more details about the status code. Messages are outlined in the Errors section of this API reference. |
| data.id | Integer | A unique ID created by Treefort and used to track a particular link. This can be provided to Treefort for troubleshooting purposes. |
| data.link | String | The unique link provided for the client to begin and complete the ID verification process. A unique link is provided for each client to complete the ID verification process. |
| data.startDate | String | The date the link was sent to the client, in the following format: 2021-03-24T12:00:00. |
| data.endDate | String | The date the link that was sent to the client will expire, in the following format: 2021-03-29T12:00:00. |
| errors | Array of Strings | An array of human-readable error messages, if available (null otherwise). Unique errors associated with this endpoint, if applicable, are shown in the example response in the right column with the corresponding HTTP status code. |