This API provides behaviour whereby merchant and business information can be shared with the journey so that form fields can be pre-populated to land a user on the review page - improving the UX and application conversion.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Call this endpoint at the point of handoffPre-population is synchronous and time-limited. Request the
entryUrlat the moment you are ready to send the merchant to Liberis, and send them straight to it.
- The
entryUrlis valid for 15 minutes from creation.- The
201response confirms your data has been accepted and the link is ready to use.Links created in advance, or in a scheduled batch, will have expired by the time the merchant opens them. The merchant then completes the standard application form instead.
Use the host for your region
Region Base URL UK and Europe https://platform.eu.liberis.comNorth America https://platform.us.liberis.comIf you are not sure which region applies to you, please speak to your partner manager.
Required fields
partner_client_idis the only mandatory field, plusemail_addressfor each applicant you send.The more of the fields below you send, the more of the review page is already completed when the merchant arrives, and the less they need to fill in themselves. You should endeavour to send as many of them as you hold.
The following fields pre-populate the merchant's review page directly:
| Field | Notes |
|---|---|
partner_client_id | Becomes the merchant ID on the application |
applicants.first_name | |
applicants.last_name | |
applicants.email_address | Required for every applicant, and must be unique across applicants |
applicants.telephone_number | |
applicants.date_of_birth | |
applicants.ownership_percentage | |
applicants.residential_status | Home Owner or Renting |
applicants.identification_number | See the note on formats below |
applicants.address.line1 | |
applicants.address.line2 | |
applicants.address.town_city | |
applicants.address.state | |
applicants.address.postal_code | |
company.legal_name | |
company.business_type | |
company.industry | |
company.business_start_date | |
company.registration_number | See the note on formats below |
company.registered_address.line1 | |
company.registered_address.line2 | |
company.registered_address.town_city | |
company.registered_address.state | |
company.registered_address.postal_code | |
company.trading_addresses[0].line1 | Only the first trading address is used |
company.trading_addresses[0].line2 | |
company.trading_addresses[0].town_city | |
company.trading_addresses[0].state | |
company.trading_addresses[0].postal_code |
If no trading address is supplied, the registered address is also used as the trading address. Send a trading address only when it differs from the registered address. Not every partner configuration uses a trading address — your partner manager can confirm whether yours does.
Other fields in the schema are accepted and used elsewhere in the application process. Send what you hold.
ApplicantsMark exactly one applicant with
"primary": true. The primary applicant's details are used for the main contact on the application and are the ones shown at the top of the review page.If no applicant is marked as primary, the first applicant in the array is used as the primary.
Each applicant's
email_addressmust be unique within the request.
Formats
Field Format Example company.registered_address.country,applicants.address.countryISO 3166-1 alpha-3 SWE, notSEcompany.currencyISO 4217 SEKcompany.business_start_date,company.partner_start_date,applicants.date_of_birthYYYY-MM-DD2021-04-30A country code, currency code or date in another format is rejected with a
400.
Identification and registration numbersSend
applicants.identification_numberandcompany.registration_numberin the national format for the merchant's country — for example a Swedish personnummer, or a UK company registration number. A value in a different format is not carried through to the review page.Each
applicants.identification_numbermust be unique across applicants, andcompany.registration_numbermust not match any applicant's identification number. Formatting is ignored when these are compared, so123-45-6789and123456789count as the same value. Where two values match, one is kept and the other is not carried through.Which of these values a journey uses varies by country. Your partner manager can confirm what applies to your region.