COconekta
Companies

Get Company

Changed on
get/companies/{id}

Request

Path parameters

idstring required
Example:6307a60c41de27127515a575

Identifier of the resource

Headers

Accept-Language'es' | 'en'

Use for knowing which language to use

Response

successful

idstring required

The unique identifier for the company.

namestring required

The name of the company.

activeboolean required

Indicates if the company is active.

account_statusstring required

The current status of the company's account.

card_payments_enabledboolean

Indicates if card payments are enabled for the company.

parent_company_idstring nullable

The identifier of the parent company, if any.

onboarding_statusstring required

The current status of the company's onboarding process.

created_atinteger required

Timestamp of when the company was created.

objectstring required

The type of object, typically "company".

three_ds_enabledboolean

Indicates if 3DS authentication is enabled for the company.

three_ds_mode'smart' | 'strict' nullable

The 3DS mode for the company, either 'smart' or 'strict'. This property is only applicable when three_ds_enabled is true. When three_ds_enabled is false, this field will be null.

onboarding_urlstring

The URL to resume onboarding

Example response

{
  "id": "6827305a1ec60400015eb116",
  "name": "test",
  "account_status": "signed_up",
  "card_payments_enabled": true,
  "parent_company_id": "680bf1da38716d00013543bc",
  "onboarding_status": "pending",
  "documents": [
    {
      "file_classification": "deposit_account_cover",
      "status": "pending"
    }
  ],
  "created_at": 1748968241,
  "object": "company",
  "three_ds_enabled": true,
  "three_ds_mode": "strict",
  "onboarding_url": "https://onboarding.conekta.com/resume/6827305a1ec60400015eb116"
}

Changes

  • 52f4c0dd8a1bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status