openapi: 3.2.0
info:
  title: Outgoing Transfer Beneficiary Verifications API
  description: Operations for Outgoing Transfers
  version: '1'
servers:
- url: https://sandbox-api.integrated.finance/v1/{instanceId}
  description: Sandbox
  variables: {}
- url: https://api.integrated.finance/v1/{instanceId}
  description: Production
  variables: {}
tags:
- name: Beneficiary Verifications
paths:
  /beneficiary-verifications:
    post:
      tags:
      - Beneficiary Verifications
      summary: Verify Beneficiary
      operationId: beneficiary-verifications.create
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/BeneficiaryVerificationRequest'
        required: true
      responses:
        '200':
          description: Beneficiary verification result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryVerificationResponse'
components:
  schemas:
    BeneficiaryVerificationIdentity:
      required:
      - type
      type: object
      properties:
        type:
          type: string
      description: Beneficiary identity
      discriminator:
        propertyName: type
        mapping:
          corporate: '#/components/schemas/Corporate'
          individual: '#/components/schemas/Individual'
    BeneficiaryVerificationResponseResource:
      required:
      - beneficiaryBankAccount
      - beneficiaryIdentity
      - clientId
      - directory
      - id
      - serviceProvider
      type: object
      properties:
        id:
          type: string
          description: ID of beneficiary verification
          format: uuid
        clientId:
          type: string
          description: ID of client in UUID format
          format: uuid
        directory:
          type: string
          description: Directory of beneficiary verification
        serviceProvider:
          type: string
          description: Service provider
        beneficiaryIdentity:
          $ref: '#/components/schemas/BeneficiaryVerificationIdentity'
        beneficiaryBankAccount:
          $ref: '#/components/schemas/BeneficiaryVerificationBankAccount'
        attributes:
          $ref: '#/components/schemas/AttributeMap'
        result:
          $ref: '#/components/schemas/BeneficiaryVerificationResult'
      description: Beneficiary Verification Request Resource Object
    BeneficiaryVerificationResponseDataContainer:
      type: object
      properties:
        beneficiaryVerification:
          $ref: '#/components/schemas/BeneficiaryVerificationResponseResource'
      description: Beneficiary verification response data container
    BeneficiaryVerificationReasonCode:
      type: string
      enum:
      - account-switched
      - account-type-not-supported
      - close-match
      - corporate-account-close-match
      - corporate-account-name-matched
      - incorrect-account-number
      - individual-account-close-match
      - individual-account-name-matched
      - invalid-secondary-identifier
      - not-applicable
      - not-matched
      - opted-out
      - sort-code-not-supported
    BeneficiaryVerificationRequest:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryVerificationWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryVerificationRequestDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiaryVerificationConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryCreateMetadataContainer'
      description: Beneficiary verification request model
    BeneficiaryVerificationConnectContainer:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: Beneficiary verification connect type
          enum:
          - explicit
          - implicit
        serviceProvider:
          type: string
          description: Beneficiary verification connect service provider
    BeneficiaryVerificationWorkflowContainer:
      required:
      - code
      type: object
      properties:
        code:
          type: string
          description: workflow code
          enum:
          - client.pay-uk.cop
    AttributeMap:
      type: object
      description: outgoing transfer attributes
    BeneficiaryVerificationBankAccount:
      type: object
      properties:
        iban:
          type: string
          description: Iban of beneficiary bank account
        routingCodes:
          $ref: '#/components/schemas/RoutingCodeMap'
        accountNumber:
          type: string
          description: Account number of beneficiary bank account
        country:
          type: string
          description: Two-letter code for the country in which the beneficiary's bank account is held
      description: Bank Account Details
    BeneficiaryVerificationResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryVerificationWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryVerificationResponseDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiaryVerificationConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryCreateMetadataContainer'
      description: Beneficiaries verification response
    LegalEntityType:
      type: string
      enum:
      - corporate
      - individual
    RoutingCodeMap:
      type: object
    LegalEntityIdentification:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/LegalEntityIdentificationType'
        identificationNumber:
          type: string
        issuingCountry:
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
          type: string
        issueDate:
          type: string
          format: date
        expirationDate:
          type: string
          format: date
    Corporate:
      required:
      - legalName
      - type
      type: object
      description: Beneficiary Corporate Identity Details
      allOf:
      - $ref: '#/components/schemas/BeneficiaryVerificationIdentity'
      - type: object
        properties:
          type:
            $ref: '#/components/schemas/LegalEntityType'
          legalName:
            type: string
            description: Legal name of corporate beneficiary
          identifications:
            type: array
            description: Identification numbers of legal entity
            items:
              $ref: '#/components/schemas/LegalEntityIdentification'
    BeneficiaryVerificationResult:
      type: object
      properties:
        matched:
          type: boolean
        reason:
          $ref: '#/components/schemas/BeneficiaryVerificationReasonCode'
        accountHolderName:
          type: string
      description: Beneficiary verification result
    Individual:
      required:
      - familyName
      - givenName
      - type
      type: object
      description: Beneficiary Individual Identity Details
      allOf:
      - $ref: '#/components/schemas/BeneficiaryVerificationIdentity'
      - type: object
        properties:
          type:
            $ref: '#/components/schemas/LegalEntityType'
          givenName:
            type: string
            description: Given name of individual beneficiary
          familyName:
            type: string
            description: Family name of individual beneficiary
    BeneficiaryVerificationRequestResource:
      required:
      - bankAccount
      - clientId
      - identity
      type: object
      properties:
        clientId:
          type: string
          description: ID of client in UUID format
          format: uuid
        identity:
          type: object
          description: Beneficiary identity
          oneOf:
          - $ref: '#/components/schemas/Corporate'
          - $ref: '#/components/schemas/Individual'
        bankAccount:
          $ref: '#/components/schemas/BeneficiaryVerificationBankAccount'
        attributes:
          $ref: '#/components/schemas/AttributeMap'
      description: Beneficiary Details
    BeneficiaryVerificationRequestDataContainer:
      required:
      - beneficiary
      type: object
      properties:
        beneficiary:
          $ref: '#/components/schemas/BeneficiaryVerificationRequestResource'
    LegalEntityIdentificationType:
      type: string
      enum:
      - registration-number
      - passport
      - identity-card
      - driving-licence
      - foreign-identity-card
      - tax-number
    BeneficiaryCreateMetadataContainer:
      type: object
x-provenance:
  method: searched
  source: https://developer.integrated.finance/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.integrated.finance/reference/beneficiariesbankaccountscreate.md
  - https://developer.integrated.finance/reference/beneficiariesbankaccountsget.md
  - https://developer.integrated.finance/reference/beneficiariesbankaccountslist.md
  - https://developer.integrated.finance/reference/beneficiariesbankaccountsrequirementsget.md
  - https://developer.integrated.finance/reference/beneficiariesbankaccountsupdate.md
  - https://developer.integrated.finance/reference/beneficiariescreate.md
  - https://developer.integrated.finance/reference/beneficiariesget.md
  - https://developer.integrated.finance/reference/beneficiarieslist.md
  - https://developer.integrated.finance/reference/beneficiariesupdate.md
  - https://developer.integrated.finance/reference/beneficiary-verificationscreate.md
  - https://developer.integrated.finance/reference/direct-debit-mandatescreate.md
  - https://developer.integrated.finance/reference/direct-debit-mandatesget.md
  - https://developer.integrated.finance/reference/direct-debit-mandateslist.md
  - https://developer.integrated.finance/reference/direct-debit-mandatesupdate.md
  - https://developer.integrated.finance/reference/direct-debit-paymentsget.md
  - https://developer.integrated.finance/reference/direct-debit-paymentslist.md
  - https://developer.integrated.finance/reference/direct-debit-paymentsupdate.md
  - https://developer.integrated.finance/reference/outgoing-transferscompliance-checkget.md
  - https://developer.integrated.finance/reference/outgoing-transferscompliance-checkupdate.md
  - https://developer.integrated.finance/reference/outgoing-transferscreate.md
  - https://developer.integrated.finance/reference/outgoing-transfersdate-metadataget.md
  - https://developer.integrated.finance/reference/outgoing-transfersdate-metadataget_1.md
  - https://developer.integrated.finance/reference/outgoing-transfersget.md
  - https://developer.integrated.finance/reference/outgoing-transferslist.md
  - https://developer.integrated.finance/reference/outgoing-transfersupdate.md
  merge:
    pages: 25
    deduped: 237
    conflicts_kept_first: 0