Person

ch:person LINK RELATION

Actions

method	description
GET	View person
PATCH	Update person
DELETE	Delete person
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required
name	string	true
social_security_number	`[a-z0-9\- ]+`	true
date_of_birth	`\d{4}-\d{2}-\d{2}`	true
address_line_1	string	true
address_line_2	string	false
zipcode	string	true
city	string	true
country	ISO 3166-1 alpha-2	true
role_director	boolean	false
role_owner	boolean	false

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

name	type	read-only	commentable
name	string	false	true
social_security_number	`[a-z0-9\- ]+`	false	true
date_of_birth	`\d{4}-\d{2}-\d{2}`	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
role_director	boolean	false	false
role_owner	boolean	false	false

Link relations

rel	conditional
self	false
ch:comments	false
ch:company	false
ch:files	false

Additional semantics

Field comments

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

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": 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:comments": {
      "href": "https://merchant.test.clearhaus.com/people/a0cae6fd-a8c1-4a63-a59c-a88322f0929c/comments{?page,per_page}"
    },
    "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"
      }
    ]
  }
}