POST
/
v1
/
document-reviews
/
user
/
:userId
/
request-general
curl -X POST https://v2.app-dev.zquence.com/v1/document-reviews/user/usr_01HX3ZAB/request-general \
  -H "content-type: application/json" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY" \
  -d '{
    "displayName": "Proof of address",
    "documentCode": "requested.proofOfAddress.s3Key",
    "note": "Please provide a utility bill issued within the last three months."
  }'
Requires API-key scope document-reviews.write and tenant permission transaction.update.
userId
string
required
The tenant user who must provide the document.
displayName
string
required
User-facing document name, up to 120 characters.
documentCode
string
Stable document code, up to 180 characters. One is generated when omitted.
note
string
Optional instructions for the user, up to 500 characters.
curl -X POST https://v2.app-dev.zquence.com/v1/document-reviews/user/usr_01HX3ZAB/request-general \
  -H "content-type: application/json" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY" \
  -d '{
    "displayName": "Proof of address",
    "documentCode": "requested.proofOfAddress.s3Key",
    "note": "Please provide a utility bill issued within the last three months."
  }'
An empty or invalid displayName returns 400. A user outside the API key’s tenant is not eligible for a document request.