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

# Run a standalone Verification of Payee check for a list of beneficiaries

Runs a standalone Verification of Payee check for the given Beneficiaries list. The beneficiary data can be provided with `beneficiary_id` + `account_id` combination, or with `beneficiary_name` + `iban` + `swift_code` combination.

The result's `authorization_id` can be used in a following Payment request as `vop_authorization_id` queryparam, as long as the beneficiary information in the VoP check request and the payment request are the same.


## OpenAPI

````yaml /openapi.json post /vop
openapi: 3.0.0
info:
  description: |
    Ebury API allows customers:
      to retrieve accounts, balances, beneficiaries, and transactions;
      to get buy/sell estimates and quotes, book trades and retrieve trade history;
      to allocate payments to a trade and beneficiary, and to submit payments in bulk;
      to download documents such as trade receipt, payment instruction and payment receipt;
      to manage the authorised persons on their account.
    The Metadata API allows applications to clarify some parts of the Ebury API
      that are impractical to express schematically.
  termsOfService: https://docs.ebury.io/#terms-of-use
  title: Ebury API
  version: '0.1'
servers:
  - url: https://{environment}.ebury.io
    variables:
      environment:
        default: api
        enum:
          - api
          - sandbox
security:
  - api_key: []
paths:
  /vop:
    post:
      tags:
        - VoP
      summary: Run a standalone Verification of Payee check for a list of beneficiaries
      description: >-
        Obtains the Verification of Payee result for each of the provided
        beneficiaries. A full-match means that the provided data is the same as
        the one in the actual Bank information. Other results mean that the
        provided data is not the same in the bank, and can potentially turn into
        a scam.
      parameters:
        - description: The ID of the client
          in: query
          name: client_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                beneficiaries:
                  type: array
                  description: List of beneficiaries to check.
                  items:
                    type: object
                    properties:
                      beneficiary_id:
                        type: string
                        description: ID of the beneficiary.
                      account_id:
                        type: string
                        description: ID of the bank account.
                      beneficiary_name:
                        type: string
                        description: >-
                          Full name of the beneficiary. If this is provided,
                          beneficiary_id and account_id should not be.
                      iban:
                        type: string
                        description: >-
                          IBAN of the beneficiary. If this is provided,
                          beneficiary_id and account_id should not be.
                      swift_code:
                        type: string
                        description: >-
                          SWIFT/BIC code of the beneficiary's bank. If this is
                          provided, beneficiary_id and account_id should not be.
              required:
                - beneficiaries
        required: true
      responses:
        '200':
          description: >-
            The Verification of Payee outcome with a list of `results`, one for
            each provided beneficiary dataset.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VopCheckDetails'
        '400':
          description: >-
            Formatting, parameter or schema validation error. See error message
            for further details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Access denied due to authentication failure
        '403':
          description: >-
            Could not complete action due to data constraints. Refer to error
            message for additional details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Client ID not found
        '409':
          description: >-
            Could not update contact due to data constraint or conflict with
            contact status. Refer to error message for additional details
        '502':
          description: Internal integration error. Contact support
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '504':
          description: Timeout error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
components:
  schemas:
    VopCheckDetails:
      description: The details of a Verification of Payee check.
      properties:
        authorization_id:
          description: >-
            The ID of the VoP check. Can be provided in payment requests as
            `vop_authorization_id` queryparam to confirm VoP checks.
          type: string
        results:
          description: >-
            The list of VoP results, one for each beneficiary data object
            provided.
          type: array
          items:
            $ref: '#/components/schemas/VopResult'
        status:
          description: >-
            Summary of the VoP status of the whole batch. It is the highest
            priority status of all the results.
          type: string
    ErrorMessage:
      description: An error message.
      properties:
        code:
          type: string
          description: The code for the error.
        details:
          description: Error details
          type: string
        message:
          type: string
          description: A short description of the cause of the error.
      required:
        - code
        - message
        - details
      type: object
    VopResult:
      description: The result of a Verification of Payee check.
      properties:
        message:
          description: Details about the result returned.
          type: string
        name:
          description: >-
            If the beneficiary name is a close match, this contains the actual
            names.
          type: string
        scheme_response_codes:
          description: List of response codes related to the response.
          type: array
          items:
            type: string
        status:
          description: The actual VoP status
          type: string
  securitySchemes:
    api_key:
      description: An API Key.
      in: header
      name: x-api-key
      type: apiKey

````