API Reference

Onboard a company with Lendica.

Overview

This endpoint accepts application details for a company (your customer) and creates an Application, Company, and Approval object in Lendica's system. The application details are used to underwrite the company.
Authentication: Include your API key in the Authorization header using the format Api-Key {your_api_key}.

Company Application Submission

When a new customer (Company) is onboarded to your platform, you need to submit their application details to Lendica for underwriting.

  • Purpose: To onboard the Company and apply for an Approval (credit line) in Lendica's system.
  • API Endpoint: /submit/application
  • Data Required: Application details including company and contact information.

Flow:

  1. Data Collection: Collect the necessary information from your customer during onboarding or application.
  2. API Request: Send a POST request to Lendica's /submit/application endpoint with the application data.
  3. Underwriting Process: Lendica processes the application and performs underwriting to assess creditworthiness.
  4. Response Handling: Lendica responds with the ID of the created Company.

Fetching Approval Details

📘

View the Approval Status API documentation here:

GET Approvals

After the underwriting process, you need to retrieve the approval status and credit details for your customer.

  • Purpose: To determine financing eligibility and available credit limits.
  • API Endpoint: /partner/status/approvals (from Lendica's Status API)
  • Data Required: partner_company_uuid to identify the customer.

Flow:

  1. API Request: Send a GET request to Lendica's /partner/status/approvals endpoint with the partner_company_uuid.
  2. Data Retrieval: Lendica responds with the approval details.
  3. Integration Logic: Use this information within your platform to enable or disable financing options, display credit limits, etc.
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!