> ## 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. # Retrieve Account Access Consents by BaseConsentId > Retrieve all Account Access Consents for an BaseConsentId ## OpenAPI ````yaml open-finance-api/yaml/uae-account-information-openapi.yaml get /account-access-consents 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: /account-access-consents: get: tags: - Account Access summary: Retrieve Account Access Consents by BaseConsentId description: | Retrieve all Account Access Consents for an BaseConsentId operationId: GetAccountAccessConsentsByBaseConsentId parameters: - $ref: '#/components/parameters/Authorization' - $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' - $ref: '#/components/parameters/baseConsentId' responses: '200': $ref: '#/components/responses/200BaseConsentIdConsentsRetrieve' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '415': $ref: '#/components/responses/415Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - TPPOAuth2Security: - 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 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 baseConsentId: in: query name: baseConsentId required: true description: | A specific baseConsentId. For example: ``` baseConsentId=abc-19877d98-ab0e-4758-92a7-vvffr1234abv ``` schema: type: string allowEmptyValue: false example: abc-19877d98-ab0e-4758-92a7-vvffr1234abv responses: 200BaseConsentIdConsentsRetrieve: description: Retrieve Payment Consents by BaseConsentId 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/AEConsentsByBaseConsentIdResponse' application/json: schema: $ref: '#/components/schemas/AEConsentsByBaseConsentIdResponse' application/jwt: schema: $ref: '#/components/schemas/AEConsentsByBaseConsentIdResponseSigned' 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' 404Error: description: Not found headers: x-fapi-interaction-id: required: true description: An RFC4122 UID used as a correlation id. schema: type: string 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 415Error: description: Unsupported Media Type 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: AEConsentsByBaseConsentIdResponse: type: array items: $ref: '#/components/schemas/AEReadConsentResponse' AEConsentsByBaseConsentIdResponseSigned: description: | Payment Consents By BaseConsentId Response Signed Schema allOf: - $ref: '#/components/schemas/Jwt' - type: object properties: message: type: array items: $ref: '#/components/schemas/AEReadConsentResponse' 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 AEReadConsentResponse: description: Account Access Consent type: object required: - Data - Links properties: Data: type: object description: Primary data for the resource required: - ConsentId - BaseConsentId - CreationDateTime - Status - StatusUpdateDateTime - Permissions - ExpirationDateTime - OpenFinanceBilling properties: ConsentId: $ref: '#/components/schemas/AEConsentId' BaseConsentId: $ref: '#/components/schemas/AEBaseConsentId' CreationDateTime: $ref: '#/components/schemas/CreationDateTime' Status: $ref: '#/components/schemas/ConsentStatus' StatusUpdateDateTime: $ref: '#/components/schemas/StatusUpdateDateTime' Permissions: $ref: '#/components/schemas/AEConsentPermissions' ExpirationDateTime: description: >- Specified date and time the permissions will expire. 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 TransactionFromDateTime: description: >- Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction.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 TransactionToDateTime: description: >- Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction.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 AccountType: type: array items: $ref: '#/components/schemas/AEExternalAccountTypeCode' AccountSubType: type: array items: $ref: '#/components/schemas/AEExternalAccountSubTypeCode' OnBehalfOf: $ref: '#/components/schemas/OnBehalfOf' OpenFinanceBilling: $ref: '#/components/schemas/AEAccountAccessOpenFinanceBilling' RevokedBy: $ref: '#/components/schemas/AERevokedBy' additionalProperties: false Subscription: $ref: '#/components/schemas/EventNotification' Links: $ref: '#/components/schemas/LinksSelf' Meta: $ref: '#/components/schemas/Meta' 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 AEConsentId: description: > Unique identification assigned by the TPP to identify the consent resource. type: string minLength: 1 maxLength: 128 example: aac-69255d98-ab0e-4758-92a7-cacbf3073efa AEBaseConsentId: description: > The original ConsentId assigned by the TPP. It is used by the TPP for updating/renewing parameters associated with long-lived consents. It must be provided when long-lived consent parameters are updated/renewed for a current consent that has not yet finished. type: string minLength: 1 maxLength: 128 example: abc-19877d98-ab0e-4758-92a7-vvffr1234abv CreationDateTime: description: >- Date and time at which the resource was created.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 ConsentStatus: description: Specifies the status of consent resource in code form. type: string enum: - Authorized - AwaitingAuthorization - Rejected - Revoked - Expired - Suspended StatusUpdateDateTime: description: >- Date and time at which the account resource status was updated. 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 AEConsentPermissions: type: array description: > Specifies the permitted Account Access data types. This is a list of the data groups being consented by the User, and requested for authorization with the LFI. items: type: string enum: - ReadAccountsBasic - ReadAccountsDetail - ReadBalances - ReadBeneficiariesBasic - ReadBeneficiariesDetail - ReadTransactionsBasic - ReadTransactionsDetail - ReadTransactionsCredits - ReadTransactionsDebits - ReadProduct - ReadScheduledPaymentsBasic - ReadScheduledPaymentsDetail - ReadDirectDebits - ReadStandingOrdersBasic - ReadStandingOrdersDetail - ReadPartyUser - ReadPartyUserIdentity - ReadParty minItems: 1 AEExternalAccountTypeCode: description: Specifies the type of account (Retail, SME or Corporate). type: string enum: - Retail - SME - Corporate AEExternalAccountSubTypeCode: description: >- Specifies the sub type of account (product family group). Examples values include: CurrentAccount, Savings type: string x-namespaced-enum: - CurrentAccount - Savings OnBehalfOf: type: object description: On Behalf Of properties: TradingName: type: string description: Trading Name example: Acme Accounting Trading Name LegalName: type: string description: Legal Name example: Acme Accounting Legal Name IdentifierType: type: string description: Identifier Type enum: - Other Identifier: type: string description: Identifier example: abcd1234 additionalProperties: false AEAccountAccessOpenFinanceBilling: type: object required: - UserType - Purpose properties: IsLargeCorporate: type: boolean description: Customer has more than 100 million AED turnover UserType: description: Type of Customer type: string enum: - Retail - SME - Corporate Purpose: description: Purpose of data sharing request type: string enum: - AccountAggregation - RiskAssessment - TaxFiling - Onboarding - Verification - QuoteComparison - BudgetingAnalysis - FinancialAdvice - AuditReconciliation description: Billing parameters specified by the TPP additionalProperties: false AERevokedBy: description: | Denotes the Identifier of the revocation. | Identifier| Description| |-----------|------------| | LFI | Revoked by LFI without User initiation| | TPP | Revoked by TPP without User initiation| | LFI.InitiatedByUser | Initiated by User via the LFI| | TPP.InitiatedByUser | Initiated by User via the TPP| type: string enum: - LFI - TPP - LFI.InitiatedByUser - TPP.InitiatedByUser EventNotification: type: object description: | A Webhook Subscription Schema required: - Webhook properties: Webhook: description: | A Webhook Schema type: object properties: Url: description: | The TPP Callback URL being registered with the LFI type: string example: https://api.tpp.com/webhook/callbackUrl IsActive: description: > The TPP specifying whether the LFI should send (IsActive true) or not send (IsActive false) Webhook Notifications to the TPP's Webhook URL type: boolean example: false additionalProperties: false additionalProperties: false LinksSelf: type: object description: Links relevant to the resource required: - Self properties: Self: $ref: '#/components/schemas/Self' additionalProperties: false Meta: type: object description: Meta Data relevant to the resource additionalProperties: false Self: description: A link to the current resource type: string format: uri securitySchemes: TPPOAuth2Security: type: oauth2 description: >- TPP confidential client authorization with the LFI to stage a consent. **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: clientCredentials: tokenUrl: https://authserver.example/token scopes: openid: Activates OpenID Connect Support accounts: Ability to read Accounts Information ````