Skip to main content
POST
Upload a filing document

Authorizations

Authorization
string
header
required

Effective API key. Send Authorization: Bearer sk-eai-...

Path Parameters

filingId
string<uuid>
required

Body

application/json
fileName
string
required

Filename including extension, for example form.pdf. Maximum 255 characters.

Required string length: 1 - 255
sizeBytes
integer
required

Exact file size in bytes.

Required range: 0 <= x <= 9007199254740991
mimeType
string

Media type, for example application/pdf. Inferred from the filename when omitted.

Required string length: 1 - 255

Response

Instructions for uploading the file. Valid for one hour.

uploadToken
string
required

Opaque upload token. Return it unchanged to the completion endpoint for this filing within one hour.

Required string length: 1 - 16384
fileName
string
required

Selected filename; may be renamed to avoid a collision.

uploadUrl
string<uri>
required

Pre-signed URL for direct PUT upload to storage

method
enum<string>
required
Available options:
PUT
headers
object
required

Include these headers when uploading the bytes. Send API credentials only to Effective, not to the upload URL.

expiresAt
string<date-time>
required

Expiry of the upload URL and completion token.