/deal-applications/{application_id}/signature-requests/Requires deal_application_sharing:write. Review the contract and confirm the recipient and access before sending. Queue a verified invitation for this exact signature and repeated item; this neither signs nor submits. Default to signature_only. Retain Idempotency-Key and exact body for retries. GET the returned request ID to observe delivery and completion; do not create another request merely because email remains queued.
- Required permissions
deal_application_sharing:write- Available scopes
- Entire Portal or Selected source channels
Headers and URL parameters
| Name | Location | Type | Required |
|---|---|---|---|
application_idView parameter schema | path | string | Yes |
Idempotency-KeyView parameter schema | header | string | Yes |
Request body
application/json · Required body
| Field | Type | Required |
|---|---|---|
access_modesignature_only authorizes the requested signing task. edit also allows application edits and submission where permitted. Existing broader access is preserved. | string | No |
block_keySignature block_key from the live contract. | string | Yes |
email | string | Yes |
item_idRequired for a repeated signature; copy item_id from repeatable-item reads. | string or null | No |
message | string | No |
View request schema
Example request
curl --request POST \
--url "https://api.levr.ai/v1/deal-applications/$APPLICATION_ID/signature-requests/" \
--header "Authorization: Bearer $LEVR_API_KEY" \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--header "Content-Type: application/json" \
--data "@request.json"curl --request POST \
--url "https://api.levr.ai/v1/deal-applications/$APPLICATION_ID/signature-requests/" \
--header "Authorization: Bearer $LEVR_API_KEY" \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--header "Content-Type: application/json" \
--data '{
"block_key": "owner_credit_authorization",
"item_id": "ansitem_9c9fd315f3e74aa0a8940698d0b341c0",
"email": "maya@example.com",
"access_mode": "signature_only",
"message": "Please review and sign your credit authorization."
}'Responses
| Status | What it means |
|---|---|
201 | Current signing request. Delivery and completion are separate facts. View response headers
View response schemaIllustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response |
400 | Correct the request fields and try again. View response headers
View response schemaIllustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response |
401 | Provide a valid API key and try again. View response headers
View response schemaIllustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response |
403 | This API key does not allow the requested action. View response headers
View response schemaIllustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response |
404 | The requested resource was not found or is not available to this API key. View response headers
View response schemaIllustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response |
409 | The request conflicts with the resource's current state. Refresh it before trying again. View response headers
View response schemaIllustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response |
429 | Too many requests were sent. Wait before trying again. View response headers
View response schemaIllustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response |
500 | Levr could not complete the request. Keep the request ID and retry when safe. View response headers
View response schemaIllustrative data. Use the identifiers, cursors, and URLs returned by your requests. View example response |
