Add Access Code Authentication After Sending

BoldSign allows you to add access code authentication even after a document has been sent for signature.

To authenticate signers using an access code via the BoldSign API, set the AuthenticationType to AccessCode and specify a unique code (e.g., “1234”) in the AccessCode property. This access code will be required when the sender wishes to verify the signer's identity using a specific code. The access code should be communicated to the signer personally in advance.

The following sample code snippets demonstrate how to add access code authentication for one of a document's recipients.

Code snippet

curl -X PATCH "https://api.boldsign.com/v1/document/addAuthentication?documentId={Your document id}"
      -H -H 'X-API-KEY: {Your API Key}'
-H "Content-Type: application/json"
      -d "{\"accessCode\": \"345678\", \"authenticationType\": \"AccessCode\", \"emailId\": \"[email protected]\"}"

using BoldSign.Api;
using BoldSign.Model;

var apiClient = new ApiClient("https://api.boldsign.com", "{Your API Key}");
var documentclient = new DocumentClient(apiClient);
await documentclient.AddAuthenticationAsync("{Your document id}", "[email protected]", AuthenticationType.AccessCode, null, "45678").ConfigureAwait(false);

import boldsign

configuration = boldsign.Configuration(host="https://api.boldsign.com", api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:

    document_api = boldsign.DocumentApi(api_client)

    access_code_detail = boldsign.AccessCodeDetail(
        authenticationType="AccessCode",
        accessCode="123456",
        emailId="[email protected]"
    )

    response = document_api.add_authentication(
        document_id="YOUR_DOCUMENT_ID",
        access_code_detail=access_code_detail
    )

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

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

$config = new Configuration();
$config->setHost('https://api.boldsign.com');
$config->setApiKey('YOUR_API_KEY');

$document_api = new DocumentApi($config);

$access_code_detail = new AccessCodeDetail();
$access_code_detail->setAuthenticationType('AccessCode');
$access_code_detail->setAccessCode('123456');
$access_code_detail->setEmailId('[email protected]');

$document_api->addAuthentication($document_id = 'YOUR_DOCUMENT_ID', $access_code_detail);

ApiClient client = Configuration.getDefaultApiClient();
client.setBasePath("https://api.boldsign.com"); 
client.setApiKey("YOUR_API_KEY");
        
DocumentApi documentApi = new DocumentApi(client);

AccessCodeDetail accessCodeDetail = new AccessCodeDetail();
accessCodeDetail.setAuthenticationType(AccessCodeDetail.AuthenticationTypeEnum.ACCESS_CODE);
accessCodeDetail.setAccessCode("123456");
accessCodeDetail.setEmailId("[email protected]");

documentApi.addAuthentication("YOUR_DOCUMENT_ID", accessCodeDetail);

import { AccessCodeDetail, DocumentApi } from "boldsign";

const documentApi = new DocumentApi("https://api.boldsign.com");
documentApi.setApiKey("YOUR_API_KEY");

const accessCodeDetail = new AccessCodeDetail();
accessCodeDetail.authenticationType = AccessCodeDetail.AuthenticationTypeEnum.AccessCode;
accessCodeDetail.accessCode = "123456";
accessCodeDetail.emailId = "[email protected]";

documentApi.addAuthentication("YOUR_DOCUMENT_ID", accessCodeDetail);

In the provided code examples, make sure to update the authenticationType to AccessCode and specify the unique value to the accessCode. Replace the documentId with the actual ID of the document you created and update SignerEmail with the signer's email address.

After executing the code, the document will be secured with access code authentication, and the signer will only be able to access the document by providing the correct access code.