POST Validate Beneficiary

post

https://sandbox.api.alphagroup.com/v1/beneficiaries/validation

This endpoint allows you to validate the beneficiary details before submitting a request to create the beneficiary. Beneficiary details and the client Account ID are required parameters. A successful response will return a no message body. In the event of an error, a failure response will be returned with problem details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Name

string

required

length ≥ 1

The name of the beneficiary.

FriendlyName

string | null

Friendly name of the beneficiary (RM Only)

DateOfBirth

date | null

The beneficiary's date of birth in YYYY-MM-DD format.

Postcode

string | null

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

City

string | null

Name of a built-up area, with defined boundaries, and a local government.

State

string | null

State field for address (RM Only)

AddressLine1

string | null

First address line.

AddressLine2

string | null

Second address line.

BankCountryCode

string

required

length between 2 and 2

The two letter country code of the beneficiary's bank country.

CountryCode

string

required

length between 2 and 2

The two letter country code of the beneficiary's country.

Iban

string | null

The beneficiary's bank account IBAN.

BankName

string | null

The beneficiary's bank name.

NationalBankCode

string | null

The beneficiary's bank code, e.g. UK sort code.

AccountNumber

string | null

The beneficiary's bank account number.

Swift

string | null

The beneficiary's bank account SWIFT code.

Type

enum

The beneficiary type.

Party

enum

First or Third.

EntityId

string

required

length ≥ 1

The Entity ID of the client creating the beneficiary.

Currency

string | null

The currency of the beneficiary.

Responses

204

Beneficiary is valid.

401

Unauthorized.

403

Forbidden.

404

Resource not found.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Beneficiary is invalid.

500Internal server error.