getstarted.ae

Upload a file

POSThttps://api.getstarted.ae/v1/files

Uploads a file and returns a fileId you can attach to any number of document slots.

  • Send multipart/form-data. Accepted types: PDF, JPEG, PNG. Maximum size 20 MB.

Form fields (multipart/form-data)

  • filebinaryrequired

    The file contents.

  • purposeenumrequired

    IDENTITY_DOCUMENT, ADDRESS_DOCUMENT, CORPORATE_DOCUMENT or OTHER.

Responses

  • 201Created. Returns the object shown in the example.
  • 400missing_file No file part in the request.
  • 413file_too_large The file is larger than 20 MB.
  • 422unsupported_file_type The file is not a PDF, JPEG or PNG.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X POST "https://api.getstarted.ae/v1/files" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY" \
  -F "file=@maya-okafor-passport.pdf" \
  -F "purpose=IDENTITY_DOCUMENT"
Response · 201
{
  "id": "file_01J9ZKG1DV4K8N",
  "object": "file",
  "filename": "maya-okafor-passport.pdf",
  "contentType": "application/pdf",
  "size": 482113,
  "purpose": "IDENTITY_DOCUMENT",
  "sha256": "9f2c4d1e7a0b3c58e6f14a27d90b5c3e81f62a4d7c09e5b1a38f6d2c4e7b9a01",
  "createdAt": "2026-09-20T08:50:44Z"
}