The Companies endpoint allows merchants to retrieve information about the company associated with a Credit Key customer.

This endpoint is typically used after a customer has completed financing or when your application needs to display or synchronize company information stored by Credit Key.

When to Use This Endpoint

Use the Companies endpoint when your application needs to:

Retrieve a customer's company information
Display company details within your application
Synchronize company records with your CRM or ERP
Verify company information associated with a Credit Key account

Most merchants use this endpoint after a customer has been approved for financing or when viewing an existing customer profile.

Path Parameters

Parameter	Type	Description
`company_id`	string	The unique identifier of the company to retrieve.

Example Request

curl --request GET \
  --url https://api.creditkey.com/v2/companies/{company_id} \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN"

Example Response

{
  "id": "cmp_123456",
  "name": "Acme Manufacturing",
  "status": "ACTIVE",
  "phone": "555-555-5555",
  "email": "[email protected]",
  "billing_address": {
    "street": "123 Main Street",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "country": "US"
  }
}

Response Fields

Field	Description
`id`	Credit Key company identifier
`name`	Company name
`status`	Current company status
`phone`	Company phone number
`email`	Primary company email address
`billing_address`	Company's billing address

Refer to the API reference for the complete response schema.

Common Use Cases

Typical uses for the Companies endpoint include:

Displaying company information within a customer portal
Populating CRM records
Synchronizing ERP customer accounts
Verifying company information before creating internal records

Error Handling

Common responses include:

Status	Meaning
200	Company retrieved successfully
401	Authentication failed
403	Not authorized to access the company
404	Company not found
500	Internal server error

Refer to the API reference for complete error details.

What's Next

After retrieving company information, you can continue working with the customer's Credit Key account by performing checkout operations, managing orders, or synchronizing additional customer data.

Continue to Hosted Checkout to learn how to create a checkout session and launch the Credit Key checkout experience.