List identities

get/v1/senderIdentities/list

This API lists the details of all the existing sender identities under your BoldSign organization account. The sender identity details like name, email address, approval status, approved date, etc., will be displayed.

Code snippet

curl -X 'GET' \
  'https://api.boldsign.com/v1/senderIdentities/list?PageSize=10&Page=1' \
      -H 'accept: application/json' \
      -H 'X-API-KEY: {your API key}'

var apiClient = new ApiClient("YOUR_API_KEY");

var senderIdentityClient = new SenderIdentityClient(apiClient);

var senderIdentityList = senderIdentityClient.ListSenderIdentities(1);

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_list = sender_identities_api.list_sender_identities(page=1)

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

use BoldSign\Configuration;
use BoldSign\Api\SenderIdentitiesApi;

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

$sender_identities_api = new SenderIdentitiesApi($config);
$sender_identity_list = $sender_identities_api->listSenderIdentities($page = 1);

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

int page = 1;       
SenderIdentityList senderIdentityList = senderIdentitiesApi.listSenderIdentities(page, null, null, null);

import { SenderIdentitiesApi } from "boldsign";

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

const senderIdentityList = senderIdentitiesApi.listSenderIdentities(1);

Query parameters

pageSizeInteger	Size of the page to list the existing sender identities.
pageIntegerRequired	Page index of the sender identities list.
searchString	Using the search key, sender identities can be filtered based on properties such as name and email address.
brandIdsarray	Filter sender identities that were assigned specific brand IDs during creation.

Example response

200 Success

{
  "result": [
    {
      "name": "Luther Cooper",
      "email": "luthercooper@cubeflakes.com",
      "status": "Pending",
      "createdBy": "516f5251-xxxx-xxxx-xxxx-04b5e34c5968",
      "approvedDate": "",
      "redirectUrl": "https://boldsign.com",
      "brandId": "c94d34e9-8f1f-4ab1-926d-daa32095a851",
      "notificationSettings": {
        "viewed": true,
        "sent": false,
        "deliveryFailed": 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"
      }
    }
  ],
  "pageDetails": {
    "pageSize": 10,
    "page": 1,
    "totalRecordsCount": 1,
    "totalPages": 1,
    "sortedColumn": "createdDate",
    "sortDirection": "DESC"
  }
}