v1

latestOpenAPI 3.0.32026-08-04404186.8 KB

Company

Update companies in batch

put/v2/company

Request body

account_status'APPROVED' | 'BLOCKED' | 'CLOSED' | 'PENDING' | 'REJECTED'

The account status for the related person at that timestamp. Refer to the Developer Guide "Entity Account Statuses" to understand what account statuses mean at Cable, and how to use them

company_idstring required

Unique external identifier of the company entity, ID stored in your database / back-office

emailstring

Main contact email for the company

first_transaction_completed_atstring date-time

Original timestamp of when the person completed their first transaction

incorporation_countrystring

2 or 3 Character ISO 3166 Country Code (https://w.wiki/4rY)

incorporation_datestring date

Date when the company was incorporated

incorporation_statestring

State where the company was incorporated (US only)

industrystring

Nature of business

is_test_companyboolean required

If the company is a test company, this should be set to true

legal_namestring

Legal name of the business

phone_numberstring

Main contact telephone number for the company

primary_operation_countrystring

2 or 3 Character ISO 3166 Country Code (https://w.wiki/4rY)

product_typestring

registered_as_inactiveboolean

If the company is registered as inactive, this should be set to true

source_of_fundsstring

Source of initial deposit of the company

source_of_wealthstring

Source of wealth of the company

timestampstring date-time required

When this company record was created or last modified in your system, in ISO 8601 format.

trading_namestring

Trading name of the business

typestring

Business entity type. eg. Sole Trader, Limited Company

Example request

[
  {
    "addresses": [
      {
        "address": {
          "city": "London",
          "country": "France",
          "county": "Buckinghamshire",
          "lines": [
            "160 Kemp House, City Road"
          ],
          "postal_code": "EC1V 2NX",
          "state": "New York"
        }
      }
    ],
    "email": "contact@company.com",
    "incorporation_country": "GBR",
    "incorporation_date": "2020-07-21",
    "incorporation_state": "California",
    "industry": "Other information technology service activities",
    "legal_name": "Cable Technology Ltd",
    "phone_number": "+441234567899",
    "primary_operation_country": "GBR",
    "registration_number": {
      "type": "CH_number"
    },
    "trading_name": "Cable Tech",
    "type": "Limited Company"
  }
]

Response

Batch processing result

messagestring required

Provides additional information about the operation result.

organization_idstring required

The organization ID for which the operation was performed.

successboolean required

Indicates if the write operation was successful.

write_countinteger required

The number of records written to the database.