> ## Documentation Index > Fetch the complete documentation index at: https://developer.paywint.com/llms.txt > Use this file to discover all available pages before exploring further. # List Payee Address > Retrieves all saved addresses for an existing payee contact. This endpoint will: - Verify the payee exists and belongs to the specified user - Fetch the payee’s saved addresses - Return the addresses along with a `total_records` count Each payee can have up to 5 addresses. ## OpenAPI ````yaml POST /api/platform/address/list-payee-address/{user_id} openapi: 3.1.0 info: title: paywint version: 0.1.0 servers: - url: http://localhost:8001 - url: https://api.pw.wintpay.com - url: https://test.pw.wintpay.com - url: https://api.sandbox.paywint.com security: [] paths: /api/platform/address/list-payee-address/{user_id}: post: tags: - Platform Address summary: List Payee Addresses description: |- Retrieves all saved addresses for an existing payee contact. This endpoint will: - Verify the payee exists and belongs to the specified user - Fetch the payee’s saved addresses - Return the addresses along with a `total_records` count Each payee can have up to 5 addresses. operationId: >- list_payee_address_api_platform_address_list_payee_address__user_id__post parameters: - name: user_id in: path required: true schema: type: string format: uuid description: Unique identifier (UUID) of the user title: User Id description: Unique identifier (UUID) of the user example: f47ac10b-****-****-****-0e02b2c3d479 - name: X-Platform-ID in: header required: true schema: type: string format: uuid description: >- Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request. title: X-Platform-Id description: >- Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request. - name: X-Signature in: header required: true schema: type: string description: >- HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`. title: X-Signature description: >- HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`. requestBody: required: true content: application/json: schema: $ref: >- #/components/schemas/Body_list_payee_address_api_platform_address_list_payee_address__user_id__post responses: '200': description: Successful Response content: application/json: schema: $ref: >- #/components/schemas/ExternalListResponse_ExternalContactAddressRead_ '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: Body_list_payee_address_api_platform_address_list_payee_address__user_id__post: properties: payee_id: type: string format: uuid title: Payee Id description: Unique identifier (UUID) of the payee type: object required: - payee_id title: >- Body_list_payee_address_api_platform_address_list_payee_address__user_id__post ExternalListResponse_ExternalContactAddressRead_: properties: success: type: boolean title: Success description: Indicates whether the request was processed successfully. default: true example: true status_code: anyOf: - type: integer - type: 'null' title: Status Code description: HTTP status code representing the result of the request. default: 200 message: anyOf: - type: string - type: 'null' title: Message description: Short, human-readable message describing the outcome of the request. default: Success records: anyOf: - items: $ref: '#/components/schemas/ExternalContactAddressRead' type: array - type: 'null' title: Records description: List of result items returned for the current page. totalRecords: anyOf: - type: integer - type: 'null' title: Totalrecords description: >- Total number of matching records in the database, useful for paginating the full dataset. default: 0 queryGeneratedTime: anyOf: - type: integer - type: 'null' title: Querygeneratedtime description: >- Unix timestamp (in seconds) indicating when this response was generated. default: 1782303609 type: object title: ExternalListResponse[ExternalContactAddressRead] HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError ExternalContactAddressRead: properties: address_id: type: string format: uuid4 title: Address Id description: Unique identifier (UUID) for this address record. example: a1b2c3d4-****-****-****-e5f6g7h8i9j0 fist_name: type: string maxLength: 100 minLength: 2 title: Fist Name description: Recipient's first name. example: John last_name: anyOf: - type: string maxLength: 100 - type: 'null' title: Last Name description: Recipient's last name (optional). example: Doe address_line_1: type: string maxLength: 100 title: Address Line 1 description: Street address including apartment, suite, or unit number. example: 123 Main Street, Apt 4B address_line_2: anyOf: - type: string maxLength: 100 - type: 'null' title: Address Line 2 description: Street address including apartment, suite, or unit number. example: 123 Main Street, Apt 4B company_name: anyOf: - type: string maxLength: 100 - type: 'null' title: Company Name description: Full name of the payee's company. example: Meta Corp city: type: string maxLength: 40 title: City description: City name. example: New York state: type: string maxLength: 30 title: State description: State, province, or region. example: NY zipcode: type: string maxLength: 10 title: Zipcode description: Postal code or ZIP code. example: '10001' country: type: string maxLength: 40 title: Country description: Country name. example: United States is_default: type: boolean title: Is Default description: Mark this address as the default payee address. default: false created_at: type: string format: date-time title: Created At description: ISO 8601 timestamp indicating when this address record was created. example: '2024-01-15T10:30:00Z' updated_at: anyOf: - type: string format: date-time - type: 'null' title: Updated At description: ISO 8601 timestamp indicating when this address record was updated. example: '2024-01-15T10:30:00Z' type: object title: ExternalContactAddressRead ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError ````