GuidesAPI Reference
Guides

Companies

Returns details, TCL, available TCL, and status on company with Credit Key.

The Companies endpoints manage the business entity that sits behind Credit Key applications and orders. Once a buyer is approved, Credit Key represents them as a company, and these endpoints let you:

  • Retrieve and update company information
  • Manage beneficial owners for compliance (KYC/AML)
  • Add or update repayment payment methods

All endpoints require authentication and should be called from your backend server, not the browser.


Retrieve a Company

GET /company/{id}

Fetch the full company record.

Common uses:

  • Displaying Credit Key account details in your admin or CRM
  • Verifying company profile data before creating an order
  • Checking addresses, contacts, and account status

You will typically obtain a company.id from an Application response or an Order that references the buyer.


Update a Company

PATCH /company/{id}

Update mutable fields on the company profile.

Common uses:

  • Updating business contact details
  • Modifying billing or operational addresses
  • Correcting non-credit profile information

Note: Core identity and underwriting-related fields may be read-only.


List Beneficial Owners

GET /company/{id}/beneficial-owner

Retrieve the beneficial owners currently on file for the company.

Common uses:

  • Viewing ownership/KYC details
  • Determining if additional owners are required
  • Pre-filling administrative or compliance tools

Add or Update a Beneficial Owner

POST /company/{id}/beneficial-owner

Add a new beneficial owner or update an existing one.

Common uses:

  • Recording ownership changes
  • Adding additional 25%+ owners for compliance
  • Updating addresses or correcting previously submitted information

Add a Payment Method

POST /company/{id}/payment-method

Attach a repayment method to the company (e.g., bank account or card).

Common uses:

  • Setting up autopay or default repayment details
  • Updating expired or replaced payment methods
  • Ensuring repayment readiness before processing new orders

Where Companies Fit in the Overall Model

  • Applications → Capture business + owner details and perform underwriting.
  • Companies → Persistent representation of the approved business.
  • Orders & Payments → Transactions and repayment activity tied to the company.

Typical flow:

  1. Application is approved → you receive a company.id.
  2. You may update company or owner details using these endpoints.
  3. You create orders and manage payment methods tied to the company account.