HomeGuidesAPI ReferenceChangelog
Home
API Reference

Upload a file for entity

Uploads one or more files against a requirement.

Allowed requirementSlug values (grouped by use case):

  • Universal KYC: ukyc-id-document, ukyc-proof-of-address-document, ukyc-curp-document
  • Universal KYB — Pack: certificate-of-incorporation, company-profile, ubo-kyc, ownership-structure-chart, board-resolution
  • Universal KYB — EDD: source-of-funds-supporting-doc, source-of-wealth-supporting-doc

Allowed extensions: .jpg, .jpeg, .pdf, .png, .gif, .xlsx, .xls, .doc, .docx, .csv. The declared multipart MIME type must match the extension (e.g. .pdf requires application/pdf).

File cap: up to 15 files per requirement. Subsequent uploads beyond the cap are rejected.

Append-on-upload: every successful POST creates a new submission record while carrying forward all previously uploaded files for the same requirement. Re-uploading therefore adds to the requirement instead of replacing it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the entity for which the file is being uploaded.

string
enum
required

The slug of the requirement for which the file is being uploaded. See the endpoint description for the slug list grouped by use case (Universal KYC, UKYB Pack, UKYB EDD).

Query Params
string

The ID of the entity member for which the file is being uploaded.

Body Params

The file(s) to upload. Allowed extensions: .jpg, .jpeg, .pdf, .png, .gif, .xlsx, .xls, .doc, .docx, .csv.

files
array of files
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json