openapi: 3.2.0
info:
  title: Outgoing Transfer Beneficiaries 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: Beneficiaries
paths:
  /beneficiaries:
    get:
      tags:
      - Beneficiaries
      summary: List Beneficiaries
      operationId: beneficiaries.list
      responses:
        '200':
          description: Beneficiary list returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryListResponse'
    post:
      tags:
      - Beneficiaries
      summary: Create a Beneficiary
      operationId: beneficiaries.create
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/BeneficiaryCreateRequest'
        required: true
      responses:
        '201':
          description: Beneficiary created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryCreateResponse'
  /beneficiaries/{id}:
    get:
      tags:
      - Beneficiaries
      summary: Get a Beneficiary
      operationId: beneficiaries.get
      parameters:
      - name: id
        in: path
        description: ID of the beneficiary in UUID format
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/BeneficiaryGetResponse'
      responses:
        '200':
          description: Beneficiary returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficiaryGetResponse'
    patch:
      tags:
      - Beneficiaries
      summary: Update a Beneficiary
      operationId: beneficiaries.update
      parameters:
      - name: id
        in: path
        description: ID of beneficiary in UUID format
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/BeneficiaryUpdateRequest'
        required: true
      responses:
        '202':
          description: Beneficiary updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientUpdateResponse'
components:
  schemas:
    BeneficiaryGetWorkflowContainer:
      type: object
    BeneficiaryGetDataContainer:
      required:
      - beneficiary
      type: object
      properties:
        beneficiary:
          $ref: '#/components/schemas/Beneficiary'
    BeneficiaryListConnectContainer:
      type: object
    BeneficiaryCreateWorkflow:
      type: string
      description: workflow code
      enum:
      - direct
      - client.direct
      - organization.direct
      - migration
      - direct
    BeneficiaryCreateConnect:
      type: string
      description: service provider selection type
      enum:
      - explicit
      - implicit
      - explicit
    BeneficiaryListMetadataContainer:
      required:
      - page
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageMetadata'
    ClientUpdateResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiariesUpdateWorkflowContainerModel'
        data:
          $ref: '#/components/schemas/BeneficiaryUpdateRequestDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiariesUpdateConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiariesUpdateMetadataContainer'
      description: Clients API Update Response
    Owner:
      type: string
      enum:
      - organization
      - client
    BeneficiaryListResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryListWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiariesListDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiaryListConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryListMetadataContainer'
    BeneficiariesUpdateWorkflowContainerModel:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/BeneficiaryUpdateWorkflow'
      description: Descriptor that navigates IF platform from which workflow does that operation runs
    BeneficiaryCreateWorkflowContainer:
      required:
      - code
      type: object
      properties:
        code:
          $ref: '#/components/schemas/BeneficiaryCreateWorkflow'
      description: workflow container
    BeneficiaryResourceListQueryInput:
      type: object
      properties:
        clientId:
          type: string
          format: uuid
        type:
          $ref: '#/components/schemas/LegalEntityType'
        country:
          type: string
        title:
          type: string
        owner:
          $ref: '#/components/schemas/Owner'
    BeneficiariesUpdateMetadataContainer:
      type: object
      description: metadata container
    BeneficiaryGetConnectContainer:
      type: object
    BeneficiaryUpdateWorkflow:
      type: string
      description: workflow code
      enum:
      - direct
      - client.direct
      - organization.direct
      - migration
    BeneficiaryCreateRequestDataContainer:
      type: object
      properties:
        beneficiary:
          $ref: '#/components/schemas/Beneficiary'
        sourceId:
          type: string
          description: id of the beneficiary to be migrated, required if workflow is migration
          writeOnly: true
    BeneficiaryListWorkflowContainer:
      type: object
    BeneficiaryCreateResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryCreateWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryCreateRequestDataContainer'
        connect:
          $ref: '#/components/schemas/PlatformAPIConnectContainer'
        metadata:
          $ref: '#/components/schemas/PlatformAPIMetadataContainer'
      description: Beneficiaries API Create Response
    BeneficiaryBankAccount:
      type: object
      properties:
        id:
          type: string
          format: uuid
        accountHolderType:
          $ref: '#/components/schemas/LegalEntityType'
        beneficiaryId:
          type: string
          format: uuid
        country:
          type: string
        currency:
          type: string
        routingCodes:
          $ref: '#/components/schemas/RoutingCodeMap'
        accountNumber:
          type: string
        iban:
          type: string
        bankName:
          type: string
        creationDateTime:
          type: string
          format: date-time
        creatingUserUsername:
          type: string
        oneTimePasswordId:
          type: string
          format: uuid
        oneTimePassword:
          type: string
        ledgerNumber:
          type: string
      description: Beneficiary Bank Account Resource Object
      readOnly: true
    Address:
      required:
      - city
      - country
      - street
      type: object
      properties:
        country:
          maxLength: 2
          minLength: 2
          pattern: ^[A-Z]{2}$
          type: string
        region:
          type: string
        postalCode:
          type: string
        city:
          type: string
        street:
          type: string
        houseNumber:
          type: string
        refinement:
          type: string
    BeneficiaryUpdateRequestDataContainer:
      type: object
      properties:
        beneficiary:
          type: object
          additionalProperties:
            type: object
    LegalEntityType:
      type: string
      enum:
      - corporate
      - individual
    PageMetadata:
      required:
      - number
      - size
      - totalElements
      - totalPages
      type: object
      properties:
        size:
          minimum: 0
          type: integer
          description: number of elements in this page
          format: int32
        number:
          minimum: 0
          type: integer
          description: index of page starting from 0
          format: int32
        totalElements:
          minimum: 0
          type: integer
          description: total number of elements in all of the pages
          format: int64
          readOnly: true
        totalPages:
          minimum: 0
          type: integer
          description: number of total pages
          format: int32
          readOnly: true
    LegalEntityIdentity:
      required:
      - type
      type: object
      properties:
        type:
          type: string
      discriminator:
        propertyName: type
        mapping:
          corporate: '#/components/schemas/LegalEntityIdentityCorporate'
          individual: '#/components/schemas/LegalEntityIdentityIndividual'
    RoutingCodeMap:
      type: object
    AccountCreateConnectContainer:
      required:
      - serviceProvider
      - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/BeneficiaryCreateConnect'
        serviceProvider:
          type: string
          description: 'account is connected to this service provider '
      description: connect container
    BeneficiaryGetMetadataContainer:
      type: object
    PlatformAPIMetadataContainer:
      type: object
    BeneficiaryCreateRequest:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryCreateWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryCreateRequestDataContainer'
        connect:
          $ref: '#/components/schemas/AccountCreateConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryCreateMetadataContainer'
      description: request model
    BeneficiaryUpdateRequest:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiariesUpdateWorkflowContainerModel'
        data:
          $ref: '#/components/schemas/BeneficiaryUpdateRequestDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiariesUpdateConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiariesUpdateMetadataContainer'
      description: request model
    BeneficiaryGetResponse:
      required:
      - connect
      - data
      - metadata
      - workflow
      type: object
      properties:
        workflow:
          $ref: '#/components/schemas/BeneficiaryGetWorkflowContainer'
        data:
          $ref: '#/components/schemas/BeneficiaryGetDataContainer'
        connect:
          $ref: '#/components/schemas/BeneficiaryGetConnectContainer'
        metadata:
          $ref: '#/components/schemas/BeneficiaryGetMetadataContainer'
    BeneficiaryContact:
      type: object
      properties:
        phone:
          type: string
          description: beneficiary contact phone number
        email:
          type: string
          description: beneficiary contact email address
        address:
          $ref: '#/components/schemas/Address'
      description: Beneficiary Contact Resource Object
    BeneficiariesListDataContainer:
      type: object
      properties:
        beneficiary:
          $ref: '#/components/schemas/BeneficiaryResourceListQueryInput'
        beneficiaries:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Beneficiary'
    Beneficiary:
      required:
      - clientId
      - identity
      type: object
      properties:
        id:
          type: string
          format: uuid
        clientId:
          type: string
          description: ID of client in UUID format
          format: uuid
        identity:
          $ref: '#/components/schemas/LegalEntityIdentity'
        contact:
          $ref: '#/components/schemas/BeneficiaryContact'
        address:
          $ref: '#/components/schemas/Address'
        title:
          type: string
        fullName:
          type: string
        bankAccounts:
          type: array
          description: beneficiary bank accounts
          readOnly: true
          items:
            $ref: '#/components/schemas/BeneficiaryBankAccount'
      description: Beneficiary Resource Object
    PlatformAPIConnectContainer:
      type: object
    BeneficiariesUpdateConnectContainer:
      type: object
      description: connect container
    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