---
updatedAt: 2025-09-23T11:11:09.000Z
agentTools:
  projectIndex: https://convera.readme.io/llms.txt
---

# Validate beneficiary details

The Validate Beneficiary Resource allows the caller to verify Beneficiary details for Euro Zone Beneficiaries. This utilises the European Validation Of Beneficiary requirement to allow customers to verify the details prior to making payment.

<br />

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.1.0",
    "title": "Payments API"
  },
  "x-explorer-enabled": false,
  "servers": [
    {
      "url": "https://masspaysandbox.api.convera.com/MassPayments",
      "description": "Staging"
    },
    {
      "url": "https://api.convera.com/v1/masspayments",
      "description": "Production"
    }
  ],
  "paths": {
    "/banks/{customerId}/validationofbeneficiary": {
      "post": {
        "tags": [
          "Bank Resource"
        ],
        "summary": "Validate beneficiary details",
        "operationId": "Banks_ValidateBeneficiary",
        "parameters": [
          {
            "name": "customerId",
            "in": "path",
            "description": "customerId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BeneficiaryValidationRequestData"
              }
            }
          },
          "description": "Beneficiary validation request data",
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BeneficiaryValidationResultData"
                }
              }
            }
          },
          "400": {
            "description": "BadRequest",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorCode": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorDescription": {
                      "type": "string"
                    },
                    "errorCode": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "errorDescription": {
                      "type": "string"
                    },
                    "errorCode": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "BeneficiaryValidationRequestData": {
        "required": [
          "currencyCode",
          "beneficiary",
          "bankAccount"
        ],
        "type": "object",
        "properties": {
          "currencyCode": {
            "type": "string",
            "description": "Currency code for the validation"
          },
          "beneficiary": {
            "$ref": "#/components/schemas/ValidationBeneficiaryData"
          },
          "bankAccount": {
            "$ref": "#/components/schemas/ValidationBankAccountData"
          }
        }
      },
      "ValidationBeneficiaryData": {
        "required": [
          "name",
          "countryCode"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Beneficiary name"
          },
          "countryCode": {
            "type": "string",
            "description": "Beneficiary country code"
          }
        }
      },
      "ValidationBankAccountData": {
        "required": [
          "iban"
        ],
        "type": "object",
        "properties": {
          "iban": {
            "type": "string",
            "description": "International Bank Account Number"
          }
        }
      },
      "BeneficiaryValidationResultData": {
        "type": "object",
        "properties": {
          "beneficiary": {
            "$ref": "#/components/schemas/ValidationResultBeneficiaryData"
          }
        }
      },
      "ValidationResultBeneficiaryData": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Validated beneficiary name"
          },
          "iban": {
            "type": "string",
            "description": "Validated IBAN"
          },
          "matchScore": {
            "type": "string",
            "description": "Match score for validation"
          },
          "matchType": {
            "type": "string",
            "description": "Type of match (e.g., MTCH)"
          },
          "matchDescription": {
            "type": "string",
            "description": "Description of the match result"
          },
          "validationMessage": {
            "type": "string",
            "description": "Validation message with instructions"
          },
          "disclaimer": {
            "type": "string"
          }
        }
      }
    }
  }
}
```