Company

The company is the top-level account object. It holds your business address, VAT ID, and the policy that controls whether two-factor authentication is required for all employees.

The company model

There is one company per account. The id is the stable public identifier you can use to reference the company in your own systems.

Properties

Name
id
Type
string
Description
Unique identifier for the company.
Name
name
Type
string
Description
The registered company name.
Name
address
Type
string
Description
Street address. May be null.
Name
city
Type
string
Description
City. May be null.
Name
state
Type
string
Description
State or region. May be null.
Name
zip
Type
string
Description
Postal code. May be null.
Name
country
Type
string
Description
ISO 3166-1 alpha-2 country code, e.g. "DK".
Name
vat_id
Type
string
Description
VAT registration number, e.g. "DK12345678". May be null.
Name
requires_two_factor
Type
boolean
Description
When true, every employee must have two-factor authentication enabled before they can access the dashboard or the mobile app.

GET/v1/company

Retrieve the company

Returns the company associated with the authenticated API key or OAuth token.

Request

GET

/v1/company

curl https://app.phone.inc/api/v1/company \
  -H "X-Api-Key: $PHONE_INC_API_KEY"

Response

{
  "id": "019daef1-085e-79ca-bb4d-7f6bf51992d2",
  "name": "Acme ApS",
  "address": "Vesterbrogade 1",
  "city": "Copenhagen",
  "state": null,
  "zip": "1620",
  "country": "DK",
  "vat_id": "DK12345678",
  "requires_two_factor": false
}

PATCH/v1/company

Update the company

Updates one or more fields on the company. Pass only the fields you want to change — omitted fields are left unchanged.

Optional attributes

Name
address
Type
string
Description
Street address.
Name
city
Type
string
Description
City.
Name
state
Type
string
Description
State or region.
Name
zip
Type
string
Description
Postal code.
Name
country
Type
string
Description
ISO 3166-1 alpha-2 country code, e.g. "DK". Must match a country Phone.inc supports.
Name
vat_id
Type
string
Description
VAT registration number.
Name
requires_two_factor
Type
boolean
Description
Set to true to require two-factor authentication for all employees.

Request

PATCH

/v1/company

curl -X PATCH https://app.phone.inc/api/v1/company \
  -H "X-Api-Key: $PHONE_INC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"city":"Aarhus","vat_id":"DK98765432","requires_two_factor":true}'

Response

{
  "id": "019daef1-085e-79ca-bb4d-7f6bf51992d2",
  "name": "Acme ApS",
  "address": "Vesterbrogade 1",
  "city": "Aarhus",
  "state": null,
  "zip": "1620",
  "country": "DK",
  "vat_id": "DK98765432",
  "requires_two_factor": true
}