API Reference
Add company information
/v1/business/company_info https://api.cable.tech Business endpoint for adding new company information
Authentication
- API key in the x-api-key header
Request body
Request body for adding information about companies
-
idstring requiredUnique external identifier of the company entity, ID stored in your database / back-office
Limits
min length 1 -
timestampstring requiredOriginal timestamp relating to when this company’s information was received
Format
date-time -
is_test_companyboolean requiredIf the company is a test company, this should be set to true
Default
false -
dataobject required-
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 -
customobjectCustom data that is relevant. This can be any JSON object. Please include any details and data points that our schema does not capture.
-
-
parentobject-
idstring requiredUnique external identifier of the parent entity, ID stored in your database / back-office
Limits
min length 1 -
typestring requiredType of the parent entity
Allowed values
companyperson
-
Responses
200 Operation success
-
successboolean requiredYou probably did something wrong if you set this to false
Default
true
Errors
- default Operation error
-
codestring required -
messagestring required -
dataobject