Home > API Reference > Document Processing > Signer Authentication via OTP (Users, In-persons, E-Signers)

Signer Authentication via OTP (Users, In-persons, E-Signers)

Business applications can use this service API to generate an OTP while signing an electronic signature field or in-person field. Same service can be used to authenticate OTP for a user signing digital signature field. An OTP will be sent to the mobile number saved in user profile settings. If no phone number is found it will throw an error. 

https://api.signinghub.com/v3/packages/{package_id}/documents/{document_id}/otp

HTTP Verb

POST

Content-Type

application/json

Accept

application/json

Authorization

Bearer {access_token}

Request Body
{
  "field_name": "12345678"
}

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": "You cannot access this document after the access period ends"
}
{
   "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.

 document_id The ID of the document.

 package_id ID of the package to which the document is added. 

 field_name
Unique identifier of the field in the document.

 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
Fill Initials
Fill Form Fields
Sign Document
Decline Document
Approve Document
Submit Document
Recall Document
Finish Processing
Get Registered Devices
Authorisation Signing Request Status