Engage Request Deep Links
You can configure the following fields in the Engage Request Deep Link, which launches and Engage Request in Legl with these query parameters:
Parameter | Required | Description |
createmodal_show | Yes | If this equals true or True the modal will be displayed on page load |
createmodal_email | Yes | Sets the Email Address field. |
createmodal_first_name | Yes | Sets the First Name field |
createmodal_middle_name | No | sets the Middle Names field |
createmodal_last_name | Yes | sets the Last Name field |
createmodal_client_reference | No | Sets the Client Reference field |
createmodal_matter_reference | No | Sets the Matter Reference field |
provider | No | Should be set to the name of the platform you are launching the deep link from (if any) |
The below example incorporates these fields into HTML which will take the user into Legl, prompting them to authenticate and launching the Engage request in the screenshot below.
https://account.legl.com/engage/?createmodal_show=true&[email protected]&createmodal_first_name=John&createmodal_last_name=Doe&createmodal_matter_reference=MR50&createmodal_client_reference=CR22&provider=microsoftteams
Business Search Deep Links
You can configure the following fields in the Business Search Deep Link, which launches company search in Legl with these query parameters:
Parameter | Required | Description |
search | Yes | Name of the Company to be searched, or regNo depending on the searchType |
country | Yes | Alpha-2 Country code for region to be searched. Bear in mind that certain jurisdictions may have limited corporate data available, which will be flagged to the user when they enter Legl |
searchType | Yes | Enum, can be ‘name’ or ‘regNo’. ‘name’ will search for the company name. |
provider | No | Should be set to the name of the platform you are launching the deep link from (if any) |
The following example searches for Lidl in the United Kingdom by name:
https://account.legl.com/businesses/search?search=Lidl&country=GB&searchType=name&provider=microsoftteams
The following example searches for Company Number 02816429 in the United Kingdom by regNo:
https://account.legl.com/businesses/search?search=02816429&country=GB&searchType=regNo&provider=actionstep
Pay Checkout Links
A payment can be initiated into a customer’s Legl instance at any time, with the following query parameters available. These are the same links used in Payment Portals, but can specify the amount to be paid, and the customer's details. Unlike Deep Links, they require no authentication - anyone can make a payment via these links:
Parameter | Required | Description |
i | Yes | Invoice reference e.g. 22 |
m | Yes | Matter reference e.g. 1671 |
a | Yes | The amount to be paid. Accepts a float with up to 2 decimal points. Numbers passed in after the second decimal point will be rounded. |
provider | No | Should be set to the name of the platform you are launching the deep link from (if any) |
For example, the following URL takes a customer through to the following screen where they can complete their Payment:
The leglco.sandbox portion of the query parameter will be replaced by the company name of the customer being configured, for example if this was Microsoft , the URL might be:
The specific moniker to use can be found by finding your Payment portal checkout link under Settings —> Bank Accounts: