---
updatedAt: 2026-05-11T09:18:25.000Z
agentTools:
  projectIndex: https://docs.okoora.com/llms.txt
---

# Get All Beneficiaries

Get all Beneficiaries details. Deleted Beneficiaries will not be retrieved.

# OpenAPI definition

```json
{
  "openapi": "3.1.1",
  "info": {
    "title": "WebAPI | v1",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://okoora-web-api-demo.azurewebsites.net/"
    }
  ],
  "paths": {
    "/api/v1/Beneficiaries": {
      "get": {
        "tags": [
          "Beneficiaries"
        ],
        "summary": "Get All Beneficiaries",
        "description": "Get all Beneficiaries details. Deleted Beneficiaries will not be retrieved.",
        "operationId": "get-all-beneficiaries",
        "parameters": [
          {
            "name": "X-On-Behalf",
            "in": "header",
            "description": "Optional impersonation header for acting on behalf of another user",
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/BeneficiaryResponse"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "BankAccountCategory": {
        "enum": [
          "Checking",
          "Payment",
          "Savings",
          "Vista",
          "Maestra",
          null
        ]
      },
      "BankAccountInformationResponse": {
        "type": "object",
        "properties": {
          "bankName": {
            "type": [
              "null",
              "string"
            ]
          },
          "swiftCode": {
            "type": [
              "null",
              "string"
            ]
          },
          "routingCode": {
            "type": [
              "null",
              "string"
            ]
          },
          "routingValue": {
            "type": [
              "null",
              "string"
            ]
          },
          "bankAccountCategory": {
            "oneOf": [
              {
                "type": "null"
              },
              {
                "$ref": "#/components/schemas/BankAccountCategory"
              }
            ]
          },
          "bankCode": {
            "type": "string"
          },
          "branchCode": {
            "type": "string"
          },
          "bankCountry": {
            "type": "string"
          },
          "bankAccountNumber": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          },
          "iban": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      },
      "BeneficiaryAddress": {
        "type": "object",
        "properties": {
          "country": {
            "type": [
              "null",
              "string"
            ]
          },
          "state": {
            "type": [
              "null",
              "string"
            ]
          },
          "city": {
            "type": [
              "null",
              "string"
            ]
          },
          "street": {
            "type": [
              "null",
              "string"
            ]
          },
          "houseNumber": {
            "type": [
              "null",
              "string"
            ]
          },
          "zipCode": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      },
      "BeneficiaryIdentity": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          },
          "firstName": {
            "type": [
              "null",
              "string"
            ]
          },
          "lastName": {
            "type": [
              "null",
              "string"
            ]
          },
          "nickname": {
            "type": [
              "null",
              "string"
            ]
          },
          "hebrewName": {
            "type": [
              "null",
              "string"
            ]
          },
          "idNumber": {
            "type": "string"
          },
          "birthDate": {
            "type": "string",
            "format": "date"
          },
          "beneficiaryType": {
            "$ref": "#/components/schemas/BeneficiaryType"
          },
          "companyName": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      },
      "BeneficiaryPaymentReason": {
        "enum": [
          "Other",
          "CompanyStocks",
          "RealEstateAbroad",
          "OtherAssetsAbroad",
          "ForeignResidentLoan",
          "CompanyOwnerLoan",
          "CapitalRefund",
          "PartnershipInvest",
          "ServicesUpTo250k",
          "ServicesOver250k",
          "ImportOfGoodsNotIncludingBooks",
          "EducationAbroad",
          "RelativeAbroad",
          "InBoarderTransfer",
          "CrossBoarderTransfer",
          "TourismServices",
          "ThirdPartyTransfer",
          "TransportationServicesOverseas",
          "SoftwareDevelopmentOrOnlineServices",
          "Salaries",
          "OptionsInvestments",
          "AdvertisingAbroad"
        ],
        "type": "string"
      },
      "BeneficiaryResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "$ref": "#/components/schemas/BeneficiaryStatus"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "identity": {
            "$ref": "#/components/schemas/BeneficiaryIdentity"
          },
          "address": {
            "$ref": "#/components/schemas/BeneficiaryAddress"
          },
          "bankAccountInformation": {
            "$ref": "#/components/schemas/BankAccountInformationResponse"
          },
          "paymentReason": {
            "oneOf": [
              {
                "type": "null"
              },
              {
                "$ref": "#/components/schemas/BeneficiaryPaymentReason"
              }
            ]
          },
          "transferMethod": {
            "$ref": "#/components/schemas/TransferMethod"
          },
          "scaLink": {
            "type": [
              "null",
              "string"
            ]
          }
        }
      },
      "BeneficiaryStatus": {
        "enum": [
          "New",
          "Pending",
          "Approved",
          "Deleted",
          "Rejected"
        ],
        "type": "string"
      },
      "BeneficiaryType": {
        "enum": [
          "Company",
          "Individual"
        ],
        "type": "string"
      },
      "TransferMethod": {
        "enum": [
          "Local",
          "Swift"
        ],
        "type": "string"
      }
    }
  },
  "tags": [
    {
      "name": "Beneficiaries"
    }
  ]
}
```