JavaScript
import Ivy from '@getivy/node-sdk';
const client = new Ivy({
apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});
const response = await client.payee.verify({
payee: {
iban: { accountHolderName: 'x', iban: 'iban' },
type: 'iban',
},
});
console.log(response.status);curl --request POST \
--url https://api.getivy.de/api/service/payee/verify \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"payee": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
}
}
}
'import requests
url = "https://api.getivy.de/api/service/payee/verify"
payload = { "payee": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
}
} }
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getivy.de/api/service/payee/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([
'payee' => [
'type' => 'iban',
'iban' => [
'accountHolderName' => '<string>',
'iban' => '<string>',
'bic' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$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.getivy.de/api/service/payee/verify"
payload := strings.NewReader("{\n \"payee\": {\n \"type\": \"iban\",\n \"iban\": {\n \"accountHolderName\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
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.getivy.de/api/service/payee/verify")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payee\": {\n \"type\": \"iban\",\n \"iban\": {\n \"accountHolderName\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/payee/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payee\": {\n \"type\": \"iban\",\n \"iban\": {\n \"accountHolderName\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"suggestedAccountHolderName": "<string>"
}VoP
Verify payee bank account
Verify that the provided account holder name matches the bank account details.
Currently supported financial address types:
iban: IBAN-based accounts (EU/SEPA). It implements Verification of Payee (VoP) as required by EU Instant Payments Regulation.
Possible status values:
match: Exact match - the name matches the account holder’s namepartial_match: Close match - similar but not identical (e.g., typos, abbreviations). ThesuggestedAccountHolderNamefield will contain the suggested account holder name.no_match: No match - the name does not match the account holdernot_available: Verification not possible (e.g., bank unreachable, timeout, unsupported)
POST
/
api
/
service
/
payee
/
verify
JavaScript
import Ivy from '@getivy/node-sdk';
const client = new Ivy({
apiKey: process.env['IVY_API_KEY'], // This is the default and can be omitted
});
const response = await client.payee.verify({
payee: {
iban: { accountHolderName: 'x', iban: 'iban' },
type: 'iban',
},
});
console.log(response.status);curl --request POST \
--url https://api.getivy.de/api/service/payee/verify \
--header 'Content-Type: application/json' \
--header 'X-Ivy-Api-Key: <api-key>' \
--data '
{
"payee": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
}
}
}
'import requests
url = "https://api.getivy.de/api/service/payee/verify"
payload = { "payee": {
"type": "iban",
"iban": {
"accountHolderName": "<string>",
"iban": "<string>",
"bic": "<string>"
}
} }
headers = {
"X-Ivy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getivy.de/api/service/payee/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([
'payee' => [
'type' => 'iban',
'iban' => [
'accountHolderName' => '<string>',
'iban' => '<string>',
'bic' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Ivy-Api-Key: <api-key>"
],
]);
$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.getivy.de/api/service/payee/verify"
payload := strings.NewReader("{\n \"payee\": {\n \"type\": \"iban\",\n \"iban\": {\n \"accountHolderName\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Ivy-Api-Key", "<api-key>")
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.getivy.de/api/service/payee/verify")
.header("X-Ivy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payee\": {\n \"type\": \"iban\",\n \"iban\": {\n \"accountHolderName\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getivy.de/api/service/payee/verify")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Ivy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payee\": {\n \"type\": \"iban\",\n \"iban\": {\n \"accountHolderName\": \"<string>\",\n \"iban\": \"<string>\",\n \"bic\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"suggestedAccountHolderName": "<string>"
}Authorizations
API key for authentication
Body
application/json
Show child attributes
Show child attributes
Was this page helpful?
⌘I