/v1/definitions/{key}/rows/{rowId}/stipulationsRequest stipulations
Work out which bank-statement months and tax-return years this record is short of, add any other papers named in documentTypes (a voided check, a driver's license — asked for by name, no calendar behind them), record one ask per missing document type carrying the exact spans, and send the merchant ONE message over SMS or email in the same act. The words come from the workspace's shelf: one paper short takes that paper's own template, several short takes the general missing-information one. Reach for it when a deal is missing paperwork and the merchant needs telling; the plain document-request route is for writing down a single named document and sends nothing. Refuses with 400 when the record already holds everything in the window and nothing was named.
Access class: def:read.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"asks": [
{
"documentType": "string",
"id": "",
"note": "string",
"periods": [
{
"label": "string",
"periodEnd": "string",
"periodStart": "string"
}
],
"requestedAt": "string",
"requestedBy": 1.5,
"rowId": "",
"status": "string"
}
],
"filed": true,
"notSentBecause": "string",
"statementMonths": 1.5,
"taxReturnYears": 1.5
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}