CHcheckout
Platforms

Upload a file

Our Platforms solution provides an easy way to upload documentation required for full due diligence.

Use this endpoint to generate a file upload link, which you can then upload a file to using a data-binary type request.

See the <a href="https://checkout.com/docs/platforms/onboarding/api/full/upload-a-file" target="_blank">documentation</a> for more information.

Please note that the sub-domain – https://files.checkout.com – is slightly different to Checkout.com's other endpoints. See the <a href="https://checkout.com/docs/platforms/onboarding/api/full/upload-a-file" target="_blank">documentation</a> for more information.

post/entities/{entityId}/files

Request

Request body

purpose'additional_document' | 'articles_of_association' | 'bank_verification' | 'certified_authorised_signatory' | 'company_ownership' | 'company_verification' | 'financial_verification' | 'identity_verification' | 'proof_of_legality' | 'proof_of_principal_address' | 'shareholder_structure' | 'tax_verification' | 'proof_of_residential_address' | 'proof_of_registration' required

The purpose of the file upload.

Example request

{
  "purpose": "identity_verification"
}

Response

File uploaded successfully

idstring

The file identifier.

maximum_size_in_bytesnumber

The maximum file size allowed, in bytes.

document_types_for_purposestring[]

The MIME file types allowed for the document purpose, provided on the initial file upload request.

Example response

{
  "id": "file_6lbss42ezvoufcb2beo76rvwly",
  "maximum_size_in_bytes": 4194304,
  "document_types_for_purpose": [
    "image/jpeg",
    "image/png",
    "image/jpg"
  ],
  "_links": {
    "upload": {
      "href": "https://s3.eu-west-1.amazonaws.com/mp-files-api-staging-prod/ent_ociwguf5a5fe3ndmpnvpnwsi3e/file_6lbss42ezvoufcb2beo76rvwly?AWSAccessKeyId=ASIX4BFJOBCQFLAMPKU3&Expires=1661355993&x-amz-security-token=some_token"
    },
    "self": {
      "href": "https://files.checkout.com/files/file_6lbss42ezvoufcb2beo76rvwly"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.