Company

ch:company LINK RELATION

Actions

method	description
GET	View company
PATCH	Update company
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required
name	string	true
registration_number¹	string	true
email	email	true
phone	string	true
address_line_1	string	true
address_line_2	string	false
zipcode	string	true
city	string	true
country	ISO 3166-1 alpha-2	true
form	string	false
ownership_structure²	string	true
ownership_structure_comment	text	false

Legal company registration identifier

One of: sole_director, sole_not_director, one_or_more_25, none_25

Profile

A Company represents the legal entity behind the Merchant.

Properties

name	type	read-only	commentable
name	string	false	true
registration_number	string	false	true
email	email	false	true
phone	string	false	true
address_line_1	string	false	true
address_line_2	string	false	true
zipcode	string	false	true
city	string	false	true
country	ISO 3166-1 alpha-2	false	true
form	string	false	true
ownership_structure	string	false	true
ownership_structure_comment	text	false	true

Link relations

rel	conditional
self	false
ch:application	false
ch:comments	false
ch:people	false
ch:files¹	true

Presence depends on form and country

Additional semantics

Field comments

This resource supports field comments. See Field comments for more information.

Example representation

{
  "name": "Acme Corporation",
  "registration_number": "33749996",
  "email": "info@example.com",
  "phone": "+45 23850071",
  "address_line_1": "Nørrebrovænget 64",
  "zipcode": "1106",
  "city": "København K",
  "country": "DK",
  "ownership_structure": "sole_not_director",
  "ownership_structure_comment": "Structure comment.",
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/companies/b3ce3642-2061-4a76-bd9b-1b145395452a"
    },
    "ch:application": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "ch:comments": {
      "href": "https://merchant.test.clearhaus.com/companies/b3ce3642-2061-4a76-bd9b-1b145395452a/comments{?page,per_page}"
    },
    "ch:people": {
      "href": "https://merchant.test.clearhaus.com/companies/b3ce3642-2061-4a76-bd9b-1b145395452a/people{?page,per_page}"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}