Submit a new application

Create a new cash advance application on behalf of a customer.

Authentication:

Use API Key authentication via the X-API-Key header.

Required Information:

  • Application details (amount, use of funds, etc.)
  • Applicant information (personal details, addresses)
  • Company/business information

Application Flow:

  1. Submit application data via this endpoint
  2. Receive application ID in response
  3. Upload supporting documents using the Documents endpoint
  4. Submit open banking data (if available)
  5. Monitor status using the application status endpoint
Body Params

Complete application data including applicant and company information

Complete application submission data

application
object
required

Application details

applicants
array of objects
required

Array of applicant information (directors, owners, etc.)

applicants*
company
object
required

Company/business information

terminals
array of objects

Optional list of card terminals associated with the application. If provided, each terminal must include a processor and MID.

terminals
Headers
string
required

Your API key for authentication.

Responses

400

Invalid request. Check the errors array in the response for details.

401

Unauthorized - Missing or invalid API key

403

Forbidden - Invalid or deactivated API key

500

Internal server error. Please contact support if the issue persists.

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