> This page is for Internet banking (beta).

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.api.corpx.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.api.corpx.com/_mcp/server.

# List boleto beneficiaries of the tenant

GET https://client.api.corpx.com/v1/boleto/charge/beneficiaries

Lists beneficiaries from the settlement bank and keeps only those whose tax number matches an account of the tenant in `X-Tenant-Id`. Pagination follows the bank's page; a page can come back short after that filter. `hasNext` means the bank has another page. Requires `boleto_charge`.

Reference: https://docs.api.corpx.com/ib/referencia/boleto-charge/list-boleto-charge-beneficiaries

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `status` (enum, optional) — Canonical beneficiary status (ELIGIBLE, PENDING, INELIGIBLE, UNDER_REVIEW).
  - Allowed values: `ELIGIBLE`, `PENDING`, `INELIGIBLE`, `UNDER_REVIEW`
- `page` (integer, optional, default: 1) — Page number, starting at 1.
- `pageSize` (integer, optional, default: 50) — Number of beneficiaries per page, up to 200.

### Headers

- `X-Tenant-Id` (string, required) — Tenant context used for authorization and routing.
- `X-Request-Timestamp` (string, required) — Unix seconds. Required on the signed host; tolerance is 300s either way (`403 request_timestamp_skew`).
- `X-Content-SHA256` (string, required) — Lowercase hex SHA-256 of the body. An empty body hashes the empty string, so the header is always present. Mismatch returns `400 body_hash_mismatch`.
- `X-Request-Signature` (string, required) — Detached JWS (`<protected>..<signature>`, ES256 or PS256) over `METHOD\nPATH?QUERY\nTIMESTAMP\nIDEMPOTENCY_KEY_OR_EMPTY\nX_CONTENT_SHA256`.

## Response

### 200

Tenant beneficiaries on this page.

- `items` (list of BoletoChargeBeneficiary, optional)
- `page` (integer, optional)
- `pageSize` (integer, optional)
- `totalItems` (integer, optional)
- `hasNext` (boolean, optional)

## Errors

### 403 Forbidden Error

Requester does not have permission to perform the operation.

- `errorCode` (string, required) — Stable machine-readable code. See `ErrorCode` for the known values.
- `message` (string, required) — Human-readable explanation (pt-BR). Presentation only; may change.
- `docs` (string, optional) — Link to this code in the public error catalogue.
- `requestId` (string, optional) — Gateway request id. Quote it when contacting support.
- `details` (map from string to any, optional) — Optional machine-readable context for the specific `errorCode` (for example `kind` on `identity_verification_monthly_limit_exceeded`, `maxBytes` on `payload_too_large`, `attemptsRemaining` on `facetec_attempts_exhausted`). Keys are documented per operation; absent when the code carries no extra context.
- `partner` (ErrorResponsePartner, optional) — Raw error from the settlement bank, when the failure came from it. Diagnostic only.

## Types

### BoletoChargeBeneficiary

Account holder as a boleto beneficiary.

- `beneficiaryId` (string, optional) — Settlement-bank beneficiary id.
- `identifier` (string, optional) — Beneficiary identifier.
- `status` (enum, optional) — Beneficiary status.
  - Allowed values: `ELIGIBLE`, `PENDING`, `INELIGIBLE`, `UNDER_REVIEW`
- `relationshipStatus` (enum, optional) — Relationship with the settlement bank.
  - Allowed values: `ACTIVE`, `CLOSED`
- `relationshipActive` (boolean, optional) — True when the relationship is active.
- `personType` (enum, optional)
  - Allowed values: `person`, `company`
- `taxNumber` (string, optional)
- `name` (string, optional)
- `legalName` (string, optional)
- `tradeName` (string, optional)
- `socialName` (string, optional)
- `relationshipStartDate` (date, optional)
- `relationshipClosedAt` (datetime, optional)
- `email` (string, optional)
- `phone` (string, optional)
- `representativeName` (string, optional)
- `representativeEmail` (string, optional)
- `representativePhone` (string, optional)
- `alertOriginators` (list of string, optional) — ISPBs of institutions that raised alerts about this beneficiary.
- `updated` (datetime, optional)
- `accountId` (string, optional) — Present on the tenant list, when the tax number matches an account.
- `lastEvent` (BoletoChargeBeneficiaryLastEvent, optional) — Latest notice from the settlement bank about this account's beneficiary. Same data as the `boleto.charge.beneficiary.*` webhooks. Absent until the first notice.

### ErrorResponsePartner

Raw error from the settlement bank, when the failure came from it. Diagnostic only.

- `code` (string, optional)
- `message` (string, optional)
- `field` (string, optional) — Field the partner pointed at, when any.

### BoletoChargeBeneficiaryLastEvent

Latest notice from the settlement bank about this account's beneficiary. Same data as the `boleto.charge.beneficiary.*` webhooks. Absent until the first notice.

- `eventType` (enum, optional) — Webhook event this notice produced.
  - Allowed values: `boleto.charge.beneficiary.approved`, `boleto.charge.beneficiary.rejected`, `boleto.charge.beneficiary.updated`, `boleto.charge.beneficiary.closed`
- `operation` (enum, optional) — Operation the notice is about.
  - Allowed values: `INCLUSION`, `UPDATE`, `STATUS_UPDATE`, `TERMINATION`
- `result` (enum, optional)
  - Allowed values: `CONFIRMED`, `REJECTED`
- `operationId` (string, optional) — Same `operationId` returned by the 202 of the operation.
- `rejectionCode` (string, optional) — Rejection code from the settlement bank. Only when `result` is `REJECTED`.
- `rejectionReason` (string, optional) — Rejection description from the settlement bank. Only when `result` is `REJECTED`.
- `occurredAt` (datetime, optional)

## Examples

**Response**

```json
{
  "items": [
    {
      "beneficiaryId": "8c1f6a2e-4d3b-4b9a-9f0e-1a2b3c4d5e6f",
      "identifier": "order-12345",
      "status": "ELIGIBLE",
      "relationshipStatus": "ACTIVE",
      "relationshipActive": true,
      "personType": "person",
      "taxNumber": "12345678000190",
      "name": "MARIA DA SILVA",
      "legalName": "MARIA DA SILVA",
      "tradeName": "MARIA DA SILVA",
      "socialName": "MARIA DA SILVA",
      "relationshipStartDate": "2026-02-20",
      "relationshipClosedAt": "2026-02-20T08:33:39Z",
      "email": "maria.silva@example.com",
      "phone": "+5511999999999",
      "representativeName": "MARIA DA SILVA",
      "representativeEmail": "maria.silva@example.com",
      "representativePhone": "+5511999999999",
      "alertOriginators": [
        "string"
      ],
      "updated": "2026-02-20T08:33:39Z",
      "accountId": "2e6b725b-84a0-400d-8740-22a5ba0f23e6"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "totalItems": 150,
  "hasNext": true
}
```

**SDK Code**

```python Boleto Charge_listBoletoChargeBeneficiaries_example
import requests

url = "https://client.api.corpx.com/v1/boleto/charge/beneficiaries"

headers = {
    "X-Content-SHA256": "X-Content-SHA256",
    "X-Request-Signature": "X-Request-Signature",
    "X-Request-Timestamp": "X-Request-Timestamp",
    "X-Tenant-Id": "X-Tenant-Id",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Boleto Charge_listBoletoChargeBeneficiaries_example
const url = 'https://client.api.corpx.com/v1/boleto/charge/beneficiaries';
const options = {
  method: 'GET',
  headers: {
    'X-Content-SHA256': 'X-Content-SHA256',
    'X-Request-Signature': 'X-Request-Signature',
    'X-Request-Timestamp': 'X-Request-Timestamp',
    'X-Tenant-Id': 'X-Tenant-Id',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Boleto Charge_listBoletoChargeBeneficiaries_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://client.api.corpx.com/v1/boleto/charge/beneficiaries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Content-SHA256", "X-Content-SHA256")
	req.Header.Add("X-Request-Signature", "X-Request-Signature")
	req.Header.Add("X-Request-Timestamp", "X-Request-Timestamp")
	req.Header.Add("X-Tenant-Id", "X-Tenant-Id")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Boleto Charge_listBoletoChargeBeneficiaries_example
require 'uri'
require 'net/http'

url = URI("https://client.api.corpx.com/v1/boleto/charge/beneficiaries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Content-SHA256"] = 'X-Content-SHA256'
request["X-Request-Signature"] = 'X-Request-Signature'
request["X-Request-Timestamp"] = 'X-Request-Timestamp'
request["X-Tenant-Id"] = 'X-Tenant-Id'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Boleto Charge_listBoletoChargeBeneficiaries_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://client.api.corpx.com/v1/boleto/charge/beneficiaries")
  .header("X-Content-SHA256", "X-Content-SHA256")
  .header("X-Request-Signature", "X-Request-Signature")
  .header("X-Request-Timestamp", "X-Request-Timestamp")
  .header("X-Tenant-Id", "X-Tenant-Id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Boleto Charge_listBoletoChargeBeneficiaries_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://client.api.corpx.com/v1/boleto/charge/beneficiaries', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'X-Content-SHA256' => 'X-Content-SHA256',
    'X-Request-Signature' => 'X-Request-Signature',
    'X-Request-Timestamp' => 'X-Request-Timestamp',
    'X-Tenant-Id' => 'X-Tenant-Id',
  ],
]);

echo $response->getBody();
```

```csharp Boleto Charge_listBoletoChargeBeneficiaries_example
using RestSharp;

var client = new RestClient("https://client.api.corpx.com/v1/boleto/charge/beneficiaries");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Content-SHA256", "X-Content-SHA256");
request.AddHeader("X-Request-Signature", "X-Request-Signature");
request.AddHeader("X-Request-Timestamp", "X-Request-Timestamp");
request.AddHeader("X-Tenant-Id", "X-Tenant-Id");
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Boleto Charge_listBoletoChargeBeneficiaries_example
import Foundation

let headers = [
  "X-Content-SHA256": "X-Content-SHA256",
  "X-Request-Signature": "X-Request-Signature",
  "X-Request-Timestamp": "X-Request-Timestamp",
  "X-Tenant-Id": "X-Tenant-Id",
  "Authorization": "Bearer <token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://client.api.corpx.com/v1/boleto/charge/beneficiaries")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```