Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

How to create your own Front-Office

TurnKey Lender offers the full stack of API methods which can be used by clients to create their own Front-Offices. This can be a website or a mobile application where your borrowers register, apply for loans, track their loan application statuses, sign contracts, pay with a single click, and more.

...

  • 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.  
    Feel free to find 'Customer details' object description for pure TurnKey Lender BOX editions  here: API. Customer Details structures.

    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'.  By doing this,  the customer's account status 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.
    Feel free to find 'Application form' specifications for pure TurnKey Lender BOX editions  here - Customer Details specifications

To add a document to the customer's details, the following steps need to be done:

...

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 iframe for the integrated bank verification provider.

  • POST /PaymentOptions/BankVerification/SaveData
    Save all data received from Bank verification service (iframe) in TurnKey Lender Database

  • GET /PaymentOptions/BankVerification/IsDataProcessed
    Check if bank account verification is passed successfully and all data is received by TurnKey Lender.

...