---
title: "Validate Beneficiary"
method: POST
path: "/beneficiaries/validate"
---

# Validate Beneficiary

`POST /beneficiaries/validate`

## Request

- Base URL: `https://sandbox.openpayd.com/api`
- URL: `https://sandbox.openpayd.com/api/beneficiaries/validate`
- Auth: API key in header `Authorization`

Validate a beneficiary without creating one first to ensure that beneficiary details are valid for a given payment type and currency.

## Request body

- object
  - `bankAccountCurrency` string, required: Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code in which the beneficiary account is held. e.g. `EUR`
  - `bankAccountCountry` string, required: Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the beneficiary account is held. e.g. `GB`
  - `beneficiaryType` string, required: `CORPORATE`, `RETAIL`
  - `paymentTypes` string[]: Payment Types against which to validate the beneficiary. If left empty, the beneficiary will be validated for all available Payment Types.
  - `bankAccountType` string: Type of the account. e.g. `Current`, `Savings`
  - `bankName` string: Name of the bank where the account is held. e.g. `HSBC UK`
  - `bankAddress` string: Address of the bank where the account is held.
  - `bankAccountHolderName` string: Name appearing the beneficiary account.
  - `accountNumber` string: Account number of the account.
  - `bankRoutingCodes` object[]: Routing codes associated with the account.
    - `routingCodeKey` string
    - `routingCodeValue` string
  - `iban` string: IBAN of the account.
  - `bic` string: SWIFT BIC of the account.
  - `companyName` string: Required if `beneficiaryType` is `CORPORATE`.
  - `title` string: Required if `beneficiaryType` is `RETAIL`.
  - `beneficiaryFirstName` string: Required if `beneficiaryType` is `RETAIL`.
  - `beneficiaryLastName` string: Required if `beneficiaryType` is `RETAIL`.
  - `beneficiaryBirthDate` string: `YYYY-MM-DD` e.g. `1986-04-29` for 29th April 1986
  - `beneficiaryAddressLine` string
  - `beneficiaryCity` string
  - `beneficiaryCountry` string: Two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code e.g. `GB`
  - `beneficiaryPostalCode` string
  - `friendlyName` string: User friendly name associated with the bank beneficiary. e.g. `My HSBC Account`
  - `taxId` string: Tax Id of the beneficiary.

## Response `200`

200

- object
  - `beneficiaryValidationResultSet` object[]
    - `paymentType` string
    - `messages` object
    - `valid` boolean

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/openpayd/apis/openpayd-api.md) - [All operations](https://skmtc.dev/openpayd/apis/openpayd-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openpayd/apis/openpayd-api/revisions/0f820ef79fab?raw)