Files

ch:files LINK RELATION , EMBEDDED RELATION

Actions

method	description
GET	View files collection
POST	Create new file
OPTIONS	Retrieve supported HTTP methods

Request parameters

property	type	required	method
label¹²³	string	true	POST
content_type	string	true	POST
name⁴	string	false	POST
size	integer	false	POST
page⁵	integer	false	GET
per_page⁵	integer	false	GET

If adding a file for a Person, must be one of picture_legitimation or address_legitimation.

If adding a file for a Company, must be one of documentation or suretyship.

If adding a file for a Website, must be ownership.

⁴

Same as label, if unspecified.

⁵

See Pagination for details.

Profile

The Files resource represents a collection of File resources.

Properties

name	type	read-only
count	integer	true
page	integer	true
per_page	integer	true

Link relations

rel	conditional
self	false
first	true
last	true
prev	true
next	true
ch:application¹	true
ch:person¹	true
ch:dispute¹	true
ch:company¹	true
ch:website¹	true

Presence depends on file ownership context.

Embedded

File

Additional semantics

This collection is paginated. See Pagination.

Example representation

{
  "count": 1,
  "page": 1,
  "per_page": 20,
  "_links": {
    "self": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f/files"
    },
    "ch:application": {
      "href": "https://merchant.test.clearhaus.com/applications/3128a7e4-9594-42fb-a9bd-4f444b58110f"
    },
    "curies": [
      {
        "href": "https://developer.clearhaus.com/rels/{rel}",
        "templated": true,
        "name": "ch"
      }
    ]
  },
  "_embedded": {
    "ch:files": [...]
  }
}