> ## Documentation Index > Fetch the complete documentation index at: https://docs.leapfinancial.com/llms.txt > Use this file to discover all available pages before exploring further. # List user recipient book > Derived read model — aggregates the user's own operations by recipient fingerprint (no separate collection). Each entry carries `destinations[]` with habitual payout arrangements (cash hints, stored instruments, wallet phones). ## OpenAPI ````yaml /raas-widgets/openapi.json get /partner/users/{userId}/recipients openapi: 3.0.0 info: title: RaaS Widgets Partner API description: > REST API for RaaS Widgets partner integrations. Create magic links for embeddable flows, manage end users, track transfer operations, handle CIP verification, and configure webhooks for real-time event notifications. This specification covers the **Partner-accessible API** only (`X-API-Key` against `/partner/*`). Widget and Superadmin APIs are out of scope. ## Authentication All endpoints require an API key passed in the `X-API-Key` header. Use `raas_sandbox_*` keys for the sandbox environment and `raas_live_*` keys for production. ## Environments | Environment | Base URL | |---|---| | Sandbox | `https://raas-widgets-backend-sandbox.up.railway.app` | version: 1.18.0 contact: {} servers: - url: https://raas-widgets-backend-sandbox.up.railway.app description: Sandbox security: [] tags: - name: Partner - Magic Links description: Create, list, and manage magic links for flows - name: Partner - Flows description: List enabled flows and the full flow catalog - name: Partner - Users description: View and manage end users associated with your partner account - name: Partner - Operations description: Track money transfer operations and their statuses - name: Partner - Requests description: List and inspect money-request records - name: Partner - Deferred Payouts description: List, inspect, and cancel deferred payout remittances - name: Partner - CIP description: Customer Identification Program (CIP) verification management - name: Partner - Data Requests description: Fulfill data requests for additional user information - name: Partner - Settings description: Configure partner-level settings (redirect URLs, logo, etc.) - name: Partner - Webhooks description: Configure webhook endpoints and inspect delivery history - name: Partner - Pricing description: >- Indicative pre-quote summaries (best / worst / averages) for partner integrations paths: /partner/users/{userId}/recipients: get: tags: - Partner - Users summary: List user recipient book description: >- Derived read model — aggregates the user's own operations by recipient fingerprint (no separate collection). Each entry carries `destinations[]` with habitual payout arrangements (cash hints, stored instruments, wallet phones). operationId: UsersController_listRecipients parameters: - name: userId required: true in: path description: M2M user identifier schema: example: user_acme_x1y2z3 type: string - name: limit required: false in: query description: Max recipients returned (1-50, default 50) schema: example: 50 type: string responses: '200': description: Recent recipients retrieved successfully content: application/json: schema: type: array items: $ref: '#/components/schemas/RecipientBookEntryDto' '401': description: Unauthorized — invalid or missing API key / bearer token '404': description: User not found security: - api-key: [] components: schemas: RecipientBookEntryDto: type: object properties: recipientKey: type: string description: Stable aggregation key (recipient fingerprint) example: fp_9a3c1d5e9f02b4d6e8f01a2b name: $ref: '#/components/schemas/CanonicalNameDto' address: $ref: '#/components/schemas/OperationRecipientAddressDto' phone: type: string example: '+5213312345678' lastUsedAt: type: string example: '2026-07-01T12:00:00.000Z' timesUsed: type: number example: 7 destinations: type: array items: $ref: '#/components/schemas/RecipientDestinationDto' required: - recipientKey - name - lastUsedAt - timesUsed - destinations CanonicalNameDto: type: object properties: firstName: type: string example: Juan lastName: type: string example: Perez middleName: type: string example: Carlos secondLastName: type: string description: Maternal surname (LatAm second last name) example: Gomez required: - firstName - lastName OperationRecipientAddressDto: type: object properties: countryISO2: type: string description: Recipient country of residence (ISO 3166-1 alpha-2) example: MX state: type: string description: Recipient state/province as a full ISO 3166-2 subdivision code example: MX-JAL city: type: string example: Guadalajara line1: type: string example: Av. Juarez 123 zip: type: string example: '44100' RecipientDestinationDto: type: object properties: payoutMethod: type: string example: CASH_PICKUP cash: description: Selection hints for cash-based payouts allOf: - $ref: '#/components/schemas/RecipientDestinationCashDto' paymentMethodId: type: string description: >- Stored destination instrument — pass as `payoutPaymentMethodId` in the create example: pm_ba_8a3c1d5e9f02 display: $ref: '#/components/schemas/RecipientDestinationDisplayDto' phone: type: string description: Recipient phone used for mobile-wallet payouts (E.164) example: '+5213312345678' lastCapabilityKey: type: string description: >- capabilityKey of the most recent operation with this destination. Reference only — never re-pin it raw (keys are catalog-versioned). example: US:MX:CRB_INTERMEX:CASH_PICKUP:MX-CMX:ANY:OXXO lastUsedAt: type: string example: '2026-07-01T12:00:00.000Z' timesUsed: type: number example: 5 required: - payoutMethod - lastUsedAt - timesUsed RecipientDestinationCashDto: type: object properties: stateCode: type: string description: Canonical destination state (ISO 3166-2) the payout was pinned to example: MX-CMX payerCode: type: string description: Payer network code the payout was pinned to example: OXXO RecipientDestinationDisplayDto: type: object properties: bankName: type: string example: BBVA maskedAccount: type: string example: ····1234 cardBrand: type: string example: visa cardLast4: type: string example: '4242' securitySchemes: api-key: type: apiKey in: header name: X-API-Key description: >- Your partner API key. Use `raas_sandbox_*` keys for the sandbox environment and `raas_live_*` keys for production. ````