{
  "openapi": "3.1.0",
  "info": {
    "title": "Blaaiz Platform API - List Beneficiaries",
    "version": "1.0.0",
    "description": "Retrieve all beneficiaries for a customer."
  },
  "tags": [
    {
      "name": "Customer"
    }
  ],
  "servers": [
    {
      "url": "https://api-prod.blaaiz.com"
    },
    {
      "url": "https://api-dev.blaaiz.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "oauth2ClientCredentials": {
        "type": "oauth2",
        "description": "Use your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/oauth/token",
            "scopes": {
              "beneficiary:read": "Read customer beneficiaries."
            }
          }
        }
      }
    },
    "schemas": {
      "Beneficiary": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "business_id": {
            "type": "string"
          },
          "first_name": {
            "type": "string",
            "nullable": true
          },
          "last_name": {
            "type": "string",
            "nullable": true
          },
          "business_name": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "id_type": {
            "type": "string",
            "nullable": true,
            "description": "Set for individual customers. May be null on business customers."
          },
          "id_number": {
            "type": "string",
            "nullable": true,
            "description": "Set for individual customers. May be null on business customers."
          },
          "verification_status": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "business_id",
          "type",
          "email",
          "country",
          "verification_status"
        ]
      },
      "ListBeneficiariesResponse": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Beneficiary"
            }
          }
        },
        "required": [
          "message",
          "data"
        ]
      },
      "Error": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        },
        "required": [
          "message"
        ]
      }
    }
  },
  "paths": {
    "/api/external/customer/{customer_id}/beneficiary": {
      "get": {
        "summary": "List beneficiaries",
        "description": "Retrieve all beneficiaries for a customer. Required scope: `beneficiary:read`.",
        "tags": [
          "Customer"
        ],
        "security": [
          {
            "oauth2ClientCredentials": [
              "beneficiary:read"
            ]
          }
        ],
        "parameters": [
          {
            "name": "customer_id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Customer ID"
          }
        ],
        "responses": {
          "200": {
            "description": "Beneficiaries retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListBeneficiariesResponse"
                },
                "example": {
                  "message": "Customers retrieved successfully.",
                  "data": [
                    {
                      "id": "9d4c4ec5-59ea-4130-bf8a-6a5edec401ee",
                      "business_id": "9d4c4ec5-572d-49de-a362-f01ed09f2b1b",
                      "first_name": "Halie",
                      "last_name": "Skiles",
                      "business_name": null,
                      "type": "individual",
                      "email": "danyka66@example.org",
                      "country": "NG",
                      "id_type": "passport",
                      "id_number": "1DaRjlBTMZ",
                      "verification_status": "PENDING"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                },
                "example": {
                  "message": "Invalid or missing access token"
                }
              }
            }
          }
        }
      }
    }
  }
}