Person

Profile

A Person represents a Company Director or Owner, as indicated by the role_director and role_owner properties.

For the purposes of the application process, every person is required to have at least 2 files, with labels picture_legitimation and address_legitimation. See ch:files for more information on handling files.

Properties

Deprecated! The role property is deprecated. Use the role_director and role_owner properties instead.

name type read-only
name string false
social_security_number [a-z0-9\- ]+ false
date_of_birth \d{4}-\d{2}-\d{2} false
address_line_1 string false
address_line_2 string false
zipcode string false
city string false
country ISO 3166-1 alpha-2 false
role string false
role_director boolean false
role_owner boolean false
rel conditional
self false
ch:company false
ch:files false

Additional semantics

No additional semantics.

Example representation

{
  "name": "Emile T. Madsen",
  "social_security_number": "191181-0820",
  "date_of_birth": "1981-11-19",
  "address_line_1": "Tårup Byvej 24",
  "zipcode": "1265",
  "city": "København K",
  "country": "DK",
  "role": "director",
  "role_director": true,
  "role_owner": false,
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/people/a0cae6fd-a8c1-4a63-a59c-a88322f0929c"
    },
    "ch:company": {
      "href": "https://merchant.test.clearhaus.com/companies/b3ce3642-2061-4a76-bd9b-1b145395452a"
    },
    "ch:files": {
      "href": "https://merchant.test.clearhaus.com/people/a0cae6fd-a8c1-4a63-a59c-a88322f0929c/files"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  }
}
Open Navigation Close Navigation