Identity details

get/v1-beta/senderIdentities/properties

This API endpoint retrieves the complete details of a sender identity, including its name, email address, approval status, and notification settings. You can retrieve these details by specifying either the sender identity's ID or email address.

Code snippet

curl -X 'GET' \ 'https://api.boldsign.com/v1-beta/senderIdentities/[email protected]' \
      -H 'accept: application/json' \
      -H 'X-API-KEY: {your API key}'

var apiClient = new ApiClient("YOUR_API_KEY");

var senderIdentityClient = new SenderIdentityClient(apiClient);

var senderIdentityDetails = senderIdentityClient.GetProperties(email: "[email protected]");

Query parameters

idString The ID of the sender identity from which the details should be fetched.

emailString

Email address of the sender identity from which the details should be fetched.

Note : id or email is needed to get the sender identity details.

Example response

200 Success

{
    "name": "Luther Cooper",
    "email": "[email protected]",
    "status": "Pending",
    "createdBy": "516f5251-xxxx-xxxx-xxxx-04b5e34c5968",
    "approvedDate": "",
    "redirectUrl": "https://boldsign.com",
    "brandId": "6f4020a7-xxxx-xxxx-xxxx-ef071e143867",
    "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"
    }
}

Error response

Error Type	Description
`MissingParameter`	The request is missing sender identity ID or email address.
`InvalidId`	The sender identity ID provided is invalid. Check that your request are specifying a valid sender identity ID.
`InvalidEmail`	The sender identity email address is invalid. Check that your request are specifying a valid sender identity email address.