Request a typed document from the client
Notifies the client through the same mechanism a message with request_upload uses, deep-linked to this item. Capped at 20 open (not forwarded or waived) requests per deal.
Authorization
ApiKeyAuth Lender keys start with cv_live_; Partner keys start with cv_pk_. Shown once at creation, sent on every request. The Lender API has no separate sandbox key: the same cv_live_ key works on sandbox.capvant.com, where only your test deals exist.
In: header
Path Parameters
The deal reference as it appears on the deal, for example 93A41205CE. Case-insensitive. Treat it as an opaque string: do not validate a prefix or a pattern.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://sandbox.capvant.com/deals/string/requests" \ -H "Content-Type: application/json" \ -d '{ "item_type": "bank_statements_6m" }'{ "request": { "id": "string", "item_type": "bank_statements_6m", "label": "string", "note": "string", "status": "requested", "requested_via": "hub", "requested_at": "2019-08-24T14:15:22Z", "uploaded_at": "2019-08-24T14:15:22Z", "forwarded_at": "2019-08-24T14:15:22Z", "file_count": 0, "has_files": true }}