...
GET /Customer/CreditProducts
The info you get through this method lets you show the list of available credit products and bounds for the Loan amount and Term sliders.GET /Customer/States
If the 'States management' feature is enabled on in the Back-Office, this method shows the list of states/provinces.This feature applies to the United States edition and the Canada edition.
POST /Customer/Loans/Calculate
Calculates the corresponding loan offer terms:GET /Customer/PromoCode/Check
If a customer provides a promo code, it should is checked and verified on the server side.
...
POST /Customer/Details
The list of the Application form fields depends on the project, that's why the Customer Details structure should be discussed with the TurnKey Lender development team.It is possible to divide and send values in several batches, in case the Application form is split into multiple steps.
To avoid losing data, all previously sent data has to be resent with every new POST request.To finalize filling in the Application Form, the parameter 'DetailsFilled' value should be set to 'true'. As a result, the status of the customer's account is changed to 'Active'.
There is no validation of the customer's data on the server!
The validation has to be implemented on the front - end according to the application form specification.
...
GET /UserDocuments
This endpoint is used to get all documents that are already linked to the customer’s profile or to one of their loan.
This method is also useful to get the actual structure of document groups and their settings. Every group has its unique ‘Id’ that is required later to link any new file to the customer’s profile or loan with the endpoint PUT /UserDocuments.POST /Files/Upload
This method should be used every time when a new file needs to be uploaded to the database. As a result, ‘DocumentId’ is generated and returned.PUT /UserDocuments
This method is used to link a previously uploaded file to a customer’s profile or to a customer’s loan.GET /Files/GetInfo
Using this method, it is possible to get all details of any previously uploaded file by its ‘DocumentId’.GET /Files/Download
This method lets download any file to the customer’s device or create a preview.DELETE /UserDocuments
To unlink a document from the customer's profile or loan, it is enough to apply the needed 'DocumentId' to this endpoint. The file is not erased from the database, so it is possible to use the same 'DocumentId' to link this file again to another document group or loan.
...
The diagram below shows how to use the API methods and this algorithm works for any built-in provider (see Integrations By Country):
GET /PaymentOptions/BankVerification/Settings
Get settings to open the iframe for the integrated bank verification provider.POST /PaymentOptions/BankVerification/SaveData
Save all data received from the Bank verification service (iframe) in TurnKey Lender DatabaseGET /PaymentOptions/BankVerification/IsDataProcessed
Check if bank account verification is passed successfully and all data is received by TurnKey Lender.
...
POST /User/RequestPasswordReset
The required parameter 'confirmationUrl' should be linked to the 'Password change confirmation' page.
As a result, the password reset link is generated as 'confirmationUrl' in addition to the unique 'code' input parameter. This link is sent to the provided email in the 'Reset password' notification.POST /User/ChangePassword
Once the customer follows the link from the email, he is redirected to the 'Password change confirmation' page where can provide a new password can be provided. After that, this method is used to change the password in the system.
...
To display and manage customer 's details, two methods can be used:
...
The list of all customer's loans, which are not sent to the Archive, can be retrieved with the next method:
...