api

Document Upload

An endpoint to allow merchants to upload documents. Max file size is 36MB. Allowed file types are PDF, PNG, JPG, JPEG.

put/api/checkout/v1/documents/

Request

Base URL
https://sbx-origination.heidipay.io
Auth
HTTP bearer
TypeScript
https://skmtc.dev/heylight/apis/heidipay-checkout-api/docs/api/checkout/v1/documents/put.ts
A function with typed inputs. Its response is checked against the schema.

external_contract_uuidstring uuid

The external UUID of the contract to which the document belongs

document_type'CUSTOMER_AGREEMENT_SIGNED' | 'ID_DOCUMENT'

The type of document to upload

filestring binary

messagestring required

A human-readable success message.

No recorded changes to this operation across all 2 revisions of this API.