Verify a payee's name
curl --request POST \
--url https://api.next.orenda.finance/v1/beneficiaries/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"beneficiary": {
"name": "Ada Lovelace"
},
"account": {
"type": "uk",
"sortCode": "040506",
"accountNumber": "87654321"
}
}
'import requests
url = "https://api.next.orenda.finance/v1/beneficiaries/verify"
payload = {
"beneficiary": { "name": "Ada Lovelace" },
"account": {
"type": "uk",
"sortCode": "040506",
"accountNumber": "87654321"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
beneficiary: {name: 'Ada Lovelace'},
account: {type: 'uk', sortCode: '040506', accountNumber: '87654321'}
})
};
fetch('https://api.next.orenda.finance/v1/beneficiaries/verify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.next.orenda.finance/v1/beneficiaries/verify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'beneficiary' => [
'name' => 'Ada Lovelace'
],
'account' => [
'type' => 'uk',
'sortCode' => '040506',
'accountNumber' => '87654321'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.next.orenda.finance/v1/beneficiaries/verify"
payload := strings.NewReader("{\n \"beneficiary\": {\n \"name\": \"Ada Lovelace\"\n },\n \"account\": {\n \"type\": \"uk\",\n \"sortCode\": \"040506\",\n \"accountNumber\": \"87654321\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.next.orenda.finance/v1/beneficiaries/verify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"beneficiary\": {\n \"name\": \"Ada Lovelace\"\n },\n \"account\": {\n \"type\": \"uk\",\n \"sortCode\": \"040506\",\n \"accountNumber\": \"87654321\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.next.orenda.finance/v1/beneficiaries/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"beneficiary\": {\n \"name\": \"Ada Lovelace\"\n },\n \"account\": {\n \"type\": \"uk\",\n \"sortCode\": \"040506\",\n \"accountNumber\": \"87654321\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Name verification completed",
"data": {
"scheme": "COP",
"outcome": "CLOSE_MATCH",
"messageKey": "cop_mbam",
"suggestedName": "Ada M Lovelace",
"match": true,
"name": "Ada M Lovelace",
"reasonCode": "MBAM",
"reasonCodeDescription": "There may be a match on the Account name"
}
}Beneficiaries
Verify a payee
Check a name matches the account before you pay.
POST
/
v1
/
beneficiaries
/
verify
Verify a payee's name
curl --request POST \
--url https://api.next.orenda.finance/v1/beneficiaries/verify \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"beneficiary": {
"name": "Ada Lovelace"
},
"account": {
"type": "uk",
"sortCode": "040506",
"accountNumber": "87654321"
}
}
'import requests
url = "https://api.next.orenda.finance/v1/beneficiaries/verify"
payload = {
"beneficiary": { "name": "Ada Lovelace" },
"account": {
"type": "uk",
"sortCode": "040506",
"accountNumber": "87654321"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
beneficiary: {name: 'Ada Lovelace'},
account: {type: 'uk', sortCode: '040506', accountNumber: '87654321'}
})
};
fetch('https://api.next.orenda.finance/v1/beneficiaries/verify', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.next.orenda.finance/v1/beneficiaries/verify",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'beneficiary' => [
'name' => 'Ada Lovelace'
],
'account' => [
'type' => 'uk',
'sortCode' => '040506',
'accountNumber' => '87654321'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.next.orenda.finance/v1/beneficiaries/verify"
payload := strings.NewReader("{\n \"beneficiary\": {\n \"name\": \"Ada Lovelace\"\n },\n \"account\": {\n \"type\": \"uk\",\n \"sortCode\": \"040506\",\n \"accountNumber\": \"87654321\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.next.orenda.finance/v1/beneficiaries/verify")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"beneficiary\": {\n \"name\": \"Ada Lovelace\"\n },\n \"account\": {\n \"type\": \"uk\",\n \"sortCode\": \"040506\",\n \"accountNumber\": \"87654321\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.next.orenda.finance/v1/beneficiaries/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"beneficiary\": {\n \"name\": \"Ada Lovelace\"\n },\n \"account\": {\n \"type\": \"uk\",\n \"sortCode\": \"040506\",\n \"accountNumber\": \"87654321\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Name verification completed",
"data": {
"scheme": "COP",
"outcome": "CLOSE_MATCH",
"messageKey": "cop_mbam",
"suggestedName": "Ada M Lovelace",
"match": true,
"name": "Ada M Lovelace",
"reasonCode": "MBAM",
"reasonCodeDescription": "There may be a match on the Account name"
}
}Before you save or pay someone, check that the name they gave you actually matches the
account — this is Confirmation of Payee (UK) / Verification of Payee (EU). It helps
catch typos and scams.
Send the name to check and the account as a discriminated
A
account object —
{ "type": "uk", "sortCode": …, "accountNumber": … } or { "type": "iban", "iban": …, "bic": … }.
- IBAN: send the payee’s
bic. It must belong to the IBAN’s bank. - UK business payee: send
beneficiary.isCorporate: true, so the name is checked against a business account. Without it the check assumes a personal account.
Reading the result
Drive what you show fromoutcome:
outcome | What it means | What to show |
|---|---|---|
MATCH | The name matches the account. | Carry on. |
CLOSE_MATCH | The name nearly matches, or matches but the account is the other type (business vs personal). | Warn the payer. Show suggestedName when present, so they can decide. |
NO_MATCH | The name doesn’t match, or (UK) the account doesn’t exist. | Warn strongly; paying may send money to the wrong person. |
UNAVAILABLE | The payee’s bank couldn’t check it (opted out, not supported, switched, an EU account it can’t find, or no answer). | Tell the payer it couldn’t be checked. |
| Field | Meaning |
|---|---|
scheme | COP (UK Confirmation of Payee) or VOP (EU Verification of Payee). |
outcome | See above. |
suggestedName | CLOSE_MATCH only: the name the payee’s bank holds, when it sent one. |
messageKey | Identifies the message Orenda’s apps show, for example vop_cmtc (all values in the API reference). |
match | true for MATCH and CLOSE_MATCH. Kept for existing integrations; prefer outcome. |
name | Your own input on MATCH and on a close match on the other account type; the bank’s name on other close matches; empty otherwise. |
reasonCode | The scheme’s own code, for example MTCH, CMTC or ANNM. Can be absent, so read outcome rather than checking for it. |
reasonCodeDescription | The scheme’s explanation of reasonCode. Not meant for the payer. |
A scheme code Orenda doesn’t recognise comes back as
UNAVAILABLE, never as a match.400 means the request itself was refused: the body is malformed, or bic is missing,
malformed or belongs to another bank than the IBAN’s. A 422 (NAME_VERIFICATION_API_ERROR)
means the check couldn’t run; treat it like UNAVAILABLE.
Test payees in sandbox
Sandbox runs no real check: the payee name picks the outcome. Names match ignoring case.outcome | UK (type: "uk") | EU (type: "iban") |
|---|---|---|
MATCH | Any name and account not listed below. | Any name and account not listed below. |
CLOSE_MATCH | John Smyth, any account. suggestedName is John Smith, reasonCode PAMM. | John Smyth, any account. suggestedName is John Smith, reasonCode CMTC. |
NO_MATCH | Jane Doe with sort code 987654 and account number 32109876 (ANNM). | Jane Doe with IBAN GB29NWBK60161331926819 (NMTC). |
UNAVAILABLE | Unavailable Payee, any account (OPTO). | Unavailable Payee, any account (NOAP). |
Jane Doe on any other account is a MATCH.Authorizations
Body
application/json