Mercury: List all recipient attachments
Mercury recipients.listRecipientsAttachments: arguments, response, policy and SDK examples.
← Recipients operations · Get started
Operation mercury.listrecipientsattachments
Provider route: GET /recipients/attachments. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["recipients"]["listRecipientsAttachments"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.recipients.listRecipientsAttachments(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_mercury import MercuryIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.recipients.list_recipients_attachments(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000 Default: 1000 Format: int64 Maximum: 1000 Minimum: 1 |
query.start_after | string | Optional | The ID of the recipient attachment to start the page after (exclusive). When provided, results will begin with the recipient attachment immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before. Format: uuid |
query.end_before | string | Optional | The ID of the recipient attachment to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after. Format: uuid |
query.order | string | Optional | Sort order. Can be ‘asc’ or ‘desc’. Defaults to ‘asc’ Default: asc One of: asc, desc |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand List all recipient attachments — response body |
Referenced models: List all recipient attachments — response body
Schemas
Section titled “Schemas”List all recipient attachments — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachments | array | Required within parent | List of attachments with recipient IDs |
attachments[] | Model | Each item | Expand List all recipient attachments — response body — attachments item |
page | object | Required within parent | Pagination information |
page.nextPage | string | Optional | ID for the recipient tax form attachment Format: uuid |
page.previousPage | string | Optional | ID for the recipient tax form attachment Format: uuid |
total | JSON | Required within parent | |
total (allOf 1) | Model | All variants apply | Expand Get all recipients — response body — total value |
total (allOf 2) | JSON | All variants apply | Total number of attachments in the current page |
Referenced models: Get all recipients — response body — total value, List all recipient attachments — response body — attachments item
Get all recipients — response body — total value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | integer | Alternative | Format: int32 Maximum: 1000 Minimum: 0 |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
List all recipient attachments — response body — attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fileName | string | Required within parent | Name of the uploaded file |
formType | JSON | Optional | |
formType (anyOf 1) | JSON | Alternative | |
formType (anyOf 1) (allOf 1) | string | All variants apply | Known values: w9, w8BEN, w8BENE, unknown |
formType (anyOf 1) (allOf 2) | JSON | All variants apply | The tax form type (W-9, W-8BEN, W-8BEN-E, or Unknown) |
formType (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the recipient tax form attachment Format: uuid |
id (allOf 2) | JSON | All variants apply | The unique identifier for this attachment |
recipientId | JSON | Required within parent | |
recipientId (allOf 1) | string | All variants apply | ID for a Mercury account. Format: uuid |
recipientId (allOf 2) | JSON | All variants apply | The external ID of the recipient this attachment belongs to |
uploadedAt | JSON | Required within parent | |
uploadedAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
uploadedAt (allOf 2) | JSON | All variants apply | Timestamp when the attachment was uploaded |
url | string | Required within parent | Presigned URL to download the attachment (valid for 12 hours) |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.listrecipientsattachments. Catalog operation: mercury:listRecipientsAttachments. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.