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);

{
  "status": "match",
  "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 name
partial_match: Close match - similar but not identical (e.g., typos, abbreviations). The suggestedAccountHolderName field will contain the suggested account holder name.
no_match: No match - the name does not match the account holder
not_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);

{
  "status": "match",
  "suggestedAccountHolderName": "<string>"
}

Authorizations

X-Ivy-Api-Key

string

header

required

API key for authentication

Body

application/json

payee

object

required

Show child attributes

Response

Verification completed successfully

status

enum<string>

required

The verification result status

Available options:

match,

partial_match,

no_match,

not_available

suggestedAccountHolderName

string

List transactions Introduction

⌘I

Getting Started

REST API

Webhooks

Webhook Events

Verify payee bank account

Authorizations

Body

Response

Getting Started

REST API

Webhooks

Webhook Events

Documentation Index

Authorizations

Body

Response