> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL.
>
> Documentation indexes by section:
> - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt
> - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt
> - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt
> - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt
>
> Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth
> Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks
>
> OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json
> MCP server: https://docusign.docs.buildwithfern.com/_mcp/server

# GetRecipientEsignList

Senders can use this method to determine if an Esign agreement pre-exists between the sender and recipient.

## Schema

![SaveTemplate](/_fern-files/_img/2e9db758451d517b156d9bc1489668612117820616442f87ca296bfc41dd06c3.webp)

**`C#`**

```csharp title="C#"
// Enter account holder's username, email and accountID,
// and the email of the user that you wish to determine if
// an esign agreement exists
DocuSignWeb.RecipientEsignList recipients =
    _apiClient.GetRecipientEsignList(_userName, _email, _accountId, "<email>");
// Display the number of people in the list
Console.WriteLine("There are {0} recipients", recipients.RecipientEsign.Length);
// Examine each record -- does the esign agreement exist?
foreach (DocuSignWeb.RecipientEsign esign in recipients.RecipientEsign)
{
    Console.WriteLine("\t{0}: {1}", esign.Email, esign.Esign);
}
```

**`PHP`**

```php title="PHP"
// Enter account holder's username, email and accountID, and the email of
// the user that you wish to determine if an esign agreement exists
$getRecipientEsignListparams = new GetRecipientEsignList();
$getRecipientEsignListparams->SenderAccountId = $AccountID;
$getRecipientEsignListparams->SenderEmail = $UserID;
$getRecipientEsignListparams->UserName = $UserName;
$getRecipientEsignListparams->RecipientEmail = $Recipient1Email;
$response = $api->GetRecipientEsignList($getRecipientEsignListparams);
```

| Name            | Schema Type | Description                |
| --------------- | ----------- | -------------------------- |
| UserName        | UserName    | Sender's name.             |
| SenderEmail     | Email       | Sender’s email address.    |
| SenderAccountId | DSXId       | Sender’s account Id.       |
| RecipientEmail  | Email       | Recipient’s email address. |

### Sample Request XML

```
SOAPAction: "http://www.docusign.net/API/3.0/GetRecipientEsignList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap: Body>
        <GetRecipientEsignList xmlns="http://www.docusign.net/API/3.0">
            <UserName>string</UserName>
            <SenderEmail>string</SenderEmail>
            <SenderAccountId>string</SenderAccountId>
            <RecipientEmail>string</RecipientEmail>
        </GetRecipientEsignList>
    </soap:Body>
</soap:Envelope>

```

## RecipientEsignList

This element returns a list of RecipientEsignRecords for a designated sender and recipient combination. For each record, the return Boolean value indicates whether or not an Esign agreement exists between the sender and that particular recipient.

### Schema

![SaveTemplate](/_fern-files/_img/3ecd546b9eaf380626cb32584b5fdd7e9c6b7db926abbb73e12bc5baf631a77b.webp)

| Name      | Schema Type | Description                                                              |
| --------- | ----------- | ------------------------------------------------------------------------ |
| AccountID | DSXId       | The account holding the ESign agreement.                                 |
| UserName  | UserName    | The recipient’s name.                                                    |
| Email     | Email       | The recipient’s email.                                                   |
| ESign     | Boolean     | If true, an Esign agreement exists between the sender and the recipient. |

## Rules for using GetRecipientEsignList and RecipientEsignList

* The UserName should be valid.
* The SenderEmail should be valid; else “Invalid_Email_Address_For_Sender” execution will be thrown.
* The length of UserName, SenderEmail, SenderAccountId and RecipientEmail must not exceed 100 characters.
* User defined by UserName and SenderEmail pair belong to SenderAccountId specified, else “User_Does_Not_Belong_To_Specified_Account” exception is thrown.