GuidesAPI Reference
Log In
API Reference

Get Offers

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Required fields

There are several fields on the application endpoint. Only a few of these are mandatory to create the application, however, there's a minimum set of fields required in order to create an application without Liberis needing to contact the customer for additional information. This is detailed in the table below and split by regional requirements (UK and US). You should endeavor to send as many these fields as possible in order to provide the most frictionless customer experience.

If you are creating an application for a region that is not US or UK, please speak to your partner manager for assistance.

📧 Unique Applicant Emails

When sending more than one applicant in an application, each email address provided must be UNIQUE in the applicants.email_address field.

Unique Applicant Identification Numbers

When sending more than one applicant in an application, each identification number (e.g. SSN) provided must be UNIQUE in the applicants.identification_number field.

Unique Company Registration Number
If sending a registration number (e.g. EIN) it must not match any applicants' identification number. While possible, this is very unlikely and has always been an error when investigated.

FieldUK RequirementUS Requirement
merchant_id✔️✔️
intended_use_of_funds✔️✔️
currency✔️✔️
bureau_search✔️✔️
application_comms✔️✔️
applicants.first_name✔️✔️
applicants.last_name✔️✔️
applicants.email_address✔️ (unique per applicant)✔️ (unique per applicant)
applicants.telephone_number✔️✔️
applicants.date_of_birth✔️✔️
applicants.ownership_percentage✔️✔️
applicants.primary✔️✔️
applicants.identification_number✔️ (aka SSN)
applicants.residences.address.line1✔️✔️
applicants.residences.address.town_city✔️✔️
applicants.residences.address.postcode✔️✔️ (aka Zip Code)
applicants.residences.address.state✔️
applicants.residences.address.country✔️✔️
applicants.residences.residential_status✔️✔️
company.legal_name✔️✔️
company.business_type✔️✔️
company.business_start_date✔️✔️
company.partner_start_date✔️✔️
company.industry✔️✔️
company.trading_addresses.trading_name✔️✔️
company.trading_addresses.currency✔️✔️
company.trading_addresses.address.line1✔️✔️
company.trading_addresses.address.town_city✔️✔️
company.trading_addresses.address.postcode✔️✔️ (aka Zip Code)
company.trading_addresses.address.state✔️
company.trading_addresses.address.country✔️✔️
company.registered_addresses.line1✔️✔️
company.registered_addresses.town_city✔️✔️
company.registered_addresses.postcode✔️✔️ (aka Zip Code)
company.registered_addresses.state✔️
company.registered_addresses.country✔️
payment_channels.name✔️✔️
payment_channels.reference✔️✔️
payment_channels.type✔️✔️
payment_channels.primary✔️✔️
payment_channels.existing_split✔️✔️
registration_number✔️ (for Limited companies & Limited Liability Partnership (LLP))✔️ (aka Business EIN)
mcc_code✔️
Address country values
CZE, DE, DK, FI, GBR, IRE, ISL, SE, UK, SVK
Body Params
application
object

Definition of application state, used to pass global application data and control endpoint flow.

consents
object

Consents to be provided in order to trigger certain flows, allow Liberis - Merchant communication etc.

applicants
array of objects

List of all applicants attributed to the application and merchant.

applicants
company
object

Company specific data for application.

marketing
object

Optional marketing parameters for pipeline tracking.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain