API Reference

📘

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.

FieldUK RequirementUS Requirement
merchant_id✔️✔️
intended_use_of_funds✔️✔️
currency✔️✔️
bureau_search✔️✔️
application_comms✔️✔️
applicants.first_name✔️✔️
applicants.last_name✔️✔️
applicants.email_address✔️✔️
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.moved_in_date✔️✔️
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 only)✔️ (aka Business EIN)
mcc_code✔️

Address country values
CZE, DE, DK, FI, GBR, IRE, ISL, SE, UK, SVK
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!