API Documentation

Create company

post
https://apim.demo01.my.fivedegrees.cloud/publicapi-sbx/api/v1/companies

API endpoint to create a company. Depending on the configuration fields are optional or mandatory.

Body Params

Create company request

Model for creating new company

string | null

Name of the company.

string | null

Registration number of company, for instance a chamber of commerce number.

string | null

Legal form shortcode of the company. In the reference data endpoint 'legal-forms' a user can get the full list of available values.

string | null

Industry shortcode of the company. In the reference data endpoint 'industries' a user can get the full list of available values.

date | null

Date the company was founded.

string | null

Country shortcode were the company was founded. In the reference data endpoint 'countries' a user can get the full list of available values.

string | null

E-mail address of the company.

string | null

E-mail address of the company.

string | null

Phone number of the company.

string | null

Website of the company.

string | null

Risk rating shortcode of the company. In the reference data endpoint 'risk-rating' a user can get the full list of available values.

string | null

Review frequency of the risk rating in months, so 12 means that every 12 months the risk rating needs to be checked.

date | null

Date the last risk rating was performed.

address
array of objects | null
address
customFields
array of objects | null
customFields
Headers
uuid
required

Format - uuid. Correlates HTTP requests between a client and server

Responses
202

Accepted

500

Server Error

Updated 3 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?