API ReferenceCompany

Add company information

Endpoint for adding new company information

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

AuthorizationstringRequired

Request

This endpoint expects a list of objects.
company_idstringRequired>=1 character

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

timestampdatetimeRequired
Original timestamp relating to when this company's information was received
is_test_companybooleanRequired
If the company is a test company, this should be set to true
account_statusenumOptional
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
Allowed values:
legal_namestringOptional
Legal name of the business
trading_namestringOptional
Trading name of the business
emailstringOptional
Main contact email for the company
addresseslist of objectsOptional
phone_numberstringOptional
Main contact telephone number for the company
typestringOptional
Business entity type. eg. Sole Trader, Limited Company
registration_numberobjectOptional
incorporation_datestringOptionalformat: "date"
Date when the company was incorporated
incorporation_countrystringOptional>=2 characters<=3 characters

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

incorporation_statestringOptional>=2 characters

State where the company was incorporated (US only)

primary_operation_countrystringOptional>=2 characters<=3 characters

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

industrystringOptional
Nature of business
industry_classificationobjectOptional
source_of_wealthstringOptional>=1 character
Source of wealth of the company
source_of_fundsstringOptional>=1 character
Source of initial deposit of the company
first_transaction_completed_atdatetimeOptional
Original timestamp of when the person completed their first transaction
product_typestringOptional>=1 character
registered_as_inactivebooleanOptional
If the company is registered as inactive, this should be set to true

Response

Company added successfully
successboolean
Indicates if the write operation was successful.
write_countinteger
The number of records written to the database.
messagestring
Provides additional information about the operation result.
organization_idstring
The organization ID for which the operation was performed.

Errors