> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Manage recipients

> View a list of recipients associated with an account, retrieve details about a given recipient, or delete a recipient.

## Retrieve a recipient's details

<Note>
  **GET** `/v2/recipients/{recipientId}`
</Note>

### Request

Use this request to retrieve details about a given recipient, based on their `recipientId`.

<CodeGroup>
  ```bash Sample request theme={null}
  curl -i -X GET \
    'https://api.equalsmoney.com/v2/recipients/8lqccfgmo?accountId=F12345' \
    -H 'Authorization: ApiKey YOUR_API_KEY_HERE'
  ```

  ```bash Request structure theme={null}
  curl -i -X GET \
    'https://api.equalsmoney.com/v2/recipients/{recipientId}?accountId={accountId}' \
    -H 'Authorization: ApiKey YOUR_API_KEY_HERE'
  ```
</CodeGroup>

#### Path parameters

<ParamField body="recipientId" type="string" required>
  The ID of the recipient that you want to retrieve details for.

  Allowable values: An existing `recipientId`
</ParamField>

#### Query parameters

<ParamField body="accountId" type="string" required>
  The ID of the account that you want to work with.

  Allowable values: An existing `accountId` (≤ 36 characters)
</ParamField>

### Response

If your request is successful, you'll receive a `200` response.

<CodeGroup>
  ```json Sample response theme={null}
  {
    "id": "8lqccfgmo",
    "accountId": "F12345",
    "accountIdentifier": "PK94XAOM0400102322019126",
    "bankIdentifier": "QBLCCCCV",
    "schemeName": "UK.OBIE.SortCodeAccountNumber",
    "name": "William Walker",
    "friendlyName": "Electrician",
    "intermediaryBankIdentifier": "QBLCCCCV",
    "paymentPurposeCode": "BKFE",
    "email": "william.walker@example.com",
    "defaultPurpose": "Payment",
    "currency": "GBP",
    "verificationMethod": "sms_otp",
    "recipientAddress": {
      "country": "GB",
      "address": "41 Middle Street",
      "city": "Enfield",
      "postcode": "EN1 3JY"
    },
    "bankAddress": {
      "bankName": "Brilliant Bank",
      "fullBankName": "Brilliant Bank",
      "country": "GB",
      "address": "223 Glossop Road",
      "city": "London",
      "postcode": "N14 4ES"
    }
  }
  ```

  ```json Response structure theme={null}
  {
    "accountId": "string",
    "accountIdentifier": "string",
    "bankIdentifier": "string",
    "schemeName": "string",
    "id": "string",
    "name": "string",
    "friendlyName": "string",
    "intermediaryBankIdentifier": "string",
    "paymentPurposeCode": "string",
    "email": "string",
    "defaultPurpose": "string",
    "currency": "string",
    "verificationMethod": "string",
    "recipientAddress": {
      "country": "string",
      "address": "string",
      "city": "string",
      "postcode": "string"
    },
    "bankAddress": {
      "bankName": "string",
      "fullBankName": "string",
      "country": "string",
      "address": "string",
      "city": "string",
      "postcode": "string"
    }
  }
  ```
</CodeGroup>

For more detailed information about this request and its response, [see the API reference](/api-reference/recipients/retrieve-a-recipient).

## List all recipients

<Note>
  **GET** `/v2/recipients`
</Note>

### Request

Use this request to retrieve a list of recipients associated with a given account.

<CodeGroup>
  ```bash Sample request theme={null}
  curl -i -X GET \
    'https://api.equalsmoney.com/v2/recipients?accountId=F12345' \
    -H 'Authorization: ApiKey YOUR_API_KEY_HERE'
  ```

  ```bash Request structure theme={null}
  curl -i -X GET \
    'https://api.equalsmoney.com/v2/recipients?accountId={accountId}' \
    -H 'Authorization: ApiKey YOUR_API_KEY_HERE'
  ```
</CodeGroup>

#### Query parameters

<ParamField body="accountId" type="string" required>
  The ID of the account that you want to retrieve a list of recipients for.

  Allowable values: An existing `accountId` (≤ 36 characters)
</ParamField>

<ParamField body="limit" type="integer">
  The maximum number of results to return. For example, `limit=25`. By default, this is set to `100`.

  Allowable values: `[ 1 .. 1000 ]`
</ParamField>

<ParamField body="offset" type="integer">
  The number of items to skip before returning results. For example, `offset=200`. By default, this is set to `0`.

  Allowable values: A valid integer
</ParamField>

<ParamField body="search" type="string">
  The term(s) to search for. You can use this to filter the results.

  Allowable values: A valid string
</ParamField>

<ParamField body="deleted" type="boolean">
  Whether or not to return deleted recipients.

  Allowable values: `true`, `false`
</ParamField>

<ParamField body="status" type="string">
  Filter recipients by status.

  Allowable values: `AUTHORISED`, `PENDING`, `UNVERIFIED`, `REJECTED`
</ParamField>

### Response

If your request is successful, you'll receive a `200` response containing a list of people.

<CodeGroup>
  ```json Sample response theme={null}
  {
    "limit": 100,
    "offset": 0,
    "count": 2,
    "rows": [
      {
        "id": "8lqccfgmo",
        "accountId": "F12345",
        "accountIdentifier": "PK94XAOM0400102322019126",
        "bankIdentifier": "QBLCCCCV",
        "schemeName": "UK.OBIE.SortCodeAccountNumber",
        "name": "William Walker",
        "friendlyName": "Electrician",
        "intermediaryBankIdentifier": "QBLCCCCV",
        "paymentPurposeCode": "BKFE",
        "email": "william.walker@example.com",
        "defaultPurpose": "Payment",
        "currency": "GBP",
        "verificationMethod": "sms_otp",
        "recipientAddress": {
          "country": "GB",
          "address": "41 Middle Street",
          "city": "Enfield",
          "postcode": "EN1 3JY"
        },
        "bankAddress": {
          "bankName": "Brilliant Bank",
          "fullBankName": "Brilliant Bank",
          "country": "GB",
          "address": "223 Glossop Road",
          "city": "London",
          "postcode": "N14 4ES"
        }
      },
      {
        "id": "8lqccok6g",
        "accountId": "F12345",
        "accountIdentifier": "GB24BKEN10000031510604",
        "bankIdentifier": "QBLCCCCV",
        "schemeName": "UK.OBIE.IBAN",
        "name": "Alison Abraham",
        "friendlyName": "Allie Abraham",
        "intermediaryBankIdentifier": "QBLCCCCV",
        "paymentPurposeCode": "BKFE",
        "email": "alison.abrahm@example.com",
        "defaultPurpose": "Payment with exchange",
        "currency": "USD",
        "verificationMethod": "phone",
        "recipientAddress": {
          "country": "GB",
          "address": "13 Chase Road",
          "city": "Malvern",
          "postcode": "WR13 6DJ"
        },
        "bankAddress": {
          "bankName": "Brilliant Bank",
          "fullBankName": "Brilliant Bank",
          "country": "GB",
          "address": "223 Glossop Road",
          "city": "London",
          "postcode": "N14 4ES"
        }
      },
    ]
  }
  ```

  ```json Response structure theme={null}
  {
    "limit": integer,
    "offset": integer,
    "count": integer,
    "rows": [
      {
        "accountId": "string",
        "accountIdentifier": "string",
        "bankIdentifier": "string",
        "schemeName": "string",
        "id": "string",
        "name": "string",
        "friendlyName": "string",
        "intermediaryBankIdentifier": "string",
        "paymentPurposeCode": "string",
        "email": "string",
        "defaultPurpose": "string",
        "currency": "string",
        "verificationMethod": "string",
        "recipientAddress": {
          "country": "string",
          "address": "string",
          "city": "string",
          "postcode": "string"
        },
        "bankAddress": {
          "bankName": "string",
          "fullBankName": "string",
          "country": "string",
          "address": "string",
          "city": "string",
          "postcode": "string"
        }
      }
    ]
  }
  ```
</CodeGroup>

For more detailed information about this request and its response, [see the API reference](/api-reference/recipients/list-all-recipients).

## Delete a recipient

<Note>
  **DELETE** `/v2/recipients/{recipientId}`
</Note>

### Request

Use this request to permanently delete a recipient.

<CodeGroup>
  ```bash Sample request theme={null}
  curl -i -X DELETE \
    'https://api.equalsmoney.com/v2/recipients/8lqccfgmo?accountId=F12345' \
    -H 'Authorization: ApiKey YOUR_API_KEY_HERE'
  ```

  ```bash Request structure theme={null}
  curl -i -X DELETE \
    'https://api.equalsmoney.com/v2/recipients/{recipientId}?accountId={accountId}' \
    -H 'Authorization: ApiKey YOUR_API_KEY_HERE'
  ```
</CodeGroup>

#### Path parameters

<ParamField body="recipientId" type="string" required>
  The ID of the recipient that you want to delete.

  Allowable values: An existing `recipientId`
</ParamField>

#### Query parameters

<ParamField body="accountId" type="string" required>
  The ID of the account that you want to work with.

  Allowable values: An existing `accountId` (≤ 36 characters)
</ParamField>

### Response

If your request is successful, you'll receive a `200` response containing the updated details for this person.

<CodeGroup>
  ```json Sample response theme={null}
  {
    "success": true
  }
  ```

  ```json Response structure theme={null}
  {
    "success": boolean
  }
  ```
</CodeGroup>

For more detailed information about this request and its response, [see the API reference](/api-reference/recipients/delete-a-recipient).