Skip to content
Platforms / Onboarding / API / Full / Upload a file

Upload a file to the Platforms solution Early access

Last updated: 14th July 2022

Use our Files API to upload supporting documentation required for full due diligence, or to connect a bank account as part of our Platforms solution.

When you upload a file, the API returns an id that represents that file. You can use this id to attach:

Before you begin

If you are uploading a bank statement to verify a set of bank details, subscribe to the following webhook events:

  • payment_instrument_verification_passed
  • payment_instrument_verification_failed

Types of identification and requirements

The API accepts the following types of documentation. Depending on the identification type, you may need to provide both the back and the front. Use the table below to find out more.

TypeFront requiredBack required

Passport

Y

N

Driving licence

Y

Y

National identity card

Y

Y

Citizen card

Y

Y

Residence permit

Y

Y

Electoral ID

Y

Y

Bank statement

Y

N

Upload a file

Your request must be multipart/form-data and the file no larger than 4Mb.

  • For identification documents: the format must be in either JPEG/JPG or PNG format.
  • For bank statements and company verification: the format must be in JPEG/JPG, PNG or PDF no larger than 4Mb.

Follow the steps to upload the document and receive an id. If the identification you are providing requires both the back and front, you will need to make 2 requests to the API.

Notice that the sub-domain – files.checkout.com – is slightly different to Checkout.com's other endpoints.

    post

    https://files.checkout.com/files

    Request example

    Your request should include the file path and the purpose of the document. When uploading an identification document, set this to identification. For a full list of possible fields, see our API reference.

      1
      2
      3
      curl https://files.checkout.com/files \
        -F "path=@cw_passport.jpg;type=image/jpg'" \
        -F "purpose=identification"

      Response examples

        If you received a file id in your response, the document was accepted. You can see this association by retrieving the sub-entity.

        1
        2
        3
        4
        5
        6
        7
        8
        {
          "id": "file_6lbss42ezvoufcb2beo76rvwly",
          "_links": {
            "self": {
              "href": "https://files.sandbox.checkout.com/files/file_6lbss42ezvoufcb2beo76rvwly"
            }
          }
        }

        Example notifications for bank account verification

          1
          2
          3
          4
          5
          6
          7
          8
          9
          10
          11
          12
          13
          14
          15
          16
          17
          18
          19
          20
          {
            "id": "evt_htielsmgcwgejgqaunl4yb2pou",
            "type": "payment_instrument_verification_passed",
            "version": "1.0.0",
            "created_on": "2020-08-20T15:24:13.8431084Z",
            "data": {
              "sub_entity_id": "ent_wxglze3wwywujg4nna5fb7ldli",
              "reference": "123456789101112",
              "legal_name": "The Cake Shop Inc.",
              "payment_instrument": {
                "id": "src_h5qk7lfsp3ludfjxba256lduju",
                "label": "The Cake Shop Barclays"
              }
            },
            "_links": {
              "self": {
                "href": "https://api.sandbox.checkout.com/workflows/events/evt_htielsmgcwgejgqaunl4yb2pou"
              }
            }
          }

          Next steps

          Update a sub-entity

          Use the file id returned by the Files API to attach identity documentation required for full due diligence.

          Upload a file to your sub-entity details

          On this page

          Before you begin
          Types of identification and requirements
          Upload a file
          Example notifications for bank account verification
          Next steps