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

NEW

For higher api limits try new version V2 Read more

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 (if prepare_document is not true), use api.rightsignature.com/public/{version}/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": "waiting_for_file", // "waiting_for_file" | "downloading" | "processing" | "creating_document" | "completed" | "errored"
}

// when prepare_document is true
POST /public/{version}/sending_requests/1ec17395-6137-4c35-9c41-37ec7265184a/uploaded
{
  "prepare_document": true
}
200
{
  "url": "https://secure.rs.dev:3000/document-builder-flow-grant?document_builder_flow_grant_token=c755e4ed-2554-485c-8906-c0a2785676b6"
}

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.