---
updatedAt: 2026-05-28T11:38:46.000Z
agentTools:
  projectIndex: https://developer.sivo.com/llms.txt
---

# Get a Beneficiary by Id

Find a beneficiary by Id

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Banking",
    "description": "SIVO public Api REST",
    "version": "0.0.1"
  },
  "x-amazon-apigateway-api-key-source": "AUTHORIZER",
  "servers": [
    {
      "url": "https://dev.sivo.com/v1",
      "description": "Sandbox server (user test data)"
    }
  ],
  "paths": {
    "/banking/beneficiaries/{id}": {
      "get": {
        "summary": "Get a Beneficiary by Id",
        "description": "Find a beneficiary by Id",
        "operationId": "getByIdBankingBeneficiary",
        "tags": [
          "Beneficiaries"
        ],
        "parameters": [
          {
            "in": "path",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            },
            "name": "id",
            "description": "ID of the Beneficiaries"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/beneficiary"
                }
              }
            }
          },
          "400": {
            "description": "Invalid ID supplied"
          },
          "404": {
            "description": "Beneficiary not found"
          }
        },
        "security": [
          {
            "prod-sandbox-sivo-api-authorizer": [
              "aws.cognito.signin.user.admin"
            ]
          }
        ],
        "x-amazon-apigateway-integration": {
          "httpMethod": "POST",
          "type": "AWS_PROXY",
          "uri": "arn:aws:apigateway:us-east-2:lambda:path/2015-03-31/functions/${Token[TOKEN.2318]}:Alias/invocations"
        }
      }
    }
  },
  "components": {
    "schemas": {
      "uuid": {
        "type": "string",
        "description": "A universal identifier (all lowercase)",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      },
      "currencyIso4217": {
        "type": "string",
        "description": "A currency identifier in ISO-4217 format",
        "pattern": "^[A-Z]{3}$"
      },
      "text": {
        "type": "string",
        "minLength": 1
      },
      "dateTimeIso8601": {
        "type": "string",
        "description": "See [Dates and Times](https://developer.sivo.com/reference/dates-and-times) for details",
        "format": "date-time"
      },
      "countryIso3166Alpha2": {
        "type": "string",
        "description": "A country identifier in 2 uppercase letters. See [ISO-3166-Alpha2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)",
        "pattern": "^(?!UK$)[A-Z]{2}$"
      },
      "bankAccountType": {
        "type": "string",
        "enum": [
          "checking",
          "savings"
        ]
      },
      "routingCodeType": {
        "type": "string",
        "enum": [
          "sort_code",
          "aba",
          "bsb_code",
          "institution_no",
          "bank_code",
          "branch_code",
          "clabe",
          "cnaps",
          "ifsc",
          "bic_swift",
          "ach_routing_number",
          "wire_routing_number",
          "routing_code"
        ]
      },
      "emailAddress": {
        "type": "string",
        "description": "An email address",
        "format": "email"
      },
      "identificationType": {
        "type": "string",
        "enum": [
          "none",
          "others",
          "employer_identification_number",
          "clave_unica_de_registro_de_poblacion",
          "registro_federal_de_contribuyentes",
          "national_id",
          "incorporation_number",
          "drivers_license",
          "social_security_number",
          "green_card",
          "passport",
          "visa",
          "matricula_consular",
          "credential_de_elector",
          "social_insurance_number",
          "citizenship_papers",
          "drivers_license_canadian",
          "existing_credit_card_details"
        ]
      },
      "website": {
        "type": "string",
        "description": "A website address",
        "pattern": "^(http:\\/\\/www\\.|https:\\/\\/www\\.|http:\\/\\/|https:\\/\\/)?[a-zA-Z0-9]+([\\-\\.]{1}[a-zA-Z0-9]+)*\\.[a-zA-Z]{2,}?\\/?$"
      },
      "beneficiary": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "beneficiaryAddress": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/text"
            }
          },
          "bankAddress": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/text"
            }
          },
          "defaultBeneficiary": {
            "$ref": "#/components/schemas/text"
          },
          "creatorContactId": {
            "$ref": "#/components/schemas/uuid"
          },
          "name": {
            "$ref": "#/components/schemas/text"
          },
          "bankAccountHolderName": {
            "$ref": "#/components/schemas/text"
          },
          "bankCountry": {
            "$ref": "#/components/schemas/countryIso3166Alpha2"
          },
          "beneficiaryEntityType": {
            "$ref": "#/components/schemas/legalEntityTypejuun"
          },
          "currency": {
            "$ref": "#/components/schemas/currencyIso4217"
          },
          "email": {
            "$ref": "#/components/schemas/emailAddress"
          },
          "beneficiaryCountry": {
            "$ref": "#/components/schemas/countryIso3166Alpha2"
          },
          "accountNumber": {
            "$ref": "#/components/schemas/text"
          },
          "routingCodeType1": {
            "$ref": "#/components/schemas/routingCodeType"
          },
          "routingCodeValue1": {
            "$ref": "#/components/schemas/text"
          },
          "routingCodeType2": {
            "$ref": "#/components/schemas/routingCodeType"
          },
          "routingCodeValue2": {
            "$ref": "#/components/schemas/text"
          },
          "bicSwift": {
            "$ref": "#/components/schemas/text"
          },
          "iban": {
            "$ref": "#/components/schemas/text"
          },
          "bankName": {
            "$ref": "#/components/schemas/text"
          },
          "bankAccountType": {
            "$ref": "#/components/schemas/bankAccountType"
          },
          "beneficiaryCompanyName": {
            "$ref": "#/components/schemas/text"
          },
          "beneficiaryFirstName": {
            "$ref": "#/components/schemas/text"
          },
          "beneficiaryLastName": {
            "$ref": "#/components/schemas/text"
          },
          "beneficiaryCity": {
            "$ref": "#/components/schemas/text"
          },
          "beneficiaryPostcode": {
            "$ref": "#/components/schemas/text"
          },
          "beneficiaryStateOrProvince": {
            "$ref": "#/components/schemas/text"
          },
          "beneficiaryDateOfBirth": {
            "$ref": "#/components/schemas/dateTimeIso8601"
          },
          "beneficiaryIdentificationType": {
            "$ref": "#/components/schemas/identificationType"
          },
          "beneficiaryIdentificationValue": {
            "$ref": "#/components/schemas/text"
          },
          "paymentTypes": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/paymentTypezrsf"
            }
          },
          "beneficiaryExternalReference": {
            "$ref": "#/components/schemas/text"
          },
          "businessNature": {
            "$ref": "#/components/schemas/text"
          },
          "companyWebsite": {
            "$ref": "#/components/schemas/website"
          }
        },
        "required": [
          "bankAccountHolderName",
          "bankAddress",
          "bankCountry",
          "beneficiaryAddress",
          "beneficiaryEntityType",
          "creatorContactId",
          "currency",
          "defaultBeneficiary",
          "name"
        ]
      },
      "legalEntityTypejuun": {
        "type": "string",
        "enum": [
          "company",
          "individual"
        ]
      },
      "paymentTypezrsf": {
        "type": "string",
        "enum": [
          "priority",
          "regular"
        ]
      }
    },
    "securitySchemes": {
      "prod-sandbox-sivo-api-authorizer": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-amazon-apigateway-authtype": "cognito_user_pools",
        "x-amazon-apigateway-authorizer": {
          "type": "cognito_user_pools",
          "providerARNs": [
            "${Token[TOKEN.1762]}"
          ]
        }
      }
    }
  },
  "x-amazon-apigateway-minimum-compression-size": 0
}
```