> ## Documentation Index > Fetch the complete documentation index at: https://docs.openfinance-hackathon.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Beneficiaries > **The list below outlines the Consent Permissions that are applicable to this resource:** * ReadBeneficiariesBasic * ReadBeneficiariesDetail Refer to *Customer Experience Guidelines*, *Account Information*, *Data Groups* for further information. ## OpenAPI ````yaml open-finance-api/yaml/uae-account-information-openapi.yaml get /accounts/{AccountId}/beneficiaries openapi: 3.0.0 info: title: UAE Account Information API description: '## UAE Open Finance Account Information API Specification' version: v1.2 servers: - url: /open-finance/account-information/v1.2 security: [] tags: - name: Account Access description: Account Access Consents Resource - name: Accounts description: Accounts Resource - name: Balances description: Balances Resource - name: Beneficiaries description: Beneficiaries Resource - name: Direct Debits description: Direct Debits Resource - name: Product description: Product Resource - name: Scheduled Payments description: Scheduled Payments Resource - name: Standing Orders description: Standing Orders Resource - name: Transactions description: Transactions Resource - name: Consents description: Consents Resource - name: Parties description: Parties Resource paths: /accounts/{AccountId}/beneficiaries: get: tags: - Beneficiaries summary: Get Beneficiaries description: > **The list below outlines the Consent Permissions that are applicable to this resource:** * ReadBeneficiariesBasic * ReadBeneficiariesDetail Refer to *Customer Experience Guidelines*, *Account Information*, *Data Groups* for further information. operationId: GetAccountsAccountIdBeneficiaries parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/AccountId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200AccountsAccountIdBeneficiariesRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - UserOAuth2Security: - openid - accounts components: parameters: Authorization: name: authorization in: header required: true description: An authorization Token as per https://tools.ietf.org/html/rfc6750 schema: type: string AccountId: name: AccountId in: path description: AccountId required: true schema: type: string x-fapi-auth-date: in: header name: x-fapi-auth-date required: false description: >- The time when the User 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)$ x-fapi-customer-ip-address: in: header name: x-fapi-customer-ip-address required: false description: The User's IP address if the User is currently logged in with the TPP. schema: type: string x-fapi-interaction-id: in: header name: x-fapi-interaction-id required: false description: An RFC4122 UID used as a correlation id. schema: type: string x-customer-user-agent: in: header name: x-customer-user-agent description: Indicates the user-agent that the User is using. required: false schema: type: string responses: 200AccountsAccountIdBeneficiariesRead: description: Beneficiaries Read headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/AEReadBeneficiary' application/json: schema: $ref: '#/components/schemas/AEReadBeneficiary' application/jwt: schema: $ref: '#/components/schemas/AEReadBeneficiarySigned' 400Error: description: Bad request headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/AEErrorResponse' application/json: schema: $ref: '#/components/schemas/AEErrorResponse' application/jwt: schema: $ref: '#/components/schemas/AEErrorResponseSigned' 401Error: description: Unauthorized headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string 403Error: description: Forbidden headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/AEErrorResponse' application/json: schema: $ref: '#/components/schemas/AEErrorResponse' application/jwt: schema: $ref: '#/components/schemas/AEErrorResponseSigned' 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string 406Error: description: Not Acceptable headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait schema: type: integer x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. schema: type: string 500Error: description: Internal Server Error headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/AEErrorResponse' application/json: schema: $ref: '#/components/schemas/AEErrorResponse' application/jwt: schema: $ref: '#/components/schemas/AEErrorResponseSigned' schemas: AEReadBeneficiary: description: List of Beneficiaries for an Account type: object required: - Data - Links - Meta properties: Data: type: object description: Primary data for the resource required: - AccountId - Beneficiary properties: AccountId: $ref: '#/components/schemas/AccountId' Beneficiary: type: array items: $ref: '#/components/schemas/AEBeneficiary' additionalProperties: false Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/MetaTotalPages' additionalProperties: false AEReadBeneficiarySigned: allOf: - $ref: '#/components/schemas/Jwt' - type: object properties: message: $ref: '#/components/schemas/AEReadBeneficiary' required: - message additionalProperties: false AEErrorResponse: description: >- An array of detail error codes, and messages, and URLs to documentation to help remediation. type: object properties: Errors: items: $ref: '#/components/schemas/AEError' type: array minItems: 1 required: - Errors additionalProperties: false AEErrorResponseSigned: allOf: - $ref: '#/components/schemas/Jwt' - type: object properties: message: $ref: '#/components/schemas/AEErrorResponse' required: - message additionalProperties: false AccountId: description: >- A unique and immutable identifier produced by the LFI to identify the account resource.This identifier has no meaning to the account owner (User 1). type: string minLength: 1 maxLength: 40 AEBeneficiary: description: Beneficiaries for a specific AccountId type: object required: - BeneficiaryId - BeneficiaryType properties: BeneficiaryId: $ref: '#/components/schemas/BeneficiaryId' BeneficiaryType: $ref: '#/components/schemas/AEBeneficiaryTypeCode' AccountHolderName: $ref: '#/components/schemas/AccountHolderName' AccountHolderShortName: $ref: '#/components/schemas/AccountHolderShortName' Reference: $ref: '#/components/schemas/Reference' SupplementaryData: $ref: '#/components/schemas/AESupplementaryData' CreditorAgent: $ref: >- #/components/schemas/AEBranchAndFinancialInstitutionIdentification6_0 CreditorAccount: type: array items: $ref: '#/components/schemas/AECashAccount5_0' additionalProperties: false Links: description: Links relevant to the resource required: - Self properties: Self: $ref: '#/components/schemas/Self' First: $ref: '#/components/schemas/First' Prev: $ref: '#/components/schemas/Prev' Next: $ref: '#/components/schemas/Next' Last: $ref: '#/components/schemas/Last' additionalProperties: false MetaTotalPages: description: Meta Data relevant to the resource type: object required: - TotalPages properties: TotalPages: $ref: '#/components/schemas/TotalPages' additionalProperties: false Jwt: description: > [https://www.rfc-editor.org/rfc/rfc7519](https://www.rfc-editor.org/rfc/rfc7519) type: object properties: iss: description: > [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1) type: string exp: description: > [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4) type: number nbf: description: > [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5) type: number aud: description: > [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3) type: array items: type: string iat: description: > [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6) type: number required: - iss - exp - nbf additionalProperties: false AEError: description: Error type: object properties: Code: description: Low level textual error code, e.g., Field.Missing type: string enum: - AccessToken.Unauthorized - AccessToken.InvalidScope - Consent.Revoked - Consent.TransientAccountAccessFailure - Consent.AccountTemporarilyBlocked - Consent.PermanentAccountAccessFailure - Consent.Invalid - JWS.InvalidSignature - JWS.Malformed - JWS.InvalidClaim - JWS.InvalidHeader - GenericRecoverableError - GenericError - JWE.DecryptionError - JWE.InvalidHeader - Event.UnexpectedEvent - Body.InvalidFormat - Resource.InvalidResourceId - Resource.InvalidFormat - Consent.BusinessRuleViolation Message: description: >- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' UAEOF doesn't standardise this field type: string minLength: 1 maxLength: 500 Path: description: >- Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency type: string minLength: 1 maxLength: 500 Url: description: >- URL to help remediate the problem, or provide more information, or to API Reference, or help etc type: string required: - Code - Message additionalProperties: false minProperties: 1 BeneficiaryId: description: >- A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner. type: string minLength: 1 maxLength: 40 AEBeneficiaryTypeCode: description: >- Specifies the Beneficiary Type. Encoded with allowable values of: 'Activated' - Beneficiary has been added to the beneficiary list using SCA. 'NotActivated' - Beneficiary has been added to the beneficiary list without SCA type: string enum: - Activated - NotActivated AccountHolderName: type: string description: > * /accounts resource The Account Holder Name is the name or names of the Account owner(s) represented at the account level * /accounts/{AccountId} resource The Account Holder Name is the name or names of the Account owner(s) represented at the account level * /beneficiaries resource The Account Holder Name is the name or names of the Beneficiary account owner(s) represented at the account level, as displayed by the Creditor Agent's online channels and as provided by the Beneficiary to the User 1 when adding the Beneficiary in the Beneficiary list. Note, the Account Holder Name is not the product name or the nickname of the account. * /scheduled-payments resource The Account Holder Name is the name or names of the Beneficiary account owner(s) represented at the account level, as displayed by the Creditor Agent's online channels and as provided by the Beneficiary to the User 1 when adding the Beneficiary in the Beneficiary list. Note, the Account Holder Name is not the product name or the nickname of the account. * /standing-orders resource The Account Holder Name is the name or names of the Beneficiary account owner(s) represented at the account level, as displayed by the Creditor Agent's online channels and as provided by the Beneficiary to the User 1 when adding the Beneficiary in the Beneficiary list. Note, the Account Holder Name is not the product name or the nickname of the account. AccountHolderShortName: type: string description: | * /accounts resource The Account holder nick name * /accounts/{AccountId} resource The Account holder nick name * /beneficiaries resource The Beneficiary account holder nick name * /scheduled-payments resource The Beneficiary account holder nick name * /standing-orders resource The Beneficiary account holder nick name Reference: description: >- Unique reference in the context of the creditor, provided by the creditor to the User1 (Debtor), to unambiguously refer to the payment transaction. Usage: If available, the initiating party (i.e. Debtor) provides this reference in the structured remittance information, to enable reconciliation by the Creditor upon receipt of the amount of money. This field is populated by the User 1 (who is the initiating party of the payment e.g. the Debtor). Field is free format text type: string minLength: 1 maxLength: 35 AESupplementaryData: type: object properties: {} additionalProperties: false description: >- Additional information that can not be captured in the structured fields and/or any other specific block. AEBranchAndFinancialInstitutionIdentification6_0: type: object description: >- Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account. required: - SchemeName - Identification properties: SchemeName: $ref: >- #/components/schemas/AEExternalFinancialInstitutionIdentificationCode Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name_1' PostalAddress: $ref: '#/components/schemas/AEPostalAddress6' additionalProperties: false AECashAccount5_0: type: object required: - SchemeName - Identification description: Provides the details to identify the beneficiary account. properties: SchemeName: $ref: '#/components/schemas/AEExternalAccountIdentificationCode1' Identification: $ref: '#/components/schemas/Identification_0' additionalProperties: false Self: description: A link to the current resource type: string format: uri First: description: A link to the first page in a paginated result set type: string format: uri Prev: description: A link to the previous page in a paginated result set type: string format: uri Next: description: A link to the next page in a paginated result set type: string format: uri Last: description: A link to the last page in a paginated result set type: string format: uri TotalPages: description: Total number of Pages where a result set is paginated type: integer format: int32 minimum: 0 AEExternalFinancialInstitutionIdentificationCode: description: > * /accounts resource The name of the identification scheme for the LFI as the account services provider. Encoded with allowable value as published in an external list. * /beneficiaries resource Refers to the Financial Institution that manages the account on behalf of the Beneficiary party, managing registration, booking of entries on the account, calculating balances on the account and providing information about the account. This is the servicing Financial Institution of the Beneficiary account. * /scheduled-payments resource Refers to the identification scheme for uniquely identifying the Creditor Agent. * /standing-orders resource Refers to the identification scheme for uniquely identifying the Creditor Agent. * /transactions resource Refers to the identification scheme for uniquely identifying the Creditor Agent. type: string enum: - BICFI - Other Identification_1: description: > * /accounts resource Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. * /beneficiaries resource Unique and unambiguous identification of the Creditor Agency as the servicing institution of the Beneficiary. * /scheduled-payments resource Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. * /standing-orders resource Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. * /transactions resource Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. * Notes: Based on the value of the field **SchemeName**, this entry may be : * BICFI: The BIC/SWIFT Code * Other: The ID; A Country Code followed by a Bank Code (4 character code). type: string minLength: 1 maxLength: 35 Name_1: description: > * Beneficiary Name by which an agent is known and which is usually used to identify that agent * Creditor agent Name by which the Financial institution(FI) which is the creditor is known and which is usually used to identify that FI. * DebtorAgent Name by which an financial institution of the debtor is known and which is usually used to identify that financial institution. type: string minLength: 1 maxLength: 140 AEPostalAddress6: type: object description: >- Postal Address specifies Information that locate and identify a specific address, as defined by postal services. properties: AddressType: $ref: '#/components/schemas/AEAddressTypeCode' ShortAddress: $ref: '#/components/schemas/ShortAddress' BuildingNumber: $ref: '#/components/schemas/BuildingNumber' UnitNumber: $ref: '#/components/schemas/AEUnitNumber' StreetName: $ref: '#/components/schemas/StreetName' SecondaryNumber: $ref: '#/components/schemas/SecondaryNumber' District: $ref: '#/components/schemas/District' PostalCode: $ref: '#/components/schemas/PostCode' City: $ref: '#/components/schemas/City' Country: $ref: '#/components/schemas/AECountry' additionalProperties: false AEExternalAccountIdentificationCode1: description: >- Name of the identification scheme for the account. Encoded with allowable values published in an external list. type: string enum: - IBAN - AccountNumber - MaskedPAN - MobileNumber - UtilityName - EWallet Identification_0: description: > Identification for the account assigned by the LFI based on the Account Scheme Name. This identification is known by the User 1 account owner. For IBAN, refer to the ISO Standard 13616. type: string minLength: 1 maxLength: 400 AEAddressTypeCode: description: Postal Address type specifies the the nature of the postal address. type: string enum: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement ShortAddress: description: 8 character Unique alphanumeric Code. type: string minLength: 1 maxLength: 8 BuildingNumber: description: Number that identifies the position of a building on a street. type: string minLength: 4 maxLength: 4 AEUnitNumber: description: This is the unit number of the business premises or dwelling type: number example: 10 StreetName: description: Name of a street or thoroughfare. type: string minLength: 1 maxLength: 70 SecondaryNumber: description: Secondary Number, if required type: string minLength: 4 maxLength: 4 District: description: Identifies the District of a City type: string minLength: 1 maxLength: 35 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 City: description: Identifies the City of a Country type: string minLength: 1 maxLength: 35 AECountry: description: Identifies a county either by full name or country code type: string pattern: ^[A-Z]{2,2}$ securitySchemes: UserOAuth2Security: type: oauth2 description: >- [OAuth2 PAR flow](https://datatracker.ietf.org/doc/html/rfc9126), it is required when the User needs to perform SCA with the LFI when a TPP wants to access an LFI resource owned by the User. **Please refer to [OpenID FAPI Security Profile 1.0 -Part 2 Advanced](https://openid.net/specs/openid-financial-api-part-2-1_0.html#authorization-server) - 5.2.2 point 14 - shall authenticate the confidential client using one of the following methods private_key_jwt and [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication) 9. Client Authentication private_key_jwt** flows: authorizationCode: authorizationUrl: https://authserver.example/authorization tokenUrl: https://authserver.example/token scopes: openid: Activates OpenID Connect Support accounts: >- Ability to read Accounts Information. This is a parameterized scope with the ConsentId ````