POST
/
customers
/
{customerId}
/
beneficiaries
/
name-verification
curl --request POST \
  --url https://api.next.orenda.finance/customers/{customerId}/beneficiaries/name-verification \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identification": "12345612345678",
  "ownerName": "Jordan Taylor",
  "isCorporate": false
}
'
{
  "success": true,
  "result": "MATCH",
  "matchedName": "Jordan Taylor"
}

Authorizations

​
Authorization
string
header
required

The back-office user's access token.

Path Parameters

​
customerId
string<uuid>
required

The customer's ID.

Query Parameters

​
programId
string
required

The program the customer/account belongs to. Required on every request.

Body

application/json

Confirmation of Payee (UK) request shape.

​
identification
string
required

The payee's sort code and account number concatenated (6-digit sort code followed by the 8-digit account number).

Example:

"12345612345678"

​
ownerName
string
required

The name the customer believes the account belongs to.

Example:

"Jordan Taylor"

​
isCorporate
boolean
required

Whether the payee account is a business (corporate) account rather than a personal one.

Response

The name-verification result.

The payee name-verification result. The exact field set depends on the scheme and provider; additional fields may be present.

​
success
boolean
Example:

true

​
result
string

Whether the supplied name matches the account holder on record.

Example:

"MATCH"