Remove authentication from the document

patch/v1/document/RemoveAuthentication

Removes authentication from the signature request document, and the recipient is no longer required to provide a secure code when accessing the signing page.

Code snippet

The following sample code snippet requests for the removal of authentication for a particular recipient in the document signing process.

curl -X PATCH "https://api.boldsign.com/v1/document/RemoveAuthentication?documentId={documentId}"
     -H 'X-API-KEY: {your API key}'
     -H "Content-Type: application/json"
     -d "{\"EmailId\": \"[email protected]\"}"

var apiClient = new ApiClient("YOUR_API_KEY");

var documentClient = new DocumentClient(apiClient);
documentClient.RemoveAuthentication("YOUR_DOCUMENT_ID", "[email protected]");

import boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    
    document_api = boldsign.DocumentApi(api_client)
	
    remove_authentication = boldsign.RemoveAuthentication(emailId="[email protected]")
    
    document_api.remove_authentication(document_id="YOUR_DOCUMENT_ID", remove_authentication =remove_authentication)

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\RemoveAuthentication;

$config = new Configuration();
$config->setApiKey('YOUR_API_KEY');

$document_api = new DocumentApi($config);

$remove_authentication = new RemoveAuthentication();
$remove_authentication->setEmailId('[email protected]');

$document_api->removeAuthentication($document_id = 'YOUR_DOCUMENT_ID', $remove_authentication);

ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
			
DocumentApi documentApi = new DocumentApi(client);

RemoveAuthentication removeAuthentication = new RemoveAuthentication();
removeAuthentication.setEmailId("[email protected]"); 

documentApi.removeAuthentication("YOUR_DOCUMENT_ID", removeAuthentication);

import { DocumentApi, RemoveAuthentication } from "boldsign";

const documentApi = new DocumentApi();
documentApi.setApiKey("YOUR_API_KEY");

const removeAuthentication = new RemoveAuthentication();
removeAuthentication.emailId = "[email protected]";

documentApi.removeAuthentication("YOUR_DOCUMENT_ID", removeAuthentication);

If a document contains repeated signers with signing order, in that case, the recipient's signing order can be specified along with the signer's email in the remove authentication request, as shown in the following code snippet.

curl -X PATCH "https://api.boldsign.com/v1/document/RemoveAuthentication?documentId={documentId}"
     -H 'X-API-KEY: {your API key}'
     -H "Content-Type: application/json"
     -d "{\"EmailId\": \"[email protected]\", \"zOrder\": 2}"

var apiClient = new ApiClient("YOUR_API_KEY");

var documentClient = new DocumentClient(apiClient);
documentClient.RemoveAuthentication("YOUR_DOCUMENT_ID", "[email protected]", 1);

import boldsign

configuration = boldsign.Configuration(api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    
    document_api = boldsign.DocumentApi(api_client)
	
    remove_authentication = boldsign.RemoveAuthentication(emailId="[email protected]", zOrder=1)
    
    document_api.remove_authentication(document_id="YOUR_DOCUMENT_ID", remove_authentication =remove_authentication)

<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\RemoveAuthentication;

$config = new Configuration();
$config->setApiKey('YOUR_API_KEY');

$document_api = new DocumentApi($config);

$remove_authentication = new RemoveAuthentication();
$remove_authentication->setEmailId('[email protected]');
$remove_authentication->setZOrder(1);

$document_api->removeAuthentication($document_id = 'YOUR_DOCUMENT_ID', $remove_authentication);

ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
			
DocumentApi documentApi = new DocumentApi(client);

RemoveAuthentication removeAuthentication = new RemoveAuthentication();
removeAuthentication.setEmailId("[email protected]"); 
removeAuthentication.setzOrder(1);

documentApi.removeAuthentication("YOUR_DOCUMENT_ID", removeAuthentication);

import { DocumentApi, RemoveAuthentication } from "boldsign";

const documentApi = new DocumentApi();
documentApi.setApiKey("YOUR_API_KEY");

const removeAuthentication = new RemoveAuthentication();
removeAuthentication.emailId = "[email protected]";
removeAuthentication.zOrder = 1;

documentApi.removeAuthentication("YOUR_DOCUMENT_ID", removeAuthentication);

Query parameters

documentIdstringRequired

ID of the requested document

Request body

EmailIdstringRequired	Email address of the signer.
OnBehalfOfstring	If the document is created on behalf of the sender, the sender's identity email address must be specified.
zOrderInt	A number that denotes the signer's order, which targets the given email address present in the recipient list.

Example response

204 No Content