CHcheckout
Platforms

Retrieve a file

Retrieve information about a previously uploaded file.

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.

get/entities/{entityId}/files/{fileId}

Request

Response

OK

idstring

The ID of the file.

statusstring

The current status of the file.

status_reasonsstring[]

If status is Invalid, returns the reasons why the file was invalid. If status is any other value, returns Null.

sizenumber

The size of the file in KB.

mime_typestring

The MIME type of the file.

uploaded_onstring date-time

The date and time the file was uploaded, in ISO 8601 UTC format.

purpose'identity_verification' | 'dispute_evidence' | 'bank_verification' | 'company_verification' | 'financial_verification' | 'tax_verification'

The purpose of the file, as provided in the initial request.

_linksunknown

Example response

{
  "id": "file_6lbss42ezvoufcb2beo76rvwly",
  "status": "invalid",
  "status_reasons": [
    "InvalidMimeType"
  ],
  "size": 1024,
  "mime_type": "application/pdf",
  "uploaded_on": "2020-12-01T15:01:01.0000000+00:00",
  "purpose": "identity_verification",
  "_links": {
    "download": {
      "href": "https://s3.eu-west-1.amazonaws.com/mp-files-api-clean-prod/ent_ociwguf5a5fe3ndmpnvpnwsi3e/file_6lbss42ezvoufcb2beo76rvwly?X-Amz-Expires=3600&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.