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

Below code snippet request removes 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\": \"alexgayle@cubeflakes.com\"}"
var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}");
var documentclient = new DocumentClient(apiClient);
await documentclient.RemoveAuthenticationAsync("{documentId}", "alexgayle@cubeflakes.com").ConfigureAwait(false);
import requests
import json

url = "https://api.boldsign.com/v1/document/RemoveAuthentication?documentId={documentId}"

payload = json.dumps({
  "emailId": "alexgayle@cubeflakes.com"
})
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'); 
await axios.patch( 
    'https://api.boldsign.com/v1/document/RemoveAuthentication', 
    { 
        emailId: 'alexgayle@cubeflakes.com' 
    }, 
    { 
        params: { documentId: '{documentId}' }, 
        headers: { 
          'X-API-KEY': '{Your API key}', 
          'Content-Type': 'application/json' 
        } 
    } 
); 

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 code snippet below.

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\": \"alexgayle@cubeflakes.com\", \"zOrder\": 2}"
var apiClient = new ApiClient("https://api.boldsign.com", "{apikey}");
var documentclient = new DocumentClient(apiClient);
await documentclient.RemoveAuthenticationAsync("{documentId}", "alexgayle@cubeflakes.com", 2).ConfigureAwait(false);
import requests
import json

url = "https://api.boldsign.com/v1/document/RemoveAuthentication?documentId={documentId}"

payload = json.dumps({
  "emailId": "alexgayle@cubeflakes.com",
  "zOrder": 2
})
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'); 
await axios.patch( 

    'https://api.boldsign.com/v1/document/RemoveAuthentication', 

    { 
        emailId: 'alexgayle@cubeflakes.com', 
        zOrder: 2 
    }, 

    { 
        params: { 'documentId': '{documentId}' }, 
        headers: { 
           'X-API-KEY': '{Your API key}', 
           'Content-Type': 'application/json' 
        } 
    } 
); 

Query parameters

Heading1Heading2
documentIdstringRequiredID of the requested document

Request body

Heading1Heading2
emailIdstringRequiredEmail address of the signer.
onBehalfOfstringIf the document is created on behalf of the sender, the sender's identity email address must be specified.
zOrderIntA number that denotes the signer's order, which targets the given email address present in the recipient list.

Example response

204 No Content