Sender identities

BoldSign allows you to perform various operations on behalf of another user. For example, you can send a document to the signer on behalf of another user. The operations like sending documents, download audit log, revoke, remind, change access code, etc., can be performed on behalf of.

To perform on behalf of operations, the sender identity should be added and approved. Add the user as a sender identity, and then the user will get an email for approval. Once the user approves the request, you can perform operations on behalf of that user.

This section demonstrates how to create a sender identity, update the identity, delete an identity, list all the identities, request for approval, and resend the invitation.

Create identity

post/v1/senderIdentities/create

Creates a new sender identity by taking the name and email address. Multiple sender identities can be created.

Code snippet

curl -X 'POST' \
  'https://api.boldsign.com/v1/senderIdentities/create' \
  -H 'accept: */*' \
  -H 'X-API-KEY: {your API key}' \
  -H 'Content-Type: application/json;odata.metadata=minimal;odata.streaming=true' \
  -d '{
  "name": "Luther Cooper",
  "email": "luthercooper@cubeflakes.com",
  "redirectUrl": "https://boldsign.com",
  "brandId": "c94d34e9-8f1f-4ab1-926d-daa32095a851",
  "notificationSettings": {
    "viewed": true,
    "sent": false,
    "deliveryFailedFor": true,
    "declined": true,
    "revoked": true,
    "reassigned": true,
    "completed": true,
    "signed": true,
    "expired": true,
    "authenticationFailed": true,
    "reminders": true,
    "attachSignedDocument": false
  },
  "metaData": {
    "tenantId": "xxxxx070-xxxx-xxxx-xxxx-757xxxxxxxxx",
    "accountPlan": "Free"
  }
}'

var apiClient = new ApiClient("YOUR_API_KEY");

var senderIdentityClient = new SenderIdentityClient(apiClient);

var senderIdentityRequest = new SenderIdentityRequest("Luther Cooper", "luthercooper@cubeflakes.com", null);
senderIdentityRequest.MetaData = new Dictionary<string, string>()
{
  ["tenantId"] = "xxxxx070-xxxx-xxxx-xxxx-757xxxxxxxxx",
  ["accountPlan"] = "Free"
};

var senderIdentityCreated = senderIdentityClient.CreateSenderIdentity(senderIdentityRequest);

import boldsign

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

with boldsign.ApiClient(configuration) as api_client:
    
    sender_identities_api = boldsign.SenderIdentitiesApi(api_client)
	
    sender_identity_request = boldsign.CreateSenderIdentityRequest(
        name="Luther Cooper",
        email="luthercooper@cubeflakes.com",
    )
    
    sender_identities_api.create_sender_identities(sender_identity_request)

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

use BoldSign\Configuration;
use BoldSign\Api\SenderIdentitiesApi;
use BoldSign\Model\CreateSenderIdentityRequest;

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

$sender_identities_api = new SenderIdentitiesApi($config);

$sender_identity_request = new CreateSenderIdentityRequest();
$sender_identity_request->setName('Luther Cooper');
$sender_identity_request->setEmail('luthercooper@cubeflakes.com');

$sender_identities_api->createSenderIdentities($sender_identity_request);

ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");
            
SenderIdentitiesApi senderIdentitiesApi = new SenderIdentitiesApi(client);

CreateSenderIdentityRequest senderIdentityRequest = new CreateSenderIdentityRequest();
senderIdentityRequest.setName("Luther Cooper");
senderIdentityRequest.setEmail("luthercooper@cubeflakes.com");

senderIdentitiesApi.createSenderIdentities(senderIdentityRequest);

import { SenderIdentitiesApi, CreateSenderIdentityRequest } from "boldsign";

const senderIdentitiesApi = new SenderIdentitiesApi();
senderIdentitiesApi.setApiKey("YOUR_API_KEY");

const senderIdentityRequest = new CreateSenderIdentityRequest();
senderIdentityRequest.name = "Luther Cooper";
senderIdentityRequest.email = "luthercooper@cubeflakes.com";

senderIdentitiesApi.createSenderIdentities(senderIdentityRequest);

Request body

namestringRequired Name of the sender identity.

emailstringRequired Email address of the sender identity.

redirectUrlstring You can set this property to redirect to a specific URL once the user has either approved or rejected.

brandIdstring You can customize the logo, colors, and other elements of the emails to match your company branding, and the brand logo will appear on the approval page. The ID of the existing brand can be obtained from the branding API or the web app.

notificationSettingsobject

Notification Settings of the sender identity.

viewedboolean	When it is enabled, an email will be automatically sent to the sender identity email address if the document is viewed.
sentboolean	When it is enabled, an email will be automatically sent to the sender identity email address if the document is sent.
deliveryFailedForboolean	When it is enabled, an email will be automatically sent to the sender identity email address if the delivery is failed.
declinedboolean	When it is enabled, an email will be automatically sent to the sender identity email address if the document is declined.
revokedboolean	When it is enabled, an email will be automatically sent to the sender identity email address if the document is revoked.
reassignedboolean	When it is enabled, an email will be automatically sent to the sender identity email address if the document is reassigned.
completedboolean	When it is enabled, an email will be automatically sent to the sender identity email address if the document is completed.
signedboolean	When it is enabled, an email will be automatically sent to the sender identity email address if the document is signed.
expiredboolean	When it is enabled, an email will be automatically sent to the sender identity email address if the document is expired.
authenticationFailedboolean	When it is enabled, an email will be automatically sent to the sender identity email address if the authentication is failed for the document.
remindersboolean	When it is enabled, all reminder email will be automatically sent to the sender identity email address.
attachSignedDocumentboolean	When it is enabled, the email sent to the sender's identity address upon document completion will include the completed document, an audit trail, and a view document link. Note that it is applicable only if the `completed` option is enabled.

metaDatadictionary Additional information about the sender identity can be provided as key-value pairs. A maximum of 50 key-value pairs may be included. Each key can have a maximum length of 40 characters, while each value can contain up to 500 characters.

Example response

201 Created