openapi: 3.1.0
info:
  title: Parties
  description: >
    Create parties, manage your payout instruments and beneficial owners and
    carry out identity verification checks.

     __Authentication__

    Set your headers


    ```

    Authorization: {your_credentials}

    WP-Api-Version: 2025-01-01

    ```


    Replace `{your_credentials}` with your base64-encoded Basic Auth username
    and password.


    __DNS Whitelisting__


    Whitelist the following URLs:

    * `https://try.access.worldpay.com/`

    * `https://access.worldpay.com/`


    Please ensure you use DNS whitelisting, not explicit IP whitelisting.


    __API Collection__


    A full set of API examples based on different scenarios.


    - <a
    href="/collections/access/parties/20250101/OpenApiDocExamples.postman_collection.json"
    download="wp-parties-api-postman">Download Postman Collection </a>

    - <a href="/collections/access/parties/20250101/Try
    environment.postman_environment.json"
    download="wp-parties-api-postman-try-env">Download environment config for
    try env </a>
  contact:
    name: Team Fusion
  license:
    name: Worldpay
    url: developers.worldpay.com/license
  version: '2025-01-01'
  x-metadata:
    category:
      - Parties
    business:
      - Marketplaces
    catalog-list: true
    generated: false
servers:
  - url: http://access.worldpay.com
    description: Live
  - url: http://try.access.worldpay.com
    description: Try
security:
  - basicAuth: []
tags:
  - name: Parties
    description: Create and maintain parties.
  - name: Payout instruments
    description: Create and maintain payout instruments.
  - name: Balance accounts
    description: Create and maintain balance accounts.
  - name: Beneficial owners
    description: Create and maintain beneficial owners.
  - name: Identity Verification
    description: Enable Identity Verification check on a party.
paths:
  /parties:
    post:
      tags:
        - Parties
      summary: Create a party
      operationId: createAccount
      parameters:
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/Company'
                - $ref: '#/components/schemas/Person'
                - $ref: '#/components/schemas/SoleTrader'
            examples:
              Create a party for a person (orchestrated):
                $ref: '#/components/examples/Create_Party_Person_orchestrated'
              Create a party for a sole trader (orchestrated):
                $ref: '#/components/examples/Create_Party_SoleTrader_orchestrated'
              Create a party for a company (orchestrated):
                $ref: '#/components/examples/Create_Party_Company_orchestrated'
              Create a party for a person (modular):
                $ref: '#/components/examples/Create_Party_Person_modular'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Party'
              examples:
                Create a party for a person (orchestrated):
                  $ref: '#/components/examples/Person_created_201_orchestrated'
                Create a party for a sole trader (orchestrated):
                  $ref: '#/components/examples/SoleTrader_created_201_orchestrated'
                Create a party for a company (orchestrated):
                  $ref: '#/components/examples/Company_created_201_orchestrated'
                Create a party for a person (modular):
                  $ref: '#/components/examples/Person_created_201_modular'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Bad request:
                  $ref: '#/components/examples/400'
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
  /parties/{partyId}:
    get:
      tags:
        - Parties
      summary: View a party
      description: Retrieve information about a party.
      operationId: partyQuery
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
          example: parV1StGXR8_Z5jdHi6B-myF0
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Party'
              examples:
                'Get a party for a person ':
                  $ref: '#/components/examples/Get_Party_Person_200_orchestrated'
                Get a party for a sole trader:
                  $ref: '#/components/examples/Get_Party_SoleTrader_200_orchestrated'
                Get a party for a company:
                  $ref: '#/components/examples/Get_Party_Company_200_orchestrated'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
    put:
      tags:
        - Parties
      summary: Update a party
      operationId: updateParty
      parameters:
        - name: partyId
          in: path
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          required: true
          schema:
            type: string
            description: >-
              A unique identifier for the party generated by us. This is sent in
              the response of your party creation call.
            example: parV1StGXR8_Z5jdHi6B-myF0
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
          example: parV1StGXR8_Z5jdHi6B-myF0
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/Company'
                - $ref: '#/components/schemas/Person'
                - $ref: '#/components/schemas/SoleTrader'
            examples:
              Update a party for a person:
                $ref: '#/components/examples/Update_Party_Person_orchestrated'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Party'
              examples:
                Update Party:
                  $ref: '#/components/examples/Update_Party_Person_200_orchestrated'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Bad request:
                  $ref: '#/components/examples/400'
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
  /parties/{partyId}/balanceAccounts:
    post:
      tags:
        - Balance accounts
      summary: Create a balance account
      operationId: createBalanceAccount
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BalanceAccount'
            examples:
              Create a balance account for existing party of person (modular):
                $ref: '#/components/examples/Create_BalanceAccount_Person_modular'
              Create a balance account for existing party of soleTrader (modular):
                $ref: '#/components/examples/Create_BalanceAccount_SoleTrader_modular'
              Create a balance account for existing party of company (modular):
                $ref: '#/components/examples/Create_BalanceAccount_Company_modular'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceAccount'
              examples:
                Create a balance account for existing party of person (modular):
                  $ref: >-
                    #/components/examples/BalanceAccount_Person_created_201_modular
                Create a balance account for existing party of soleTrader (modular):
                  $ref: >-
                    #/components/examples/BalanceAccount_SoleTrader_created_201_modular
                Create a balance account for existing party of company (modular):
                  $ref: >-
                    #/components/examples/BalanceAccount_Company_created_201_modular
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Bad request:
                  $ref: '#/components/examples/400'
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
  /parties/{partyId}/balanceAccounts/{balanceAccountId}:
    get:
      tags:
        - Balance accounts
      summary: View a balance account
      operationId: getBalanceAccount
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: balanceAccountId
          in: path
          required: true
          description: >-
            Unique ID created by us to identify a balance account. This sent in
            the response after `balanceAccount` creation.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: par.*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceAccount'
              examples:
                Get a Balance Account for existing party of company (modular):
                  $ref: '#/components/examples/Get_BalanceAccount_Company_200_modular'
                Get a Balance Account for existing party of person (modular):
                  $ref: '#/components/examples/Get_BalanceAccount_Person_200_modular'
                Get a Balance Account for existing party of soleTrader (modular):
                  $ref: >-
                    #/components/examples/Get_BalanceAccount_SoleTrader_200_modular
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Bad request:
                  $ref: '#/components/examples/400'
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
    put:
      tags:
        - Balance accounts
      summary: Update a balance account
      operationId: updateBalanceAccount
      parameters:
        - name: partyId
          in: path
          required: true
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: balanceAccountId
          in: path
          required: true
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: par.*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BalanceAccount'
            examples:
              Update a Balance Account:
                $ref: >-
                  #/components/examples/Update_Balance_Account_SoleTrader_modular
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceAccount'
              examples:
                Update Balance Account:
                  $ref: >-
                    #/components/examples/Update_Balance_Account_SoleTrader_200_modular
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Bad request:
                  $ref: '#/components/examples/400'
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
  /parties/{partyId}/beneficialOwners:
    post:
      tags:
        - Beneficial owners
      summary: Create a beneficial owner
      operationId: createBeneficialOwner
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BeneficialOwners'
            examples:
              Create beneficial owner for existing company (modular):
                $ref: '#/components/examples/Create_Beneficial_Owner_modular'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficialOwners'
              examples:
                Create beneficial owner for existing company (modular):
                  $ref: '#/components/examples/Beneficial_owner_created_201_modular'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Bad request:
                  $ref: '#/components/examples/400'
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
  /parties/{partyId}/beneficialOwners/{beneficialOwnerId}:
    get:
      tags:
        - Beneficial owners
      summary: View a beneficial owner
      operationId: getBeneficialOwner
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: beneficialOwnerId
          in: path
          required: true
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: par.*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficialOwners'
              examples:
                Get a Beneficial Owner:
                  $ref: '#/components/examples/Get_Beneficial_Owner_200_modular'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
    put:
      tags:
        - Beneficial owners
      summary: Update a beneficial owner
      operationId: updateBeneficialOwner
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: beneficialOwnerId
          in: path
          required: true
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: par.*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BeneficialOwners'
            examples:
              Update a Beneficial Owner:
                $ref: '#/components/examples/Update_Beneficial_Owner_modular'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BeneficialOwners'
              examples:
                Update Beneficial Owner:
                  $ref: '#/components/examples/Update_Beneficial_Owner_200_modular'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Bad request:
                  $ref: '#/components/examples/400'
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
    delete:
      tags:
        - Beneficial owners
      summary: Delete a beneficial owner
      operationId: deleteBeneficialOwner
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: beneficialOwnerId
          in: path
          required: true
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: par.*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      responses:
        '204':
          description: No Content
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
  /parties/{partyId}/identityVerification:
    post:
      tags:
        - Identity Verification
      summary: Perform identity verification
      operationId: performIdentityVerification
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityVerification'
            examples:
              Perform an Identity Verification request for a company with beneficial owners (modular):
                $ref: '#/components/examples/Perform_IVS_Company_modular'
              URL has invalid value:
                $ref: '#/components/examples/400_Invalid_Url'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityVerificationResponse'
              examples:
                Perform an Identity Verification request for a company with beneficial owners (modular):
                  $ref: '#/components/examples/Perform_IVS_Company_200_modular'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Bad request:
                  $ref: '#/components/examples/400'
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
    get:
      tags:
        - Identity Verification
      summary: View identity verification status
      operationId: getIdentityVerificationStatus
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityVerificationResponse'
              examples:
                Verify an Identity Verification status for a company with beneficial owners (modular):
                  $ref: '#/components/examples/Get_IVS_Company_200_modular'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
  /parties/{partyId}/payoutInstruments:
    post:
      tags:
        - Payout instruments
      summary: Create a payout instrument
      operationId: createPayoutInstruments
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankAccount'
            examples:
              Create a payout instrument for existing party of person (modular):
                $ref: '#/components/examples/Create_PayoutInstrument_Person_modular'
              Create a payout instrument for existing party of sole Trader (modular):
                $ref: >-
                  #/components/examples/Create_PayoutInstrument_SoleTrader_modular
              Create a payout instrument for existing party of company (modular):
                $ref: '#/components/examples/Create_PayoutInstrument_Company_modular'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutInstrument'
              examples:
                Create a payout instrument for existing party of person (modular):
                  $ref: >-
                    #/components/examples/PayoutInstrument_Person_created_201_modular
                Create a payout instrument for existing party of sole Trader (modular):
                  $ref: >-
                    #/components/examples/PayoutInstrument_SoleTrader_created_201_modular
                Create a payout instrument for existing party of company (modular):
                  $ref: >-
                    #/components/examples/PayoutInstrument_Company_created_201_modular
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Bad request:
                  $ref: '#/components/examples/400'
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
  /parties/{partyId}/payoutInstruments/{payoutInstrumentId}:
    get:
      tags:
        - Payout instruments
      summary: View a payout instrument
      operationId: getPayoutInstrument
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: payoutInstrumentId
          in: path
          required: true
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: par.*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutInstrument'
              examples:
                Get a payout instrument for existing party of person (modular):
                  $ref: >-
                    #/components/examples/Get_PayoutInstrument_Person_200_modular
                Get a payout instrument for existing party of sole trader (modular):
                  $ref: >-
                    #/components/examples/Get_PayoutInstrument_SoleTrader_200_modular
                Get a payout instrument for existing party of company (modular):
                  $ref: >-
                    #/components/examples/Get_PayoutInstrument_Company_200_modular
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
    put:
      tags:
        - Payout instruments
      summary: Update a payout instrument
      operationId: updatePayoutInstruments
      parameters:
        - name: partyId
          in: path
          required: true
          description: >-
            A unique identifier for the party generated by us. This is sent in
            the response of your party creation call.
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: ^par[a-zA-Z0-9-_]*0$
        - name: payoutInstrumentId
          in: path
          required: true
          schema:
            type: string
            maxLength: 25
            minLength: 25
            pattern: par.*0$
        - name: WP-Api-Version
          in: header
          description: The API version.
          required: true
          schema:
            type: string
            format: date
          example: '2025-01-01'
        - name: WP-CorrelationId
          in: header
          description: Optional ID to trace requests, if not provided, it is generated.
          required: false
          schema:
            type: string
          example: fa96ca86-0ae9-425a-b079-d5bcbcb6fdd3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankAccount'
            examples:
              Update a payout instrument for existing party of company (modular):
                $ref: '#/components/examples/Update_PayoutInstrument_Company_modular'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutInstrument'
              examples:
                Update a payout instrument for existing party of company (modular):
                  $ref: >-
                    #/components/examples/Update_PayoutInstrument_Company_200_modular
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Bad request:
                  $ref: '#/components/examples/400'
                URL has invalid value:
                  $ref: '#/components/examples/400_Invalid_Url'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Internal error occurred:
                  $ref: '#/components/examples/500'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Service Unavailable:
                  $ref: '#/components/examples/503'
components:
  schemas:
    Address:
      type: object
      description: Object containing details about the address.
      properties:
        address1:
          type: string
          description: |-
            The address.

             Must consist of at least two letters, two words, and one number.
          example: 1847 Kingsbury Court
          maxLength: 35
          minLength: 2
        address2:
          type: string
          description: Line two of the address.
          example: Unit 42
          maxLength: 35
          minLength: 2
        city:
          type: string
          description: The city of this address.
          example: London
          maxLength: 35
          minLength: 1
        state:
          type: string
          description: The state of this address.
          example: Greater London
          maxLength: 35
          minLength: 2
        countryCode:
          type: string
          description: >-
            The country code specified in [ISO 3166-1 Alpha-2 code
            format](/products/access/reference/supported-countries-currencies#iso-country-codes).
          example: GB
        postalCode:
          type: string
          description: The postal code of this address.
          example: NW9 0RR
          maxLength: 20
          minLength: 1
        type:
          type: string
          description: Identifies the type of this address.
          enum:
            - home
            - business
            - poBox
            - other
          example: home
      required:
        - address1
        - city
        - countryCode
        - postalCode
    BalanceAccount:
      type: object
      properties:
        currency:
          type: string
          description: >-
            The currency in [ISO 4217 currency
            format](/products/access/reference/supported-countries-currencies#iso-currency-codes).
          example: GBP
          maxLength: 3
          minLength: 3
          pattern: ^[A-Z]*$
        payoutInstrumentReference:
          type: string
          description: >-
            A reference of the `payoutInstrument` created by you. This field
            holds the beneficiary bank details. Use this to direct payouts to
            the relevant beneficiary. This must be unique within an entity.
          example: MyPayoutInstrument1
        scheduledPayoutDay:
          type: string
          description: The scheduled payout day for this `balanceAccount`.
          enum:
            - monday
            - tuesday
            - wednesday
            - thursday
            - friday
        balanceAccountId:
          type: string
          description: >-
            Unique ID created by us to identify a balance account. This sent in
            the response after `balanceAccount` creation.
          readOnly: true
        dateTimeCreated:
          type: string
          description: >-
            The date and time that the balance account was created, as an ISO
            8601 zoned date time.
          example: 2025-01-23T12:23:445.222Z
          readOnly: true
        dateTimeUpdated:
          type: string
          description: >-
            The date and time that the balance account was last updated, as an
            ISO 8601 zoned date time.
          example: 2025-01-25T02:43:499.202Z
          readOnly: true
        version:
          type: integer
          format: int32
          readOnly: true
      required:
        - currency
        - version
    BankAccount:
      type: object
      properties:
        payoutInstrumentReference:
          type: string
          description: >-
            A reference of the `payoutInstrument` created by you. This field
            holds the beneficiary bank details. Use this to direct payouts to
            the relevant beneficiary. This must be unique within an entity.
          example: MyPayoutInstrument1
          maxLength: 64
          minLength: 3
          pattern: ^[A-Za-z0-9\-_ ]*$
        payoutInstrumentId:
          type: string
          description: >-
            An ID generated by us to identify a payout instrument. You receive
            this in the response after successfully creating a payout
            instrument.
          example: parOk0YlPtQogrqQdz7_fKXs0
          maxLength: 25
          minLength: 25
          pattern: ^par[a-zA-Z0-9-_]*0$
        payoutInstrumentType:
          type: string
          description: The type of the payout instrument.
          enum:
            - bankAccount
            - wallet
            - card
        currency:
          type: string
          description: >-
            The currency in [ISO 4217 currency
            format](/products/access/reference/supported-countries-currencies#iso-currency-codes).
          example: GBP
          maxLength: 3
          minLength: 3
          pattern: ^[A-Z]*$
        dateTimeCreated:
          type: string
          description: >-
            The date and time the `payoutInstrument` was created, as an ISO 8601
            zoned date time.
          readOnly: true
        dateTimeUpdated:
          type: string
          description: >-
            The date and time the `payoutInstrument` was updated, as an ISO 8601
            zoned date time.
          readOnly: true
        version:
          type: integer
          format: int32
        accountHolderName:
          type: string
        swiftBic:
          type: string
        bankCode:
          type: string
          description: The bankCode must be exactly 6 digits.
          example: 184758
        accountNumber:
          type: string
        accountType:
          type: string
          enum:
            - checking
            - savings
            - moneyMarket
            - certificateOfDeposit
            - vista
            - other
        iban:
          type: string
        bankName:
          type: string
        address:
          $ref: '#/components/schemas/Address'
        branchCode:
          type: string
      required:
        - currency
        - payoutInstrumentReference
        - payoutInstrumentType
    BeneficialOwners:
      type: object
      properties:
        identityVerificationState:
          type: string
          enum:
            - verified
            - notVerified
            - pending
            - rejected
            - notApplicable
          readOnly: true
        identityVerificationMethod:
          type: string
          enum:
            - merchantCompliant
            - identityVerificationService
          readOnly: true
        identityVerificationDate:
          type: string
          format: date
          description: A valid date as YYYY-MM-DD
          example: '2033-11-22'
          readOnly: true
        url:
          type: string
          description: >-
            The link returned from Identity Verification Status (IVS) used to
            retrieve additional details from the user.
          readOnly: true
        beneficialOwnerReference:
          type: string
          description: >+
            Your reference for this beneficial owner, must be unique within an
            entity.

          example: Hosaka27384910
          maxLength: 64
          minLength: 3
          pattern: ^[A-Za-z0-9\-_ ]*$
        beneficialOwnerId:
          type: string
          description: A unique identifier for the beneficial owner generated by us.
          readOnly: true
        personalDetails:
          $ref: '#/components/schemas/PersonalDetailsForBeneficialOwner'
        relationshipToBusiness:
          $ref: '#/components/schemas/RelationshipToBusiness'
        email:
          type: string
        phones:
          type: array
          items:
            $ref: '#/components/schemas/Phone'
        identityDocuments:
          type: array
          items:
            $ref: '#/components/schemas/IdentityDocument'
        dateTimeCreated:
          type: string
          description: >-
            The date and time that the beneficial owner was created, as an ISO
            8601 zoned date time.
          example: 2025-01-23T12:23:445.222Z
          readOnly: true
        version:
          type: integer
          format: int32
          readOnly: true
        dateTimeUpdated:
          type: string
          description: >-
            The date and time that the beneficial owner was last updated, as an
            ISO 8601 zoned date time.
          example: 2025-01-25T02:43:499.202Z
          readOnly: true
      required:
        - beneficialOwnerReference
        - personalDetails
        - relationshipToBusiness
        - version
    Company:
      allOf:
        - $ref: '#/components/schemas/Party'
        - type: object
          properties:
            companyDetails:
              $ref: '#/components/schemas/CompanyDetails'
            beneficialOwners:
              type: array
              items:
                $ref: '#/components/schemas/BeneficialOwners'
      description: >-
        A party represents the overall party record of your beneficiary (seller,
        vendor, provider). You can use this to store information about the
        party, to perform either an identity verification checks, a split
        payment, or a payout.
      required:
        - companyDetails
        - merchant
        - partyReference
        - partyType
        - type
    CompanyDetails:
      type: object
      description: Object containing details about a company. Required for company.
      properties:
        merchantCategoryCode:
          type: string
          description: >-
            A 4-digit code to represent the merchant category. Only provide this
            where `typeCode` is `soleTrader` or `company`.
          example: 5411
          pattern: ^\d{4}$
        merchantCategoryCodeDescription:
          type: string
          description: >-
            A description to describe the merchant category code. Only provide
            this where `typeCode` is `soleTrader` or `company`.
          example: Grocery Stores
        website:
          type: string
          description: The URL of the merchant's website.
          example: https://example.com/
        legalName:
          type: string
          description: The legal name of the company.
          example: Tessier-Ashpool Systems Ltd.
          maxLength: 140
          minLength: 2
          pattern: >-
            ^( *[\p{L}\p{N}+&\/\-.()])*+( *[\p{L}\p{N}\-.,\/&()@#']{2,140})*+(
            *[\p{L}\p{N}&\/\-.()])*+ *$
        tradingName:
          type: string
          description: The trading common name of the company.
          example: TASynth.com
          maxLength: 140
          minLength: 2
          pattern: >-
            ^( *[\p{L}\p{N}+&\/\-.()])*+( *[\p{L}\p{N}\-.,\/&()@#']{2,140})*+(
            *[\p{L}\p{N}&\/\-.()])*+ *$
        registrationNumber:
          type: string
          description: >-
            The registration number for the company. What should be supplied in
            this field may differ by country, for instance in the United States
            it will be a Tax ID. Number (TIN).
          example: 7564389201
          maxLength: 15
          minLength: 1
          pattern: '[a-zA-Z0-9-]*'
        vatNumber:
          type: string
          description: The Value Added Tax (VAT) number of the company.
          example: JP987654321
          maxLength: 15
          minLength: 1
          pattern: '[a-zA-Z0-9-]*'
        companyType:
          type: string
          description: A description of the type of company.
          example: Public Limited
          maxLength: 50
          minLength: 1
        dateOfIncorporation:
          type: string
          description: The incorporation date for the company.
          example: '1977-07-04'
        legalAddress:
          $ref: '#/components/schemas/Address'
          description: The legal address of this company.
        tradingAddress:
          $ref: '#/components/schemas/Address'
          description: The trading address of this company.
        customerReference:
          type: string
          description: >-
            Unique reference provided by the payee. Only required for certain
            payout destinations.
          example: 7564389201
        countryOfIncorporation:
          type: string
          description: >-
            The country code specified in [ISO 3166-1 Alpha-2
            code](/products/access/reference/supported-countries-currencies#iso-country-codes)
            format.
          example: GB
      required:
        - legalAddress
        - legalName
        - registrationNumber
        - vatNumber
    ErrorResponse:
      type: object
      properties:
        errorName:
          type: string
          description: >-
            An ordinal error type that is part of the API contract. It is
            machine readable, but also human readable for clarity and semantic
            understanding of the error.
          example: bodyDoesNotMatchSchema
        message:
          type: string
          description: >-
            A human readable message giving a corrective action for the error.
            THIS IS NOT FOR MACHINE CONSUMPTION
        validationErrors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseItem'
        pathParameter:
          type: string
        queryParameter:
          type: string
        jsonPath:
          type: string
      readOnly: true
      title: Error Response
    ErrorResponseItem:
      type: object
      properties:
        errorName:
          type: string
        message:
          type: string
        path:
          type: string
        jsonPath:
          type: string
        queryParameter:
          type: string
        pathParameter:
          type: string
    IdentityDocument:
      type: object
      description: An identity document.
      properties:
        type:
          type: string
          description: The type of the identity document.
          enum:
            - passport
            - nationalId
            - driverLicence
            - workPermit
            - employmentPass
            - studentPass
            - permanentResidentCard
            - companyRegistrationNumber
            - companyVATNumber
            - citizenshipCard
            - taxId
            - nationalInsurance
            - other
            - legalIdentityCard
            - taxRegistrationCode
        number:
          type: string
        issuingInstitution:
          type: string
          description: The name of the institution that issued this document.
          example: State Department
        issuingCountry:
          type: string
          description: >-
            The country code of the issuing country specified in [ISO 3166-1
            Alpha-2
            code](/products/access/reference/supported-countries-currencies#iso-country-codes)
            format.
          example: JP
        validFrom:
          type: string
          description: The ISO 8601 date since when this document is valid from.
          example: '2023-11-22'
        validTo:
          type: string
          description: The ISO 8601 date until which this document is valid to.
          example: '2023-11-22'
      required:
        - issuingCountry
        - number
        - type
      title: identityDocument
    IdentityVerification:
      type: object
      properties:
        performIdentityVerification:
          type: boolean
          writeOnly: true
    IdentityVerificationInfo:
      type: object
      properties:
        identityVerificationState:
          type: string
          enum:
            - verified
            - notVerified
            - pending
            - rejected
            - notApplicable
          readOnly: true
        identityVerificationMethod:
          type: string
          enum:
            - merchantCompliant
            - identityVerificationService
          readOnly: true
        identityVerificationDate:
          type: string
          format: date
          description: A valid date as YYYY-MM-DD
          example: '2033-11-22'
          readOnly: true
        url:
          type: string
          description: >-
            The link returned from Identity Verification Status (IVS) used to
            retrieve additional details from the user.
          readOnly: true
    IdentityVerificationResponse:
      type: object
      properties:
        overall:
          $ref: '#/components/schemas/IdentityVerificationInfo'
        party:
          oneOf:
            - $ref: '#/components/schemas/Company'
            - $ref: '#/components/schemas/Person'
            - $ref: '#/components/schemas/SoleTrader'
        beneficialOwners:
          type: array
          items:
            $ref: '#/components/schemas/BeneficialOwners'
    Merchant:
      type: object
      description: An object that contains information about the merchant.
      properties:
        entity:
          type: string
          description: >-
            Used to route the request in Access Worldpay, created as part of
            on-boarding.
          example: default
          maxLength: 36
          minLength: 1
          pattern: '[a-zA-Z0-9- ]*'
      required:
        - entity
      title: Merchant
    Party:
      type: object
      description: >-
        A party represents the overall party record of your beneficiary (seller,
        vendor, provider). You can use this to store information about the
        party, to perform either an identity verification checks, a split
        payment, or a payout.
      discriminator:
        propertyName: type
      properties:
        identityVerificationState:
          type: string
          enum:
            - verified
            - notVerified
            - pending
            - rejected
            - notApplicable
          readOnly: true
        identityVerificationMethod:
          type: string
          enum:
            - merchantCompliant
            - identityVerificationService
          readOnly: true
        identityVerificationDate:
          type: string
          format: date
          description: A valid date as YYYY-MM-DD
          example: '2033-11-22'
          readOnly: true
        url:
          type: string
          description: >-
            The link returned from Identity Verification Status (IVS) used to
            retrieve additional details from the user.
          readOnly: true
        merchant:
          $ref: '#/components/schemas/Merchant'
          description: An object that contains information about the merchant.
        partyReference:
          type: string
          description: |+
            Your reference for this party, must be unique within an entity.

          example: Hosaka27384910
          maxLength: 64
          minLength: 3
          pattern: ^[A-Za-z0-9\-_ ]*$
        partyType:
          type: string
          description: |-
            The type of this party.

            `beneficiary` - the person or business that will receive funds.

            `payer` - a transmitter of funds to a third party.
          enum:
            - beneficiary
            - payer
        type:
          type: string
          description: |+
            What the party represents:

            `person` - an individual 

            `soleTrader` - a single person enterprise 

            `company` - a corporation or partnership with multiple owners

          enum:
            - company
            - person
            - soleTrader
        partyId:
          type: string
          description: A unique identifier for the party generated by us.
          readOnly: true
        email:
          type: string
          description: An email address for this party.
        phones:
          type: array
          description: A list of phone numbers associated with this party.
          items:
            $ref: '#/components/schemas/Phone'
        identityDocuments:
          type: array
          description: A list of identity documents for this party.
          items:
            $ref: '#/components/schemas/IdentityDocument'
        balanceAccounts:
          type: array
          description: A list of balance accounts that have been set up for this party.
          items:
            $ref: '#/components/schemas/BalanceAccount'
        overallAccountStatus:
          type: string
          description: >-
            The overallStatus provides an complete view of the parties
            identityVerificationState.
        dateTimeCreated:
          type: string
          description: >-
            The date and time that the party was created, as an ISO 8601 zoned
            date time
          example: 2025-01-23T12:23:445.222Z
          readOnly: true
        dateTimeUpdated:
          type: string
          description: >-
            The date and time that the party was last updated, as an ISO 8601
            zoned date time
          example: 2025-01-25T02:43:499.202Z
          readOnly: true
        version:
          type: integer
          format: int32
          readOnly: true
        payoutInstruments:
          type: array
          items:
            $ref: '#/components/schemas/BankAccount'
        performIdentityVerification:
          type: boolean
          writeOnly: true
      required:
        - merchant
        - partyReference
        - partyType
        - type
    PayoutInstrument:
      type: object
      discriminator:
        propertyName: payoutInstrumentType
      properties:
        payoutInstrumentReference:
          type: string
          description: >-
            A reference of the `payoutInstrument` created by you. This field
            holds the beneficiary bank details. Use this to direct payouts to
            the relevant beneficiary. This must be unique within an entity.
          example: MyPayoutInstrument01
          maxLength: 64
          minLength: 3
          pattern: ^[A-Za-z0-9\-_ ]*$
        payoutInstrumentId:
          type: string
          description: >-
            An ID generated by us to identify a payout instrument. You receive
            this in the response after successfully creating a payout
            instrument.
          example: parOk0YlPtQogrqQdz7_fKXs0
          maxLength: 25
          minLength: 25
          pattern: ^par[a-zA-Z0-9-_]*0$
        payoutInstrumentType:
          type: string
          description: The type of the payout instrument.
          enum:
            - bankAccount
            - wallet
            - card
        currency:
          type: string
          description: >-
            The currency in [ISO 4217 currency
            format](/products/access/reference/supported-countries-currencies#iso-currency-codes).
          example: GBP
          maxLength: 3
          minLength: 3
          pattern: ^[A-Z]*$
        dateTimeCreated:
          type: string
          description: >-
            The date and time the `payoutInstrument` was created, as an ISO 8601
            zoned date time.
          readOnly: true
        dateTimeUpdated:
          type: string
          description: >-
            The date and time the `payoutInstrument` was updated, as an ISO 8601
            zoned date time.
          readOnly: true
        version:
          type: integer
          format: int32
      required:
        - currency
        - payoutInstrumentReference
        - payoutInstrumentType
    Person:
      allOf:
        - $ref: '#/components/schemas/Party'
        - type: object
          properties:
            personalDetails:
              $ref: '#/components/schemas/PersonalDetailsImplForPerson'
      description: >-
        A party represents the overall party record of your beneficiary (seller,
        vendor, provider). You can use this to store information about the
        party, to perform either an identity verification checks, a split
        payment, or a payout.
      required:
        - merchant
        - partyReference
        - partyType
        - personalDetails
        - type
    PersonalDetailsForBeneficialOwner:
      type: object
      properties:
        title:
          type: string
          description: The title for this `person`/`soleTrader`.
          enum:
            - Mr
            - Mrs
            - Miss
            - Ms
            - Dr
            - Mx
            - Misc
          example: Mr
        firstName:
          type: string
          description: |
            The `person`'s/`soleTrader`'s first name.
          example: Case
          maxLength: 35
          minLength: 2
          pattern: ^[\p{L}\-.,'()&]{2,}$
        middleName:
          type: string
          description: |+
            The `person`'s/`soleTrader`'s middle name or initial.

          example: Henry
          maxLength: 35
          minLength: 1
          pattern: ^(\p{L}\.?)*+$
        lastName:
          type: string
          description: |+
            The `person`'s/`soleTrader`'s last name.

          example: Mitchell
          maxLength: 35
          minLength: 2
          pattern: ^([\p{L}\-.,'()&]{2,} *)*+$
        dateOfBirth:
          type: string
          description: |+
            The date the `person`/`soleTrader` was born.

          example: '1983-10-12'
        address:
          $ref: '#/components/schemas/Address'
          description: The address of the `person`/`soleTrader`.
        residentialStatus:
          type: string
          description: The residential status of the `person`/`soleTrader`.
          enum:
            - resident
            - nonResident
            - other
        customerReference:
          type: string
          description: >-
            Unique reference provided by the payee. Only required for certain
            payout destinations.
          example: 7564389201
        nationality:
          type: string
          description: The nationality of the `person`/`soleTrader`.
        currentAddressLessThanThreeYears:
          type: boolean
        previousHomeAddress:
          $ref: '#/components/schemas/Address'
          description: The previous home address of the `person`/`soleTrader`.
        website:
          type: string
          description: The URL of the merchant's website.
          example: https://example.com/
      required:
        - address
        - firstName
        - lastName
        - middleName
        - title
    PersonalDetailsImplForPerson:
      type: object
      properties:
        title:
          type: string
          description: The title for this `person`/`soleTrader`.
          enum:
            - Mr
            - Mrs
            - Miss
            - Ms
            - Dr
            - Mx
            - Misc
          example: Mr
        firstName:
          type: string
          description: |
            The `person`'s/`soleTrader`'s first name.
          example: Case
          maxLength: 35
          minLength: 2
          pattern: ^[\p{L}\-.,'()&]{2,}$
        middleName:
          type: string
          description: |+
            The `person`'s/`soleTrader`'s middle name or initial.

          example: Henry
          maxLength: 35
          minLength: 1
          pattern: ^(\p{L}\.?)*+$
        lastName:
          type: string
          description: |+
            The `person`'s/`soleTrader`'s last name.

          example: Mitchell
          maxLength: 35
          minLength: 2
          pattern: ^([\p{L}\-.,'()&]{2,} *)*+$
        dateOfBirth:
          type: string
          description: |+
            The date the `person`/`soleTrader` was born.

          example: '1983-10-12'
        address:
          $ref: '#/components/schemas/Address'
          description: The address of the `person`/`soleTrader`.
        residentialStatus:
          type: string
          description: The residential status of the `person`/`soleTrader`.
          enum:
            - resident
            - nonResident
            - other
        customerReference:
          type: string
          description: >-
            Unique reference provided by the payee. Only required for certain
            payout destinations.
          example: 7564389201
        nationality:
          type: string
          description: The nationality of the `person`/`soleTrader`.
        currentAddressLessThanThreeYears:
          type: boolean
        previousHomeAddress:
          $ref: '#/components/schemas/Address'
          description: The previous home address of the `person`/`soleTrader`.
        website:
          type: string
          description: The URL of the merchant's website.
          example: https://example.com/
      required:
        - address
        - firstName
        - lastName
        - middleName
        - title
    PersonalDetailsImplForSoleTrader:
      type: object
      properties:
        title:
          type: string
          description: The title for this `person`/`soleTrader`.
          enum:
            - Mr
            - Mrs
            - Miss
            - Ms
            - Dr
            - Mx
            - Misc
          example: Mr
        firstName:
          type: string
          description: |
            The `person`'s/`soleTrader`'s first name.
          example: Case
          maxLength: 35
          minLength: 2
          pattern: ^[\p{L}\-.,'()&]{2,}$
        middleName:
          type: string
          description: |+
            The `person`'s/`soleTrader`'s middle name or initial.

          example: Henry
          maxLength: 35
          minLength: 1
          pattern: ^(\p{L}\.?)*+$
        lastName:
          type: string
          description: |+
            The `person`'s/`soleTrader`'s last name.

          example: Mitchell
          maxLength: 35
          minLength: 2
          pattern: ^([\p{L}\-.,'()&]{2,} *)*+$
        dateOfBirth:
          type: string
          description: |+
            The date the `person`/`soleTrader` was born.

          example: '1983-10-12'
        address:
          $ref: '#/components/schemas/Address'
          description: The address of the `person`/`soleTrader`.
        residentialStatus:
          type: string
          description: The residential status of the `person`/`soleTrader`.
          enum:
            - resident
            - nonResident
            - other
        customerReference:
          type: string
          description: >-
            Unique reference provided by the payee. Only required for certain
            payout destinations.
          example: 7564389201
        nationality:
          type: string
          description: The nationality of the `person`/`soleTrader`.
        currentAddressLessThanThreeYears:
          type: boolean
        previousHomeAddress:
          $ref: '#/components/schemas/Address'
          description: The previous home address of the `person`/`soleTrader`.
        website:
          type: string
          description: The URL of the merchant's website.
          example: https://example.com/
        merchantCategoryCode:
          type: string
          description: >-
            A 4-digit code to represent the merchant category. Only provide this
            where `typeCode` is `soleTrader` or `company`.
          example: 5411
          pattern: ^\d{4}$
        merchantCategoryCodeDescription:
          type: string
          description: >-
            A description to describe the merchant category code. Only provide
            this where `typeCode` is `soleTrader` or `company`.
          example: Grocery Stores
      required:
        - address
        - firstName
        - lastName
        - middleName
        - title
    Phone:
      type: object
      description: Object containing phone information.
      properties:
        prefix:
          type: string
          description: The dialing prefix for the phone number.
          example: 44
          pattern: ^[0-9]{1,3}$
        number:
          type: string
          description: The phone number, without dashes.
          example: 4281234
          pattern: '[0-9]{1,20}'
      required:
        - number
        - prefix
    RelationshipToBusiness:
      type: object
      properties:
        ownershipPercentage:
          type: number
          format: double
          maximum: 100
        director:
          type: boolean
        position:
          type: string
          enum:
            - soleTrader
            - accountant
            - bursar
            - ceo
            - chairman
            - chairwoman
            - chiefExecutiveOfficer
            - clerk
            - companySecretary
            - creditController
            - deputyLeader
            - generalManager
            - leader
            - manager
            - managingDirector
            - master
            - mayor
            - officeManager
            - operationsManager
            - president
            - principal
            - proprietor
            - townClerk
            - director
            - apportionmentAndOversight
            - chiefExecutive
            - complianceOversight
            - directorUnincorporatedAssociate
            - nonExecutiveDirector
            - significantManagement
            - smallFriendlySociety
            - chairPerson
            - designatedMember
            - secretary
            - trustee
            - treasurer
            - businessRepresentative
            - authorizedSignatory
            - signatory
            - technicalContact
            - contractSignatory
            - publicOfficer
            - controller
            - beneficialOwner
            - partner
            - shareHolder
            - chiefFinancialOfficer
            - chiefOperatingOfficer
            - beneficiary
            - charitySecretary
            - member
            - protector
            - settlor
            - soleProprietor
            - nonDesignatedMember
      required:
        - director
        - ownershipPercentage
        - position
    SoleTrader:
      allOf:
        - $ref: '#/components/schemas/Party'
        - type: object
          properties:
            personalDetails:
              $ref: '#/components/schemas/PersonalDetailsImplForSoleTrader'
      description: >-
        A party represents the overall party record of your beneficiary (seller,
        vendor, provider). You can use this to store information about the
        party, to perform either an identity verification checks, a split
        payment, or a payout.
      required:
        - merchant
        - partyReference
        - partyType
        - personalDetails
        - type
  securitySchemes:
    basicAuth:
      type: http
      description: Basic authentication with user name and password
      scheme: basic
  examples:
    '400':
      value:
        errorName: bodyDoesNotMatchSchema
        message: >-
          There were field validation errors. The errors that occurred are
          within the validationErrors array.
        validationErrors:
          - errorName: fieldIsNotAllowed
            message: >-
              The identified field is present when it is explicitly not allowed
              in the request.
            jsonPath: $.additionalData
    '500':
      value:
        errorName: internalErrorOccurred
        message: >-
          An error occurred within the service (potentially due to an
          interaction with a downstream service).
    '503':
      value:
        errorName: serviceUnavailable
        message: >-
          Service cannot fulfil the request even though service functions witout
          internal errors.
    Create_Party_Person_orchestrated:
      description: Create a party for a person (orchestrated)
      value:
        merchant:
          entity: default
        partyReference: VuzvLew4y7
        partyType: beneficiary
        type: person
        personalDetails:
          title: Mr
          firstName: Case
          middleName: Henry
          lastName: Mitchell
          residentialStatus: resident
          dateOfBirth: '1983-10-12'
          address:
            address1: 1847 Kingsbury Court
            address2: Unit 42
            type: home
            city: Manchester
            countryCode: GB
            postalCode: M1 1AA
        email: case.mitchell@example.com
        phones:
          - number: '02079461234'
            prefix: '44'
        balanceAccounts:
          - currency: GBP
            scheduledPayoutDay: tuesday
            payoutInstrumentReference: MyPayoutInstrument1
        payoutInstruments:
          - accountHolderName: Case H. Mitchell
            payoutInstrumentType: bankAccount
            swiftBic: BUKBGB22
            bankCode: '045110'
            branchCode: Taunton Branch
            accountNumber: '2319876543210'
            accountType: checking
            iban: GB892019000123456789
            bankName: HSBC UK BANK PLC
            payoutInstrumentReference: MyPayoutInstrument1
            currency: GBP
            address:
              address1: 17 Neo-London Financial Tower
              address2: Suite 1288
              type: business
              city: London
              countryCode: GB
              postalCode: EC1A 1BB
        identityDocuments:
          - type: passport
            number: NEO456789
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2022-08-01'
            validTo: '2032-08-01'
          - type: nationalId
            number: ZAIBATSU-00792
            issuingInstitution: Zaibatsu Holding HR Dept.
            issuingCountry: GB
            validFrom: '2025-01-01'
            validTo: '2030-12-31'
        performIdentityVerification: true
    Create_Party_SoleTrader_orchestrated:
      description: Create a party for a sole trader (orchestrated)
      value:
        merchant:
          entity: default
        partyReference: CGeC6vSmyb
        partyType: beneficiary
        type: soleTrader
        personalDetails:
          merchantCategoryCode: '5411'
          merchantCategoryCodeDescription: Grocery Stores, Supermarkets
          website: https://www.example.com/
          title: Ms
          firstName: Linda
          middleName: Liam
          lastName: Lee
          dateOfBirth: '1990-07-15'
          address:
            address1: 123 Sprawl Avenue
            address2: Flat 202
            city: Chester
            countryCode: GB
            postalCode: CH1 4PL
            type: home
          residentialStatus: resident
          customerReference: customerrefSoleTrader
          nationality: GB
          currentAddressLessThanThreeYears: true
          previousHomeAddress:
            address1: 456 Sprawl Avenue
            address2: Flat 303
            city: Chester
            countryCode: GB
            postalCode: CH2 4PL
            type: other
        email: lee.linda@example.com
        phones:
          - prefix: '81'
            number: '9098765432'
        identityDocuments:
          - type: passport
            number: '789'
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2021-01-01'
            validTo: '2031-01-01'
          - type: taxRegistrationCode
            number: '123'
            issuingInstitution: HMRC
            issuingCountry: GB
            validFrom: '2023-11-30'
            validTo: '2030-12-30'
        balanceAccounts:
          - currency: GBP
        payoutInstruments:
          - payoutInstrumentReference: MyPayoutInstrument1
            payoutInstrumentType: bankAccount
            currency: GBP
            accountHolderName: Linda Lee
            swiftBic: LLOYGB21
            bankCode: '000112'
            branchCode: Bradford Branch
            accountNumber: '12345678'
            accountType: savings
            iban: JP123000400003123456789
            bankName: Lloyds Bank
            address:
              address1: 789 Sakura Street
              address2: Suite 5A
              city: London
              countryCode: GB
              postalCode: E1 6AN
              type: other
    Create_Party_Company_orchestrated:
      description: Create a party for a company (orchestrated)
      value:
        merchant:
          entity: default
        partyReference: BGy1nSxvSw
        partyType: beneficiary
        type: company
        companyDetails:
          legalName: Tessier-Ashpool Systems Ltd.
          tradingName: Example.co.uk
          customerReference: CustRefZA98765
          registrationNumber: '7564389201'
          vatNumber: GB987654321
          companyType: Public Limited
          dateOfIncorporation: '1977-07-04'
          merchantCategoryCode: '5734'
          merchantCategoryCodeDescription: Computer Software Stores
          website: https://www.example.com
          legalAddress:
            address1: 7 Straylight Complex
            address2: Corporate District, Level 99
            type: business
            city: London
            countryCode: GB
            postalCode: EC1A 1BB
          tradingAddress:
            address1: 789 Freeside Blvd
            address2: Villa Straylight
            city: Manchester
            countryCode: GB
            postalCode: M1 1AA
            type: poBox
        email: info@example.com
        phones:
          - number: '8475932'
            prefix: '81'
        balanceAccounts:
          - currency: GBP
          - currency: EUR
            scheduledPayoutDay: monday
            payoutInstrumentReference: MyPayoutInstrument1
        payoutInstruments:
          - accountHolderName: Tessier-Ashpool Systems Ltd.
            payoutInstrumentType: bankAccount
            swiftBic: FSFCGB33
            bankCode: '045110'
            branchCode: Barclays Branch
            accountNumber: '1234567890'
            accountType: savings
            iban: GB33TASS12345678901234
            bankName: Freeside Financial Corporation
            payoutInstrumentReference: MyPayoutInstrument1
            currency: EUR
            address:
              address1: Villa Straylight
              address2: Freeside
              type: business
              city: London
              countryCode: GB
              postalCode: EC1A 1BB
        beneficialOwners:
          - beneficialOwnerReference: 39XaAW8hCf
            personalDetails:
              title: Dr
              firstName: Peter
              middleName: Illusionet
              lastName: Riviera
              residentialStatus: nonResident
              dateOfBirth: '1972-03-22'
              nationality: GB
              address:
                address1: 789 Downing Street
                address2: Flat 404
                city: London
                type: home
                countryCode: GB
                postalCode: SW1A 2AA
              currentAddressLessThanThreeYears: true
              previousHomeAddress:
                address1: 123 Oxford Street
                address2: Flat 101
                city: London
                type: home
                countryCode: GB
                postalCode: W1D 1LP
            relationshipToBusiness:
              ownershipPercentage: 10
              director: false
              position: partner
            identityDocuments:
              - type: passport
                number: B98765432
                issuingInstitution: UK Passport Office
                issuingCountry: GB
                validFrom: '2018-05-15'
                validTo: '2028-05-15'
            email: peter.riviera@example.com
            phones:
              - number: '0205556789'
                prefix: '44'
          - beneficialOwnerReference: A9CuJNpryM
            personalDetails:
              title: Ms
              firstName: Molly
              middleName: Puppet
              lastName: Millions
              residentialStatus: resident
              dateOfBirth: '1980-05-15'
              nationality: GB
              address:
                address1: 456 Sprawl Street
                address2: Flat 101
                city: Burbank
                countryCode: GB
                postalCode: RM1 4PL
              currentAddressLessThanThreeYears: true
              previousHomeAddress:
                address1: 789 Night City Blvd
                address2: Flat 303
                city: Night City
                countryCode: GB
                postalCode: RM2 3PL
            relationshipToBusiness:
              ownershipPercentage: 25
              director: false
              position: officeManager
            identityDocuments:
              - type: passport
                number: A12345678
                issuingInstitution: UK Passport Office
                issuingCountry: GB
                validFrom: '2020-01-01'
                validTo: '2030-01-01'
            email: molly.millions@example.com
            phones:
              - number: '02079461234'
                prefix: '44'
    Create_Party_Person_modular:
      description: Create a party for a person (modular)
      value:
        merchant:
          entity: default
        partyReference: 5htNU0XQ7V
        partyType: beneficiary
        type: person
        personalDetails:
          title: Mr
          firstName: Case
          middleName: Henry
          lastName: Mitchell
          residentialStatus: resident
          dateOfBirth: '1983-10-12'
          address:
            address1: 1847 Kingsbury Court
            address2: Unit 42
            type: home
            city: Manchester
            countryCode: GB
            postalCode: M1 1AA
        email: case.mitchell@example.com
        phones:
          - number: '02079461234'
            prefix: '44'
        identityDocuments:
          - type: passport
            number: NEO456789
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2022-08-01'
            validTo: '2032-08-01'
          - type: nationalId
            number: ZAIBATSU-00792
            issuingInstitution: Zaibatsu Holding HR Dept.
            issuingCountry: GB
            validFrom: '2025-01-01'
            validTo: '2030-12-31'
    Person_created_201_orchestrated:
      description: Party for a person (orchestrated)
      value:
        identityVerificationState: pending
        identityVerificationMethod: identityVerificationService
        merchant:
          entity: default
        partyReference: Heidi197
        partyType: beneficiary
        type: person
        partyId: parMbuHucAsLeLL0BhDpWdjE0
        personalDetails:
          title: Mr
          firstName: Case
          middleName: Henry
          lastName: Mitchell
          dateOfBirth: '1983-10-12'
          address:
            address1: 1847 Kingsbury Court
            address2: Unit 42
            city: Manchester
            countryCode: GB
            postalCode: M1 1AA
            type: home
          residentialStatus: resident
          currentAddressLessThanThreeYears: false
        email: case.mitchell@example.com
        phones:
          - prefix: '44'
            number: '02079461234'
        identityDocuments:
          - type: passport
            number: NEO456789
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2022-08-01'
            validTo: '2032-08-01'
          - type: nationalId
            number: ZAIBATSU-00792
            issuingInstitution: Zaibatsu Holding HR Dept.
            issuingCountry: GB
            validFrom: '2025-01-01'
            validTo: '2030-12-31'
        balanceAccounts:
          - currency: GBP
            payoutInstrumentReference: MyPayoutInstrument1
            scheduledPayoutDay: tuesday
            balanceAccountId: par3GymZO5MtP18qe5NFaaPp0
            dateTimeCreated: '2025-04-16T20:46:24.122Z'
            version: 0
        dateTimeCreated: '2025-04-16T20:46:24.122Z'
        version: 0
        payoutInstruments:
          - payoutInstrumentReference: MyPayoutInstrument1
            payoutInstrumentId: parclOAFlaOX-H_2UBp9tWbd0
            payoutInstrumentType: bankAccount
            currency: GBP
            dateTimeCreated: '2025-04-16T20:46:24.122Z'
            version: 0
            accountHolderName: Case H. Mitchell
            swiftBic: BUKBGB22
            bankCode: '045110'
            accountNumber: '2319876543210'
            accountType: checking
            iban: GB892019000123456789
            bankName: HSBC UK BANK PLC
            address:
              address1: 17 Neo-London Financial Tower
              address2: Suite 1288
              city: London
              countryCode: GB
              postalCode: EC1A 1BB
              type: business
            branchCode: Taunton Branch
    SoleTrader_created_201_orchestrated:
      description: Party for a soleTrader (orchestrated)
      value:
        identityVerificationState: notVerified
        identityVerificationMethod: identityVerificationService
        merchant:
          entity: default
        partyReference: Anderson736
        partyType: beneficiary
        type: soleTrader
        partyId: parUbyQnnkuOPHFiHsVutAru0
        personalDetails:
          merchantCategoryCode: '5411'
          merchantCategoryCodeDescription: Grocery Stores, Supermarkets
          website: https://www.example.com/
          title: Ms
          firstName: Linda
          middleName: Liam
          lastName: Lee
          dateOfBirth: '1990-07-15'
          address:
            address1: 123 Sprawl Avenue
            address2: Flat 202
            city: Chester
            countryCode: GB
            postalCode: CH1 4PL
            type: home
          residentialStatus: resident
          customerReference: customerrefSoleTrader
          nationality: GB
          currentAddressLessThanThreeYears: true
          previousHomeAddress:
            address1: 456 Sprawl Avenue
            address2: Flat 303
            city: Chester
            countryCode: GB
            postalCode: CH2 4PL
            type: other
        email: lee.linda@example.com
        phones:
          - prefix: '81'
            number: '9098765432'
        identityDocuments:
          - type: taxRegistrationCode
            number: '123'
            issuingInstitution: HMRC
            issuingCountry: GB
            validFrom: '2023-11-30'
            validTo: '2030-12-30'
          - type: passport
            number: '789'
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2021-01-01'
            validTo: '2031-01-01'
        balanceAccounts:
          - currency: GBP
            balanceAccountId: parQj9Y4leX3ysLFSQ7DXm1z0
            dateTimeCreated: '2025-04-16T20:46:25.444Z'
            version: 0
        dateTimeCreated: '2025-04-16T20:46:25.444Z'
        version: 0
        payoutInstruments:
          - payoutInstrumentReference: MyPayoutInstrument1
            payoutInstrumentId: parFrc7XcecQ7zVXbAodFe6m0
            payoutInstrumentType: bankAccount
            currency: GBP
            dateTimeCreated: '2025-04-16T20:46:25.444Z'
            version: 0
            accountHolderName: Linda Lee
            swiftBic: LLOYGB21
            bankCode: '000112'
            accountNumber: '12345678'
            accountType: savings
            iban: JP123000400003123456789
            bankName: Lloyds Bank
            address:
              address1: 789 Sakura Street
              address2: Suite 5A
              city: London
              countryCode: GB
              postalCode: E1 6AN
              type: other
            branchCode: Bradford Branch
    Company_created_201_orchestrated:
      description: Party for a company (orchestrated)
      value:
        identityVerificationState: notVerified
        identityVerificationMethod: identityVerificationService
        merchant:
          entity: default
        partyReference: Genesis829
        partyType: beneficiary
        type: company
        partyId: par1Gya_pV7rRYUMI3Ep_ssX0
        companyDetails:
          merchantCategoryCode: '5734'
          merchantCategoryCodeDescription: Computer Software Stores
          website: https://www.example.com
          legalName: Tessier-Ashpool Systems Ltd.
          tradingName: Example.co.uk
          registrationNumber: '7564389201'
          vatNumber: GB987654321
          dateOfIncorporation: '1977-07-04'
          legalAddress:
            address1: 7 Straylight Complex
            address2: Corporate District, Level 99
            city: London
            countryCode: GB
            postalCode: EC1A 1BB
            type: business
          tradingAddress:
            address1: 789 Freeside Blvd
            address2: Villa Straylight
            city: Manchester
            countryCode: GB
            postalCode: M1 1AA
            type: poBox
          customerReference: CustRefZA98765
        email: info@example.com
        phones:
          - prefix: '81'
            number: '8475932'
        identityDocuments: []
        balanceAccounts:
          - currency: GBP
            balanceAccountId: parFwA0DbiCax4y5mzj6207T0
            dateTimeCreated: '2025-04-24T18:05:40.908Z'
            version: 0
          - currency: EUR
            payoutInstrumentReference: MyPayoutInstrument1
            scheduledPayoutDay: monday
            balanceAccountId: parKXSsjAGYuzsJ6AnD_NSCD0
            dateTimeCreated: '2025-04-24T18:05:40.908Z'
            version: 0
        dateTimeCreated: '2025-04-24T18:05:40.908Z'
        version: 0
        payoutInstruments:
          - payoutInstrumentReference: MyPayoutInstrument1
            payoutInstrumentId: parxYYu5sdO559Yo60Ud4ep50
            payoutInstrumentType: bankAccount
            currency: EUR
            dateTimeCreated: '2025-04-24T18:05:40.908Z'
            version: 0
            accountHolderName: Tessier-Ashpool Systems Ltd.
            swiftBic: FSFCGB33
            bankCode: '045110'
            accountNumber: '1234567890'
            accountType: savings
            iban: GB33TASS12345678901234
            bankName: Freeside Financial Corporation
            address:
              address1: Villa Straylight
              address2: Freeside
              city: London
              countryCode: GB
              postalCode: EC1A 1BB
              type: business
            branchCode: Barclays Branch
        beneficialOwners:
          - identityVerificationState: notVerified
            identityVerificationMethod: identityVerificationService
            beneficialOwnerReference: Jennings377
            beneficialOwnerId: parrLsIhp6pE9VQmWG2Y8wKm0
            personalDetails:
              title: Dr
              firstName: Peter
              middleName: Illusionet
              lastName: Riviera
              dateOfBirth: '1972-03-22'
              address:
                address1: 789 Downing Street
                address2: Flat 404
                city: London
                countryCode: GB
                postalCode: SW1A 2AA
                type: home
              residentialStatus: nonResident
              nationality: GB
              currentAddressLessThanThreeYears: true
              previousHomeAddress:
                address1: 123 Oxford Street
                address2: Flat 101
                city: London
                countryCode: GB
                postalCode: W1D 1LP
                type: home
            relationshipToBusiness:
              ownershipPercentage: 10
              director: false
              position: partner
            email: peter.riviera@example.com
            phones:
              - prefix: '44'
                number: '0205556789'
            identityDocuments:
              - type: passport
                number: B98765432
                issuingInstitution: UK Passport Office
                issuingCountry: GB
                validFrom: '2018-05-15'
                validTo: '2028-05-15'
            dateTimeCreated: '2025-04-24T18:05:40.908Z'
            version: 0
          - identityVerificationState: notVerified
            identityVerificationMethod: identityVerificationService
            beneficialOwnerReference: Dana455
            beneficialOwnerId: parC3Po42KDFr1SRgu351Ncy0
            personalDetails:
              title: Ms
              firstName: Molly
              middleName: Puppet
              lastName: Millions
              dateOfBirth: '1980-05-15'
              address:
                address1: 456 Sprawl Street
                address2: Flat 101
                city: Burbank
                countryCode: GB
                postalCode: RM1 4PL
              residentialStatus: resident
              nationality: GB
              currentAddressLessThanThreeYears: true
              previousHomeAddress:
                address1: 789 Night City Blvd
                address2: Flat 303
                city: Night City
                countryCode: GB
                postalCode: RM2 3PL
            relationshipToBusiness:
              ownershipPercentage: 25
              director: false
              position: officeManager
            email: molly.millions@example.com
            phones:
              - prefix: '44'
                number: '02079461234'
            identityDocuments:
              - type: passport
                number: A12345678
                issuingInstitution: UK Passport Office
                issuingCountry: GB
                validFrom: '2020-01-01'
                validTo: '2030-01-01'
            dateTimeCreated: '2025-04-24T18:05:40.908Z'
            version: 0
    Person_created_201_modular:
      description: Create a party for a person (modular)
      value:
        identityVerificationState: notVerified
        identityVerificationMethod: identityVerificationService
        merchant:
          entity: default
        partyReference: Frank118
        partyType: beneficiary
        type: person
        partyId: parpI1tAL2bK8Lb-52Rfblg30
        personalDetails:
          title: Mr
          firstName: Case
          middleName: Henry
          lastName: Mitchell
          dateOfBirth: '1983-10-12'
          address:
            address1: 1847 Kingsbury Court
            address2: Unit 42
            city: Manchester
            countryCode: GB
            postalCode: M1 1AA
            type: home
          residentialStatus: resident
          currentAddressLessThanThreeYears: false
        email: case.mitchell@example.com
        phones:
          - prefix: '44'
            number: '02079461234'
        identityDocuments:
          - type: nationalId
            number: ZAIBATSU-00792
            issuingInstitution: Zaibatsu Holding HR Dept.
            issuingCountry: GB
            validFrom: '2025-01-01'
            validTo: '2030-12-31'
          - type: passport
            number: NEO456789
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2022-08-01'
            validTo: '2032-08-01'
        balanceAccounts: []
        dateTimeCreated: '2025-04-07T20:42:17.292Z'
        version: 0
        payoutInstruments: []
    400_Invalid_Url:
      value:
        errorName: urlContainsInvalidValue
        message: The URL contains a value or values that are invalid.
        validationErrors:
          - errorName: fieldHasInvalidValue
            message: Party 'parDgfhD9O5lWVjWiUOo3Cdf0' was not found.
            jsonPath: $.partyId
    Get_Party_Person_200_orchestrated:
      description: Get a party for person
      value:
        identityVerificationState: pending
        identityVerificationMethod: identityVerificationService
        merchant:
          entity: default
        partyReference: Heidi197
        partyType: beneficiary
        type: person
        partyId: parMbuHucAsLeLL0BhDpWdjE0
        personalDetails:
          title: Mr
          firstName: Case
          middleName: Henry
          lastName: Mitchell
          dateOfBirth: '1983-10-12'
          address:
            address1: 1847 Kingsbury Court
            address2: Unit 42
            city: Manchester
            countryCode: GB
            postalCode: M1 1AA
            type: home
          residentialStatus: resident
          currentAddressLessThanThreeYears: false
        email: case.mitchell@example.com
        phones:
          - prefix: '44'
            number: '02079461234'
        identityDocuments:
          - type: passport
            number: NEO456789
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2022-08-01'
            validTo: '2032-08-01'
          - type: nationalId
            number: ZAIBATSU-00792
            issuingInstitution: Zaibatsu Holding HR Dept.
            issuingCountry: GB
            validFrom: '2025-01-01'
            validTo: '2030-12-31'
        balanceAccounts:
          - currency: EUR
            payoutInstrumentReference: MyPayoutInstrument1
            scheduledPayoutDay: friday
            balanceAccountId: pareBH4YMkUx7MA2X7bnS4750
            dateTimeCreated: '2025-04-16T20:46:26.727Z'
            version: 0
          - currency: GBP
            payoutInstrumentReference: MyPayoutInstrument2
            scheduledPayoutDay: tuesday
            balanceAccountId: par3GymZO5MtP18qe5NFaaPp0
            dateTimeCreated: '2025-04-16T20:46:24.122Z'
            version: 0
        dateTimeCreated: '2025-04-16T20:46:24.122Z'
        version: 0
        payoutInstruments:
          - payoutInstrumentReference: MyPayoutInstrument1
            payoutInstrumentId: parclOAFlaOX-H_2UBp9tWbd0
            payoutInstrumentType: bankAccount
            currency: GBP
            dateTimeCreated: '2025-04-16T20:46:24.122Z'
            version: 0
            accountHolderName: Case H. Mitchell
            swiftBic: BUKBGB22
            bankCode: '045110'
            accountNumber: '2319876543210'
            accountType: checking
            iban: GB892019000123456789
            bankName: HSBC UK BANK PLC
            address:
              address1: 17 Neo-London Financial Tower
              address2: Suite 1288
              city: London
              countryCode: GB
              postalCode: EC1A 1BB
              type: business
            branchCode: Taunton Branch
          - payoutInstrumentReference: MyPayoutInstrument2
            payoutInstrumentId: parKsh3dSA_VRckwEDRHLzOR0
            payoutInstrumentType: bankAccount
            currency: EUR
            dateTimeCreated: '2025-04-16T20:46:26.235Z'
            version: 0
            accountHolderName: Case H. Mitchell
            swiftBic: BUKBGB22
            bankCode: '045110'
            accountNumber: '2319876543210'
            accountType: checking
            iban: GB892019000123456789
            bankName: Metro Bank
            address:
              address1: 17 Neo-London Financial Tower
              address2: Suite 1288
              city: London
              countryCode: GB
              postalCode: EC1A 1BB
              type: business
            branchCode: Barclays Branch
    Get_Party_SoleTrader_200_orchestrated:
      description: Get a party for soleTrader
      value:
        identityVerificationState: notVerified
        identityVerificationMethod: identityVerificationService
        merchant:
          entity: default
        partyReference: Anderson736
        partyType: beneficiary
        type: soleTrader
        partyId: parUbyQnnkuOPHFiHsVutAru0
        personalDetails:
          merchantCategoryCode: '5411'
          merchantCategoryCodeDescription: Grocery Stores, Supermarkets
          website: https://www.example.com/
          title: Ms
          firstName: Linda
          middleName: Liam
          lastName: Lee
          dateOfBirth: '1990-07-15'
          address:
            address1: 123 Sprawl Avenue
            address2: Flat 202
            city: Chester
            countryCode: GB
            postalCode: CH1 4PL
            type: home
          residentialStatus: resident
          customerReference: customerrefSoleTrader
          nationality: GB
          currentAddressLessThanThreeYears: true
          previousHomeAddress:
            address1: 456 Sprawl Avenue
            address2: Flat 303
            city: Chester
            countryCode: GB
            postalCode: CH2 4PL
            type: other
        email: lee.linda@example.com
        phones:
          - prefix: '81'
            number: '9098765432'
        identityDocuments:
          - type: taxRegistrationCode
            number: '123'
            issuingInstitution: HMRC
            issuingCountry: GB
            validFrom: '2023-11-30'
            validTo: '2030-12-30'
          - type: passport
            number: '789'
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2021-01-01'
            validTo: '2031-01-01'
        balanceAccounts:
          - currency: CHF
            payoutInstrumentReference: MyPayoutInstrument1
            scheduledPayoutDay: friday
            balanceAccountId: parApcraCq1bmBuCotAMoyss0
            dateTimeCreated: '2025-04-16T20:46:26.852Z'
            version: 0
          - currency: GBP
            balanceAccountId: parQj9Y4leX3ysLFSQ7DXm1z0
            dateTimeCreated: '2025-04-16T20:46:25.444Z'
            version: 0
        dateTimeCreated: '2025-04-16T20:46:25.444Z'
        version: 0
        payoutInstruments:
          - payoutInstrumentReference: MyPayoutInstrument1
            payoutInstrumentId: parFrc7XcecQ7zVXbAodFe6m0
            payoutInstrumentType: bankAccount
            currency: GBP
            dateTimeCreated: '2025-04-16T20:46:25.444Z'
            version: 0
            accountHolderName: Linda Lee
            swiftBic: LLOYGB21
            bankCode: '000112'
            accountNumber: '12345678'
            accountType: savings
            iban: JP123000400003123456789
            bankName: Lloyds Bank
            address:
              address1: 789 Sakura Street
              address2: Suite 5A
              city: London
              countryCode: GB
              postalCode: E1 6AN
              type: other
            branchCode: Bradford Branch
          - payoutInstrumentReference: MyPayoutInstrument2
            payoutInstrumentId: parnHhcim1r9IYtG8I7Twbbc0
            payoutInstrumentType: bankAccount
            currency: CHF
            dateTimeCreated: '2025-04-16T20:46:26.420Z'
            version: 0
            accountHolderName: Case H. Mitchell
            swiftBic: BUKBGB22
            bankCode: '045110'
            accountNumber: '2319876543210'
            accountType: checking
            iban: GB892019000123456789
            bankName: Metro Bank
            address:
              address1: 17 Neo-London Financial Tower
              address2: Suite 1288
              city: London
              countryCode: GB
              postalCode: EC1A 1BB
              type: business
            branchCode: Barclays Branch
    Get_Party_Company_200_orchestrated:
      description: Get a party for company
      value:
        identityVerificationState: pending
        identityVerificationMethod: identityVerificationService
        merchant:
          entity: default
        partyReference: Genesis829
        partyType: beneficiary
        type: company
        partyId: par1Gya_pV7rRYUMI3Ep_ssX0
        companyDetails:
          merchantCategoryCode: '5734'
          merchantCategoryCodeDescription: Computer Software Stores
          website: https://www.example.com
          legalName: Tessier-Ashpool Systems Ltd.
          tradingName: Example.co.uk
          registrationNumber: '7564389201'
          vatNumber: GB987654321
          dateOfIncorporation: '1977-07-04'
          legalAddress:
            address1: 7 Straylight Complex
            address2: Corporate District, Level 99
            city: London
            countryCode: GB
            postalCode: EC1A 1BB
            type: business
          tradingAddress:
            address1: 789 Freeside Blvd
            address2: Villa Straylight
            city: Manchester
            countryCode: GB
            postalCode: M1 1AA
            type: poBox
          customerReference: CustRefZA98765
        email: info@example.com
        phones:
          - prefix: '81'
            number: '8475932'
        identityDocuments: []
        balanceAccounts:
          - currency: GBP
            balanceAccountId: parFwA0DbiCax4y5mzj6207T0
            dateTimeCreated: '2025-04-24T18:05:40.908Z'
            version: 1
          - currency: EUR
            payoutInstrumentReference: MyPayoutInstrument1
            scheduledPayoutDay: monday
            balanceAccountId: parKXSsjAGYuzsJ6AnD_NSCD0
            dateTimeCreated: '2025-04-24T18:05:40.908Z'
            version: 1
          - currency: CHF
            payoutInstrumentReference: MyPayoutInstrument2
            scheduledPayoutDay: thursday
            balanceAccountId: par0yJR1v3RBd8B1CrEYDpTx0
            dateTimeCreated: '2025-04-24T18:05:41.948Z'
            version: 1
        dateTimeCreated: '2025-04-24T18:05:41.046Z'
        version: 2
        payoutInstruments:
          - payoutInstrumentReference: MyPayoutInstrument1
            payoutInstrumentId: parxYYu5sdO559Yo60Ud4ep50
            payoutInstrumentType: bankAccount
            currency: EUR
            dateTimeCreated: '2025-04-24T18:05:40.908Z'
            version: 1
            accountHolderName: Tessier-Ashpool Systems Ltd.
            swiftBic: FSFCGB33
            bankCode: '045110'
            accountNumber: '1234567890'
            accountType: savings
            iban: GB33TASS12345678901234
            bankName: Freeside Financial Corporation
            address:
              address1: 3 Villa Straylight
              address2: Freeside
              city: London
              countryCode: GB
              postalCode: EC1A 1BB
              type: business
            branchCode: Barclays Branch
          - payoutInstrumentReference: MyPayoutInstrument2
            payoutInstrumentId: parbLmHCft8cLP8XXsay63fQ0
            payoutInstrumentType: bankAccount
            currency: CHF
            dateTimeCreated: '2025-04-24T18:05:41.525Z'
            version: 1
            accountHolderName: Tessier-Ashpool Systems Ltd.
            swiftBic: FSFCUS33
            bankCode: '045110'
            accountNumber: '2276581'
            accountType: savings
            iban: GB33TASS12345678901234
            bankName: Freeside Financial Corporation
            address:
              address1: 3 Villa Straylight
              address2: Freeside
              city: York
              state: NA
              countryCode: GB
              postalCode: L502 MK54
              type: business
            branchCode: Muswell Hill Branch
        beneficialOwners:
          - identityVerificationState: pending
            identityVerificationMethod: identityVerificationService
            beneficialOwnerReference: Jennings377
            beneficialOwnerId: parrLsIhp6pE9VQmWG2Y8wKm0
            personalDetails:
              title: Dr
              firstName: Peter
              middleName: Illusionet
              lastName: Riviera
              dateOfBirth: '1972-03-22'
              address:
                address1: 789 Downing Street
                address2: Flat 404
                city: London
                countryCode: GB
                postalCode: SW1A 2AA
                type: home
              residentialStatus: nonResident
              nationality: GB
              currentAddressLessThanThreeYears: true
              previousHomeAddress:
                address1: 123 Oxford Street
                address2: Flat 101
                city: London
                countryCode: GB
                postalCode: W1D 1LP
                type: home
            relationshipToBusiness:
              ownershipPercentage: 10
              director: false
              position: partner
            email: peter.riviera@example.com
            phones:
              - prefix: '44'
                number: '0205556789'
            identityDocuments:
              - type: passport
                number: B98765432
                issuingInstitution: UK Passport Office
                issuingCountry: GB
                validFrom: '2018-05-15'
                validTo: '2028-05-15'
            dateTimeCreated: '2025-04-24T18:05:40.908Z'
            version: 1
          - identityVerificationState: pending
            identityVerificationMethod: identityVerificationService
            beneficialOwnerReference: Orpha684
            beneficialOwnerId: parjDSIhcZTkdGD31KwawOrn0
            personalDetails:
              title: Dr
              firstName: John
              middleName: Illusionet
              lastName: Bailey
              dateOfBirth: '1972-05-22'
              address:
                address1: 200 Downing Street
                address2: Flat 404
                city: London
                countryCode: GB
                postalCode: SW1A 2AA
                type: home
              residentialStatus: nonResident
              nationality: GB
              currentAddressLessThanThreeYears: true
              previousHomeAddress:
                address1: 425 Oxford Street
                address2: Flat 101
                city: London
                countryCode: GB
                postalCode: W1D 1LP
                type: home
            relationshipToBusiness:
              ownershipPercentage: 10
              director: false
              position: partner
            email: John.bailey@example.com
            phones:
              - prefix: '44'
                number: '0205556789'
            identityDocuments:
              - type: passport
                number: B98765432
                issuingInstitution: UK Passport Office
                issuingCountry: GB
                validFrom: '2018-05-15'
                validTo: '2028-05-15'
            dateTimeCreated: '2025-04-24T18:05:41.045Z'
            version: 1
          - identityVerificationState: pending
            identityVerificationMethod: identityVerificationService
            beneficialOwnerReference: Dana455
            beneficialOwnerId: parC3Po42KDFr1SRgu351Ncy0
            personalDetails:
              title: Ms
              firstName: Molly
              middleName: Puppet
              lastName: Millions
              dateOfBirth: '1980-05-15'
              address:
                address1: 456 Sprawl Street
                address2: Flat 101
                city: Burbank
                countryCode: GB
                postalCode: RM1 4PL
              residentialStatus: resident
              nationality: GB
              currentAddressLessThanThreeYears: true
              previousHomeAddress:
                address1: 789 Night City Blvd
                address2: Flat 303
                city: Night City
                countryCode: GB
                postalCode: RM2 3PL
            relationshipToBusiness:
              ownershipPercentage: 25
              director: false
              position: officeManager
            email: molly.millions@example.com
            phones:
              - prefix: '44'
                number: '02079461234'
            identityDocuments:
              - type: passport
                number: A12345678
                issuingInstitution: UK Passport Office
                issuingCountry: GB
                validFrom: '2020-01-01'
                validTo: '2030-01-01'
            dateTimeCreated: '2025-04-24T18:05:40.908Z'
            version: 1
    Update_Party_Person_orchestrated:
      description: Update a party for a person
      value:
        merchant:
          entity: default
        partyReference: 8X87XwQ7Fv
        partyType: beneficiary
        type: person
        personalDetails:
          title: Mr
          firstName: Case
          middleName: Henry
          lastName: Mitchell
          residentialStatus: resident
          dateOfBirth: '1983-10-12'
          address:
            address1: 2025 Kingsbury Court
            address2: Unit 42
            type: home
            city: Manchester
            countryCode: GB
            postalCode: M1 1AA
        email: case.mitchell@example.com
        phones:
          - number: '02079461234'
            prefix: '44'
        identityDocuments:
          - type: passport
            number: NEO456789
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2022-08-01'
            validTo: '2032-08-01'
          - type: nationalId
            number: ZAIBATSU-00792
            issuingInstitution: Zaibatsu Holding HR Dept.
            issuingCountry: GB
            validFrom: '2025-01-01'
            validTo: '2030-12-31'
    Update_Party_Person_200_orchestrated:
      description: Update party of a person (orchestrated)
      value:
        identityVerificationState: pending
        identityVerificationMethod: identityVerificationService
        merchant:
          entity: default
        partyReference: Lela300
        partyType: beneficiary
        type: person
        partyId: par4733xO8y2YI9HSOTG-kba0
        personalDetails:
          title: Mr
          firstName: Case
          middleName: Henry
          lastName: Mitchell
          dateOfBirth: '1983-10-12'
          address:
            address1: 2025 Kingsbury Court
            address2: Unit 42
            city: Manchester
            countryCode: GB
            postalCode: M1 1AA
            type: home
          residentialStatus: resident
          currentAddressLessThanThreeYears: false
        email: case.mitchell@example.com
        phones:
          - prefix: '44'
            number: '02079461234'
        identityDocuments:
          - type: passport
            number: NEO456789
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2022-08-01'
            validTo: '2032-08-01'
          - type: nationalId
            number: ZAIBATSU-00792
            issuingInstitution: Zaibatsu Holding HR Dept.
            issuingCountry: GB
            validFrom: '2025-01-01'
            validTo: '2030-12-31'
        balanceAccounts:
          - currency: GBP
            payoutInstrumentReference: MyPayoutInstrument1
            scheduledPayoutDay: tuesday
            balanceAccountId: parXRSh-RDDLU5NyGZpQhyNb0
            dateTimeCreated: '2025-04-21T20:11:08.699Z'
            version: 0
          - currency: EUR
            payoutInstrumentReference: MyPayoutInstrument2
            scheduledPayoutDay: friday
            balanceAccountId: parBTwBk8J3s3nhgbo1vNyvJ0
            dateTimeCreated: '2025-04-21T20:11:12.991Z'
            version: 0
        dateTimeCreated: '2025-04-21T20:11:08.695Z'
        dateTimeUpdated: '2025-04-21T20:11:15.341Z'
        version: 1
        payoutInstruments:
          - payoutInstrumentReference: MyPayoutInstrument1
            payoutInstrumentId: paru47L8iaV-cm7doWxO7oWm0
            payoutInstrumentType: bankAccount
            currency: GBP
            dateTimeCreated: '2025-04-21T20:11:08.698Z'
            version: 0
            accountHolderName: Case H. Mitchell
            swiftBic: BUKBGB22
            bankCode: '045110'
            accountNumber: '2319876543210'
            accountType: checking
            iban: GB892019000123456789
            bankName: HSBC UK BANK PLC
            address:
              address1: Neo-London Financial Tower
              address2: Suite 1288
              city: London
              countryCode: GB
              postalCode: EC1A 1BB
              type: business
            branchCode: Taunton Branch
          - payoutInstrumentReference: MyPayoutInstrument2
            payoutInstrumentId: parbQkpoZT3adRASZB9Zp9e-0
            payoutInstrumentType: bankAccount
            currency: EUR
            dateTimeCreated: '2025-04-21T20:11:11.251Z'
            version: 0
            accountHolderName: Case H. Mitchell
            swiftBic: BUKBGB22
            bankCode: '045110'
            accountNumber: '2319876543210'
            accountType: checking
            iban: GB892019000123456789
            bankName: Metro Bank
            address:
              address1: 17 Neo-London Financial Tower
              address2: Suite 1288
              city: London
              countryCode: GB
              postalCode: EC1A 1BB
              type: business
            branchCode: Barclays Branch
    Create_BalanceAccount_Person_modular:
      description: Create balance account for existing party of a person (modular)
      value:
        currency: EUR
        scheduledPayoutDay: friday
        payoutInstrumentReference: MyPayoutInstrument1
    Create_BalanceAccount_SoleTrader_modular:
      description: Create balance account for existing party of a soleTader (modular)
      value:
        currency: CHF
        scheduledPayoutDay: friday
        payoutInstrumentReference: MyPayoutInstrument1
    Create_BalanceAccount_Company_modular:
      description: Create balance account for existing party of a company (modular)
      value:
        currency: CHF
        scheduledPayoutDay: thursday
        payoutInstrumentReference: MyPayoutInstrument1
    BalanceAccount_Person_created_201_modular:
      description: Balance account for a party of an existing person (modular)
      value:
        currency: EUR
        payoutInstrumentReference: MyPayoutInstrument1
        scheduledPayoutDay: friday
        balanceAccountId: pareBH4YMkUx7MA2X7bnS4750
        dateTimeCreated: '2025-04-16T20:46:26.727Z'
        version: 0
    BalanceAccount_SoleTrader_created_201_modular:
      description: Balance account for a party of an existing soleTrader (modular)
      value:
        currency: CHF
        payoutInstrumentReference: MyPayoutInstrument1
        scheduledPayoutDay: friday
        balanceAccountId: parApcraCq1bmBuCotAMoyss0
        dateTimeCreated: '2025-04-16T20:46:26.852Z'
        version: 0
    BalanceAccount_Company_created_201_modular:
      description: Balance account for a party of an existing company (modular)
      value:
        currency: CHF
        payoutInstrumentReference: MyPayoutInstrument1
        scheduledPayoutDay: thursday
        balanceAccountId: parGWfE__Xr1F-AmY0v72fwR0
        dateTimeCreated: '2025-04-16T20:46:27.014Z'
        version: 0
    Get_BalanceAccount_Company_200_modular:
      description: Balance account for a party of type company (modular)
      value:
        currency: CHF
        payoutInstrumentReference: MyPayoutInstrument1
        scheduledPayoutDay: thursday
        balanceAccountId: parGWfE__Xr1F-AmY0v72fwR0
        dateTimeCreated: '2025-04-16T20:46:27.014Z'
        version: 1
    Get_BalanceAccount_Person_200_modular:
      description: Balance account for a party of type person (modular)
      value:
        currency: EUR
        payoutInstrumentReference: MyPayoutInstrument1
        scheduledPayoutDay: friday
        balanceAccountId: pareBH4YMkUx7MA2X7bnS4750
        dateTimeCreated: '2025-04-16T20:46:26.727Z'
        version: 0
    Get_BalanceAccount_SoleTrader_200_modular:
      description: Balance account for a party of type sole trader (modular)
      value:
        currency: CHF
        payoutInstrumentReference: MyPayoutInstrument1
        scheduledPayoutDay: friday
        balanceAccountId: parApcraCq1bmBuCotAMoyss0
        dateTimeCreated: '2025-04-16T20:46:26.852Z'
        version: 0
    Update_Balance_Account_SoleTrader_modular:
      description: Update balance account for existing party of a sole trader (modular)
      value:
        currency: CHF
        payoutInstrumentReference: MyPayoutInstrument1
        scheduledPayoutDay: wednesday
    Update_Balance_Account_SoleTrader_200_modular:
      description: Update balance account for existing party of a sole trader (modular)
      value:
        currency: CHF
        payoutInstrumentReference: MyPayoutInstrument1
        scheduledPayoutDay: wednesday
        balanceAccountId: parApcraCq1bmBuCotAMoyss0
        dateTimeCreated: '2025-04-16T20:46:26.852Z'
        dateTimeUpdated: '2025-04-16T20:46:29.901Z'
        version: 1
    Create_Beneficial_Owner_modular:
      description: Create beneficial owner for existing company (modular)
      value:
        beneficialOwnerReference: xdl12goH60
        personalDetails:
          title: Dr
          firstName: John
          middleName: Illusionet
          lastName: Bailey
          residentialStatus: nonResident
          dateOfBirth: '1972-05-22'
          nationality: GB
          address:
            address1: 200 Downing Street
            address2: Flat 404
            city: London
            type: home
            countryCode: GB
            postalCode: SW1A 2AA
          currentAddressLessThanThreeYears: true
          previousHomeAddress:
            address1: 425 Oxford Street
            address2: Flat 101
            city: London
            type: home
            countryCode: GB
            postalCode: W1D 1LP
        relationshipToBusiness:
          ownershipPercentage: 10
          director: false
          position: partner
        identityDocuments:
          - type: passport
            number: B98765432
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2018-05-15'
            validTo: '2028-05-15'
        email: John.bailey@example.com
        phones:
          - number: '0205556789'
            prefix: '44'
    Beneficial_owner_created_201_modular:
      description: Beneficial owner for existing party type company (modular)
      value:
        identityVerificationState: pending
        identityVerificationMethod: identityVerificationService
        beneficialOwnerReference: owner28
        beneficialOwnerId: parNtJbNC8_fd_HRKyQRekiN0
        personalDetails:
          title: Dr
          firstName: John
          middleName: Illusionet
          lastName: Bailey
          dateOfBirth: '1972-05-22'
          address:
            address1: 200 Downing Street
            address2: Flat 404
            city: London
            countryCode: GB
            postalCode: SW1A 2AA
            type: home
          residentialStatus: nonResident
          nationality: GB
          currentAddressLessThanThreeYears: true
          previousHomeAddress:
            address1: 425 Oxford Street
            address2: Flat 101
            city: London
            countryCode: GB
            postalCode: W1D 1LP
            type: home
        relationshipToBusiness:
          ownershipPercentage: 10
          director: false
          position: partner
        email: John.bailey@example.com
        phones:
          - prefix: '44'
            number: '0205556789'
        identityDocuments:
          - type: passport
            number: B98765432
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2018-05-15'
            validTo: '2028-05-15'
        dateTimeCreated: '2025-03-20T18:33:41.480Z'
        version: 1
    Get_Beneficial_Owner_200_modular:
      description: Get a beneficial owner
      value:
        identityVerificationState: pending
        identityVerificationMethod: identityVerificationService
        beneficialOwnerReference: Santino227
        beneficialOwnerId: parNKRss9vllWyX1MUVOj7b-0
        personalDetails:
          title: Dr
          firstName: John
          middleName: Illusionet
          lastName: Bailey
          dateOfBirth: '1972-05-22'
          address:
            address1: 200 Downing Street
            address2: Flat 404
            city: London
            countryCode: GB
            postalCode: SW1A 2AA
            type: home
          residentialStatus: nonResident
          nationality: GB
          currentAddressLessThanThreeYears: true
          previousHomeAddress:
            address1: 425 Oxford Street
            address2: Flat 101
            city: London
            countryCode: GB
            postalCode: W1D 1LP
            type: home
        relationshipToBusiness:
          ownershipPercentage: 10
          director: false
          position: partner
        email: John.bailey@example.com
        phones:
          - prefix: '44'
            number: '0205556789'
        identityDocuments:
          - type: passport
            number: B98765432
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2018-05-15'
            validTo: '2028-05-15'
        dateTimeCreated: '2025-04-07T20:47:59.479Z'
        version: 1
    Update_Beneficial_Owner_modular:
      description: Update a Beneficial Owner
      value:
        beneficialOwnerReference: uWBzL2nzx3
        personalDetails:
          title: Dr
          firstName: John
          middleName: Illusionet
          lastName: Bailey
          residentialStatus: nonResident
          dateOfBirth: '1972-05-22'
          nationality: GB
          address:
            address1: 200 Downing Street
            address2: Flat 404
            city: London
            type: home
            countryCode: GB
            postalCode: SW1A 2AA
          currentAddressLessThanThreeYears: true
          previousHomeAddress:
            address1: 200 Oxford Street
            address2: Flat 101
            city: London
            type: home
            countryCode: GB
            postalCode: W1D 1LP
        relationshipToBusiness:
          ownershipPercentage: 10
          director: false
          position: partner
        identityDocuments:
          - type: passport
            number: B98765432
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2018-05-15'
            validTo: '2028-05-15'
        email: John.bailey@example.com
        phones:
          - number: '0205556789'
            prefix: '44'
    Update_Beneficial_Owner_200_modular:
      description: Update the beneficial owner for a party company (modular)
      value:
        identityVerificationState: notVerified
        identityVerificationMethod: identityVerificationService
        beneficialOwnerReference: Gerson337
        beneficialOwnerId: pardPhiwdlp8VcnS8U7LHVbE0
        personalDetails:
          title: Dr
          firstName: John
          middleName: Illusionet
          lastName: Bailey
          dateOfBirth: '1972-05-22'
          address:
            address1: 200 Downing Street
            address2: Flat 404
            city: London
            countryCode: GB
            postalCode: SW1A 2AA
            type: home
          residentialStatus: nonResident
          nationality: GB
          currentAddressLessThanThreeYears: true
          previousHomeAddress:
            address1: 200 Oxford Street
            address2: Flat 101
            city: London
            countryCode: GB
            postalCode: W1D 1LP
            type: home
        relationshipToBusiness:
          ownershipPercentage: 10
          director: false
          position: partner
        email: John.bailey@example.com
        phones:
          - prefix: '44'
            number: '0205556789'
        identityDocuments:
          - type: passport
            number: B98765432
            issuingInstitution: UK Passport Office
            issuingCountry: GB
            validFrom: '2018-05-15'
            validTo: '2028-05-15'
        dateTimeCreated: '2025-04-10T15:45:06.349Z'
        version: 2
        dateTimeUpdated: '2025-04-10T15:45:09.389Z'
    Get_IVS_Company_200_modular:
      description: Get Identiy Verification Status on a party of a company (modular)
      value:
        overall:
          identityVerificationState: pending
          identityVerificationMethod: identityVerificationService
        party:
          identityVerificationState: pending
          partyReference: Linnea474
          partyId: parWcAyq5G2-1KwvsEkFAKwz0
        beneficialOwners:
          - identityVerificationState: pending
            beneficialOwnerReference: Mac551
            beneficialOwnerId: parAZo80iViOTdKRJi4Oq14Z0
          - identityVerificationState: pending
            beneficialOwnerReference: Thea799
            beneficialOwnerId: parB5ON-IEK4olrLuHvjEDpE0
          - identityVerificationState: pending
            beneficialOwnerReference: Santino227
            beneficialOwnerId: parNKRss9vllWyX1MUVOj7b-0
    Perform_IVS_Company_modular:
      description: Perform Identity Verification on a party of a company (modular)
      value:
        performIdentityVerification: true
    Perform_IVS_Company_200_modular:
      description: Identity Verification Status on a party of a company (modular)
      value:
        overall:
          identityVerificationState: pending
          identityVerificationMethod: identityVerificationService
        party:
          identityVerificationState: pending
          partyReference: Euna925
          partyId: par1Bbf6r80Q3mEvhp_xBKNM0
        beneficialOwners:
          - identityVerificationState: pending
            beneficialOwnerReference: Floy829
            beneficialOwnerId: parsH2dSCcczQveB-GQNx0qq0
          - identityVerificationState: pending
            beneficialOwnerReference: Christina843
            beneficialOwnerId: parbQR-8sRkYASaOzOVPX5d10
          - identityVerificationState: pending
            beneficialOwnerReference: Arlo912
            beneficialOwnerId: pargosUuzW0vv8HrWsCTuadb0
    Create_PayoutInstrument_Person_modular:
      description: Create a payoutInstrument for a party of person (modular)
      value:
        accountHolderName: Case H. Mitchell
        payoutInstrumentType: bankAccount
        swiftBic: BUKBGB22
        bankCode: '045110'
        branchCode: Barclays Branch
        accountNumber: '2319876543210'
        accountType: checking
        iban: GB892019000123456789
        bankName: Metro Bank
        payoutInstrumentReference: MyPayoutInstrument1
        currency: EUR
        address:
          address1: 17 Neo-London Financial Tower
          address2: Suite 1288
          type: business
          city: London
          countryCode: GB
          postalCode: EC1A 1BB
    Create_PayoutInstrument_SoleTrader_modular:
      description: Create a payoutInstrument for a party of soleTrader (modular)
      value:
        accountHolderName: Case H. Mitchell
        payoutInstrumentType: bankAccount
        swiftBic: BUKBGB22
        bankCode: '045110'
        branchCode: Barclays Branch
        accountNumber: '2319876543210'
        accountType: checking
        iban: GB892019000123456789
        bankName: Metro Bank
        payoutInstrumentReference: MyPayoutInstrument1
        currency: CHF
        address:
          address1: 17 Neo-London Financial Tower
          address2: Suite 1288
          type: business
          city: London
          countryCode: GB
          postalCode: EC1A 1BB
    Create_PayoutInstrument_Company_modular:
      description: Create a payoutInstrument for a party of company (modular)
      value:
        accountHolderName: Tessier-Ashpool Systems Ltd.
        payoutInstrumentType: bankAccount
        swiftBic: FSFCUS33
        bankCode: '045110'
        branchCode: Muswell Hill Branch
        accountNumber: '2276581'
        accountType: savings
        iban: GB33TASS12345678901234
        bankName: Freeside Financial Corporation
        payoutInstrumentReference: MyPayoutInstrument1
        currency: CHF
        address:
          address1: 3 Villa Straylight
          address2: Freeside
          type: business
          city: York
          state: NA
          countryCode: GB
          postalCode: L502 MK54
    PayoutInstrument_Person_created_201_modular:
      description: PayoutInstrument for a person (modular)
      value:
        payoutInstrumentReference: MyPayoutInstrument1
        payoutInstrumentId: parF4BlVTN_zIcADcyBpXK6J0
        payoutInstrumentType: bankAccount
        currency: EUR
        dateTimeCreated: '2025-04-07T20:42:24.408Z'
        version: 0
        accountHolderName: Case H. Mitchell
        swiftBic: BUKBGB22
        bankCode: '045110'
        accountNumber: '2319876543210'
        accountType: checking
        iban: GB892019000123456789
        bankName: Metro Bank
        address:
          address1: 17 Neo-London Financial Tower
          address2: Suite 1288
          city: London
          countryCode: GB
          postalCode: EC1A 1BB
          type: business
        branchCode: Barclays Branch
    PayoutInstrument_SoleTrader_created_201_modular:
      description: PayoutInstrument for a soleTrader (modular)
      value:
        payoutInstrumentReference: MyPayoutInstrument1
        payoutInstrumentId: parC_x1lzotG7wnqx1_Den9E0
        payoutInstrumentType: bankAccount
        currency: CHF
        dateTimeCreated: '2025-04-07T20:42:24.759Z'
        version: 0
        accountHolderName: Case H. Mitchell
        swiftBic: BUKBGB22
        bankCode: '045110'
        accountNumber: '2319876543210'
        accountType: checking
        iban: GB892019000123456789
        bankName: Metro Bank
        address:
          address1: 17 Neo-London Financial Tower
          address2: Suite 1288
          city: London
          countryCode: GB
          postalCode: EC1A 1BB
          type: business
        branchCode: Barclays Branch
    PayoutInstrument_Company_created_201_modular:
      description: PayoutInstrument for a company (modular)
      value:
        payoutInstrumentReference: MyPayoutInstrument1
        payoutInstrumentId: parbLmHCft8cLP8XXsay63fQ0
        payoutInstrumentType: bankAccount
        currency: CHF
        dateTimeCreated: '2025-04-24T18:05:41.525Z'
        version: 0
        accountHolderName: Tessier-Ashpool Systems Ltd.
        swiftBic: FSFCUS33
        bankCode: '045110'
        accountNumber: '2276581'
        accountType: savings
        iban: GB33TASS12345678901234
        bankName: Freeside Financial Corporation
        address:
          address1: 3 Villa Straylight
          address2: Freeside
          city: York
          state: NA
          countryCode: GB
          postalCode: L502 MK54
          type: business
        branchCode: Muswell Hill Branch
    Get_PayoutInstrument_Person_200_modular:
      description: Get a payoutInstrument for a party of person  (modular)
      value:
        payoutInstrumentReference: MyPayoutInstrument1
        payoutInstrumentId: parVID57-ep4PqX6J-25AkZk0
        payoutInstrumentType: bankAccount
        currency: EUR
        dateTimeCreated: '2025-04-07T20:48:00.227Z'
        version: 0
        accountHolderName: Case H. Mitchell
        swiftBic: BUKBGB22
        bankCode: '045110'
        accountNumber: '2319876543210'
        accountType: checking
        iban: GB892019000123456789
        bankName: Metro Bank
        address:
          address1: 17 Neo-London Financial Tower
          address2: Suite 1288
          city: London
          countryCode: GB
          postalCode: EC1A 1BB
          type: business
        branchCode: Barclays Branch
    Get_PayoutInstrument_SoleTrader_200_modular:
      description: Get a payoutInstrument for a party of soleTrader  (modular)
      value:
        payoutInstrumentReference: MyPayoutInstrument1
        payoutInstrumentId: partA3SpNddFfGPV0fYk_zI-0
        payoutInstrumentType: bankAccount
        currency: CHF
        dateTimeCreated: '2025-04-07T20:48:00.660Z'
        version: 0
        accountHolderName: Case H. Mitchell
        swiftBic: BUKBGB22
        bankCode: '045110'
        accountNumber: '2319876543210'
        accountType: checking
        iban: GB892019000123456789
        bankName: Metro Bank
        address:
          address1: 17 Neo-London Financial Tower
          address2: Suite 1288
          city: London
          countryCode: GB
          postalCode: EC1A 1BB
          type: business
        branchCode: Barclays Branch
    Get_PayoutInstrument_Company_200_modular:
      description: Get a payoutInstrument for a party of company (modular)
      value:
        payoutInstrumentReference: MyPayoutInstrument1
        payoutInstrumentId: parRI-eYCnF_sOAK59-38hUF0
        payoutInstrumentType: bankAccount
        currency: CHF
        dateTimeCreated: '2025-04-24T18:22:16.393Z'
        version: 1
        accountHolderName: Tessier-Ashpool Systems Ltd.
        swiftBic: FSFCUS33
        bankCode: '045110'
        accountNumber: '2276581'
        accountType: savings
        iban: GB33TASS12345678901234
        bankName: Freeside Financial Corporation
        address:
          address1: 3 Villa Straylight
          address2: Freeside
          city: York
          state: NA
          countryCode: GB
          postalCode: L502 MK54
          type: business
        branchCode: Muswell Hill Branch
    Update_PayoutInstrument_Company_modular:
      description: Update payout instrument for existing party of a company (modular)
      value:
        accountHolderName: Tessier-Ashpool Systems Ltd.
        payoutInstrumentType: bankAccount
        swiftBic: FSFCUS33
        bankCode: '045110'
        branchCode: Muswell Hill Branch
        accountNumber: '2276581'
        accountType: savings
        iban: GB33TASS12345678901234
        bankName: Freeside Financial Corporation
        payoutInstrumentReference: MyPayoutInstrument1
        currency: EUR
        address:
          address1: 9105 Villa Straylight
          address2: Freeside
          type: business
          city: York
          state: NA
          countryCode: GB
          postalCode: L502 MK54
    Update_PayoutInstrument_Company_200_modular:
      description: Update payout instrument for existing party of a company (modular)
      value:
        payoutInstrumentReference: MyPayoutInstrument1
        payoutInstrumentId: parWm7eF6Dfwry4EYQdpXSSB0
        payoutInstrumentType: bankAccount
        currency: EUR
        dateTimeCreated: '2025-04-22T19:24:07.680Z'
        dateTimeUpdated: '2025-04-22T19:24:11.462Z'
        version: 2
        accountHolderName: Tessier-Ashpool Systems Ltd.
        swiftBic: FSFCUS33
        bankCode: '045110'
        accountNumber: '2276581'
        accountType: savings
        iban: GB33TASS12345678901234
        bankName: Freeside Financial Corporation
        address:
          address1: 9105 Villa Straylight
          address2: Freeside
          city: York
          state: NA
          countryCode: GB
          postalCode: L502 MK54
          type: business
        branchCode: Muswell Hill Branch
