Skip to main content
POST
Upload init: create a Pending document row and return a

Authorizations

Authorization
string
header
required

Issue keys in Settings → API. Send them as Authorization: Bearer ont_… (an X-Api-Key: ont_… header is also accepted). Session-cookie routes are used by the OnTime web apps and are shown for completeness.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
category
enum<string>
required
Available options:
IdentityKYC,
Onboarding,
Education,
Payroll,
Medical,
Performance,
Other
name
string
required
Minimum string length: 1
mimeType
string
required
Minimum string length: 1
sizeBytes
integer
required
Required range: x <= 9007199254740991
expiresAt
string | null
description
string | null

Response

200 - application/json

Success

documentId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
uploadUrl
string
required
storageKey
string
required