Qodex.ai

Create Single Company

POST {{base_url}}/company/v2/companies

Create a company to link their financial data to the company. While creating a company, you can add the following as company details:

  • Name
  • Description
  • Website
  • Address
  • Industry
  • External id
  • CRN (Companies house number)

Attributes

Field NameTypeDescription
namestringCompany name
addressstringRegistered address of the company
websitestringWebsite (www.smewebsite.com)
industrystringIndustry name
descriptionstringCompany description
externalIdstringExternal ID that a partner may want to use to identify a company
crnstringCompanies house number; specific to companies registered with Companies house in the UK

Error messages

ConditionResponse StatusResponse Body
Without company name400 Bad Request{“error”: “Missing/Invalid name”}
Wrong body400 Bad Request{error: Missing/Invalid JSON}
Empty request body400 Bad Request{error: Missing/Invalid name}
Wrong Partner ID403 Access Denied{"error”: “Access denied”}

Request Body

{"name"=>"Company name", "description"=>"Micro SME", "website"=>"www.companyname.com", "address"=>"London", "industry"=>"IT", "externalId"=>"19988-7766", "crn"=>"14455-345"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
X-Api-Keystring
X-Partner-Idstring
Authorizationstring

RESPONSES

status: Created

{"id":"CompanyID12345","name":"Company name","description":"Micro SME","website":"www.companyname.com","industry":"IT","address":"London","externalId":"19988-7766","crn":"14455-345","createdAt":"2020-10-28T15:27:15.367Z"}