Change access code

patch/v1/document/changeAccessCode

The sender can change the access code on an already authenticated document, and you must communicate with the recipient and pass on the code.

Code snippet

Use the following sample code snippet to change the access code for the signer who has already been authenticated.

curl -X PATCH "https://api.boldsign.com/v1/document/changeAccessCode?documentId={documentId}&emailId=alexgayle@cubeflakes.com" 
     -H 'X-API-KEY: {your API key}' 
     -H "Content-Type: application/json" 
     -d "{\"AccessCode\": \"123456\"}"

var apiClient = new ApiClient("YOUR_API_KEY");

var documentClient = new DocumentClient(apiClient);
documentClient.ChangeAccessCode("YOUR_DOCUMENT_ID", "david@cubeflakes.com", "123456");

import boldsign

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

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)
	
    access_code_details = boldsign.AccessCodeDetails(accessCode="12345")
    
    document_api.change_access_code(document_id="YOUR_DOCUMENT_ID", access_code_details=access_code_details, email_id="david@cubeflakes.com")

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

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

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

$document_api = new DocumentApi($config);

$access_code_details = new AccessCodeDetails();
$access_code_details->setAccessCode('123456');

$document_api->changeAccessCode($document_id = 'YOUR_DOCUMENT_ID', $access_code_details, $email_id = 'david@cubeflakes.com');

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

AccessCodeDetails accessCodeDetails = new AccessCodeDetails();
accessCodeDetails.setAccessCode("123456");

documentApi.changeAccessCode("YOUR_DOCUMENT_ID", accessCodeDetails, "alexgayle@cubeflakes.com", null);

import { DocumentApi, AccessCodeDetails } from "boldsign";

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

const accessCodeDetails = new AccessCodeDetails();
accessCodeDetails.accessCode = "12345";

documentApi.changeAccessCode("YOUR_DOCUMENT_ID", accessCodeDetails, "alexgayle@cubeflakes.com");

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

curl -X PATCH "https://api.boldsign.com/v1/document/changeAccessCode?documentId={documentId}&emailId=alexgayle@cubeflakes.com&zOrder=2" 
    -H 'X-API-KEY: {your API key}' 
    -H "Content-Type: application/json" 
    -d "{\"AccessCode\": \"123456\"}"

var apiClient = new ApiClient("YOUR_API_KEY");

var documentClient = new DocumentClient(apiClient);
documentClient.ChangeAccessCode("YOUR_DOCUMENT_ID", "david@cubeflakes.com", "123456", 1);

import boldsign

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

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)
	
    access_code_details = boldsign.AccessCodeDetails(accessCode="123456")
    
    document_api.change_access_code(document_id="YOUR_DOCUMENT_ID", access_code_details=access_code_details, email_id="david@cubeflakes.com", z_order=1)

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

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

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

$document_api = new DocumentApi($config);

$access_code_details = new AccessCodeDetails();
$access_code_details->setAccessCode('123456');

$document_api->changeAccessCode($document_id = 'YOUR_DOCUMENT_ID', $access_code_details, $email_id = 'david@cubeflakes.com', $z_order = 1);

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

AccessCodeDetails accessCodeDetails = new AccessCodeDetails();
accessCodeDetails.setAccessCode("123456");

documentApi.changeAccessCode("YOUR_DOCUMENT_ID", accessCodeDetails, "alexgayle@cubeflakes.com", 1);

import { AccessCodeDetails, DocumentApi } from "boldsign";

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

const accessCodeDetails = new AccessCodeDetails();
accessCodeDetails.accessCode = "123456";

documentApi.changeAccessCode("YOUR_DOCUMENT_ID", accessCodeDetails, "alexgayle@cubeflakes.com", 1);

Query parameters

documentIdstringRequired	ID of the requested document.
emailIdstringRequired	Email address of the signer.
zOrderInt	A number that denotes the signer's order, which targets the given email address present in the recipient list.

Request body

AccessCodestringRequired	A set of alphanumeric characters will be specified by the sender that the recipient wants to change.
OnBehalfOfstring	If the document is created on behalf of the sender, the sender's identity email address must be specified.

Example response

204 No Content