---
updatedAt: 2026-04-29T13:55:36.000Z
agentTools:
  projectIndex: https://integrate.toq.io/llms.txt
---

# Update Beneficiary

Updates an existing beneficiary. Profile fields (name, address and visibility) can be edited. Bank-account detail fields are immutable: they are captured at creation and marked read-only on the update request body, so any value supplied for them is ignored and the stored value is preserved before the request is forwarded to the provider.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Toqio Integration Hub API",
    "version": "v0"
  },
  "servers": [
    {
      "url": "https://your_connector_url",
      "description": "This is an example url that you could use for testing purposes as this documentation describes the API that you must develop in your connector."
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/customers/{customerId}/clients/{clientId}/beneficiaries/{accountId}": {
      "put": {
        "tags": [
          "Beneficiary"
        ],
        "summary": "Update Beneficiary",
        "description": "Updates an existing beneficiary. Profile fields (name, address and visibility) can be edited. Bank-account detail fields are immutable: they are captured at creation and marked read-only on the update request body, so any value supplied for them is ignored and the stored value is preserved before the request is forwarded to the provider.",
        "operationId": "updateBeneficiary",
        "parameters": [
          {
            "name": "customerId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "clientId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "accountId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UpdatePersonalAccountRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ToqioHttpOkViewPersonalAccountResponse"
                }
              }
            }
          },
          "404": {
            "description": "CUSTOMER_NOT_FOUND"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ViewPersonalAccountResponse": {
        "type": "object",
        "properties": {
          "ukAccountNumber": {
            "type": "string"
          },
          "ukSortCode": {
            "type": "string"
          },
          "iban": {
            "type": "string"
          },
          "bicSwift": {
            "type": "string"
          },
          "bank": {
            "type": "string"
          },
          "bsbCode": {
            "type": "string"
          },
          "routingNumber": {
            "type": "string"
          },
          "caRoutingNumber": {
            "type": "string"
          },
          "accountNumber": {
            "type": "string"
          },
          "clabe": {
            "type": "string"
          },
          "aba": {
            "type": "string",
            "deprecated": true
          },
          "cnaps": {
            "type": "string"
          },
          "ifsc": {
            "type": "string"
          },
          "bankCode": {
            "type": "string",
            "deprecated": true
          },
          "branchCode": {
            "type": "string",
            "deprecated": true
          },
          "type": {
            "type": "string",
            "enum": [
              "PERSON",
              "COMPANY"
            ]
          },
          "assetType": {
            "type": "string",
            "enum": [
              "aud",
              "chf",
              "cad",
              "sek",
              "usd",
              "nok",
              "jpy",
              "nzd",
              "gold",
              "gbp",
              "eur",
              "czk",
              "dkk",
              "huf",
              "pln",
              "ron",
              "ils",
              "rub",
              "bhd",
              "sar",
              "bgn",
              "kes",
              "sgd",
              "kwd",
              "zar",
              "cny",
              "myr",
              "hrk",
              "mxn",
              "thb",
              "try",
              "omr",
              "ugx",
              "hkd",
              "php",
              "aed",
              "inr",
              "qar",
              "idr",
              "points"
            ]
          },
          "name": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "addressStreet": {
            "type": "string"
          },
          "addressPostalCode": {
            "type": "string"
          },
          "addressCity": {
            "type": "string"
          },
          "addressIsoCountry": {
            "type": "string"
          },
          "bankCountry": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "userId": {
            "type": "string"
          },
          "companyId": {
            "type": "string"
          },
          "beneficiaryAccountId": {
            "type": "string"
          },
          "visible": {
            "type": "boolean"
          },
          "bankingProviderBeneficiaryId": {
            "type": "string"
          },
          "baasOTP": {
            "type": "string"
          },
          "operationId": {
            "type": "string"
          },
          "sourceAccount": {
            "type": "string"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time"
          },
          "fullName": {
            "type": "string"
          },
          "nameOrFullName": {
            "type": "string"
          },
          "fullAddress": {
            "type": "string"
          },
          "addressLine": {
            "type": "string"
          }
        }
      },
      "UpdatePersonalAccountRequest": {
        "type": "object",
        "description": "Request body for the Update Beneficiary operation. Identical to SavePersonalAccountRequest except that all bank-account detail fields are read-only: they are captured at creation and cannot be modified on update. Any value supplied for a read-only field is ignored and the stored value is preserved before forwarding to the provider.",
        "properties": {
          "ukAccountNumber": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "ukSortCode": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "iban": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "bicSwift": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "bank": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "bsbCode": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "routingNumber": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "caRoutingNumber": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "accountNumber": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "clabe": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "aba": {
            "type": "string",
            "readOnly": true,
            "deprecated": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "cnaps": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "ifsc": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "bankCode": {
            "type": "string",
            "readOnly": true,
            "deprecated": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "branchCode": {
            "type": "string",
            "readOnly": true,
            "deprecated": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "type": {
            "type": "string",
            "enum": [
              "PERSON",
              "COMPANY"
            ]
          },
          "assetType": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Currency / asset type, set at creation and ignored on update.",
            "enum": [
              "aud",
              "chf",
              "cad",
              "sek",
              "usd",
              "nok",
              "jpy",
              "nzd",
              "gold",
              "gbp",
              "eur",
              "czk",
              "dkk",
              "huf",
              "pln",
              "ron",
              "ils",
              "rub",
              "bhd",
              "sar",
              "bgn",
              "kes",
              "sgd",
              "kwd",
              "zar",
              "cny",
              "myr",
              "hrk",
              "mxn",
              "thb",
              "try",
              "omr",
              "ugx",
              "hkd",
              "php",
              "aed",
              "inr",
              "qar",
              "idr",
              "points"
            ]
          },
          "name": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "addressStreet": {
            "type": "string"
          },
          "addressPostalCode": {
            "type": "string"
          },
          "addressCity": {
            "type": "string"
          },
          "addressIsoCountry": {
            "type": "string"
          },
          "bankCountry": {
            "type": "string",
            "readOnly": true,
            "description": "Immutable. Set at creation and ignored on update."
          },
          "id": {
            "type": "string"
          },
          "userId": {
            "type": "string"
          },
          "companyId": {
            "type": "string"
          },
          "beneficiaryAccountId": {
            "type": "string"
          },
          "visible": {
            "type": "boolean"
          },
          "bankingProviderBeneficiaryId": {
            "type": "string"
          },
          "baasOTP": {
            "type": "string"
          },
          "operationId": {
            "type": "string"
          },
          "sourceAccount": {
            "type": "string"
          }
        }
      },
      "ToqioHttpOkViewPersonalAccountResponse": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/ViewPersonalAccountResponse"
          },
          "code": {
            "type": "string",
            "example": "OK"
          },
          "errorSeverity": {
            "type": "string",
            "example": "NONE"
          },
          "message": {
            "type": "string",
            "example": "Ok"
          },
          "httpStatus": {
            "type": "integer",
            "format": "int32",
            "example": 200
          },
          "requestId": {
            "type": "string",
            "example": "26b0f78a-79f9-426d-a20b-79841345ae51"
          },
          "date": {
            "type": "string",
            "example": "2024-08-01T00:00:00.000Z"
          }
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}
```