Skip to main content
POST
Request documents from a customer
Ask an individual customer for documents — the same flow the in-app “request documents” action runs, emailing them a secure portal link. Provide items inline, or reference a saved document packageId. Requires the documents:write scope.

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers in your Instant Compliance organisation. Format: ic_live_….

Headers

Idempotency-Key
string

Caller-supplied unique key for safe retries. Repeat the same key within 24 hours and we replay the original response instead of repeating the side effect. Reusing the key with a different request body returns 409 idempotency_conflict.

Maximum string length: 255

Path Parameters

id
string
required

Individual customer identifier (UUID or your external_id).

Body

application/json

Provide at least one inline item, or a packageId.

title
string
required
Required string length: 1 - 255
note
string
Maximum string length: 2000
items
object[]
Maximum array length: 50
packageId
string<uuid>

Reference a saved document package instead of inline items.

Response

The document request that was created.

id
string<uuid>
title
string
note
string | null
status
enum<string>
Available options:
PENDING,
IN_PROGRESS,
SUBMITTED,
COMPLETE,
CANCELLED
recipient_name
string | null
recipient_email
string | null
requested_at
string<date-time>
completed_at
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>
items
object[]