/v1/definitions/{key}/rows/{rowId}/documents/{documentType}/standingSet a document's standing on a deal
Sets ONE record's own standing on ONE document (0208): severity — required, warning (the app's "Needed") or nice_to_have ("Helpful"), or "" to hand the decision back to the deal type's rule — and waived with an optional waivedReason, which flags that paper not necessary on THIS deal. The document type is the path segment. Use it when a deal type's required documents do not fit a particular merchant (a sole trader with no articles of incorporation, a licence already on file from the last funding) — it changes nothing for any other deal, unlike editing the workspace's completeness rules. A waived item stays on the checklist and stops counting towards complete. PUT replaces, so saying it twice is saying it once and there is no 409. Answers the whole refreshed checklist, the same shape get_definitions_key_rows_rowId_documents_checklist returns.
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": {
"complete": true,
"dealType": "string",
"dealTypeLabel": "string",
"formBorn": true,
"items": [
{
"askedBy": "string",
"check": "string",
"documentType": "string",
"fileIds": "string",
"label": "string",
"requestId": "",
"severity": "string",
"source": "string",
"state": "string",
"waived": "string",
"waivedReason": "string"
}
],
"judged": true
}
}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"
}