Home > API Reference > Document Workflow > Open Document via OTP (Generate)

Open Document via OTP (Generate)

Business applications can use this service API to generate an OTP for a particular recipient, specified by the order. 

https://api.signinghub.com/v3/packages/{package_id}/workflow/{order}/authentication/otp

HTTP Verb

POST

Content-Type

application/json

Accept

application/json

Authorization

Bearer {access_token}

Request Body

 

Status Code

Message

Response Body

200

OK


401

Unauthorized

{
  "Message": "Request authorization denied"
}
{
  "Message": "User authentication required"
}

403

Forbidden

{
  "Message": "Document does not belong to user"
}
{
  "Message": "Account is disabled"
}

404

Not Found

{
  "Message": "Document not found"
}

500

Internal Server Error

{
  "Message": "An internal server error occurred while processing the request"
}

The detail of each item provided in the request and response is provided below:

 Item Details
 Names
 Description
 Request Parameters
 access_token The access token obtained as a result of successful authentication. If "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges.

 order The order of the recipient for which the OTP is to be generated.

 package_id
The ID of the package for which the OTP is to be generated.

 Response Parameters
 Message The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.



See also
Get Workflow Details
Update Workflow Details
Get Workflow History
Get Workflow History Details
Get Certificate Saved In Workflow History
Get Process Evidence Report
Update Post Processing
Add Users to Workflow
Update Workflow User
Add Groups to Workflow
Update Workflow Group
Add Placeholder to Workflow
Update Placeholder
Get Workflow Users
Update Workflow Users Order
Get Workflow User Permissions
Update Workflow User Permissions
Get Workflow User Authentication (Document Opening)
Update Workflow User Authentication (Document Opening)
Delete Workflow User
Open Document via Password
Get Workflow Reminders
Update Workflow Reminders
Complete Workflow in the Middle (Terminate Workflow)