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

# Batch import of account entries

> Accepts a list of account entries and returns import results.



## OpenAPI

````yaml api/vop-verifier-openapi.json post /v1/accounts
openapi: 3.0.1
info:
  description: Verification of Payee (VoP) API for SEPA payment validation
  title: VoP Verifier API
  version: 1.0.0
servers:
  - description: VoP test environment
    url: https://api.vop-sandbox.finventi.com
  - description: VoP prod environment
    url: https://api.vop.finventi.com
security: []
tags:
  - description: >-
      Endpoints for creating, updating, and deleting IBAN-to-account-holder
      records. Used by data providers to keep verification data accurate and up
      to date.
    name: Accounts management
paths:
  /v1/accounts:
    post:
      tags:
        - Accounts management
      summary: Batch import of account entries
      description: Accepts a list of account entries and returns import results.
      operationId: importAccounts
      parameters:
        - description: >-
            Unique idempotency key to prevent duplicate batch account import
            requests
          example: b7f3f8a2-9e0c-4d1e-8a2f-1234567890ab
          in: header
          name: Idempotency-Key
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportAccountsRequest'
        description: Batch import request containing account entries
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchImportResponse'
          description: Response returned after a batch account import operation
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Bad request
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Tenant does not have an access to the resource
components:
  schemas:
    ImportAccountsRequest:
      properties:
        accounts:
          description: >-
            Payload for importing a single account via IBAN and owner
            identification.
          example: >-
            [{iban: LT121000011101001000, account_holder_names: [Alice
            Johnson]}]
          properties:
            account_holder_names:
              description: >-
                Account holder name (natural person or legal entity) of the
                associated IBAN.
              example: Alice Johnson
              items:
                description: >-
                  Account holder name (natural person or legal entity) of the
                  associated IBAN.
                example: Alice Johnson
                maxLength: 70
                minLength: 1
                type: string
              maxLength: 70
              minItems: 1
              minLength: 1
              type: array
            aliases:
              description: >-
                Optional alternative names or identifiers to improve matching
                (e.g., acronyms, short forms like "IBM" for "International
                Business Machines")
              example:
                - HGRP
              items:
                description: >-
                  Optional alternative names or identifiers to improve matching
                  (e.g., acronyms, short forms like "IBM" for "International
                  Business Machines")
                example: '["HGRP"]'
                type: string
              type: array
            client_id:
              description: Client identifier in the internal system.
              example: client-12345
              type: string
            iban:
              description: Account holder IBAN. Must be a valid IBAN format.
              example: LT121000011101001000
              minLength: 1
              type: string
            organisation_identification:
              $ref: '#/components/schemas/OrganisationIdentification'
          required:
            - account_holder_names
            - iban
          type: object
      required:
        - accounts
      type: object
    BatchImportResponse:
      description: Response returned after a batch account import operation
      properties:
        failed_count:
          description: Number of account entries that failed to import
          example: 15
          format: int32
          type: integer
        failed_entries:
          description: >-
            List of account entries that failed to be imported along with
            reasons
          properties:
            account_holder_names:
              description: Names of the account holders
              example:
                - Alice Johnson
              items:
                description: Names of the account holders
                example: '["Alice Johnson"]'
                type: string
              type: array
            aliases:
              description: >-
                Alternative names or identifiers to improve matching (e.g.,
                acronyms, short forms like "IBM" for "International Business
                Machines")
              items:
                description: >-
                  Alternative names or identifiers to improve matching (e.g.,
                  acronyms, short forms like "IBM" for "International Business
                  Machines")
                type: string
              type: array
            client_id:
              description: Client identifier if provided
              example: client-12345
              type: string
            iban:
              description: IBAN of the failed account
              example: LT121000011101001000
              type: string
            organisation_identification:
              $ref: '#/components/schemas/OrganisationIdentificationResponse'
            reasons:
              description: Reasons why the entry failed to import
              example:
                - IBAN is required and cannot be empty
              items:
                description: Reasons why the entry failed to import
                example: '["IBAN is required and cannot be empty"]'
                type: string
              type: array
              uniqueItems: true
          required:
            - account_holder_names
            - aliases
            - reasons
          type: object
        imported_count:
          description: Number of account entries successfully imported
          example: 85
          format: int32
          type: integer
        imported_entries:
          description: List of account entries that were successfully imported
          properties:
            account_holder_names:
              description: Names of the account holders
              example:
                - Alice Johnson
              items:
                description: Names of the account holders
                example: '["Alice Johnson"]'
                type: string
              type: array
            aliases:
              description: >-
                Alternative names or identifiers to improve matching (e.g.,
                acronyms, short forms like "IBM" for "International Business
                Machines")
              example:
                - HGRP
              items:
                description: >-
                  Alternative names or identifiers to improve matching (e.g.,
                  acronyms, short forms like "IBM" for "International Business
                  Machines")
                example: '["HGRP"]'
                type: string
              type: array
            client_id:
              description: Client identifier
              example: client-12345
              type: string
            iban:
              description: IBAN of the account
              example: LT121000011101001000
              type: string
            organisation_identification:
              $ref: '#/components/schemas/OrganisationIdentificationResponse'
          required:
            - account_holder_names
            - aliases
            - iban
          type: object
        total_count:
          description: Total number of account entries submitted for import
          example: 100
          format: int32
          type: integer
      required:
        - failed_count
        - failed_entries
        - imported_count
        - imported_entries
        - total_count
      type: object
    Problem:
      properties:
        detail:
          type: string
        instance:
          format: uri
          type: string
        parameters:
          additionalProperties:
            type: object
          type: object
        status:
          $ref: '#/components/schemas/StatusType'
        title:
          type: string
        type:
          format: uri
          type: string
      type: object
    OrganisationIdentification:
      description: Legal-entity identifiers for the IBAN owner.
      properties:
        bic:
          description: >-
            Business Identifier Code (BIC). 11 characters, conforming to ISO
            9362 format.
          example: DEUTDEFFXXX
          type: string
        lei:
          description: Legal Entity Identifier (LEI) conforming to ISO 17442 format.
          example: 5493001KJTIIGC8Y1R12
          type: string
        other:
          $ref: '#/components/schemas/OtherOrganisationIdentificationRequest'
      type: object
    OrganisationIdentificationResponse:
      description: Identification details for the organisation.
      properties:
        bic:
          description: >-
            Business Identifier Code (BIC) 11 characters, conforming to ISO 9362
            format.
          example: DEUTDEFFXXX
          type: string
        lei:
          description: Legal Entity Identifier (LEI) conforming to ISO 17442 format.
          example: 5493001KJTIIGC8Y1R12
          type: string
        other:
          $ref: '#/components/schemas/OtherOrganisationIdentificationResponse'
      type: object
    StatusType:
      properties:
        reasonPhrase:
          type: string
        statusCode:
          format: int32
          type: integer
      type: object
    OtherOrganisationIdentificationRequest:
      description: Custom identification scheme for organisations.
      properties:
        identification:
          description: Identifier value in this custom scheme.
          example: 123-ABC-XYZ
          maxLength: 256
          minLength: 1
          type: string
        issuer:
          description: Authority or body that issued this identifier.
          example: ChamberOfCommerce
          type: string
        scheme_name_code:
          description: Coded name of the identifier scheme
          enum:
            - BANK
            - CBID
            - CHID
            - CINC
            - COID
            - CUST
            - DUNS
            - EMPL
            - GS1G
            - SREN
            - SRET
            - TXID
            - BDID
            - BOID
          example: BANK
          type: string
        scheme_name_proprietary:
          description: Proprietary name of the identifier scheme.
          example: LocalRegistry
          type: string
      required:
        - identification
      type: object
    OtherOrganisationIdentificationResponse:
      description: Custom identification scheme for organisations.
      properties:
        identification:
          description: Identifier value in this custom scheme.
          example: 123-ABC-XYZ
          maxLength: 256
          minLength: 1
          type: string
        issuer:
          description: Authority or body that issued this identifier.
          example: ChamberOfCommerce
          type: string
        scheme_name_code:
          description: Coded name of the identifier scheme
          example: VAT
          type: string
        scheme_name_proprietary:
          description: Proprietary name of the identifier scheme.
          example: LocalRegistry
          type: string
      required:
        - identification
      type: object

````