Participant access control

Transaction documents often contain personal or private information. Thus, by default, the access to the signature page for all the participants of a transaction is protected by an OTP authentication.

However, you may want to disable this secured access in order to simplify your participant’s journey. We allow you to deactivate access control, so your participants can access directly the transaction documents.

Note that when access control is active, the access token generated after email verification is valid for 10 hours.

Deactivate access control for simple signatures

To deactivate access control and allow a participant performing a simple signature to access the signature page without any email OTP authentication, follow the steps below:

1. Make sure the disable_access_control feature for simple signature is activated on your workspace. If not, contact your account manager at Universign.
2. Set the min_signature_level argument. Expected value is level0 or level1.
3. Set the access_control agrument to none.
4. Set the send_signed_documents_mail argument to false. For more details, visit Deactivate completed transactions email.
5. Do not set the schedule argument. For more details, visit Add invitation message.

To disable access control for a participant performing a simple signature, send a request to POST /v1/transactions/{transaction_id}/participants as follows:

curl
https://api.universign.com/v1/transactions/tx_AWo949MOq0JE/participants \
-d [email protected] \
-d min_signature_level=level1 \
-d send_signed_documents_mail=false \
-d access_control=none

Response example

{
"email" : "[email protected]",
"phone_number_type" : "suggestion",
"min_signature_level" : "level1",
"schedule" : [ ],
"send_signed_documents_mail" : false,
"ongoing_conversation" : false,
"has_unread_message" : false,
"state" : "open",
"access_control" : "none",
"waiting_period" : 0,
"full_name_type" : "suggestion"
}

Deactivate access control for all signature levels

To deactivate access control and allow a participant performing a signature of any level to access the signature page without any email OTP authentication, follow the steps below:

1. Make sure the disable_access_control feature is activated on your workspace. If not, contact your account manager at Universign.
2. Set the min_signature_level argument.
3. Set the access_control agrument to none.
4. Set the send_signed_documents_mail argument to false. For more details, visit Deactivate completed transactions email.
5. Do not set the schedule argument. For more details, visit Add invitation message.
6. Set the email_verification_method argument to prevalidated. This means that you need to verify the participant’s email address by your own means.

Note that deactivating access control for all signature levels is only available fot the Full Transaction Request. For more details, visit Full transaction request.

Request example

"participants" : [
    {
    "email" : "[email protected]",
    "full_name" : "john Doe",
    "full_name_type" : "prerequisite",
    "invitation_subject" : "This is an invitation subject",
    "invitation_message" : "This is an invitation message",
    "min_signature_level": "level1",
    "access_control": "none",
    "send_signed_documents_mail": "false",
    "email_verification_method": "prevalidated",
    "invitation_redirect_url" : "https://www.signaturit.com/&redirect_time_out=5"
  }]

Response example

"participants" : [ {
    "email" : "[email protected]",
    "phone_number_type" : "suggestion",
    "min_signature_level" : "level1",
    "invitation_subject" : "This is an invitation subject",
    "invitation_message" : "This is an invitation message",
    "schedule" : [ ],
    "send_signed_documents_mail" : false,
    "ongoing_conversation" : false,
    "has_unread_message" : false,
    "state" : "open",
    "access_control" : "none",
    "email_verification_method" : "prevalidated",
    "signature_image_policy" : "none",
    "document_reading_policy" : "optional",
    "name_constraint" : "john Doe",
    "fullname_prerequisite" : "john Doe",
    "waiting_period" : 0,
    "invitation_redirect_url" : "https://www.signaturit.com/&redirect_time_out=5",
    "full_name_type" : "prerequisite",
    "full_name" : "john Doe"
  } ],

---

Set workflow

← Previous

Set URL redirection

Next →