API Reference
Update companies in batch
/v2/company https://api.cable.tech Authentication
- Bearer token in the Authorization header
company:write
Request body
An array of company update payloads. Each payload must include the ‘company_id’ to identify the company and can include any other fields that need to be updated. The ‘timestamp’ field should represent the time of update.
-
company_idstring requiredUnique external identifier of the company entity, ID stored in your database / back-office
Limits
min length 1 -
timestampstring requiredWhen this company record was created or last modified in your system, in ISO 8601 format.
Format
date-time -
is_test_companyboolean requiredIf the company is a test company, this should be set to true
Default
false -
account_statusstringThe 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
Allowed values
APPROVEDBLOCKEDCLOSEDPENDINGREJECTED -
legal_namestringLegal name of the business
Example
Cable Technology Ltd -
trading_namestringTrading name of the business
Example
Cable Tech -
emailstringMain contact email for the company
Example
[email protected] -
addresseslist of objectsLimits
min items 1-
typestringType of address. eg. Registered, Trading, Legal
-
addressobjectLegal/contact address for the entity
-
lineslist of stringsLimits
min items 1Example
160 Kemp House, City Road -
citystringExample
London -
statestringExample
New York -
countystringExample
Buckinghamshire -
postal_codestringExample
EC1V 2NX -
countrystringExample
France
-
-
-
phone_numberstringMain contact telephone number for the company
Example
+441234567899 -
typestringBusiness entity type. eg. Sole Trader, Limited Company
Example
Limited Company -
registration_numberobject-
typestring requiredType of registration number, e.g. Companies House number (UK), EIN number (US) etc.
Limits
min length 1Example
CH_number -
valuestring requiredThe registration number
Limits
min length 1
-
-
incorporation_datestringDate when the company was incorporated
Format
dateExample
2020-07-21 -
incorporation_countrystring2 or 3 Character ISO 3166 Country Code (https://w.wiki/4rY)
Limits
min length 2max length 3Example
GBR -
incorporation_statestringState where the company was incorporated (US only)
Limits
min length 2Example
California -
primary_operation_countrystring2 or 3 Character ISO 3166 Country Code (https://w.wiki/4rY)
Limits
min length 2max length 3Example
GBR -
industrystringNature of business
Example
Other information technology service activities -
industry_classificationobject-
code_typestring requiredType of industry classification code
Limits
min length 1 -
codelist of strings requiredIndustry classification codes
Limits
min length 1min items 1 -
descriptionstringDescription of the industry classification code
Limits
min length 1
-
-
source_of_wealthstringSource of wealth of the company
Limits
min length 1 -
source_of_fundsstringSource of initial deposit of the company
Limits
min length 1 -
first_transaction_completed_atstringOriginal timestamp of when the person completed their first transaction
Format
date-time -
product_typestringLimits
min length 1 -
registered_as_inactivebooleanIf the company is registered as inactive, this should be set to true
Example
false
Responses
200 Batch processing result
-
successboolean requiredIndicates if the write operation was successful.
-
write_countinteger requiredThe number of records written to the database.
Format
int32 -
messagestring requiredProvides additional information about the operation result.
-
organization_idstring requiredThe organization ID for which the operation was performed.
Errors
- 400 Invalid company data in batch
- 401 Unauthorized request
- 404 Company not found in batch
- 429 Rate limit exceeded
- 500 Server error
- default General error
-
codeinteger requiredFormat
int32 -
messagestring required -
errorslist of objectsDetailed information about errors in specific fields.
-
fieldstring -
messagestring
-