Product updates
API Reference

Create a company

post
https://api.dotfile.com/v1/companies

Create a company in a case.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 160

Name for the company (at most 160 characters).

string
enum
Defaults to main
Allowed:
string | null

Commercial name for the company (at most 160 characters).

string | null
date | null

Date in format ISO 8601(yyyy-MM-dd eg 2023-01-31)

string
enum
Defaults to not_reported
Allowed:
string | null
string | null

ISO 20275 code (eg: 6CHY)

string | null

ISO 3166-1 alpha-2 country code (eg FR)

address
object
classifications
array of objects
Defaults to
classifications
banking_information
object
string | null
string | null
string | null
string | null
custom_properties
object

Optional partial custom properties object in a format of key (string) / value (string | boolean | string[] | number | null) to create the company.

Archived custom properties are not accepted.

uuid
required

Case id where the company is created

relations
array of objects
Defaults to
relations
Responses

400

The request is either malformed or contain invalid parameters.

  • Make sure the body payload matches the expected schema
  • A case can have only one main company
  • A case must have a main company before creating an affiliated company
404

No case can be found.

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago