List identities


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' \
  '' \
      -H 'accept: application/json' \
      -H 'X-API-KEY: {your API key}'
            var apiClient = new ApiClient("", "{your API key}");
            var senderIdentityClient = new SenderIdentityClient(apiClient);
            var senderIdentities = senderIdentityClient.ListSenderIdentities(1, 10);
import requests
url = ""
headers = {
  'accept': 'application/json',
  'X-API-KEY': '{your API key}'
response = requests.request("GET", url, headers=headers, data=payload)
const axios = require('axios');
const response = await axios.get('',
  params: {
    'PageSize': '10',
    'Page': '1'
  headers: {
    'accept': 'application/json',
    'X-API-KEY': '{your API key}'

Query parameters

PageSizeIntegerSize of the page to list the existing sender identities.
PageIntegerRequiredPage index of the sender identities list.
SearchStringUsing the search key, users can be listed based on the sender identities like sender identity name and email address.

Example response

200 Success

  "result": [
      "name": "Luther Cooper",
      "email": "",
      "status": "Pending",
      "createdBy": "516f5251-xxxx-xxxx-xxxx-04b5e34c5968",
      "approvedDate": "",
      "redirectUrl": "",
      "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
  "pageDetails": {
    "pageSize": 10,
    "page": 1,
    "totalRecordsCount": 1,
    "totalPages": 1,
    "sortedColumn": "createdDate",
    "sortDirection": "DESC"