TL;DR: You can make a signer prove who they are even after the document is sent. One request to
/v1/document/addAuthenticationadds an email code, SMS code, access code, ID check or knowledge-based authentication (KBA) to that signer. Our signer authentication guide compares the methods.
Your app sent a lease to a tenant this morning, with no check on who opens it. Then the landlord asks for an ID check before anyone signs.
You do not need to cancel the request and start over. This guide shows how to add a check to a signer on a sent document. Each method comes with samples in five or six languages.
Why add signer authentication after sending?
Plans change after a request goes out. A deal grows, a signer’s role turns out to be more sensitive, or your team spots a risk.
Adding the check later keeps the same document, the same link and the same audit trail. The signer simply meets the check the next time they open it.
See our guide on how to require signer authentication for eSignature requests via API to set a check when you first send.
Which methods can you add to a sent document?
The add authentication endpoint accepts five values for authenticationType. Each one asks the signer to prove something different before the document opens.
- An access code is a code you pick and share with the signer yourself.
- An email one-time passcode (OTP) is a code we email to the signer.
- An SMS OTP is a code we text to the signer’s phone.
- ID verification asks for a passport, driver’s license or ID card.
- KBA asks questions drawn from public records.
KBA works only for signers based in the US. It adds a check without asking for an ID upload.
How does the add authentication request work?
You send a PATCH request to /v1/document/addAuthentication with the document ID in the address. The body names the signer by EmailId and sets the method in AuthenticationType.
Add Order when the same email appears more than once on the document. It takes the signer’s place in the list, from 1 to 50.
Each method then needs its own extra fields, shown in the sections below. Our add authentication reference lists every field.
How do you add email OTP to a sent document?
Set AuthenticationType to EmailOTP and give the signer’s email. We email them a code when they open the link, and they enter it to see the document.
curl -X PATCH \
"https://api.boldsign.com/v1/document/addAuthentication?documentId={documentId}" \
-H 'X-API-KEY: {your API key}' \
-H "Content-Type: application/json" \
-d "{\"AuthenticationType\": \"EmailOTP\", \"EmailId\": \"alex@example.com\"}"
var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");
var documentClient = new DocumentClient(apiClient);
documentClient.AddAuthentication("YOUR_DOCUMENT_ID", "alex@example.com", AuthenticationType.EmailOTP);
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="EmailOTP", emailId="alex@example.com"
)
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('EmailOTP');
$access_code_detail->setEmailId('alex@example.com');
$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.EMAIL_OTP);
accessCodeDetail.setEmailId("alex@example.com");
documentApi.addAuthentication("YOUR_DOCUMENT_ID", accessCodeDetail);
import { DocumentApi, AccessCodeDetail } from "boldsign";
const documentApi = new DocumentApi();
documentApi.setApiKey("YOUR_API_KEY");
var accessCodeDetail = new AccessCodeDetail();
accessCodeDetail.authenticationType = AccessCodeDetail.AuthenticationTypeEnum.EmailOtp;
accessCodeDetail.emailId = "alex@example.com";
var documentId = "YOUR_DOCUMENT_ID";
async function addAuthenticationToDocument() {
try {
documentApi.addAuthentication(documentId, accessCodeDetail);
console.log("Authentication added successfully!");
} catch (error: any) {
console.error("Error occurred while calling the API:", error.message);
}
}
addAuthenticationToDocument();
Too many wrong codes lock the document. Follow our guide to unlock a failed email OTP document with Resume signing.
How do you add SMS OTP to a sent document?
Set AuthenticationType to SMSOTP and add a PhoneNumber object with CountryCode and Number. We text a code to that number, and the signer enters it to open the document.
curl -X PATCH \
"https://api.boldsign.com/v1/document/addAuthentication?documentId={documentId}" \
-H 'X-API-KEY: {your API key}' \
-H "Content-Type: application/json" \
-d "{\"AuthenticationType\": \"SMSOTP\", \"EmailId\": \"alex@example.com\", \"PhoneNumber\": {\"CountryCode\": \"+1\", \"Number\": \"2015666802\"}}"
var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");
var documentClient = new DocumentClient(apiClient);
var phoneNumber = new PhoneNumber() {
CountryCode = "+1",
Number = "2015666802"
};
documentClient.AddAuthentication("YOUR_DOCUMENT_ID", "alex@example.com", AuthenticationType.SMSOTP, null, phoneNumber: phoneNumber);
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="SMSOTP",
emailId="alex@example.com",
phone_number=boldsign.PhoneNumber(country_code="+1", number="2015666802"),
)
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, PhoneNumber};
$config = new Configuration();
$config->setHost('https://api.boldsign.com');
$config->setApiKey('YOUR_API_KEY');
$document_api = new DocumentApi($config);
$phone_number = new PhoneNumber();
$phone_number->setCountryCode('+1');
$phone_number->setNumber('2015666802');
$access_code_detail = new AccessCodeDetail();
$access_code_detail->setAuthenticationType('SMSOTP');
$access_code_detail->setPhoneNumber($phone_number);
$access_code_detail->setEmailId('alex@example.com');
$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);
PhoneNumber phoneNumber = new PhoneNumber();
phoneNumber.setCountryCode("+1");
phoneNumber.setNumber("2015666802");
AccessCodeDetail accessCodeDetail = new AccessCodeDetail();
accessCodeDetail.setAuthenticationType(AccessCodeDetail.AuthenticationTypeEnum.SMSOTP);
accessCodeDetail.setPhoneNumber(phoneNumber);
accessCodeDetail.setEmailId("alex@example.com");
documentApi.addAuthentication("YOUR_DOCUMENT_ID", accessCodeDetail);
import { AccessCodeDetail, DocumentApi, PhoneNumber } from "boldsign";
const documentApi = new DocumentApi("https://api.boldsign.com");
documentApi.setApiKey("YOUR_API_KEY");
const phoneNumber = new PhoneNumber();
phoneNumber.countryCode = "+1";
phoneNumber.number = "2015666802";
const accessCodeDetail = new AccessCodeDetail();
accessCodeDetail.authenticationType = AccessCodeDetail.AuthenticationTypeEnum.Smsotp;
accessCodeDetail.phoneNumber = phoneNumber;
accessCodeDetail.emailId = "alex@example.com";
documentApi.addAuthentication("YOUR_DOCUMENT_ID", accessCodeDetail);
Check the number before you send the request. A wrong number means the signer never gets the code.
How do you add an access code to a sent document?
Set AuthenticationType to AccessCode and put your code in AccessCode. Share the code with the signer yourself, such as in a phone call, never in the same email.
curl -X PATCH \
"https://api.boldsign.com/v1/document/addAuthentication?documentId={documentId}" \
-H 'X-API-KEY: {your API key}' \
-H "Content-Type: application/json" \
-d "{\"AccessCode\": \"123456\", \"AuthenticationType\": \"AccessCode\", \"EmailId\": \"alex@example.com\"}"
var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");
var documentClient = new DocumentClient(apiClient);
documentClient.AddAuthentication("YOUR_DOCUMENT_ID", "alex@example.com", AuthenticationType.AccessCode, null, "123456");
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="alex@example.com"
)
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('alex@example.com');
$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("alex@example.com");
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 = "alex@example.com";
documentApi.addAuthentication("YOUR_DOCUMENT_ID", accessCodeDetail);
The sample uses 123456 to keep it short. Pick a code that is hard to guess for real documents.
How do you add ID verification to a sent document?
Set AuthenticationType to IdVerification and add an identityVerificationSettings object. The signer photographs a government ID before the document opens.
curl -X 'PATCH' \
'https://api.boldsign.com/v1/document/addAuthentication?documentId={your document id}' \
-H 'accept: */*' \
-H 'X-API-KEY: {your api key}' \
-H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
-d '{
"emailId": "alex@example.com",
"order": 1,
"authenticationType": "IdVerification",
"identityVerificationSettings": {
"type": "EveryAccess",
"maximumRetryCount": 10,
"requireLiveCapture": true,
"requireMatchingSelfie": true,
"nameMatcher": "Strict"
}
}'
var apiClient = new ApiClient("https://api.boldsign.com", "{your api key}");
var documentClient = new DocumentClient(apiClient);
var identityVerificationSettings = new IdentityVerificationSettings
{
Type = IdVerificationType.EveryAccess,
MaximumRetryCount = 10,
RequireLiveCapture = true,
RequireMatchingSelfie = true,
NameMatcher = NameVariation.Strict
};
await documentClient.AddAuthenticationAsync(
"{your document id}",
"alex@example.com",
AuthenticationType.IdVerification,
identityVerificationSettings: identityVerificationSettings
).ConfigureAwait(false);
import requests
import json
url = "https://api.boldsign.com/v1/document/addAuthentication?documentId={your document id}"
payload = json.dumps(
{
"emailId": "alex@example.com",
"order": 1,
"authenticationType": "IdVerification",
"identityVerificationSettings": {
"type": "EveryAccess",
"maximumRetryCount": 10,
"requireLiveCapture": True,
"requireMatchingSelfie": True,
"nameMatcher": "Strict",
},
}
)
headers = {"X-API-KEY": "{your api key}", "Content-Type": "application/json"}
response = requests.request("PATCH", url, headers=headers, data=payload)
print(response.text)
const axios = require("axios");
const documentId = "{your document id}";
const apiKey = "{your api key}";
async function addAuthentication() {
try {
const response = await axios.patch(
"https://api.boldsign.com/v1/document/addAuthentication",
{
emailId: "alex@example.com",
order: 1,
authenticationType: "IdVerification",
identityVerificationSettings: {
type: "EveryAccess",
maximumRetryCount: 10,
requireLiveCapture: true,
requireMatchingSelfie: true,
nameMatcher: "Strict",
},
},
{
params: { documentId: documentId },
headers: {
"X-API-KEY": apiKey,
"Content-Type": "application/json",
},
},
);
console.log(response.data);
} catch (error) {
console.error(error.response ? error.response.data : error.message);
}
}
addAuthentication();
<?php
require 'vendor/autoload.php';
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
$documentId = '{your document id}';
$apiKey = '{your api key}';
$client = new Client([
'base_uri' => 'https://api.boldsign.com',
'headers' => [
'X-API-KEY' => $apiKey,
'Content-Type' => 'application/json'
]
]);
$body = [
'emailId' => 'alex@example.com',
'order' => 1,
'authenticationType' => 'IdVerification',
'identityVerificationSettings' => [
'type' => 'EveryAccess',
'maximumRetryCount' => 10,
'requireLiveCapture' => true,
'requireMatchingSelfie' => true,
'nameMatcher' => 'Strict'
]
];
try {
$response = $client->patch('/v1/document/addAuthentication', [
'query' => ['documentId' => $documentId],
'json' => $body
]);
echo $response->getBody();
} catch (RequestException $e) {
if ($e->hasResponse()) {
echo $e->getResponse()->getBody();
} else {
echo $e->getMessage();
}
}
The settings object controls how the check runs:
typesets how often:EveryAccess,UntilSignCompletedorOncePerDocument.maximumRetryCountsets the number of tries, up to 10.requireLiveCaptureasks for a live camera photo of the ID.requireMatchingSelfiecompares the ID photo with a selfie.nameMatchersets how closely names must match:Strict,ModerateorLenient.
Read our identity verification settings article for what each one does.
What should you watch out for?
Test each method in the sandbox with your own email and phone first. Then check these settings before you go live.
AuthenticationRetryCountsets 1 to 10 tries for access codes and one-time codes.AuthenticationSettingssets how often those three methods ask for a code.- KBA allows 1 to 3 tries and does not work for group or in-person signers.
Use the remove authentication endpoint to take a check off again. For help with a request, open a ticket in our support portal.
Which BoldSign plan do you need, and what does it cost?
Live API access comes with the Enterprise API plan, which starts at $30 a month with 40 envelopes. Extra envelopes cost $0.75 each.
Email codes and access codes have no extra charge. SMS authentication costs $0.20 per SMS, KBA costs $1.50 per attempt and ID verification costs $2 per check.
You can build and test first in our free sandbox, with no credit card.
In the web app, SMS codes and ID checks come with the Business plan and the Premium plan. Business costs $15 per user a month and Premium $99 a month, billed yearly.
See the web app pricing or start a 30-day free trial. Prices are in USD, as of November 2026.
Where do you go next with signer authentication after sending?
Start with an email code for most documents, and add an ID check when the risk grows.
- Create a free API sandbox account and run the email OTP sample.
- Schedule a demo to pick the right check for each of your documents.
- Read how to send documents with identity verification via API.
Frequently asked questions
Can I add signer authentication after a document is sent?
Yes. Send one request to the add authentication endpoint with the document ID, the signer's email and the method. The signer then has to pass that check to open the document.
Which authentication types can I add to a sent document?
Our API reference lists five: an access code, an email code, an SMS code, an ID check and knowledge-based authentication (KBA). You set one per signer.
Do I need to send the document again after adding a check?
No. The request changes the document that is already out. The signer uses the same link and meets the new check when they open it.
What happens when a signer enters the wrong code too many times?
We lock the document and move it to Needs Attention. You unlock it with Resume signing on the document's Overview page.
How do I pick the right signer when one email appears twice?
Add the order field with that signer's place in the list, from 1 to 50. We then apply the check to that one signer.
Can I remove authentication from a sent document?
Yes. A separate endpoint removes the check from a signer on a document that is already out.
Can I add KBA after sending a document?
Yes, for signers based in the US. Set authenticationType to KBA and add kbaSettings, with one to three tries.
Is a document still legally binding after I add authentication?
Yes, when the signer agrees to sign electronically and the signed record is kept. Confirm the rules for your document type and country.