Skip to main content
Update a company

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string
Required string length: 1 - 256
country
string | null

Two-letter code of the country the company is registered in. Null clears it.

Pattern: ^[A-Za-z]{2}$
registration_number
string | null

The registration number as printed; spaces, dots and hyphens are ignored. Where Watchdog knows the country's format it must fit it, check digit included. Changing it renames the company to the name the register holds, unless name is given too.

Maximum string length: 100
registration_exception_reason
string | null

Why the company legitimately has no registration number. Ignored while it has one.

Required string length: 1 - 1000
description
string | null

Replaces the company's description, which coding suggestions read. Null or an empty string clears it.

Maximum string length: 600

Response

The company.

id
string<uuid>
required
name
string
required

The name the workspace uses for the company.

country
string | null
required

Two-letter code of the country the company is registered in. Null until given.

registration_number
string | null
required

The company's registration number without spaces or a country prefix: a Norwegian organization number is its nine digits. Null when none was given.

registration_exception_reason
string | null
required

Why the company legitimately has no registration number, as an Admin recorded it. Null when it has a number or none was recorded.

description
string | null
required

A short paragraph on what the company does. Coding suggestions for the company's invoices read it with the company's name. Null when none is given.

register
object | null
required

What the national register says about the number. Null where Watchdog has no register for the country, or without a number.

peppol_available
boolean
required

Watchdog can receive Peppol invoices for companies in this country. Watchdog staff set receiving up; nothing here turns it on.

identity_problems
enum<string>[]
required

What the company's legal identity still lacks; empty when complete. missing_country: no country. missing_registration_number: neither a number nor a reason for having none. not_in_register: the country's register holds no company with the number.

Available options:
missing_country,
missing_registration_number,
not_in_register
archived_at
string<date-time> | null
required

When an Admin archived the company (archiveCompany). An archived company receives nothing new and nothing automated runs for it; its history stays readable. Null while it is in use.

erasure_requested_at
string<date-time> | null
required

When an Admin asked to erase the archived company (requestCompanyErasure). Null when nobody has.