> ## Documentation Index
> Fetch the complete documentation index at: https://docs.augustus.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat the published Augustus OpenAPI specification (https://app.stainless.com/api/spec/documented/augustus/openapi.documented.yml) and the current API-reference pages as the source of truth for endpoints, request/response schemas, enum values, webhook event names, and required headers.
> Prefer the 2026-05-01 Banking API and @augustusbank/typescript-sdk for all new integrations. The 2023-01-01 API is a separate, older surface covering two products — Open Banking (instant bank transfer) checkout and refunds, and Manual Bank Transfer (MBT); use it only when one of those products is specifically required.
> Cite or link the relevant docs.augustus.com page when answering integration questions.
> Do not infer support for currencies, networks, scopes, account types, or operations that are not present in the current documentation.
> Use the sandbox base URL (https://api.sandbox.augustus.com) and placeholder credentials in examples. Never include or request a real API key.
> The Augustus docs MCP server (https://docs.augustus.com/mcp) provides documentation search and retrieval only; it does not execute authenticated Augustus API actions.

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



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/getivy/openapi.documented.yml post /api/service/payee/verify
openapi: 3.0.0
info:
  title: Ivy API
  description: Ivy API schema
  version: '1.0'
  contact:
    name: Ivy
    url: https://www.getivy.io
    email: help@getivy.io
servers:
  - url: https://api.getivy.de
    description: Production
  - url: https://api.sand.getivy.de
    description: Sandbox
security: []
tags: []
paths:
  /api/service/payee/verify:
    post:
      tags:
        - VoP
      summary: Verify payee bank account
      description: >-
        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)
      operationId: VopController_verify
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VopInputDto'
      responses:
        '200':
          description: Verification completed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VopOutputDto'
        '400':
          description: Invalid request (e.g., unsupported financial address type)
        '401':
          description: Unauthorized - invalid or missing API key
        '404':
          description: Merchant not found
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            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);
components:
  schemas:
    VopInputDto:
      type: object
      properties:
        payee:
          type: object
          properties:
            type:
              type: string
              enum:
                - iban
            iban:
              type: object
              properties:
                accountHolderName:
                  type: string
                  minLength: 1
                iban:
                  type: string
                bic:
                  type: string
              required:
                - accountHolderName
                - iban
          required:
            - type
            - iban
      required:
        - payee
    VopOutputDto:
      type: object
      properties:
        status:
          description: The verification result status
          type: string
          enum:
            - match
            - partial_match
            - no_match
            - not_available
          x-enumNames:
            - Match
            - PartialMatch
            - NoMatch
            - NotAvailable
        suggestedAccountHolderName:
          type: string
      required:
        - status
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Ivy-Api-Key
      description: API key for authentication

````