Back to Developers
Getting Started Authentication Document Workflows Resources What's New in API v2

API version:

POST /public/v2/sending_requests/:id/uploaded
Create a new Sending Request to ultimately send a one-off Document

Triggers the processing of the uploaded file into a Document. The file must be completely uploaded to the Sending Request's upload_url. Processing happens asynchronously, use api.rightsignature.com/public/v2/sending_requests/SENDING_REQUEST_ID to check the status or wait for updates if callback_url is set.

Supported Formats

json

Errors

Code Description
400 invalid_scope
400 unauthorized_client
401 Could not find resource owner
401 Resource owner is not entitled
401 invalid_token
401 Must be authenticated.
401 Unauthorized application.
422 Bad input parameter. Error message should indicate which one and why.
404 Sending Request not found.
404 Sending Request '<ID>' not found.
404 Sending Request already processed.

Examples

POST /public/{version}/sending_requests/SENDING_REQUEST_ID/uploaded

curl -H "Accept: application/json" -H "Content-Type: application/json" -X POST https://api.rightsignature.com/public/{version}/sending_requests/SENDING_REQUEST_ID/uploaded

{
  "id": SENDING_REQUEST_ID,
  "status": "processing",
  "status_message": null,
  "document_template_id": null,
  "created_at": "created date and time",
  "updated_at": "updated date and time",
  "document_preparation_url": null
}

Params

Param name Description
id
required

Sending Request ID

Validations:

  • Must be a String
prepare_document
optional

Whether the document should be sent or an url to be returned for preparing the document

Validations:

  • Must be one of: true, false.