Allica Bank Parties API

openapi: 3.2.0
info:
  title: Account and Transaction API Specification Parties API
  description: '# AISP API Overview


    These APIs can be used to access account information for Allica Business Rewards accounts.


    ## Base URL

    The base URL for all AIS APIs is: `https://rs1.api.ob.allica.bank/open-banking/v4.0/aisp/**`


    ## Account Access Consents

    [Account Access Consents API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Account_Access)


    ## Accounts

    [Accounts API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Accounts)


    Accounts API supports only Business Rewards Account and Savings Pot.


    ## Balances

    [Balances API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Balances)


    Balances shown in this endpoint provide the `InterimAvailable` value.


    `InterimAvailable` balance is the value displayed most widely to our customers within the Allica apps.


    ## Transactions

    [Transactions API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Transactions)


    Pagination is supported on GET /accounts/{AccountId}/transactions end point with a page size of 100 transactions.


    > Please note GET /transactions end point is not supported


    ## Beneficiaries

    [Beneficiaries API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Beneficiaries)


    Payment recipients are accessible via the Beneficiaries API. This API is useful when setting up payments.


    ## Direct Debits

    [Direct Debits API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Direct_Debits)


    Only GET /accounts/{accountId}/direct-debits is supported.


    ## Standing Orders

    [Standing Orders API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Standing_Orders)


    Only GET /acccounts/{accountId}/standing-orders are supported



    ## Offers

    [Offers API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Offers)


    Not currently supported.


    ## Parties

    [Parties API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Parties)


    Not currently supported.


    ## Scheduled Payments

    [Scheduled Payments API](/perry/developer/documentation?resource=ukhub-allica-portal&document=swagger/account-info-openapi.yaml#operations-tag-Scheduled_Payments)


    Only GET /accounts/{accountId}/scheduled-payments is supported.

    '
  termsOfService: https://www.openbanking.org.uk/terms
  contact:
    name: Service Desk
    email: ServiceDesk@openbanking.org.uk
  license:
    name: open-licence
    url: https://www.openbanking.org.uk/open-licence
  version: 3.1.10
servers:
- url: /open-banking/v3.1/aisp
tags:
- name: Parties
paths:
  /accounts/{AccountId}/parties:
    get:
      tags:
      - Parties
      summary: Get Parties
      operationId: GetAccountsAccountIdParties
      parameters:
      - name: AccountId
        in: path
        description: AccountId
        required: true
        schema:
          type: string
      - in: header
        name: x-fapi-auth-date
        required: false
        description: 'The time when the PSU last logged in with the TPP.

          All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:

          Sun, 10 Sep 2017 19:43:31 UTC'
        schema:
          type: string
          pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$
      - in: header
        name: x-fapi-customer-ip-address
        required: false
        description: The PSU's IP address if the PSU is currently logged in with the TPP.
        schema:
          type: string
      - in: header
        name: x-fapi-interaction-id
        required: false
        description: An RFC4122 UID used as a correlation id.
        schema:
          type: string
      - in: header
        name: Authorization
        required: true
        description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        schema:
          type: string
      - in: header
        name: x-customer-user-agent
        description: Indicates the user-agent that the PSU is using.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Parties Read
          headers:
            x-fapi-interaction-id:
              description: An RFC4122 UID used as a correlation id.
              required: true
              schema:
                type: string
          content:
            application/json; charset=utf-8:
              schema:
                type: object
                required:
                - Data
                properties:
                  Data:
                    type: object
                    properties:
                      Party:
                        type: array
                        items:
                          type: object
                          required:
                          - PartyId
                          properties:
                            PartyId:
                              description: A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
                              type: string
                              minLength: 1
                              maxLength: 40
                            PartyNumber:
                              description: Number assigned by an agent to identify its customer.
                              type: string
                              minLength: 1
                              maxLength: 35
                            PartyType:
                              description: Party type, in a coded form.
                              type: string
                              enum:
                              - Delegate
                              - Joint
                              - Sole
                            Name:
                              description: Name by which a party is known and which is usually used to identify that party.
                              type: string
                              minLength: 1
                              maxLength: 350
                            FullLegalName:
                              description: Specifies a character string with a maximum length of 350 characters.
                              type: string
                              minLength: 1
                              maxLength: 350
                            LegalStructure:
                              description: Legal standing of the party.
                              type: string
                              x-namespaced-enum:
                              - UK.OBIE.CIC
                              - UK.OBIE.CIO
                              - UK.OBIE.Charity
                              - UK.OBIE.CoOp
                              - UK.OBIE.GeneralPartnership
                              - UK.OBIE.Individual
                              - UK.OBIE.LimitedLiabilityPartnership
                              - UK.OBIE.LimitedPartnership
                              - UK.OBIE.PrivateLimitedCompany
                              - UK.OBIE.PublicLimitedCompany
                              - UK.OBIE.ScottishLimitedPartnership
                              - UK.OBIE.Sole
                            BeneficialOwnership:
                              type: boolean
                            AccountRole:
                              description: A party’s role with respect to the related account.
                              type: string
                              x-namespaced-enum:
                              - UK.OBIE.Administrator
                              - UK.OBIE.Beneficiary
                              - UK.OBIE.CustodianForMinor
                              - UK.OBIE.Granter
                              - UK.OBIE.LegalGuardian
                              - UK.OBIE.OtherParty
                              - UK.OBIE.PowerOfAttorney
                              - UK.OBIE.Principal
                              - UK.OBIE.Protector
                              - UK.OBIE.RegisteredShareholderName
                              - UK.OBIE.SecondaryOwner
                              - UK.OBIE.SeniorManagingOfficial
                              - UK.OBIE.Settlor
                              - UK.OBIE.SuccessorOnDeath
                            EmailAddress:
                              description: Address for electronic mail (e-mail).
                              type: string
                              minLength: 1
                              maxLength: 256
                            Phone:
                              description: Collection of information that identifies a phone number, as defined by telecom services.
                              type: string
                              pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
                            Mobile:
                              description: Collection of information that identifies a mobile phone number, as defined by telecom services.
                              type: string
                              pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
                            Relationships:
                              type: object
                              description: The Party's relationships with other resources.
                              properties:
                                Account:
                                  type: object
                                  required:
                                  - Related
                                  - Id
                                  description: Relationship to the Account resource.
                                  properties:
                                    Related:
                                      description: Absolute URI to the related resource.
                                      type: string
                                      format: uri
                                    Id:
                                      description: Unique identification as assigned by the ASPSP to uniquely identify the related resource.
                                      type: string
                                      minLength: 1
                                      maxLength: 40
                            Address:
                              type: array
                              items:
                                type: object
                                description: Postal address of a party.
                                required:
                                - Country
                                properties:
                                  AddressType:
                                    description: Identifies the nature of the postal address.
                                    type: string
                                    enum:
                                    - Business
                                    - Correspondence
                                    - DeliveryTo
                                    - MailTo
                                    - POBox
                                    - Postal
                                    - Residential
                                    - Statement
                                  AddressLine:
                                    type: array
                                    items:
                                      description: Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.
                                      type: string
                                      minLength: 1
                                      maxLength: 70
                                    minItems: 0
                                    maxItems: 5
                                  StreetName:
                                    description: Name of a street or thoroughfare.
                                    type: string
                                    minLength: 1
                                    maxLength: 70
                                  BuildingNumber:
                                    description: Number that identifies the position of a building on a street.
                                    type: string
                                    minLength: 1
                                    maxLength: 16
                                  PostCode:
                                    description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
                                    type: string
                                    minLength: 1
                                    maxLength: 16
                                  TownName:
                                    description: Name of a built-up area, with defined boundaries, and a local government.
                                    type: string
                                    minLength: 1
                                    maxLength: 35
                                  CountrySubDivision:
                                    description: Identifies a subdivision of a country eg, state, region, county.
                                    type: string
                                    minLength: 1
                                    maxLength: 35
                                  Country:
                                    description: Nation with its own government, occupying a particular territory.
                                    type: string
                                    pattern: ^[A-Z]{2,2}$
                          additionalProperties: false
                  Links:
                    type: object
                    description: Links relevant to the payload
                    properties:
                      Self:
                        type: string
                        format: uri
                      First:
                        type: string
                        format: uri
                      Prev:
                        type: string
                        format: uri
                      Next:
                        type: string
                        format: uri
                      Last:
                        type: string
                        format: uri
                    additionalProperties: false
                    required:
                    - Self
                  Meta:
                    title: MetaData
                    type: object
                    description: Meta Data relevant to the payload
                    properties:
                      TotalPages:
                        type: integer
                        format: int32
                      FirstAvailableDateTime:
                        description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format.

                          All date-time fields in responses must include the timezone. An example is below:

                          2017-04-05T10:43:07+00:00'
                        type: string
                        format: date-time
                      LastAvailableDateTime:
                        description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format.

                          All date-time fields in responses must include the timezone. An example is below:

                          2017-04-05T10:43:07+00:00'
                        type: string
                        format: date-time
                    additionalProperties: false
                additionalProperties: false
            application/json:
              schema:
                type: object
                required:
                - Data
                properties:
                  Data:
                    type: object
                    properties:
                      Party:
                        type: array
                        items:
                          type: object
                          required:
                          - PartyId
                          properties:
                            PartyId:
                              description: A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
                              type: string
                              minLength: 1
                              maxLength: 40
                            PartyNumber:
                              description: Number assigned by an agent to identify its customer.
                              type: string
                              minLength: 1
                              maxLength: 35
                            PartyType:
                              description: Party type, in a coded form.
                              type: string
                              enum:
                              - Delegate
                              - Joint
                              - Sole
                            Name:
                              description: Name by which a party is known and which is usually used to identify that party.
                              type: string
                              minLength: 1
                              maxLength: 350
                            FullLegalName:
                              description: Specifies a character string with a maximum length of 350 characters.
                              type: string
                              minLength: 1
                              maxLength: 350
                            LegalStructure:
                              description: Legal standing of the party.
                              type: string
                              x-namespaced-enum:
                              - UK.OBIE.CIC
                              - UK.OBIE.CIO
                              - UK.OBIE.Charity
                              - UK.OBIE.CoOp
                              - UK.OBIE.GeneralPartnership
                              - UK.OBIE.Individual
                              - UK.OBIE.LimitedLiabilityPartnership
                              - UK.OBIE.LimitedPartnership
                              - UK.OBIE.PrivateLimitedCompany
                              - UK.OBIE.PublicLimitedCompany
                              - UK.OBIE.ScottishLimitedPartnership
                              - UK.OBIE.Sole
                            BeneficialOwnership:
                              type: boolean
                            AccountRole:
                              description: A party’s role with respect to the related account.
                              type: string
                              x-namespaced-enum:
                              - UK.OBIE.Administrator
                              - UK.OBIE.Beneficiary
                              - UK.OBIE.CustodianForMinor
                              - UK.OBIE.Granter
                              - UK.OBIE.LegalGuardian
                              - UK.OBIE.OtherParty
                              - UK.OBIE.PowerOfAttorney
                              - UK.OBIE.Principal
                              - UK.OBIE.Protector
                              - UK.OBIE.RegisteredShareholderName
                              - UK.OBIE.SecondaryOwner
                              - UK.OBIE.SeniorManagingOfficial
                              - UK.OBIE.Settlor
                              - UK.OBIE.SuccessorOnDeath
                            EmailAddress:
                              description: Address for electronic mail (e-mail).
                              type: string
                              minLength: 1
                              maxLength: 256
                            Phone:
                              description: Collection of information that identifies a phone number, as defined by telecom services.
                              type: string
                              pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
                            Mobile:
                              description: Collection of information that identifies a mobile phone number, as defined by telecom services.
                              type: string
                              pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
                            Relationships:
                              type: object
                              description: The Party's relationships with other resources.
                              properties:
                                Account:
                                  type: object
                                  required:
                                  - Related
                                  - Id
                                  description: Relationship to the Account resource.
                                  properties:
                                    Related:
                                      description: Absolute URI to the related resource.
                                      type: string
                                      format: uri
                                    Id:
                                      description: Unique identification as assigned by the ASPSP to uniquely identify the related resource.
                                      type: string
                                      minLength: 1
                                      maxLength: 40
                            Address:
                              type: array
                              items:
                                type: object
                                description: Postal address of a party.
                                required:
                                - Country
                                properties:
                                  AddressType:
                                    description: Identifies the nature of the postal address.
                                    type: string
                                    enum:
                                    - Business
                                    - Correspondence
                                    - DeliveryTo
                                    - MailTo
                                    - POBox
                                    - Postal
                                    - Residential
                                    - Statement
                                  AddressLine:
                                    type: array
                                    items:
                                      description: Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.
                                      type: string
                                      minLength: 1
                                      maxLength: 70
                                    minItems: 0
                                    maxItems: 5
                                  StreetName:
                                    description: Name of a street or thoroughfare.
                                    type: string
                                    minLength: 1
                                    maxLength: 70
                                  BuildingNumber:
                                    description: Number that identifies the position of a building on a street.
                                    type: string
                                    minLength: 1
                                    maxLength: 16
                                  PostCode:
                                    description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.
                                    type: string
                                    minLength: 1
                                    maxLength: 16
                                  TownName:
                                    description: Name of a built-up area, with defined boundaries, and a local government.
                                    type: string
                                    minLength: 1
                                    maxLength: 35
                                  CountrySubDivision:
                                    description: Identifies a subdivision of a country eg, state, region, county.
                                    type: string
                                    minLength: 1
                                    maxLength: 35
                                  Country:
                                    description: Nation with its own government, occupying a particular territory.
                                    type: string
                                    pattern: ^[A-Z]{2,2}$
                          additionalProperties: false
                  Links:
                    type: object
                    description: Links relevant to the payload
                    properties:
                      Self:
                        type: string
                        format: uri
                      First:
                        type: string
                        format: uri
                      Prev:
                        type: string
                        format: uri
                      Next:
                        type: string
                        format: uri
                      Last:
                        type: string
                        format: uri
                    additionalProperties: false
                    required:
                    - Self
                  Meta:
                    title: MetaData
                    type: object
                    description: Meta Data relevant to the payload
                    properties:
                      TotalPages:
                        type: integer
                        format: int32
                      FirstAvailableDateTime:
                        description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format.

                          All date-time fields in responses must include the timezone. An example is below:

                          2017-04-05T10:43:07+00:00'
                        type: string
                        format: date-time
                      LastAvailableDateTime:
                        description: 'All dates in the JSON payloads are represented in ISO 8601 date-time format.

                          All date-time fields in responses must include the timezone. An example is below:

                          2017-04-05T10:43:07+00:00'
                        type: string
                        format: date-time
                    additionalProperties: false
                additionalProperties: false
            application/jose+jwe:
              schema:
                type: object
                required:
                - Data
                properties:
                  Data:
                    type: object
                    properties:
                      Party:
                        type: array
                        items:
                          type: object
                          required:
                          - PartyId
                          properties:
                            PartyId:
                              description: A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner.
                              type: string
                              minLength: 1
                              maxLength: 40
                            PartyNumber:
                              description: Number assigned by an agent to identify its customer.
                              type: string
                              minLength: 1
                              maxLength: 35
                            PartyType:
                              description: Party type, in a coded form.
                              type: string
                              enum:
                              - Delegate
                              - Joint
                              - Sole
                            Name:
                              description: Name by which a party is known and which is usually used to identify that party.
                              type: string
                              minLength: 1
                              maxLength: 350
                            FullLegalName:
                              description: Specifies a character string with a maximum length of 350 characters.
                              type: string
                              minLength: 1
                              maxLength: 350
                            LegalStructure:
                              description: Legal standing of the party.
                              type: string
                              x-namespaced-enum:
                              - UK.OBIE.CIC
                              - UK.OBIE.CIO
                              - UK.OBIE.Charity
                              - UK.OBIE.CoOp
                              - UK.OBIE.GeneralPartnership
                              - UK.OBIE.Individual
                              - UK.OBIE.LimitedLiabilityPartnership
                              - UK.OBIE.LimitedPartnership
                              - UK.OBIE.PrivateLimitedCompany
                              - UK.OBIE.PublicLimitedCompany
                              - UK.OBIE.ScottishLimitedPartnership
                              - UK.OBIE.Sole
                            BeneficialOwnership:
                              type: boolean
                            AccountRole:
                              description: A party’s role with respect to the related account.
                              type: string
                              x-namespaced-enum:
                              - UK.OBIE.Administrator
                              - UK.OBIE.Beneficiary
                              - UK.OBIE.CustodianForMinor
                              - UK.OBIE.Granter
                              - UK.OBIE.LegalGuardian
                              - UK.OBIE.OtherParty
                              - UK.OBIE.PowerOfAttorney
                              - UK.OBIE.Principal
                              - UK.OBIE.Protector
                              - UK.OBIE.RegisteredShareholderName
                              - UK.OBIE.SecondaryOwner
                              - UK.OBIE.SeniorManagingOfficial
                              - UK.OBIE.Settlor
                              - UK.OBIE.SuccessorOnDeath
                            EmailAddress:
                              description: Address for electronic mail (e-mail).
                              type: string
                              minLength: 1
                              maxLength: 256
                            Phone:
                              description: Collection of information that identifies a phone number, as defined by telecom services.
                              type: string
                              pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
                            Mobile:
                              description: Collection of information that identifies a mobile phone number, as defined by telecom services.
                              type: string
                              pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30}
                            Relationships:
                              type: object
                              description: The Party's relationships with other resources.
                              properties:
                                Account:
                                  type: object
                                  

# --- truncated at 32 KB (149 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/allica-bank/refs/heads/main/openapi/allica-bank-parties-api-openapi.yml