GET Company details

Overview

The /company/details endpoint is intended to retrieve details of the company currently engaged with Lendica. The information retrieved from this endpoint is utilized to pre-populate application forms, streamlining the user experience and reducing the time it takes to complete necessary processes.

When Will Lendica Call This Route?

Lendica will invoke this endpoint once a user has consented to share their data. This typically occurs at the commencement of the application process. By fetching company details at this stage, Lendica aims to simplify the application process for the user, pre-filling fields in the application form where possible.

Authentication

Requests to this endpoint should be authenticated using the company's API key (partner_token) retrieved from the GET /company/token endpoint.

How to Use This Endpoint

HTTP Method: GET

URL: /company/details

No query parameters are required for this endpoint. It is assumed that the company-specific API key used to authenticate this request will be used to specify which company's details are being requested.

Required Fields in Response

The response from this endpoint should be a JSON object containing details of the company. At a minimum, the following fields are required:

partner_company_uuid: The unique identifier of the company in the partner's system.
company_name: The official registered name of the company.

Example Response

NOTE: For a complete example of a response with all possible fields and types, click on the "EXAMPLES" dropdown to the right and select the 200 status code. Alternatively, scroll down to the bottom and click on the 200 response.

{
  "partner_company_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "company_name": "Acme inc.",
  "first_name": "john",
  "last_name": "doe",
  "phone_number": 1234567890,
  "email": "[email protected]",
  "company_address": "123 main st",
  "business_ein": 123456789
}

HTTP Status Codes

200 OK: The request was successful, and company details were retrieved.
401 Unauthorized: The request was not authenticated. Ensure your API key is valid and included in the request header.
404 Not Found: No company details were found for the provided criteria.
500 Internal Server Error: An error occurred on the server side. Please contact support.