{ "specVersion": "v2.1", "openapiVersion": "3.0.0", "pinSha": "bc1cd976956d97195c5000235125cb65aca6aec8", "retrievedAt": "2026-04-28T19:01:20Z", "upstreamRepo": "Nebras-Open-Finance/api-specs", "upstreamPath": "dist/standards/v2.1/uae-account-information-openapi.yaml", "inScopePaths": [ "/accounts", "/accounts/{AccountId}", "/accounts/{AccountId}/balances", "/accounts/{AccountId}/transactions", "/accounts/{AccountId}/standing-orders", "/accounts/{AccountId}/direct-debits", "/accounts/{AccountId}/beneficiaries", "/accounts/{AccountId}/scheduled-payments", "/accounts/{AccountId}/product", "/accounts/{AccountId}/parties", "/parties", "/accounts/{AccountId}/statements" ], "schemaLines": { "get": 658, "patch": 106, "Jwt": 1016, "AEReadConsentResponseSigned": 1047, "AEConsentsByBaseConsentIdResponseSigned": 1057, "AEReadAccountSigned": 1071, "AEReadAccountIdSigned": 1081, "AEReadBalanceSigned": 1091, "AEReadBeneficiarySigned": 1101, "AEReadDirectDebitSigned": 1111, "AEReadProduct1Signed": 1121, "AEReadScheduledPaymentSigned": 1131, "AEReadStandingOrderSigned": 1141, "AEReadTransactionSigned": 1151, "AEReadStatementsSigned": 1161, "EventNotification": 1171, "AEError400ResponseSigned": 1196, "AEError403ResponseSigned": 1207, "AEError500ResponseSigned": 1218, "AEError400Response": 1229, "AEError403Response": 1241, "AEError500Response": 1253, "AEMessage": 1265, "AEError400": 1274, "AEError400Code": 1296, "AEError403": 1320, "AEError403Code": 1342, "AEError500": 1357, "AEError500Code": 1379, "Links": 1390, "MetaTotalPages": 1406, "MetaTransactionsStatements": 1415, "Self": 1428, "First": 1432, "Prev": 1436, "Next": 1440, "Last": 1444, "TotalPages": 1448, "TransactionDateTime": 1453, "PaymentMode": 1461, "TransactionType": 1468, "SubTransactionType": 1482, "Flags": 1487, "AccountHolderName": 1498, "AccountHolderShortName": 1536, "StatementReference": 1553, "LocalTimeZone": 1558, "ISODateTime": 1565, "StandingOrderId": 1572, "StandingOrderType": 1579, "Frequency": 1588, "PurposeSO": 1672, "FirstPaymentDateTime": 1680, "NextPaymentDateTime": 1690, "LastPaymentDateTime": 1700, "FinalPaymentDateTime": 1710, "NumberOfPayments": 1720, "AEExternalStandingOrderStatusCode": 1727, "DirectDebitId": 1733, "MandateIdentification": 1740, "AEExternalDirectDebitStatusCode": 1745, "FrequencyDD": 1751, "PreviousPaymentDateTime": 1763, "AEActiveOrHistoricCurrencyAndAmount_0": 1773, "AEActiveOrHistoricCurrencyAndAmount_1": 1785, "AEActiveOrHistoricCurrencyAndAmount_2": 1802, "AEActiveOrHistoricCurrencyAndAmount_3": 1814, "AEActiveOrHistoricCurrencyAndAmount_4": 1826, "AEActiveOrHistoricCurrencyAndAmount_5": 1838, "AEActiveOrHistoricCurrencyAndAmount_6": 1850, "AEActiveOrHistoricCurrencyAndAmount_7": 1866, "AEActiveOrHistoricCurrencyAndAmount_8": 1878, "AEReadDirectDebit": 1890, "AEDirectDebit": 1917, "AEReadStandingOrder": 1942, "AEStandingOrder": 1969, "AEReadStatements": 2022, "AEBranchAndFinancialInstitutionIdentification5_1": 2037, "DebtorReference": 2053, "AEExternalScheduleTypeCode": 2063, "ScheduledPaymentDateTime": 2073, "ScheduledPaymentId": 2083, "BeneficiaryId": 2090, "AEBeneficiaryTypeCode": 2097, "AEBranchAndFinancialInstitutionIdentification6_0": 2105, "AECashAccount5_0": 2125, "AECashAccount6_0": 2137, "AECashAccount6_1": 2161, "Reference": 2186, "TransactionId": 2196, "TransactionReference": 2203, "AECreditDebitCode_1": 2211, "AEEntryStatusCode": 2217, "AETransactionMutabilityCode": 2224, "BookingDateTime": 2230, "ValueDateTime": 2242, "TransactionInformation": 2262, "AccountId": 6134, "StatusUpdateDateTime": 2274, "AEAccountStatusCode": 2284, "ActiveOrHistoricCurrencyCode_0": 2322, "ActiveOrHistoricCurrencyCode_1": 2330, "Description_0": 2338, "Nickname": 2343, "OpeningDate": 2350, "MaturityDate": 2357, "AEExternalAccountIdentificationCode": 2366, "AEExternalAccountIdentificationCode1": 2375, "Identification_0": 2385, "Identification_1": 2392, "AEExternalFinancialInstitutionIdentificationCode": 2430, "AccountIdentifiers": 2462, "AEBranchAndFinancialInstitutionIdentification5_0": 2478, "AEReadBeneficiary": 2492, "AEBeneficiary": 2519, "AEReadAccount": 2550, "AEReadAccountId": 2574, "AEActiveCurrencyAndAmount_SimpleType": 2599, "AECreditDebitCode_2": 2605, "AEBalanceTypeCode": 2613, "ProprietaryBankTransactionCodeStructure1": 2669, "Name_0": 2690, "Name_1": 2698, "Name_2": 2718, "AEBranchAndFinancialInstitutionIdentification6_1": 2723, "AEPostalAddress": 2749, "AEPartyPostalAddress": 2833, "AEMerchantDetails1": 2844, "AETransactionCashBalance": 2873, "AEBankTransactionCodeStructure": 2900, "AECurrencyExchange": 2933, "AEReadProduct1": 3003, "AEProductFinancialCalculationMeasure": 3031, "AEProductConditions": 3077, "AEJwe": 3095, "AEProduct": 3103, "AEReadTransaction": 3155, "AETransactionCardInstrument": 3182, "AESupplementaryData": 3223, "AEBranchAndFinancialInstitutionIdentification6_2": 3228, "AETransaction": 3254, "AEAccountId": 3347, "AEAccountArrayId": 3392, "AEPatchConsentSigned": 3441, "AEPatchConsent": 3451, "AEConsentsByBaseConsentIdResponse": 3469, "AEReadBalance": 3473, "AEBalance": 3501, "AEReadScheduledPayment": 3582, "AEScheduledPayment": 3609, "TerminalId": 3641, "BillDetails": 3646, "PatchConsentStatus": 3687, "AERevokedBy": 3694, "AEGeoLocation": 3710, "AEPaymentPurposeCode": 3724, "AEProductCharges": 3732, "AEExternalAccountRoleCode": 3813, "AEExternalPartyTypeCode": 3863, "AEPartyCalendarType": 3875, "AEPartyIdentityAssurance2": 3886, "AEPartyIdentityAssurance4": 3929, "AEPartyIdentityCheckDetail": 3966, "AEPartyIdentityEvidenceAttachment": 3997, "AEPartyIdentityEvidenceAttachments": 4022, "AEPartyIdentityEvidenceTypeDocument": 4036, "AEPartyIdentityEvidenceTypeElectronicRecord": 4060, "AEReadParty2": 4082, "AEReadParty2Data": 4097, "AEReadParty2Signed": 4111, "AEReadParty4": 4139, "AEReadParty4Data": 4154, "AEReadParty4Signed": 4162, "AssuranceDetails": 4190, "AssuranceProcess": 4209, "Claims": 4234, "CorporateClaims": 4323, "CountryCode": 4365, "DocumentEvidenceDetails": 4375, "DocumentEvidenceDetailsIssuer": 4404, "DocumentEvidenceDetailsType": 4427, "DocumentEvidenceType": 4439, "DocumentEvidenceVerifier": 4443, "ElectronicRecordEvidenceType": 4461, "ElectronicRecordProperties": 4465, "ElectronicRecordSourceProperties": 4494, "ElectronicRecordType": 4518, "EvidenceMetadata": 4526, "EvidenceRef": 4537, "LinksResource": 4550, "TrustFrameworkCode": 4567, "VerifiedClaim": 4577, "VerifiedClaimVerification": 4608, "AESubTransactionType": 4655, "AEBalanceCategory": 4677, "AEShariaFlag": 4686, "AEAmountWithCategorization": 4690, "AEBalanceWithCategorization": 4709, "AEStatements": 4732, "AEDuration": 4910, "AEProductAssetBackedProducts": 4917, "AEProductRewardsBenefitsBaseProperties": 5099, "AEProductRewardsBenefitsCashbackProperties": 5112, "AEProductRewardsBenefitsPointsProperties": 5147, "AEProductRewardsBenefitsComplimentaryServicesProperties": 5177, "AEProductRewardsBenefitsDiscountsProperties": 5197, "AEProductRewardsBenefitsLifestyleProperties": 5217, "AEProductRewardsBenefitsProtectionProperties": 5237, "AEProductRewardsBenefitsOtherProperties": 5257, "AEProductBenefitRewardsTypes": 5277, "AEProductRewardsBenefitsProperties": 5297, "AEProductInterestCalculationMethod": 5304, "AEProductRateFrequencyCodes": 5312, "AEProductCalculationFrequency": 5320, "AEProductApplicationFrequency": 5325, "AEProductInterestCalculationMethodProperties": 5331, "AEProductProfitCalculationMethodProperties": 5337, "AEProductFinanceRateProperties": 5343, "AEProductVariableRateProperties": 5461, "AEProductFixedRateProperties": 5491, "AEProductVariableInterestRateProperties": 5510, "AEProductVariableProfitRateProperties": 5526, "AEProductFixedInterestRateProperties": 5542, "AEProductFixedProfitRateProperties": 5558, "AEProductFixedRateEndProperties": 5574, "AEProductVariableTermProperties": 5581, "AEProductHybridInterestRateProperties": 5589, "AEProductHybridProfitRateProperties": 5615, "AEProductFinanceRates": 5641, "AEProductDepositRates": 5660, "AEBankDataSharingRichAuthorizationRequests.AEBankDataSharingFromDate": 5769, "AEBankDataSharingRichAuthorizationRequests.AEBankDataSharingToDate": 5781, "AEConsentStatus.AEBankDataSharingOpenFinanceBilling": 5794, "AEBankDataSharingRichAuthorizationRequests.OnBehalfOf": 5826, "AEConsentStatus.AEBankDataSharingConsentPropertiesV21": 5846, "AEConsentStatus.AECreationDateTime": 5917, "AEPushedAuthorizationRequests.AEBaseConsentId": 5926, "AEPushedAuthorizationRequests.AEConsentExpirationDateTime": 5937, "AEPushedAuthorizationRequests.AEConsentId": 5946, "AEConsentStatus.AEConsentStatusCodes": 5951, "AEConsentStatus.AEStatusUpdateDateTime": 5973, "AEBankDataSharingConsentPermissionCodesItem": 5982, "AEBankDataSharing.AEExternalAccountSubTypeCode": 6009, "AEBankDataSharing.AEExternalAccountTypeCode": 6029, "AEConsentStatus.AERevokedByCodes": 6036, "AEStandardModels.AEEventNotification": 6052, "AEStandardModels.AELinksSelf": 6068, "AEStandardModels.AEMeta": 6077, "AEStandardModels.AESelfLink": 6081, "Authorization": 6086, "ConsentId": 6127, "FromBookingDateTimeParam": 6141, "ToBookingDateTimeParam": 6151, "baseConsentId": 6161, "TPPOAuth2Security": 6175, "UserOAuth2Security": 6190, "LFIWebhookSecurity": 6207 }, "endpoints": { "/accounts": { "method": "GET", "summary": "Get Accounts", "operationId": "GetAccounts", "schemaRef": "#/components/schemas/AEReadAccount", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory", "description": "Primary data for the resource" }, { "path": "Data.Account", "name": "Account", "type": "array", "status": "mandatory" }, { "path": "Data.Account[]", "name": "Account[]", "type": "object", "status": "optional", "description": "Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched:\n\n * Data.Currency \n * Data.AccountType \n * Data.AccountSubType\n\nFor all other accounts, the fields must be populated by the LFI." }, { "path": "Data.Account[].AccountId", "name": "AccountId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "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)." }, { "path": "Data.Account[].AccountHolderName", "name": "AccountHolderName", "type": "string", "status": "optional", "description": "* /accounts resource\nThe Account Holder Name is the name or names of the Account owner(s) represented at the account level\n\n* /accounts/{AccountId} resource\nThe Account Holder Name is the name or names of the Account owner(s) represented at the account level\n\n* /beneficiaries resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account. \n\n* /scheduled-payments resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account. \n\n* /standing-orders resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account.\n" }, { "path": "Data.Account[].AccountHolderShortName", "name": "AccountHolderShortName", "type": "string", "status": "optional", "description": "* /accounts resource\nThe Account holder nick name\n\n* /accounts/{AccountId} resource\nThe Account holder nick name\n\n* /beneficiaries resource\nThe Beneficiary account holder nick name\n\n* /scheduled-payments resource\nThe Beneficiary account holder nick name\n\n* /standing-orders resource\nThe Beneficiary account holder nick name\n" }, { "path": "Data.Account[].Status", "name": "Status", "type": "string", "enum": [ "Active", "Inactive", "Dormant", "Unclaimed", "Deceased", "Suspended", "Closed" ], "status": "optional", "description": "Specifies the status of account resource in code form.\n\n* Active: The account exist and is in an active state.\n\n* Inactive: The account is deemed not active by the LFI. Please refer to the \n [CBUAE Website](https://rulebook.centralbank.ae/en/rulebook/dormant-accounts-regulation)\n for qualification of Inactive status.\n\n* Dormant: Please refer to the [CBUAE Website](https://rulebook.centralbank.ae/en/rulebook/dormant-accounts-regulation)\n for the definition of Dormant status.\n\n* Unclaimed: Please refer to the [CBUAE Website](https://rulebook.centralbank.ae/en/rulebook/dormant-accounts-regulation)\n for the definition of Unclaimed status.\n\n* Deceased: The account holder has passed away.\n\n* Suspended: The account has been temporarily deactivated by the LFI for reasons such as\n suspicious activities or non-compliance with regulations. The account holder might\n be unable to access funds or perform transactions until the bank's requirements \n are met, and the suspension is lifted. \n\n* Closed: The account is closed\n" }, { "path": "Data.Account[].StatusUpdateDateTime", "name": "StatusUpdateDateTime", "type": "string", "format": "date-time", "status": "optional", "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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Account[].Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "optional", "description": "Identification of the currency in which the account is held. A code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Account[].AccountType", "name": "AccountType", "type": "string", "enum": [ "Retail", "SME", "Corporate" ], "status": "optional", "description": "Specifies the type of account (Retail, SME or Corporate)." }, { "path": "Data.Account[].AccountSubType", "name": "AccountSubType", "type": "string", "enum": [ "CurrentAccount", "Savings", "CreditCard", "Mortgage", "Finance" ], "status": "optional", "description": "Specifies the sub type of account (product family group). Supported values:\n\n* CurrentAccount\n\n* Savings\n\n* CreditCard\n\n* Mortgage\n\n* Finance" }, { "path": "Data.Account[].Description", "name": "Description", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "Specifies the description of the account sub-type." }, { "path": "Data.Account[].Nickname", "name": "Nickname", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "The nickname of the account, assigned by User 1 to provide an additional and easier means of identification of the account at the LFI." }, { "path": "Data.Account[].OpeningDate", "name": "OpeningDate", "type": "string", "format": "date-time", "status": "optional", "description": "Date on which the account and its related basic services by LFI started to be operational for User 1. 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" }, { "path": "Data.Account[].MaturityDate", "name": "MaturityDate", "type": "string", "format": "date-time", "status": "optional", "description": "* Fixed Term Savings Account\n MaturityDate is the date on which the savings mature and the balance can be withdrawn by the User without penalty\n\n* 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: 2017-04-05T10:43:07+00:00\n" }, { "path": "Data.Account[].AccountIdentifiers", "name": "AccountIdentifiers", "type": "array", "status": "optional" }, { "path": "Data.Account[].AccountIdentifiers[]", "name": "AccountIdentifiers[]", "type": "object", "status": "optional", "description": "Provides the details to identify an account." }, { "path": "Data.Account[].AccountIdentifiers[].SchemeName", "name": "SchemeName", "type": "string", "enum": [ "IBAN", "AccountNumber", "MaskedPAN", "MortgageReference", "FinanceReference" ], "status": "mandatory", "description": "Name of the identification scheme for the account. Encoded with allowable values published in an external list." }, { "path": "Data.Account[].AccountIdentifiers[].Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 400, "status": "mandatory", "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.\n" }, { "path": "Data.Account[].AccountIdentifiers[].Name", "name": "Name", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "The account name is the name or names of the User 1 account owner(s) represented at an account level, as displayed by the LFI's online channels. Note: The account name is not the product name or the nickname of the account." }, { "path": "Data.Account[].Servicer", "name": "Servicer", "type": "object", "status": "optional", "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." }, { "path": "Data.Account[].Servicer.SchemeName", "name": "SchemeName", "type": "string", "enum": [ "BICFI", "Other" ], "status": "mandatory", "description": "* /accounts resource \nThe name of the identification scheme for the LFI as the account services provider. Encoded with allowable value as published in an external list.\n\n* /beneficiaries resource \nRefers 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.\n\n* /scheduled-payments resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /standing-orders resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /transactions resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n" }, { "path": "Data.Account[].Servicer.Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 35, "status": "mandatory", "description": "* /accounts resource\nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /beneficiaries resource\nUnique and unambiguous identification of the Creditor Agency as the servicing institution of the Beneficiary.\n\n* /scheduled-payments resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /standing-orders resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /transactions resource \n Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* Notes:\nBased on the value of the field **SchemeName**, this entry may be :\n* BICFI: The BIC/SWIFT Code \n* Other: Identifier based on non-SWIFT payment system or local market scheme.\n" }, { "path": "Data.Account[].IsShariaCompliant", "name": "IsShariaCompliant", "type": "boolean", "status": "optional", "description": "A flag to denote if the Product is Sharia Compliant" }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" } ] }, "/accounts/{AccountId}": { "method": "GET", "summary": "Get an Account", "operationId": "GetAccountsAccountId", "schemaRef": "#/components/schemas/AEReadAccountId", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory", "description": "Primary data for the resource" }, { "path": "Data.AccountId", "name": "AccountId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "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)." }, { "path": "Data.Account", "name": "Account", "type": "object", "status": "mandatory", "description": "Unambiguous identification of the account to which credit and debit entries are made. The following fields are optional only for accounts that are switched:\n\n * Data.Currency \n * Data.AccountType \n * Data.AccountSubType\n\nFor all other accounts, the fields must be populated by the LFI." }, { "path": "Data.Account.AccountHolderName", "name": "AccountHolderName", "type": "string", "status": "optional", "description": "* /accounts resource\nThe Account Holder Name is the name or names of the Account owner(s) represented at the account level\n\n* /accounts/{AccountId} resource\nThe Account Holder Name is the name or names of the Account owner(s) represented at the account level\n\n* /beneficiaries resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account. \n\n* /scheduled-payments resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account. \n\n* /standing-orders resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account.\n" }, { "path": "Data.Account.AccountHolderShortName", "name": "AccountHolderShortName", "type": "string", "status": "optional", "description": "* /accounts resource\nThe Account holder nick name\n\n* /accounts/{AccountId} resource\nThe Account holder nick name\n\n* /beneficiaries resource\nThe Beneficiary account holder nick name\n\n* /scheduled-payments resource\nThe Beneficiary account holder nick name\n\n* /standing-orders resource\nThe Beneficiary account holder nick name\n" }, { "path": "Data.Account.Status", "name": "Status", "type": "string", "enum": [ "Active", "Inactive", "Dormant", "Unclaimed", "Deceased", "Suspended", "Closed" ], "status": "optional", "description": "Specifies the status of account resource in code form.\n\n* Active: The account exist and is in an active state.\n\n* Inactive: The account is deemed not active by the LFI. Please refer to the \n [CBUAE Website](https://rulebook.centralbank.ae/en/rulebook/dormant-accounts-regulation)\n for qualification of Inactive status.\n\n* Dormant: Please refer to the [CBUAE Website](https://rulebook.centralbank.ae/en/rulebook/dormant-accounts-regulation)\n for the definition of Dormant status.\n\n* Unclaimed: Please refer to the [CBUAE Website](https://rulebook.centralbank.ae/en/rulebook/dormant-accounts-regulation)\n for the definition of Unclaimed status.\n\n* Deceased: The account holder has passed away.\n\n* Suspended: The account has been temporarily deactivated by the LFI for reasons such as\n suspicious activities or non-compliance with regulations. The account holder might\n be unable to access funds or perform transactions until the bank's requirements \n are met, and the suspension is lifted. \n\n* Closed: The account is closed\n" }, { "path": "Data.Account.StatusUpdateDateTime", "name": "StatusUpdateDateTime", "type": "string", "format": "date-time", "status": "optional", "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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Account.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "optional", "description": "Identification of the currency in which the account is held. A code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Account.AccountType", "name": "AccountType", "type": "string", "enum": [ "Retail", "SME", "Corporate" ], "status": "optional", "description": "Specifies the type of account (Retail, SME or Corporate)." }, { "path": "Data.Account.AccountSubType", "name": "AccountSubType", "type": "string", "enum": [ "CurrentAccount", "Savings", "CreditCard", "Mortgage", "Finance" ], "status": "optional", "description": "Specifies the sub type of account (product family group). Supported values:\n\n* CurrentAccount\n\n* Savings\n\n* CreditCard\n\n* Mortgage\n\n* Finance" }, { "path": "Data.Account.Description", "name": "Description", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "Specifies the description of the account sub-type." }, { "path": "Data.Account.Nickname", "name": "Nickname", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "The nickname of the account, assigned by User 1 to provide an additional and easier means of identification of the account at the LFI." }, { "path": "Data.Account.OpeningDate", "name": "OpeningDate", "type": "string", "format": "date-time", "status": "optional", "description": "Date on which the account and its related basic services by LFI started to be operational for User 1. 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" }, { "path": "Data.Account.MaturityDate", "name": "MaturityDate", "type": "string", "format": "date-time", "status": "optional", "description": "* Fixed Term Savings Account\n MaturityDate is the date on which the savings mature and the balance can be withdrawn by the User without penalty\n\n* 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: 2017-04-05T10:43:07+00:00\n" }, { "path": "Data.Account.AccountIdentifiers", "name": "AccountIdentifiers", "type": "array", "status": "optional" }, { "path": "Data.Account.AccountIdentifiers[]", "name": "AccountIdentifiers[]", "type": "object", "status": "optional", "description": "Provides the details to identify an account." }, { "path": "Data.Account.AccountIdentifiers[].SchemeName", "name": "SchemeName", "type": "string", "enum": [ "IBAN", "AccountNumber", "MaskedPAN", "MortgageReference", "FinanceReference" ], "status": "mandatory", "description": "Name of the identification scheme for the account. Encoded with allowable values published in an external list." }, { "path": "Data.Account.AccountIdentifiers[].Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 400, "status": "mandatory", "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.\n" }, { "path": "Data.Account.AccountIdentifiers[].Name", "name": "Name", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "The account name is the name or names of the User 1 account owner(s) represented at an account level, as displayed by the LFI's online channels. Note: The account name is not the product name or the nickname of the account." }, { "path": "Data.Account.Servicer", "name": "Servicer", "type": "object", "status": "optional", "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." }, { "path": "Data.Account.Servicer.SchemeName", "name": "SchemeName", "type": "string", "enum": [ "BICFI", "Other" ], "status": "mandatory", "description": "* /accounts resource \nThe name of the identification scheme for the LFI as the account services provider. Encoded with allowable value as published in an external list.\n\n* /beneficiaries resource \nRefers 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.\n\n* /scheduled-payments resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /standing-orders resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /transactions resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n" }, { "path": "Data.Account.Servicer.Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 35, "status": "mandatory", "description": "* /accounts resource\nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /beneficiaries resource\nUnique and unambiguous identification of the Creditor Agency as the servicing institution of the Beneficiary.\n\n* /scheduled-payments resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /standing-orders resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /transactions resource \n Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* Notes:\nBased on the value of the field **SchemeName**, this entry may be :\n* BICFI: The BIC/SWIFT Code \n* Other: Identifier based on non-SWIFT payment system or local market scheme.\n" }, { "path": "Data.Account.IsShariaCompliant", "name": "IsShariaCompliant", "type": "boolean", "status": "optional", "description": "A flag to denote if the Product is Sharia Compliant" }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" } ] }, "/accounts/{AccountId}/balances": { "method": "GET", "summary": "Get Balances", "operationId": "GetAccountsAccountIdBalances", "schemaRef": "#/components/schemas/AEReadBalance", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory", "description": "Primary data for the resource" }, { "path": "Data.AccountId", "name": "AccountId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "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)." }, { "path": "Data.Balance", "name": "Balance", "type": "array", "status": "mandatory" }, { "path": "Data.Balance[]", "name": "Balance[]", "type": "object", "status": "optional", "description": "Set of elements used to define the balance details." }, { "path": "Data.Balance[].CreditDebitIndicator", "name": "CreditDebitIndicator", "type": "string", "enum": [ "Credit", "Debit" ], "status": "mandatory", "description": "Indicates whether the balance of the account is a credit or a debit balance. Encoded with allowable values: 'Credit', 'Debit' Usage: A zero balance is considered to be a credit balance." }, { "path": "Data.Balance[].Type", "name": "Type", "type": "string", "enum": [ "ClosingAvailable", "ClosingBooked", "ClosingCleared", "Expected", "ForwardAvailable", "Information", "InterimAvailable", "InterimBooked", "InterimCleared", "OpeningAvailable", "OpeningBooked", "OpeningCleared", "PreviouslyClosedBooked" ], "status": "mandatory", "description": "The type of balance for the account. \nEncoded with allowable values of: \n* 'ClosingAvailable' - end of day balance specifying the amount available to User 1 to withdraw or use. \n* 'ClosingBooked' - end of day balance including value of payments for cheques or payments which have not been cleared yet. \n* 'ClosingCleared' - end of day balance including value of payments for cheques or payments which have been cleared. \n* 'Expected' - intra day balance including value of payments for cheques or payments which have been cleared. \n* 'ForwardAvailable' - intraday balance specifying the amount available to User 1 to withdraw or use considering forward dated payments or other intraday payments or cheques that will be clearing to the account. \n* 'Information' - TBC. \n* 'InterimAvailable' - intraday balance specifying the amount available to User 1 to withdraw or use (most probably real-time.'InterimBooked' - intraday balance including value of payments for cheques or payments which have not been cleared yet. \n* 'InterimCleared' - intraday balance including value of payments for cheques or payments which have been cleared (probably real-time). \n* 'OpeningAvailable' - start of day balance specifying the amount available to User 1 to withdraw or use. \n* 'OpeningBooked' - start of day balance including value of payments for cheques or payments which have not been cleared yet. \n* 'OpeningCleared' - start of day balance including value of payments for cheques or payments which have been cleared.\n* 'PreviouslyClosedBooked' -TBC. \n\nNote: LFIs support different types for presenting account balance, so this list is used to support different LFI systems in UAE.\n" }, { "path": "Data.Balance[].DateTime", "name": "DateTime", "type": "string", "format": "date-time", "status": "mandatory", "description": "Indicates the date (and time) that the account balance was checked.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" }, { "path": "Data.Balance[].Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "Amount of money of the cash balance." }, { "path": "Data.Balance[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Balance[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Balance[].CreditLine", "name": "CreditLine", "type": "array", "status": "optional" }, { "path": "Data.Balance[].CreditLine[]", "name": "CreditLine[]", "type": "object", "status": "optional", "description": "Set of elements used to provide details on the credit line." }, { "path": "Data.Balance[].CreditLine[].Included", "name": "Included", "type": "boolean", "status": "mandatory", "description": "Boolean flag to Indicate whether or not a credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account." }, { "path": "Data.Balance[].CreditLine[].Type", "name": "Type", "type": "string", "enum": [ "Available", "Credit", "Emergency", "Pre-Agreed", "Temporary" ], "status": "mandatory", "description": "Type of credit line provided to the account. Encoded with allowable values of: Available, Credit, Emergency, Pre-Agreed, Temporary. Note: LFIs support different types of credit lines on accounts, so this list is used to support different LFI systmes in UAE." }, { "path": "Data.Balance[].CreditLine[].Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "Amount of money of the credit line." }, { "path": "Data.Balance[].CreditLine[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Balance[].CreditLine[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Balance[].Components", "name": "Components", "type": "array", "status": "optional" }, { "path": "Data.Balance[].Components[]", "name": "Components[]", "type": "object", "status": "optional" }, { "path": "Data.Balance[].Components[].BalanceCategory", "name": "BalanceCategory", "type": "string", "enum": [ "Principal", "Interest", "FeesAndCharges", "PastDue", "Profit", "Rental" ], "status": "mandatory" }, { "path": "Data.Balance[].Components[].Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "The value of the categorized balance, incorporating `Amount` and `Currency`." }, { "path": "Data.Balance[].Components[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Balance[].Components[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" } ] }, "/accounts/{AccountId}/transactions": { "method": "GET", "summary": "Get Transactions", "operationId": "GetAccountsAccountIdTransactions", "schemaRef": "#/components/schemas/AEReadTransaction", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory", "description": "Primary data for the resource" }, { "path": "Data.AccountId", "name": "AccountId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "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)." }, { "path": "Data.Transaction", "name": "Transaction", "type": "array", "status": "mandatory" }, { "path": "Data.Transaction[]", "name": "Transaction[]", "type": "object", "status": "optional", "description": "Provides further details on an entry in the report." }, { "path": "Data.Transaction[].TransactionId", "name": "TransactionId", "type": "string", "minLength": 1, "maxLength": 210, "status": "mandatory", "description": "Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable." }, { "path": "Data.Transaction[].TransactionDateTime", "name": "TransactionDateTime", "type": "string", "format": "date-time", "status": "mandatory", "description": "The Date Time of when the transaction occurred.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. \nAn example is below: 2017-04-05T10:43:07+00:00\n" }, { "path": "Data.Transaction[].LocalTimeZone", "name": "LocalTimeZone", "type": "string", "pattern": "^UTC[+-]([01]\\d|2[0-4])(:?[0-5]\\d)?$", "status": "optional", "description": "The UTC offset of the local date and time of where the transaction occurred\nE.g. UTC+03:00\n" }, { "path": "Data.Transaction[].StatementReference", "name": "StatementReference", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "Unique reference for the statement. This reference may be optionally populated if available." }, { "path": "Data.Transaction[].TransactionReference", "name": "TransactionReference", "type": "string", "minLength": 1, "maxLength": 210, "status": "optional", "description": "Unique reference for the transaction.\nWhen processed through a national payment system, it is mandatory to be populated by the LFI.\nAs an example, it may be a reference code for the local payment scheme.\"\n" }, { "path": "Data.Transaction[].TransactionType", "name": "TransactionType", "type": "string", "enum": [ "POS", "ECommerce", "ATM", "BillPayments", "LocalBankTransfer", "SameBankTransfer", "InternationalTransfer", "Teller", "Cheque", "Other" ], "status": "mandatory", "description": "The type of transaction" }, { "path": "Data.Transaction[].SubTransactionType", "name": "SubTransactionType", "type": "string", "enum": [ "Purchase", "Reversal", "Refund", "Withdrawal", "WithdrawalReversal", "Deposit", "DepositReversal", "MoneyTransfer", "Repayments", "Interest", "Fee", "Charges", "Profit", "Disbursement", "Adjustment", "Tax", "Rewards", "NotApplicable", "LeaseRepayment" ], "status": "mandatory" }, { "path": "Data.Transaction[].TerminalId", "name": "TerminalId", "type": "integer", "minLength": 8, "maxLength": 20, "status": "optional", "description": "ID of the Terminal if the transaction was initiated from a retail POS" }, { "path": "Data.Transaction[].Flags", "name": "Flags", "type": "array", "status": "optional" }, { "path": "Data.Transaction[].Flags[]", "name": "Flags[]", "type": "string", "enum": [ "Cashback", "Payroll", "DirectDebit", "StandingOrder", "Finance", "Dividend", "OpenFinance" ], "status": "optional", "description": "The flag of a transaction" }, { "path": "Data.Transaction[].PaymentModes", "name": "PaymentModes", "type": "string", "enum": [ "Online", "Offline", "Batch" ], "status": "optional", "description": "The mode of payment" }, { "path": "Data.Transaction[].CreditDebitIndicator", "name": "CreditDebitIndicator", "type": "string", "enum": [ "Credit", "Debit" ], "status": "mandatory", "description": "Indicates whether the transaction is a credit or a debit entry." }, { "path": "Data.Transaction[].Status", "name": "Status", "type": "string", "enum": [ "Booked", "Pending", "Rejected" ], "status": "mandatory", "description": "Status of a transaction entry on the books of the account servicer." }, { "path": "Data.Transaction[].TransactionMutability", "name": "TransactionMutability", "type": "string", "enum": [ "Mutable", "Immutable" ], "status": "optional", "description": "Specifies the Mutability of the Transaction record." }, { "path": "Data.Transaction[].BookingDateTime", "name": "BookingDateTime", "type": "string", "format": "date-time", "status": "mandatory", "description": "Date and time when a transaction entry is posted to an account on the account servicer's books.\nUsage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00\n" }, { "path": "Data.Transaction[].ValueDateTime", "name": "ValueDateTime", "type": "string", "format": "date-time", "status": "optional", "description": "Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. \nUsage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. \nFor transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days.\nAvailability float refers to the time period between fund deposits and clearing.\nThe float is essentially double-counted money: a paid sum which, due to delays in processing, appears simultaneously in the accounts of the Debtor and the Creditor.\nAll 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\"\n" }, { "path": "Data.Transaction[].TransactionInformation", "name": "TransactionInformation", "type": "string", "minLength": 1, "maxLength": 500, "status": "optional", "description": "Further details of the transaction. This is the transaction narrative, which is unstructured text." }, { "path": "Data.Transaction[].Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "Amount of money in the transaction entry." }, { "path": "Data.Transaction[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Transaction[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Transaction[].ChargeAmount", "name": "ChargeAmount", "type": "object", "status": "optional", "description": "Transaction charges to be paid by the charge bearer." }, { "path": "Data.Transaction[].ChargeAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Transaction[].ChargeAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Transaction[].ChargeAmount.ChargeIncluded", "name": "ChargeIncluded", "type": "boolean", "status": "optional", "description": "If true then the value in the Amount has the ChargeAmount deducted from it\n" }, { "path": "Data.Transaction[].ChargeAmountVat", "name": "ChargeAmountVat", "type": "object", "status": "optional", "description": " The VAT associated with the ChargeAmount" }, { "path": "Data.Transaction[].ChargeAmountVat.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Transaction[].ChargeAmountVat.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Transaction[].CurrencyExchange", "name": "CurrencyExchange", "type": "object", "status": "optional", "description": "Set of elements used to provide details on the currency exchange." }, { "path": "Data.Transaction[].CurrencyExchange.SourceCurrency", "name": "SourceCurrency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "Currency from which an amount is to be converted in a currency conversion. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\"." }, { "path": "Data.Transaction[].CurrencyExchange.TargetCurrency", "name": "TargetCurrency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "Currency into which an amount is to be converted in a currency conversion.A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\"." }, { "path": "Data.Transaction[].CurrencyExchange.UnitCurrency", "name": "UnitCurrency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "Currency in which the rate of exchange is expressed in a currency exchange. In the example 1AED = xxxCUR, the unit currency is AED.A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 \"Codes for the representation of currencies and funds\"." }, { "path": "Data.Transaction[].CurrencyExchange.ExchangeRate", "name": "ExchangeRate", "type": "number", "status": "mandatory", "description": "Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.\nUsage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency)." }, { "path": "Data.Transaction[].CurrencyExchange.ContractIdentification", "name": "ContractIdentification", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "Unique identification to unambiguously identify the foreign exchange contract." }, { "path": "Data.Transaction[].CurrencyExchange.QuotationDate", "name": "QuotationDate", "type": "string", "format": "date-time", "status": "optional", "description": "Date and time at which an exchange rate is quoted.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Transaction[].CurrencyExchange.InstructedAmount", "name": "InstructedAmount", "type": "object", "status": "mandatory", "description": "Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party." }, { "path": "Data.Transaction[].CurrencyExchange.InstructedAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Transaction[].CurrencyExchange.InstructedAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Transaction[].BankTransactionCode", "name": "BankTransactionCode", "type": "object", "status": "optional", "description": "BankTransactionCode is mandatory (with code specifying the Domain, Family and SubFamily as per External Codes ISO20022) when the ProprietaryBankTransactionCode is absent. \nSpecifies the domain, the family and the sub-family of the bank transaction code, in a structured and hierarchical format.\nUsage: If a specific family or sub-family code cannot be provided, the generic family code defined for the domain or the generic sub-family code defined for the family should be provided.\n[https://www.iso20022.org/sites/default/files/2022-05/BTC_Codification_31May2022.xls](https://www.iso20022.org/sites/default/files/2022-05/BTC_Codification_31May2022.xls)\n" }, { "path": "Data.Transaction[].BankTransactionCode.Domain", "name": "Domain", "type": "string", "status": "optional", "description": "Specifies the Domain" }, { "path": "Data.Transaction[].BankTransactionCode.DomainCode", "name": "DomainCode", "type": "string", "status": "optional", "description": "Specifies the Domain Code." }, { "path": "Data.Transaction[].BankTransactionCode.Family", "name": "Family", "type": "string", "status": "optional", "description": "Specifies the Family" }, { "path": "Data.Transaction[].BankTransactionCode.FamilyCode", "name": "FamilyCode", "type": "string", "status": "optional", "description": "Specifies the Family Code" }, { "path": "Data.Transaction[].BankTransactionCode.SubFamily", "name": "SubFamily", "type": "string", "status": "optional", "description": "Specifies the Sub-Family" }, { "path": "Data.Transaction[].BankTransactionCode.SubFamilyCode", "name": "SubFamilyCode", "type": "string", "status": "optional", "description": "Specifies the Sub-family Code" }, { "path": "Data.Transaction[].ProprietaryBankTransactionCode", "name": "ProprietaryBankTransactionCode", "type": "object", "status": "optional", "description": "ProprietaryBankTransactionCode is mandatory when the BankTransactionCode (with code specifying the Domain, Family and SubFamily as per External Codes ISO20022) is absent. \nSet of elements to fully identify a proprietary bank transaction code\n" }, { "path": "Data.Transaction[].ProprietaryBankTransactionCode.Code", "name": "Code", "type": "string", "minLength": 1, "maxLength": 35, "status": "mandatory", "description": "Proprietary bank transaction code to identify the underlying transaction." }, { "path": "Data.Transaction[].ProprietaryBankTransactionCode.Issuer", "name": "Issuer", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "Identification of the issuer of the proprietary bank transaction code." }, { "path": "Data.Transaction[].Balance", "name": "Balance", "type": "object", "status": "optional", "description": "Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account." }, { "path": "Data.Transaction[].Balance.CreditDebitIndicator", "name": "CreditDebitIndicator", "type": "string", "enum": [ "Credit", "Debit" ], "status": "mandatory", "description": "Indicates whether the balance of the account is a credit or a debit balance. Encoded with allowable values: 'Credit', 'Debit' Usage: A zero balance is considered to be a credit balance." }, { "path": "Data.Transaction[].Balance.Type", "name": "Type", "type": "string", "enum": [ "ClosingAvailable", "ClosingBooked", "ClosingCleared", "Expected", "ForwardAvailable", "Information", "InterimAvailable", "InterimBooked", "InterimCleared", "OpeningAvailable", "OpeningBooked", "OpeningCleared", "PreviouslyClosedBooked" ], "status": "mandatory", "description": "The type of balance for the account. \nEncoded with allowable values of: \n* 'ClosingAvailable' - end of day balance specifying the amount available to User 1 to withdraw or use. \n* 'ClosingBooked' - end of day balance including value of payments for cheques or payments which have not been cleared yet. \n* 'ClosingCleared' - end of day balance including value of payments for cheques or payments which have been cleared. \n* 'Expected' - intra day balance including value of payments for cheques or payments which have been cleared. \n* 'ForwardAvailable' - intraday balance specifying the amount available to User 1 to withdraw or use considering forward dated payments or other intraday payments or cheques that will be clearing to the account. \n* 'Information' - TBC. \n* 'InterimAvailable' - intraday balance specifying the amount available to User 1 to withdraw or use (most probably real-time.'InterimBooked' - intraday balance including value of payments for cheques or payments which have not been cleared yet. \n* 'InterimCleared' - intraday balance including value of payments for cheques or payments which have been cleared (probably real-time). \n* 'OpeningAvailable' - start of day balance specifying the amount available to User 1 to withdraw or use. \n* 'OpeningBooked' - start of day balance including value of payments for cheques or payments which have not been cleared yet. \n* 'OpeningCleared' - start of day balance including value of payments for cheques or payments which have been cleared.\n* 'PreviouslyClosedBooked' -TBC. \n\nNote: LFIs support different types for presenting account balance, so this list is used to support different LFI systems in UAE.\n" }, { "path": "Data.Transaction[].Balance.Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "Amount of money of the cash balance after a transaction entry is applied to the account.." }, { "path": "Data.Transaction[].Balance.Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Transaction[].Balance.Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Transaction[].MerchantDetails", "name": "MerchantDetails", "type": "object", "status": "optional", "description": "Details of the Merchant involved in the transaction.\nMerchant Details are specified only for those merchant categories that are generally expected to originate retail financial transactions\n" }, { "path": "Data.Transaction[].MerchantDetails.MerchantId", "name": "MerchantId", "type": "integer", "minLength": 8, "maxLength": 20, "status": "optional", "description": "MerchantId" }, { "path": "Data.Transaction[].MerchantDetails.MerchantName", "name": "MerchantName", "type": "string", "minLength": 1, "maxLength": 350, "status": "optional", "description": "Name by which the merchant is known." }, { "path": "Data.Transaction[].MerchantDetails.MerchantCategoryCode", "name": "MerchantCategoryCode", "type": "string", "minLength": 3, "maxLength": 4, "status": "optional", "description": "Category code values are used to enable the classification of merchants into specific categories based on the type of business, trade or services supplied. \nCategory code conforms to ISO 18245, related to the type of services or goods the merchant provides for the transaction.\"\n" }, { "path": "Data.Transaction[].CreditorAgent", "name": "CreditorAgent", "type": "object", "status": "optional", "description": "Financial institution servicing an account for the creditor in case the transaction is a Debit transaction.\nThese are optional because there are situations where this cannot be populated for the following Debit transactions\n- Cash withdrawals (no creditor account/agent)\n- Cheques and DDs may not have this information at least during the process of clearing and sometimes (e.g. for agency banks) may not be reconciled ever\n- Some corner situations with international payments \n- For card payments (instead merchant information fields should be populated)\n" }, { "path": "Data.Transaction[].CreditorAgent.SchemeName", "name": "SchemeName", "type": "string", "enum": [ "BICFI", "Other" ], "status": "optional", "description": "* /accounts resource \nThe name of the identification scheme for the LFI as the account services provider. Encoded with allowable value as published in an external list.\n\n* /beneficiaries resource \nRefers 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.\n\n* /scheduled-payments resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /standing-orders resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /transactions resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n" }, { "path": "Data.Transaction[].CreditorAgent.Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "* /accounts resource\nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /beneficiaries resource\nUnique and unambiguous identification of the Creditor Agency as the servicing institution of the Beneficiary.\n\n* /scheduled-payments resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /standing-orders resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /transactions resource \n Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* Notes:\nBased on the value of the field **SchemeName**, this entry may be :\n* BICFI: The BIC/SWIFT Code \n* Other: Identifier based on non-SWIFT payment system or local market scheme.\n" }, { "path": "Data.Transaction[].CreditorAgent.Name", "name": "Name", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "* Beneficiary\nName by which an agent is known and which is usually used to identify that agent\n\n* Creditor agent\nName by which the Financial institution(FI) which is the creditor is known and which is usually used to identify that FI.\n\n* DebtorAgent\nName by which an financial institution of the debtor is known and which is usually used to identify that financial institution.\n" }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress", "name": "PostalAddress", "type": "object", "status": "optional", "description": "Address properties based on ISO 20022 `PostalAddress27` definition" }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.AddressType", "name": "AddressType", "type": "string", "enum": [ "Billing", "Business", "Correspondence", "DeliveryTo", "MailTo", "POBox", "Postal", "Permanent", "Residential", "Statement", "Other" ], "status": "optional", "description": "The type of address. Omitted if type not held." }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.AddressLine", "name": "AddressLine", "type": "array", "status": "mandatory", "description": "Information that locates and identifies a specific address for a transaction entry, that is presented in free format text." }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.AddressLine[]", "name": "AddressLine[]", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional" }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.BuildingNumber", "name": "BuildingNumber", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The unit, apartment, or villa number within a building or community" }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.BuildingName", "name": "BuildingName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of the building or house." }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.Floor", "name": "Floor", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "Floor or storey within a building." }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.StreetName", "name": "StreetName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The name of the street or road where the property is located." }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.DistrictName", "name": "DistrictName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The district, community, or neighbourhood where the property is located." }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.PostBox", "name": "PostBox", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The P.O. Box number assigned to the recipient for mail delivery." }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.TownName", "name": "TownName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of a built-up area, such as a town or city." }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.CountrySubDivision", "name": "CountrySubDivision", "type": "string", "enum": [ "AbuDhabi", "Ajman", "Dubai", "Fujairah", "RasAlKhaimah", "Sharjah", "UmmAlQuwain" ], "status": "optional", "description": "Country subdivision, such as state or province. This is the Emirate where the address is registered." }, { "path": "Data.Transaction[].CreditorAgent.PostalAddress.Country", "name": "Country", "type": "string", "pattern": "^[A-Z]{2}$", "status": "mandatory", "description": "The country associated with the address, represented using the ISO 3166-1 alpha-2 country code." }, { "path": "Data.Transaction[].CreditorAccount", "name": "CreditorAccount", "type": "array", "status": "optional" }, { "path": "Data.Transaction[].CreditorAccount[]", "name": "CreditorAccount[]", "type": "object", "status": "optional", "description": "Creditor account details available in case the transaction is a Debit transaction.\nThese are optional because there are situations where this cannot be populated for the following Debit transactions:\n- cash withdrawals (no creditor account/agent)\n- cheques and DDs may not have this information at least during the process of clearing and sometimes (e.g. for agency banks) may not be reconciled ever\n- some corner situations with international payments \n- for card payments (instead merchant information fields should be populated)\n" }, { "path": "Data.Transaction[].CreditorAccount[].SchemeName", "name": "SchemeName", "type": "string", "enum": [ "IBAN", "AccountNumber", "MaskedPAN", "MortgageReference", "FinanceReference" ], "status": "optional", "description": "Name of the identification scheme for the account. Encoded with allowable values published in an external list." }, { "path": "Data.Transaction[].CreditorAccount[].Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 400, "status": "optional", "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.\n" }, { "path": "Data.Transaction[].CreditorAccount[].Name", "name": "Name", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "The account name is the name or names of the User 1 account owner(s) represented at an account level, as displayed by the LFI's online channels. Note: The account name is not the product name or the nickname of the account." }, { "path": "Data.Transaction[].DebtorAgent", "name": "DebtorAgent", "type": "object", "status": "optional", "description": "Financial institution servicing an account for the Debtor in case the transaction is a Credit transaction.\nThese are optional because there are situations where this cannot be populated for the following Credit transactions\n- cash deposits (no creditor account/agent)\n- cheques and DDs may not have this information at least during the process of clearing and sometimes (e.g. for agency banks) may not be reconciled ever\n- some corner situations with international payments \n- for refunds with card payments (instead merchant information fields should be populated)\n" }, { "path": "Data.Transaction[].DebtorAgent.SchemeName", "name": "SchemeName", "type": "string", "enum": [ "BICFI", "Other" ], "status": "optional", "description": "* /accounts resource \nThe name of the identification scheme for the LFI as the account services provider. Encoded with allowable value as published in an external list.\n\n* /beneficiaries resource \nRefers 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.\n\n* /scheduled-payments resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /standing-orders resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /transactions resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n" }, { "path": "Data.Transaction[].DebtorAgent.Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "* /accounts resource\nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /beneficiaries resource\nUnique and unambiguous identification of the Creditor Agency as the servicing institution of the Beneficiary.\n\n* /scheduled-payments resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /standing-orders resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /transactions resource \n Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* Notes:\nBased on the value of the field **SchemeName**, this entry may be :\n* BICFI: The BIC/SWIFT Code \n* Other: Identifier based on non-SWIFT payment system or local market scheme.\n" }, { "path": "Data.Transaction[].DebtorAgent.Name", "name": "Name", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "* Beneficiary\nName by which an agent is known and which is usually used to identify that agent\n\n* Creditor agent\nName by which the Financial institution(FI) which is the creditor is known and which is usually used to identify that FI.\n\n* DebtorAgent\nName by which an financial institution of the debtor is known and which is usually used to identify that financial institution.\n" }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress", "name": "PostalAddress", "type": "object", "status": "optional", "description": "Address properties based on ISO 20022 `PostalAddress27` definition" }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.AddressType", "name": "AddressType", "type": "string", "enum": [ "Billing", "Business", "Correspondence", "DeliveryTo", "MailTo", "POBox", "Postal", "Permanent", "Residential", "Statement", "Other" ], "status": "optional", "description": "The type of address. Omitted if type not held." }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.AddressLine", "name": "AddressLine", "type": "array", "status": "mandatory", "description": "Information that locates and identifies a specific address for a transaction entry, that is presented in free format text." }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.AddressLine[]", "name": "AddressLine[]", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional" }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.BuildingNumber", "name": "BuildingNumber", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The unit, apartment, or villa number within a building or community" }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.BuildingName", "name": "BuildingName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of the building or house." }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.Floor", "name": "Floor", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "Floor or storey within a building." }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.StreetName", "name": "StreetName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The name of the street or road where the property is located." }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.DistrictName", "name": "DistrictName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The district, community, or neighbourhood where the property is located." }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.PostBox", "name": "PostBox", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The P.O. Box number assigned to the recipient for mail delivery." }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.TownName", "name": "TownName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of a built-up area, such as a town or city." }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.CountrySubDivision", "name": "CountrySubDivision", "type": "string", "enum": [ "AbuDhabi", "Ajman", "Dubai", "Fujairah", "RasAlKhaimah", "Sharjah", "UmmAlQuwain" ], "status": "optional", "description": "Country subdivision, such as state or province. This is the Emirate where the address is registered." }, { "path": "Data.Transaction[].DebtorAgent.PostalAddress.Country", "name": "Country", "type": "string", "pattern": "^[A-Z]{2}$", "status": "mandatory", "description": "The country associated with the address, represented using the ISO 3166-1 alpha-2 country code." }, { "path": "Data.Transaction[].DebtorAccount", "name": "DebtorAccount", "type": "object", "status": "optional", "description": "Account details of the Debtor in case the transaction is a Credit transaction.\n\nThese are optional because there are situations where this cannot be populated for the following Credit transactions\n- cash deposits (no creditor account/agent)\n- cheques and DDs may not have this information at least during the process of clearing and sometimes (e.g. for agency banks) may not be reconciled ever\n- some corner situations with international payments \n- for refunds with card payments (instead merchant information fields should be populated)\n" }, { "path": "Data.Transaction[].DebtorAccount.SchemeName", "name": "SchemeName", "type": "string", "enum": [ "IBAN", "AccountNumber", "MaskedPAN", "MortgageReference", "FinanceReference" ], "status": "optional", "description": "Name of the identification scheme for the account. Encoded with allowable values published in an external list." }, { "path": "Data.Transaction[].DebtorAccount.Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 400, "status": "optional", "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.\n" }, { "path": "Data.Transaction[].DebtorAccount.Name", "name": "Name", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "The account name is the name or names of the User 1 account owner(s) represented at an account level, as displayed by the LFI's online channels. Note: The account name is not the product name or the nickname of the account." }, { "path": "Data.Transaction[].CardInstrument", "name": "CardInstrument", "type": "object", "status": "optional", "description": "Set of elements to describe the card instrument used in the transaction." }, { "path": "Data.Transaction[].CardInstrument.CardSchemeName", "name": "CardSchemeName", "type": "string", "enum": [ "AmericanExpress", "Diners", "Discover", "GCC", "MasterCard", "UPI", "VISA" ], "status": "mandatory", "description": "Name of the card scheme." }, { "path": "Data.Transaction[].CardInstrument.InstrumentType", "name": "InstrumentType", "type": "string", "enum": [ "ApplePay", "Contactless", "MagStripe", "Chip", "Other" ], "status": "mandatory", "description": "The card instrument type." }, { "path": "Data.Transaction[].CardInstrument.Name", "name": "Name", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "Name of the cardholder using the card instrument." }, { "path": "Data.Transaction[].CardInstrument.Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and MUST be masked." }, { "path": "Data.Transaction[].SupplementaryData", "name": "SupplementaryData", "type": "object", "status": "optional", "description": "Additional information that can not be captured in the structured fields and/or any other specific block." }, { "path": "Data.Transaction[].BillDetails", "name": "BillDetails", "type": "object", "status": "optional", "description": "Bill Details" }, { "path": "Data.Transaction[].BillDetails.BillerId", "name": "BillerId", "type": "number", "status": "optional", "description": "This should be 'BillerCode' as per SP-SADAD specifications. It is a unique biller identifier within SADAD that could be used by the end-user to refer to a specific SADAD biller (e.g. STC biller code is 001, water services biller code is 015, etc.)" }, { "path": "Data.Transaction[].BillDetails.BillNumber", "name": "BillNumber", "type": "string", "status": "optional", "description": "Unique bill identifier within the account." }, { "path": "Data.Transaction[].BillDetails.BillPaymentType", "name": "BillPaymentType", "type": "string", "enum": [ "Post-Paid", "AdvancePaymentForRoaming", "Recharge", "Renewal", "RoamingDeposit", "One-Off", "RecurringPayment" ], "status": "optional", "description": "Indicates whether the bill could be a One-off payment, Recurring payment, Postpaid, Pre-paid, etc. Example values:\n- \"Post-Paid\"\n- \"AdvancePaymentForRoaming\"\n- \"Recharge\"\n- \"Renewal\"\n- \"RoamingDeposit\"\n- \"One-Off\"\n- \"RecurringPayment\"\n" }, { "path": "Data.Transaction[].GeoLocation", "name": "GeoLocation", "type": "object", "status": "optional", "description": "Estimated latitude and longitude coordinates, in degrees. Contains one latitude and one longitude subfield." }, { "path": "Data.Transaction[].GeoLocation.Latitude", "name": "Latitude", "type": "string", "status": "mandatory", "description": "Latitude in degrees" }, { "path": "Data.Transaction[].GeoLocation.Longitude", "name": "Longitude", "type": "string", "status": "mandatory", "description": "Longitude in degrees" }, { "path": "Data.Transaction[].PaymentPurposeCode", "name": "PaymentPurposeCode", "type": "string", "pattern": "^[A-Z]{3}$", "minLength": 1, "maxLength": 3, "status": "optional", "description": "Aani purpose code that relates to the type of services or goods that corresponds to the underlying purpose of the payment. The code must conform to the published Aani payment purpose code list" }, { "path": "Data.Transaction[].IsPrimaryInstrument", "name": "IsPrimaryInstrument", "type": "boolean", "status": "optional", "description": "Indicates if the transaction is made with primary instrument." }, { "path": "Data.Transaction[].Allocations", "name": "Allocations", "type": "object", "status": "optional" }, { "path": "Data.Transaction[].Allocations.BalanceCategory", "name": "BalanceCategory", "type": "string", "enum": [ "Principal", "Interest", "FeesAndCharges", "PastDue", "Profit", "Rental" ], "status": "mandatory" }, { "path": "Data.Transaction[].Allocations.Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "The value of the categorized balance, incorporating `Amount` and `Currency`." }, { "path": "Data.Transaction[].Allocations.Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Transaction[].Allocations.Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" }, { "path": "Meta.FirstAvailableDateTime", "name": "FirstAvailableDateTime", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Meta.LastAvailableDateTime", "name": "LastAvailableDateTime", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" } ] }, "/accounts/{AccountId}/standing-orders": { "method": "GET", "summary": "Get Standing Orders", "operationId": "GetAccountsAccountIdStandingOrders", "schemaRef": "#/components/schemas/AEReadStandingOrder", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory", "description": "Primary data for the resource" }, { "path": "Data.AccountId", "name": "AccountId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "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)." }, { "path": "Data.StandingOrder", "name": "StandingOrder", "type": "array", "status": "mandatory" }, { "path": "Data.StandingOrder[]", "name": "StandingOrder[]", "type": "object", "status": "optional", "description": "Standing Orders for a specific AccountId" }, { "path": "Data.StandingOrder[].StandingOrderId", "name": "StandingOrderId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "description": "A unique and immutable identifier produced by the LFI to identify the account resource. This identifier has no meaning to the account owner." }, { "path": "Data.StandingOrder[].AccountHolderName", "name": "AccountHolderName", "type": "string", "status": "optional", "description": "* /accounts resource\nThe Account Holder Name is the name or names of the Account owner(s) represented at the account level\n\n* /accounts/{AccountId} resource\nThe Account Holder Name is the name or names of the Account owner(s) represented at the account level\n\n* /beneficiaries resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account. \n\n* /scheduled-payments resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account. \n\n* /standing-orders resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account.\n" }, { "path": "Data.StandingOrder[].AccountHolderShortName", "name": "AccountHolderShortName", "type": "string", "status": "optional", "description": "* /accounts resource\nThe Account holder nick name\n\n* /accounts/{AccountId} resource\nThe Account holder nick name\n\n* /beneficiaries resource\nThe Beneficiary account holder nick name\n\n* /scheduled-payments resource\nThe Beneficiary account holder nick name\n\n* /standing-orders resource\nThe Beneficiary account holder nick name\n" }, { "path": "Data.StandingOrder[].StandingOrderType", "name": "StandingOrderType", "type": "string", "enum": [ "BetweenMyAccounts", "SameBankTransfer", "LocalBankTransfer", "InternationalTransfer", "Charity" ], "status": "optional", "description": "The type of Standing Order." }, { "path": "Data.StandingOrder[].Frequency", "name": "Frequency", "type": "string", "minLength": 1, "maxLength": 35, "status": "mandatory", "description": "* The frequency that the Standing Order payments are executed from the User1s account. Encoded with allowable values as follows:\n\n* Individual Definitions:\nNotKnown - SO frequency is not known (i.e. not provided) \nEveryDay - SO frequency is Every day\nEveryWorkingDay - SO frequency is every working day \nIntervalDay - SO frequency is an interval specified in number of calendar days (2 to 31) \nIntervalWeekDay - SO frequency is an interval specified in weeks (1 to 51), and the day within the week (1 to 7) \nWeekInMonthDay - SO frequency is a monthly interval, specifying the week of the month (1 to 5) and day within the week (1 to 7) \nIntervalMonthDay - SO frequency is an interval specified in months (between 1 to 6, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) \nQuarterDay - SO frequency is quarterly RECEIVED\nBiAnnual - SO frequency is every 6 months\nAnnual - SO frequency is every year\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \n\n* Individual Patterns:\nNotKnown (ScheduleCode)\nEveryDay (ScheduleCode)\nEveryWorkingDay (ScheduleCode)\nIntervalDay:NoOfDay (ScheduleCode + NoOfDay)\nIntervalWeekDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWeekInMonthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntervalMonthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQuarterDay: + either (RECEIVED) ScheduleCode + QuarterDay\n\n* The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nNotKnown\nEveryDay\nEveryWorkingDay\nIntervalDay:(([2-9])|([1-2][0-9])|3[0-1])\nIntervalWeekDay:[1-51]:[1-7]\nWeekInMonthDay:[1-5]:[1-7]\nIntervalMonthDay:([1-6]|12|24):(-[1-5]|[1-9]|[12][0-9]|3[01])\nQuarterDay:(RECEIVED)\n\n* Full Regular Expression:\n^(NotKnown)$|^(EveryDay)$|^(EveryWorkingDay)$|^(IntervalDay:(([2-9])|([1-2][0-9])|3[0-1]))$|^(IntervalWeekDay:[1-51]:[1-7])$|^(WeekInMonthDay:[1-5]:[1-7])$|^(IntervalMonthDay:([1-6]|12|24):(-[1-5]|[1-9]|[12][0-9]|3[01]))$|^(QuarterDay:(RECEIVED))$\"\ntype: \"string\"\npattern: \"^(NotKnown)$|^(EveryDay)$|^(EveryWorkingDay)$|^(IntervalDay:(([2-9])|([1-2][0-9])|3[0-1]))$|^(IntervalWeekDay:[1-51]:[1-7])$|^(WeekInMonthDay:[1-5]:[1-7])$|^(IntervalMonthDay:([1-6]|12|24):(-[1-5]|[1-9]|[12][0-9]|3[01]))$|^(QuarterDay:(RECEIVED))$\"\n" }, { "path": "Data.StandingOrder[].CreditorReference", "name": "CreditorReference", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "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" }, { "path": "Data.StandingOrder[].Purpose", "name": "Purpose", "type": "string", "minLength": 1, "maxLength": 50, "status": "optional", "description": "The purpose of the Standing Order payment.\nA free format string in the form of transaction categorisation.\nExample: \"Bills and expenses\", \"Government payment\", \"Personal Expenses\".\n" }, { "path": "Data.StandingOrder[].FirstPaymentDateTime", "name": "FirstPaymentDateTime", "type": "string", "format": "date-time", "status": "mandatory", "description": "The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.StandingOrder[].NextPaymentDateTime", "name": "NextPaymentDateTime", "type": "string", "format": "date-time", "status": "optional", "description": "The date on which the next payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.StandingOrder[].LastPaymentDateTime", "name": "LastPaymentDateTime", "type": "string", "format": "date-time", "status": "optional", "description": "The date on which the last (most recent) payment for a Standing Order schedule was made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.StandingOrder[].FinalPaymentDateTime", "name": "FinalPaymentDateTime", "type": "string", "format": "date-time", "status": "optional", "description": "The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.StandingOrder[].NumberOfPayments", "name": "NumberOfPayments", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date." }, { "path": "Data.StandingOrder[].StandingOrderStatusCode", "name": "StandingOrderStatusCode", "type": "string", "enum": [ "Active", "Inactive" ], "status": "mandatory", "description": "Specifies the status of the standing order in code form." }, { "path": "Data.StandingOrder[].FirstPaymentAmount", "name": "FirstPaymentAmount", "type": "object", "status": "mandatory", "description": "The amount of the first Standing Order" }, { "path": "Data.StandingOrder[].FirstPaymentAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.StandingOrder[].FirstPaymentAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.StandingOrder[].NextPaymentAmount", "name": "NextPaymentAmount", "type": "object", "status": "optional", "description": "The amount of the next Standing Order." }, { "path": "Data.StandingOrder[].NextPaymentAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.StandingOrder[].NextPaymentAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.StandingOrder[].LastPaymentAmount", "name": "LastPaymentAmount", "type": "object", "status": "optional", "description": "The amount of the last (most recent) Standing Order instruction." }, { "path": "Data.StandingOrder[].LastPaymentAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.StandingOrder[].LastPaymentAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.StandingOrder[].FinalPaymentAmount", "name": "FinalPaymentAmount", "type": "object", "status": "optional", "description": "The amount of the final Standing Order" }, { "path": "Data.StandingOrder[].FinalPaymentAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.StandingOrder[].FinalPaymentAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.StandingOrder[].CreditorAgent", "name": "CreditorAgent", "type": "object", "status": "optional", "description": "Creditor Agent refers to the Financial Institution that manages the account on behalf of the scheduled payment 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.\n" }, { "path": "Data.StandingOrder[].CreditorAgent.SchemeName", "name": "SchemeName", "type": "string", "enum": [ "BICFI", "Other" ], "status": "mandatory", "description": "* /accounts resource \nThe name of the identification scheme for the LFI as the account services provider. Encoded with allowable value as published in an external list.\n\n* /beneficiaries resource \nRefers 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.\n\n* /scheduled-payments resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /standing-orders resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /transactions resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n" }, { "path": "Data.StandingOrder[].CreditorAgent.Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 35, "status": "mandatory", "description": "* /accounts resource\nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /beneficiaries resource\nUnique and unambiguous identification of the Creditor Agency as the servicing institution of the Beneficiary.\n\n* /scheduled-payments resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /standing-orders resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /transactions resource \n Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* Notes:\nBased on the value of the field **SchemeName**, this entry may be :\n* BICFI: The BIC/SWIFT Code \n* Other: Identifier based on non-SWIFT payment system or local market scheme.\n" }, { "path": "Data.StandingOrder[].CreditorAccount", "name": "CreditorAccount", "type": "array", "status": "optional" }, { "path": "Data.StandingOrder[].CreditorAccount[]", "name": "CreditorAccount[]", "type": "object", "status": "optional", "description": "Provides the details to identify the beneficiary account." }, { "path": "Data.StandingOrder[].CreditorAccount[].SchemeName", "name": "SchemeName", "type": "string", "enum": [ "IBAN", "AccountNumber", "MaskedPAN", "MobileNumber", "UtilityName", "EWallet" ], "status": "mandatory", "description": "Name of the identification scheme for the account. Encoded with allowable values published in an external list." }, { "path": "Data.StandingOrder[].CreditorAccount[].Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 400, "status": "mandatory", "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.\n" }, { "path": "Data.StandingOrder[].SupplementaryData", "name": "SupplementaryData", "type": "object", "status": "optional", "description": "Additional information that can not be captured in the structured fields and/or any other specific block." }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" } ] }, "/accounts/{AccountId}/direct-debits": { "method": "GET", "summary": "Get Direct Debits", "operationId": "GetAccountsAccountIdDirectDebits", "schemaRef": "#/components/schemas/AEReadDirectDebit", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory", "description": "Primary data for the resource" }, { "path": "Data.AccountId", "name": "AccountId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "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)." }, { "path": "Data.DirectDebit", "name": "DirectDebit", "type": "array", "status": "mandatory" }, { "path": "Data.DirectDebit[]", "name": "DirectDebit[]", "type": "object", "status": "optional", "description": "Account to or from which a cash entry is made." }, { "path": "Data.DirectDebit[].DirectDebitId", "name": "DirectDebitId", "type": "string", "minLength": 1, "maxLength": 256, "status": "mandatory", "description": "A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner." }, { "path": "Data.DirectDebit[].MandateIdentification", "name": "MandateIdentification", "type": "string", "minLength": 1, "maxLength": 35, "status": "mandatory", "description": "This is the unique and immutable reference to the User 1 for the Direct Debit mandate." }, { "path": "Data.DirectDebit[].DirectDebitStatusCode", "name": "DirectDebitStatusCode", "type": "string", "enum": [ "Active", "Inactive" ], "status": "mandatory", "description": "Specifies the status of the direct debit. Encoded with allowable values of: 'Active', 'Inactive'" }, { "path": "Data.DirectDebit[].Name", "name": "Name", "type": "string", "minLength": 1, "maxLength": 70, "status": "mandatory", "description": "This is the name of the regulated beneficiary entity that initiates the Direct Debit collection." }, { "path": "Data.DirectDebit[].Frequency", "name": "Frequency", "type": "string", "enum": [ "Annual", "Daily", "Fortnightly", "HalfYearly", "Monthly", "NotKnown", "Quarterly", "Weekly" ], "status": "mandatory", "description": "Specifies the frequency of the Direct Debit collections to the User 1 account." }, { "path": "Data.DirectDebit[].PreviousPaymentDateTime", "name": "PreviousPaymentDateTime", "type": "string", "format": "date-time", "status": "optional", "description": "The date of most recent direct debit collection to the User 1 account. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.DirectDebit[].PreviousPaymentAmount", "name": "PreviousPaymentAmount", "type": "object", "status": "optional", "description": "This is the value of the last direct debit collection from the User 1 account." }, { "path": "Data.DirectDebit[].PreviousPaymentAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.DirectDebit[].PreviousPaymentAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" } ] }, "/accounts/{AccountId}/beneficiaries": { "method": "GET", "summary": "Get Beneficiaries", "operationId": "GetAccountsAccountIdBeneficiaries", "schemaRef": "#/components/schemas/AEReadBeneficiary", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory", "description": "Primary data for the resource" }, { "path": "Data.AccountId", "name": "AccountId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "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)." }, { "path": "Data.Beneficiary", "name": "Beneficiary", "type": "array", "status": "mandatory" }, { "path": "Data.Beneficiary[]", "name": "Beneficiary[]", "type": "object", "status": "optional", "description": "Beneficiaries for a specific AccountId" }, { "path": "Data.Beneficiary[].BeneficiaryId", "name": "BeneficiaryId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "description": "A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner." }, { "path": "Data.Beneficiary[].BeneficiaryType", "name": "BeneficiaryType", "type": "string", "enum": [ "Activated", "NotActivated" ], "status": "mandatory", "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" }, { "path": "Data.Beneficiary[].AddedViaOF", "name": "AddedViaOF", "type": "boolean", "status": "mandatory", "description": "Indicates whether the Beneficiary record was created as part of an Open Finance (OF) payment. If false, the Beneficiary was created through an existing LFI channel." }, { "path": "Data.Beneficiary[].AccountHolderName", "name": "AccountHolderName", "type": "string", "status": "optional", "description": "* /accounts resource\nThe Account Holder Name is the name or names of the Account owner(s) represented at the account level\n\n* /accounts/{AccountId} resource\nThe Account Holder Name is the name or names of the Account owner(s) represented at the account level\n\n* /beneficiaries resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account. \n\n* /scheduled-payments resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account. \n\n* /standing-orders resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account.\n" }, { "path": "Data.Beneficiary[].AccountHolderShortName", "name": "AccountHolderShortName", "type": "string", "status": "optional", "description": "* /accounts resource\nThe Account holder nick name\n\n* /accounts/{AccountId} resource\nThe Account holder nick name\n\n* /beneficiaries resource\nThe Beneficiary account holder nick name\n\n* /scheduled-payments resource\nThe Beneficiary account holder nick name\n\n* /standing-orders resource\nThe Beneficiary account holder nick name\n" }, { "path": "Data.Beneficiary[].Reference", "name": "Reference", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "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" }, { "path": "Data.Beneficiary[].SupplementaryData", "name": "SupplementaryData", "type": "object", "status": "optional", "description": "Additional information that can not be captured in the structured fields and/or any other specific block." }, { "path": "Data.Beneficiary[].CreditorAgent", "name": "CreditorAgent", "type": "object", "status": "optional", "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.\nThis is the servicer of the beneficiary account." }, { "path": "Data.Beneficiary[].CreditorAgent.SchemeName", "name": "SchemeName", "type": "string", "enum": [ "BICFI", "Other" ], "status": "mandatory", "description": "* /accounts resource \nThe name of the identification scheme for the LFI as the account services provider. Encoded with allowable value as published in an external list.\n\n* /beneficiaries resource \nRefers 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.\n\n* /scheduled-payments resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /standing-orders resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /transactions resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n" }, { "path": "Data.Beneficiary[].CreditorAgent.Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 35, "status": "mandatory", "description": "* /accounts resource\nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /beneficiaries resource\nUnique and unambiguous identification of the Creditor Agency as the servicing institution of the Beneficiary.\n\n* /scheduled-payments resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /standing-orders resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /transactions resource \n Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* Notes:\nBased on the value of the field **SchemeName**, this entry may be :\n* BICFI: The BIC/SWIFT Code \n* Other: Identifier based on non-SWIFT payment system or local market scheme.\n" }, { "path": "Data.Beneficiary[].CreditorAgent.Name", "name": "Name", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "* Beneficiary\nName by which an agent is known and which is usually used to identify that agent\n\n* Creditor agent\nName by which the Financial institution(FI) which is the creditor is known and which is usually used to identify that FI.\n\n* DebtorAgent\nName by which an financial institution of the debtor is known and which is usually used to identify that financial institution.\n" }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress", "name": "PostalAddress", "type": "object", "status": "optional", "description": "Address properties based on ISO 20022 `PostalAddress27` definition" }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.AddressType", "name": "AddressType", "type": "string", "enum": [ "Billing", "Business", "Correspondence", "DeliveryTo", "MailTo", "POBox", "Postal", "Permanent", "Residential", "Statement", "Other" ], "status": "optional", "description": "The type of address. Omitted if type not held." }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.AddressLine", "name": "AddressLine", "type": "array", "status": "mandatory", "description": "Information that locates and identifies a specific address for a transaction entry, that is presented in free format text." }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.AddressLine[]", "name": "AddressLine[]", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional" }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.BuildingNumber", "name": "BuildingNumber", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The unit, apartment, or villa number within a building or community" }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.BuildingName", "name": "BuildingName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of the building or house." }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.Floor", "name": "Floor", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "Floor or storey within a building." }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.StreetName", "name": "StreetName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The name of the street or road where the property is located." }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.DistrictName", "name": "DistrictName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The district, community, or neighbourhood where the property is located." }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.PostBox", "name": "PostBox", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The P.O. Box number assigned to the recipient for mail delivery." }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.TownName", "name": "TownName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of a built-up area, such as a town or city." }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.CountrySubDivision", "name": "CountrySubDivision", "type": "string", "enum": [ "AbuDhabi", "Ajman", "Dubai", "Fujairah", "RasAlKhaimah", "Sharjah", "UmmAlQuwain" ], "status": "optional", "description": "Country subdivision, such as state or province. This is the Emirate where the address is registered." }, { "path": "Data.Beneficiary[].CreditorAgent.PostalAddress.Country", "name": "Country", "type": "string", "pattern": "^[A-Z]{2}$", "status": "mandatory", "description": "The country associated with the address, represented using the ISO 3166-1 alpha-2 country code." }, { "path": "Data.Beneficiary[].CreditorAccount", "name": "CreditorAccount", "type": "array", "status": "optional" }, { "path": "Data.Beneficiary[].CreditorAccount[]", "name": "CreditorAccount[]", "type": "object", "status": "optional", "description": "Provides the details to identify the beneficiary account." }, { "path": "Data.Beneficiary[].CreditorAccount[].SchemeName", "name": "SchemeName", "type": "string", "enum": [ "IBAN", "AccountNumber", "MaskedPAN", "MobileNumber", "UtilityName", "EWallet" ], "status": "mandatory", "description": "Name of the identification scheme for the account. Encoded with allowable values published in an external list." }, { "path": "Data.Beneficiary[].CreditorAccount[].Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 400, "status": "mandatory", "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.\n" }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" } ] }, "/accounts/{AccountId}/scheduled-payments": { "method": "GET", "summary": "Get Scheduled Payments", "operationId": "GetScheduledPayments", "schemaRef": "#/components/schemas/AEReadScheduledPayment", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory", "description": "Primary data for the resource" }, { "path": "Data.AccountId", "name": "AccountId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "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)." }, { "path": "Data.ScheduledPayment", "name": "ScheduledPayment", "type": "array", "status": "mandatory" }, { "path": "Data.ScheduledPayment[]", "name": "ScheduledPayment[]", "type": "object", "status": "optional", "description": "Scheduled Payments for a specific AccountId" }, { "path": "Data.ScheduledPayment[].ScheduledPaymentId", "name": "ScheduledPaymentId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "description": "A unique and immutable identifier produced by the LFI to identify the scheduled payment resource. This identifier has no meaning to the account owner." }, { "path": "Data.ScheduledPayment[].AccountHolderName", "name": "AccountHolderName", "type": "string", "status": "optional", "description": "* /accounts resource\nThe Account Holder Name is the name or names of the Account owner(s) represented at the account level\n\n* /accounts/{AccountId} resource\nThe Account Holder Name is the name or names of the Account owner(s) represented at the account level\n\n* /beneficiaries resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account. \n\n* /scheduled-payments resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account. \n\n* /standing-orders resource\nThe 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. \nNote, the Account Holder Name is not the product name or the nickname of the account.\n" }, { "path": "Data.ScheduledPayment[].AccountHolderShortName", "name": "AccountHolderShortName", "type": "string", "status": "optional", "description": "* /accounts resource\nThe Account holder nick name\n\n* /accounts/{AccountId} resource\nThe Account holder nick name\n\n* /beneficiaries resource\nThe Beneficiary account holder nick name\n\n* /scheduled-payments resource\nThe Beneficiary account holder nick name\n\n* /standing-orders resource\nThe Beneficiary account holder nick name\n" }, { "path": "Data.ScheduledPayment[].ScheduledType", "name": "ScheduledType", "type": "string", "enum": [ "Arrival", "Execution" ], "status": "mandatory", "description": "Specifies the type of scheduled payment date provided under ScheduledPaymentDateTime. \n Encoded with allowable values of:\n \"Arrival\" - User1 specifies the date for the arrival of funds in the beneficiary (Creditor) account\n \"Execution\" - User1 specifies the date which the payment needs to be executed from the User 1 (Debtor) account.\n" }, { "path": "Data.ScheduledPayment[].ScheduledPaymentDateTime", "name": "ScheduledPaymentDateTime", "type": "string", "format": "date-time", "status": "mandatory", "description": "Date (and time) information related to the scheduled payment (Arrival or Execution) based on the ScheduleType field. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.ScheduledPayment[].CreditorReference", "name": "CreditorReference", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "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" }, { "path": "Data.ScheduledPayment[].DebtorReference", "name": "DebtorReference", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "Reference in the context of the User 1 (i.e. the Debtor) to refer to the payment transaction. \nUsage: If available, the initiating party (i.e. Debtor) generates this reference for internal purposes (e.g. to enable reconciliation, refer to a PO, invoice etc). This field is captured by the LFI and is not transmitted via the payment rails to the Creditor of the payment.\n" }, { "path": "Data.ScheduledPayment[].InstructedAmount", "name": "InstructedAmount", "type": "object", "status": "mandatory", "description": "The amount of money that was moved between the User 1 (Debtor) and the payment beneficiary (Creditor) by the LFI, before adding any charges from the sending LFI.\nIt is expressed in the currency as ordered by the User 1 (i.e. the initiating party of the payment). This amount is transported unchanged through the transaction chain.\n" }, { "path": "Data.ScheduledPayment[].InstructedAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.ScheduledPayment[].InstructedAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.ScheduledPayment[].CreditorAgent", "name": "CreditorAgent", "type": "object", "status": "optional", "description": "Creditor Agent refers to the Financial Institution that manages the account on behalf of the scheduled payment 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.\n" }, { "path": "Data.ScheduledPayment[].CreditorAgent.SchemeName", "name": "SchemeName", "type": "string", "enum": [ "BICFI", "Other" ], "status": "mandatory", "description": "* /accounts resource \nThe name of the identification scheme for the LFI as the account services provider. Encoded with allowable value as published in an external list.\n\n* /beneficiaries resource \nRefers 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.\n\n* /scheduled-payments resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /standing-orders resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n\n* /transactions resource \nRefers to the identification scheme for uniquely identifying the Creditor Agent.\n" }, { "path": "Data.ScheduledPayment[].CreditorAgent.Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 35, "status": "mandatory", "description": "* /accounts resource\nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /beneficiaries resource\nUnique and unambiguous identification of the Creditor Agency as the servicing institution of the Beneficiary.\n\n* /scheduled-payments resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /standing-orders resource \nUnique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* /transactions resource \n Unique and unambiguous identification of the LFI as the account servicing institution for the Open Banking Services. \n\n* Notes:\nBased on the value of the field **SchemeName**, this entry may be :\n* BICFI: The BIC/SWIFT Code \n* Other: Identifier based on non-SWIFT payment system or local market scheme.\n" }, { "path": "Data.ScheduledPayment[].CreditorAccount", "name": "CreditorAccount", "type": "array", "status": "optional" }, { "path": "Data.ScheduledPayment[].CreditorAccount[]", "name": "CreditorAccount[]", "type": "object", "status": "optional", "description": "Provides the details to identify the beneficiary account." }, { "path": "Data.ScheduledPayment[].CreditorAccount[].SchemeName", "name": "SchemeName", "type": "string", "enum": [ "IBAN", "AccountNumber", "MaskedPAN", "MobileNumber", "UtilityName", "EWallet" ], "status": "mandatory", "description": "Name of the identification scheme for the account. Encoded with allowable values published in an external list." }, { "path": "Data.ScheduledPayment[].CreditorAccount[].Identification", "name": "Identification", "type": "string", "minLength": 1, "maxLength": 400, "status": "mandatory", "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.\n" }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" } ] }, "/accounts/{AccountId}/product": { "method": "GET", "summary": "Get Product for an Account", "operationId": "GetAccountsAccountIdProduct", "schemaRef": "#/components/schemas/AEReadProduct1", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory", "description": "Primary data for the resource" }, { "path": "Data.AccountId", "name": "AccountId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "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)." }, { "path": "Data.Product", "name": "Product", "type": "array", "status": "mandatory" }, { "path": "Data.Product[]", "name": "Product[]", "type": "object", "status": "optional", "description": "Set of elements used to define the product details." }, { "path": "Data.Product[].ShariaStructure", "name": "ShariaStructure", "type": "string", "enum": [ "Ijara", "ServiceIjara", "Murabaha", "Musharaka", "Tawarruq" ], "status": "optional", "description": "Provides the Islamic finance contract or structure type applied to a product when it has been confirmed as Sharia-compliant." }, { "path": "Data.Product[].Charges", "name": "Charges", "type": "array", "status": "optional", "description": "Fees and charges applicable to the account or product" }, { "path": "Data.Product[].Charges[]", "name": "Charges[]", "type": "object", "status": "optional", "description": "Properties of the charges applied" }, { "path": "Data.Product[].Charges[].Type", "name": "Type", "type": "string", "enum": [ "MonthlyFees", "AnnualFees", "BalanceFallBelow", "Overdraft", "DomesticTransaction", "ForeignTransaction", "ATMWithdrawal", "ChequeBook", "ReplacementChequeBook", "ReturnCheque", "CardReplacement", "AccountStatement", "LetterIssued", "AccountClosure", "CashAdvance", "LatePayment", "BalanceTransfer", "OverLimit", "SalesVoucherCopy", "Processing", "FinanceCancellation", "PartialPayment", "EarlySettlement", "FinalSettlement", "Other" ], "status": "optional", "description": "Type of charge." }, { "path": "Data.Product[].Charges[].Name", "name": "Name", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "description": "Name of the charge" }, { "path": "Data.Product[].Charges[].Description", "name": "Description", "type": "string", "status": "mandatory", "description": "Description of the fee, including purpose and applicability" }, { "path": "Data.Product[].Charges[].Charge", "name": "Charge", "type": "array", "status": "mandatory", "description": "Array of charge components including amount, currency, and applicable rate" }, { "path": "Data.Product[].Charges[].Charge[]", "name": "Charge[]", "type": "object", "status": "optional" }, { "path": "Data.Product[].Charges[].Charge[].Amount", "name": "Amount", "type": "object", "status": "optional", "description": "This is the value of the last direct debit collection from the User 1 account." }, { "path": "Data.Product[].Charges[].Charge[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Product[].Charges[].Charge[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Product[].Charges[].Charge[].Rate", "name": "Rate", "type": "number", "status": "optional", "description": "Specifies the percentage rate applied when the charge is calculated as a percentage rather than as a fixed monetary amount." }, { "path": "Data.Product[].Charges[].Charge[].ApplicationFrequency", "name": "ApplicationFrequency", "type": "string", "enum": [ "Monthly", "Daily" ], "status": "optional", "description": "Frequency at which reward, interest, or profit is applied, such as monthly or quarterly, including Islamic profit distribution" }, { "path": "Data.Product[].Charges[].Charge[].InterestCalculationMethod", "name": "InterestCalculationMethod", "type": "string", "enum": [ "PrincipalBalance", "OutstandingBalance", "InitialDrawdownAmount" ], "status": "optional", "description": "Method used to calculate interest or profit, such as based on principal or drawdown, including Islamic calculation methods" }, { "path": "Data.Product[].Charges[].Charge[].MaximumChargeAmount", "name": "MaximumChargeAmount", "type": "object", "status": "optional", "description": "Defines the maximum monetary amount that can be applied when a percentage-based charge calculation would otherwise exceed this limit." }, { "path": "Data.Product[].Charges[].Charge[].MaximumChargeAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Product[].Charges[].Charge[].MaximumChargeAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Product[].Charges[].Charge[].Basis", "name": "Basis", "type": "string", "status": "optional", "description": "Confirmation of what the charge is based on and calculated against." }, { "path": "Data.Product[].Charges[].Conditions", "name": "Conditions", "type": "array", "status": "optional", "description": "Array of conditions that trigger the fee" }, { "path": "Data.Product[].Charges[].Conditions[]", "name": "Conditions[]", "type": "object", "status": "optional" }, { "path": "Data.Product[].Charges[].Conditions[].Field", "name": "Field", "type": "string", "status": "optional", "description": "Field in the product spec that the condition applies to" }, { "path": "Data.Product[].Charges[].Conditions[].Operator", "name": "Operator", "type": "string", "status": "optional", "description": "Logical operator used in the condition (e.g., ==, >, <=, !=)" }, { "path": "Data.Product[].Charges[].Conditions[].Value", "name": "Value", "type": "string", "status": "optional", "description": "Value used in the condition" }, { "path": "Data.Product[].Charges[].Conditions[].Description", "name": "Description", "type": "string", "status": "mandatory", "description": "Description of the fee, including purpose and applicability" }, { "path": "Data.Product[].Charges[].Justification", "name": "Justification", "type": "string", "status": "optional", "description": "Reasoning or business logic behind the imposition of the fee" }, { "path": "Data.Product[].Charges[].Frequency", "name": "Frequency", "type": "string", "status": "optional", "description": "Frequency or trigger logic for the reward or fee, such as monthly if balance < 1000, or periodic Hibah distribution" }, { "path": "Data.Product[].Charges[].DonatedToCharity", "name": "DonatedToCharity", "type": "boolean", "status": "optional", "description": "Confirmation if the charge will be donated to charity when the product is Sharia compliant" }, { "path": "Data.Product[].Charges[].Notes", "name": "Notes", "type": "string", "minLength": 1, "maxLength": 500, "status": "optional", "description": "Additional notes or clarifications about the rate structure" }, { "path": "Data.Product[].Charges[].SupplementaryInformation", "name": "SupplementaryInformation", "type": "object", "status": "optional", "description": "Optional object for supplementary metadata, such as Sharia compliance notes or reward history" }, { "path": "Data.Product[].FinanceRates", "name": "FinanceRates", "type": "object", "status": "optional", "description": "Properties of a fixed rate associated with all or part of a product." }, { "path": "Data.Product[].FinanceRates.Description", "name": "Description", "type": "string", "status": "optional", "description": "Description of the rate." }, { "path": "Data.Product[].FinanceRates.Rate", "name": "Rate", "type": "number", "status": "optional", "description": "Value of the rate." }, { "path": "Data.Product[].FinanceRates.FixedRateEndDate", "name": "FixedRateEndDate", "type": "string", "format": "date", "status": "optional", "description": "End date for the fixed rate period." }, { "path": "Data.Product[].FinanceRates.CalculationFrequency", "name": "CalculationFrequency", "type": "unknown", "status": "optional", "description": "Describes how often the interest rate is calculated" }, { "path": "Data.Product[].FinanceRates.CalculationFrequency", "name": "CalculationFrequency", "type": "string", "enum": [ "Monthly", "Daily", "Quarterly", "Annually" ], "status": "optional" }, { "path": "Data.Product[].FinanceRates.ApplicationFrequency", "name": "ApplicationFrequency", "type": "unknown", "status": "optional", "description": "Describes how often the rate is charged, especially in relation to the conditions or triggers (e.g., monthly, one-off, or on each trigger)" }, { "path": "Data.Product[].FinanceRates.ApplicationFrequency", "name": "ApplicationFrequency", "type": "string", "enum": [ "Monthly", "Daily", "Quarterly", "Annually" ], "status": "optional" }, { "path": "Data.Product[].FinanceRates", "name": "FinanceRates", "type": "object", "status": "optional" }, { "path": "Data.Product[].FinanceRates.InterestCalculationMethod", "name": "InterestCalculationMethod", "type": "string", "enum": [ "PrincipalBalance", "OutstandingBalance", "InitialDrawdownAmount" ], "status": "optional", "description": "Method used to calculate interest or profit, depending on the product type" }, { "path": "Data.Product[].FinanceRates", "name": "FinanceRates", "type": "object", "status": "optional", "description": "Details of the annual percentage rate" }, { "path": "Data.Product[].FinanceRates.AnnualPercentageRate", "name": "AnnualPercentageRate", "type": "object", "status": "optional", "description": "The annual percentage rate for the product." }, { "path": "Data.Product[].FinanceRates.AnnualPercentageRate.StartingFrom", "name": "StartingFrom", "type": "unknown", "status": "optional", "description": "The starting annual percentage rate." }, { "path": "Data.Product[].FinanceRates.AnnualPercentageRate.UpTo", "name": "UpTo", "type": "number", "status": "optional", "description": "The maximum annual percentage rate." }, { "path": "Data.Product[].FinanceRates.AnnualPercentageRate.AdditionalInformation", "name": "AdditionalInformation", "type": "string", "status": "optional", "description": "Additional notes or clarifications about the annual percentage rate." }, { "path": "Data.Product[].FinanceRates.Tiers", "name": "Tiers", "type": "array", "status": "optional", "description": "The tiers of the finance profit rate product." }, { "path": "Data.Product[].FinanceRates.Tiers[]", "name": "Tiers[]", "type": "object", "status": "optional", "description": "The tier of the finance profit rate product." }, { "path": "Data.Product[].FinanceRates.Tiers[].Name", "name": "Name", "type": "string", "status": "mandatory", "description": "The name of the tier." }, { "path": "Data.Product[].FinanceRates.Tiers[].Unit", "name": "Unit", "type": "string", "enum": [ "Balance", "LTV", "Rate" ], "status": "mandatory", "description": "The unit of the tier." }, { "path": "Data.Product[].FinanceRates.Tiers[].ApplicationMethod", "name": "ApplicationMethod", "type": "string", "enum": [ "PerTier", "WholeBalance" ], "status": "optional", "description": "Specifies whether the tier rate is applied only to the balance within the defined balance band or to the customers entire balance once that tier level is reached." }, { "path": "Data.Product[].FinanceRates.Tiers[].BalanceTierDetails", "name": "BalanceTierDetails", "type": "array", "status": "optional", "description": "Required when `Unit` is set to `Balance`. Describes balance tier range values." }, { "path": "Data.Product[].FinanceRates.Tiers[].BalanceTierDetails[]", "name": "BalanceTierDetails[]", "type": "object", "status": "optional" }, { "path": "Data.Product[].FinanceRates.Tiers[].BalanceTierDetails[].MinimumTierValue", "name": "MinimumTierValue", "type": "object", "status": "optional", "description": "This is the value of the last direct debit collection from the User 1 account." }, { "path": "Data.Product[].FinanceRates.Tiers[].BalanceTierDetails[].MinimumTierValue.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Product[].FinanceRates.Tiers[].BalanceTierDetails[].MinimumTierValue.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Product[].FinanceRates.Tiers[].BalanceTierDetails[].MaximumTierValue", "name": "MaximumTierValue", "type": "object", "status": "optional", "description": "This is the value of the last direct debit collection from the User 1 account." }, { "path": "Data.Product[].FinanceRates.Tiers[].BalanceTierDetails[].MaximumTierValue.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Product[].FinanceRates.Tiers[].BalanceTierDetails[].MaximumTierValue.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Product[].FinanceRates.Tiers[].BalanceTierDetails[].TierRate", "name": "TierRate", "type": "number", "status": "optional", "description": "The tier rate." }, { "path": "Data.Product[].FinanceRates.Tiers[].LTVTierDetails", "name": "LTVTierDetails", "type": "array", "status": "optional", "description": "Required when `Unit` is set to `LTV`. Defines the interest rate or profit rate applicable to each Loan-to-Value (LTV) range where different rates apply." }, { "path": "Data.Product[].FinanceRates.Tiers[].LTVTierDetails[]", "name": "LTVTierDetails[]", "type": "object", "status": "optional" }, { "path": "Data.Product[].FinanceRates.Tiers[].LTVTierDetails[].LTVStart", "name": "LTVStart", "type": "number", "status": "optional", "description": "Start rate for LTV Tier" }, { "path": "Data.Product[].FinanceRates.Tiers[].LTVTierDetails[].LTVEnd", "name": "LTVEnd", "type": "number", "status": "optional", "description": "End rate for LTV Tier" }, { "path": "Data.Product[].FinanceRates.Tiers[].LTVTierDetails[].TierRate", "name": "TierRate", "type": "number", "status": "optional", "description": "The tier rate." }, { "path": "Data.Product[].FinanceRates.Tiers[].RateRange", "name": "RateRange", "type": "object", "status": "optional", "description": "Required when `Unit` is set to `Rate`. Defines the minimum and maximum interest rate or profit rate range that a customer may be eligibility for, depending on factors such as their credit score, income, etc." }, { "path": "Data.Product[].FinanceRates.Tiers[].RateRange.MinimumRate", "name": "MinimumRate", "type": "number", "status": "optional", "description": "Minimum rate range" }, { "path": "Data.Product[].FinanceRates.Tiers[].RateRange.MaximumRate", "name": "MaximumRate", "type": "number", "status": "optional", "description": "Maximum rate range" }, { "path": "Data.Product[].FinanceRates.Tiers[].RateRange.AdditionalInformation", "name": "AdditionalInformation", "type": "string", "status": "optional", "description": "Additional information on rate range" }, { "path": "Data.Product[].FinanceRates.Conditions", "name": "Conditions", "type": "array", "status": "optional", "description": "A set of conditions under which the finance rate applies." }, { "path": "Data.Product[].FinanceRates.Conditions[]", "name": "Conditions[]", "type": "object", "status": "optional" }, { "path": "Data.Product[].FinanceRates.Conditions[].Field", "name": "Field", "type": "string", "status": "optional", "description": "Field in the product spec that the condition applies to" }, { "path": "Data.Product[].FinanceRates.Conditions[].Operator", "name": "Operator", "type": "string", "status": "optional", "description": "Logical operator used in the condition (e.g., ==, >, <=, !=)" }, { "path": "Data.Product[].FinanceRates.Conditions[].Value", "name": "Value", "type": "string", "status": "optional", "description": "Value used in the condition" }, { "path": "Data.Product[].FinanceRates.Conditions[].Description", "name": "Description", "type": "string", "status": "mandatory", "description": "Description of the fee, including purpose and applicability" }, { "path": "Data.Product[].FinanceRates.Notes", "name": "Notes", "type": "string", "minLength": 1, "maxLength": 500, "status": "optional", "description": "Additional notes or clarifications about the rate structure/charge" }, { "path": "Data.Product[].FinanceRates.AdditionalInformation", "name": "AdditionalInformation", "type": "array", "status": "optional", "description": "The additional information of the finance profit rate product." }, { "path": "Data.Product[].FinanceRates.AdditionalInformation[]", "name": "AdditionalInformation[]", "type": "object", "status": "optional" }, { "path": "Data.Product[].FinanceRates.AdditionalInformation[].Type", "name": "Type", "type": "string", "enum": [ "Other" ], "status": "optional", "description": "The type of additional information." }, { "path": "Data.Product[].FinanceRates.AdditionalInformation[].Description", "name": "Description", "type": "string", "status": "optional", "description": "The description of the additional information." }, { "path": "Data.Product[].DepositRates", "name": "DepositRates", "type": "object", "status": "optional" }, { "path": "Data.Product[].DepositRates.RateType", "name": "RateType", "type": "string", "enum": [ "FixedInterest", "FixedProfit", "VariableInterest", "VariableProfit" ], "status": "mandatory", "description": "The deposit rate type" }, { "path": "Data.Product[].DepositRates.RateDetails", "name": "RateDetails", "type": "array", "status": "mandatory", "description": "Details of the deposit rates" }, { "path": "Data.Product[].DepositRates.RateDetails[]", "name": "RateDetails[]", "type": "object", "status": "optional", "description": "Details of the fixed or variable rates that are available to the customer or is applicable to the customers product." }, { "path": "Data.Product[].DepositRates.RateDetails[].RateCategory", "name": "RateCategory", "type": "string", "enum": [ "Applied", "Standard", "Bonus", "Introductory", "Other" ], "status": "optional", "description": "Confirmation what the rate relates to." }, { "path": "Data.Product[].DepositRates.RateDetails[].AnnualRate", "name": "AnnualRate", "type": "number", "status": "optional", "description": "The annual rate applied when a single rate is applicable." }, { "path": "Data.Product[].DepositRates.RateDetails[].AnnualRateRange", "name": "AnnualRateRange", "type": "object", "status": "optional", "description": "When a rate range applies" }, { "path": "Data.Product[].DepositRates.RateDetails[].AnnualRateRange.MinRate", "name": "MinRate", "type": "number", "status": "optional", "description": "The minimum rate that could apply" }, { "path": "Data.Product[].DepositRates.RateDetails[].AnnualRateRange.MaxRate", "name": "MaxRate", "type": "number", "status": "optional", "description": "The maximum rate that could apply" }, { "path": "Data.Product[].DepositRates.RateDetails[].Tier", "name": "Tier", "type": "object", "status": "optional", "description": "Applicable when a rate applies to a balance tier or band." }, { "path": "Data.Product[].DepositRates.RateDetails[].Tier.MinBalance", "name": "MinBalance", "type": "string", "status": "optional", "description": "The minimum tier or band balance." }, { "path": "Data.Product[].DepositRates.RateDetails[].Tier.MaxBalance", "name": "MaxBalance", "type": "string", "status": "optional", "description": "The maximum tier or band balance." }, { "path": "Data.Product[].DepositRates.RateDetails[].Tier.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "optional", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Product[].DepositRates.RateDetails[].Term", "name": "Term", "type": "string", "format": "duration", "pattern": "^P(\\d+Y)?(\\d+M)?$", "status": "optional", "description": "A period of time implemented using ISO 8601 compatible duration format" }, { "path": "Data.Product[].DepositRates.RateDetails[].EffectiveDate", "name": "EffectiveDate", "type": "string", "format": "date", "status": "optional", "description": "When applicable, the date when the bonus or introductory rate will be expire." }, { "path": "Data.Product[].DepositRates.RateDetails[].ExpiryDate", "name": "ExpiryDate", "type": "string", "format": "date", "status": "optional", "description": "When applicable, the date when the bonus or introductory rate is effective from." }, { "path": "Data.Product[].DepositRates.RateDetails[].CalculationMethod", "name": "CalculationMethod", "type": "string", "enum": [ "DailyClosingBalance", "MinimumMonthlyBalance", "AverageDailyBalance", "AverageMonthlyBalance", "AccountOpeningBalance", "NotApplicable", "Other" ], "status": "optional", "description": "The balance used to calculate the interest or profit." }, { "path": "Data.Product[].DepositRates.RateDetails[].CalculationFrequency", "name": "CalculationFrequency", "type": "string", "enum": [ "Monthly", "Daily", "Quarterly", "HalfYearly", "Annually", "NotApplicable" ], "status": "optional", "description": "The frequency the interest or profit is calculated." }, { "path": "Data.Product[].DepositRates.RateDetails[].ApplicationFrequency", "name": "ApplicationFrequency", "type": "string", "enum": [ "Monthly", "Daily", "Quarterly", "HalfYearly", "Annually", "NotApplicable" ], "status": "optional", "description": "When the interest or profit is applied to the account." }, { "path": "Data.Product[].DepositRates.RateDetails[].Notes", "name": "Notes", "type": "string", "status": "optional", "description": "Additional free-text notes." }, { "path": "Data.Product[].IsSecured", "name": "IsSecured", "type": "boolean", "status": "optional", "description": "Indicates if the product is secured by collateral." }, { "path": "Data.Product[].IsSalaryTransferRequired", "name": "IsSalaryTransferRequired", "type": "boolean", "status": "optional", "description": "Indicates whether salary transfer is required as part of the product eligibility or approval conditions. Common for salary-assigned lending products." }, { "path": "Data.Product[].Tenor", "name": "Tenor", "type": "object", "status": "optional", "description": "Product tenor" }, { "path": "Data.Product[].Tenor.OriginalTenor", "name": "OriginalTenor", "type": "string", "format": "duration", "pattern": "^P(\\d+Y)?(\\d+M)?$", "status": "optional", "description": "A period of time implemented using ISO 8601 compatible duration format" }, { "path": "Data.Product[].Tenor.RemainingTenor", "name": "RemainingTenor", "type": "string", "format": "duration", "pattern": "^P(\\d+Y)?(\\d+M)?$", "status": "optional", "description": "A period of time implemented using ISO 8601 compatible duration format" }, { "path": "Data.Product[].AssetBacked", "name": "AssetBacked", "type": "array", "status": "optional", "description": "Array containing details of collateral required or pledged for the product" }, { "path": "Data.Product[].AssetBacked[]", "name": "AssetBacked[]", "type": "object", "status": "optional" }, { "path": "Data.Product[].AssetBacked[].Type", "name": "Type", "type": "string", "enum": [ "Collateral", "OwnershipTransfer" ], "status": "mandatory", "description": "Defines how the financed asset is treated as security. Use `Collateral`` when the asset is owned by the customer and pledged as security. Use `OwnershipTransfer`` when the asset is owned by the bank and will be transferred to the customer under Islamic finance structures at the end of the finance." }, { "path": "Data.Product[].AssetBacked[].AssetType", "name": "AssetType", "type": "string", "enum": [ "Property", "SalaryAssignment", "EndOfServiceGratuity", "SalaryAndGratuityAssignment", "FixedDepositLien", "Vehicle", "TakafulPolicy", "Rahn", "PostDatedCheque", "Other" ], "status": "mandatory", "description": "Defines the specific category of collateral pledged to secure a financial product, applicable across both conventional and Islamic finance structures. This field classifies the nature of the asset or guarantee—such as real estate, salary assignment, or vehicle lien—used to mitigate credit risk and support underwriting decisions." }, { "path": "Data.Product[].AssetBacked[].Description", "name": "Description", "type": "string", "status": "mandatory", "description": "Provides a free-text explanation or contextual detail about the collateral pledged to secure a financial product. This may include asset characteristics, legal references, or contractual notes relevant to underwriting and risk assessment." }, { "path": "Data.Product[].AssetBacked[].Valuation", "name": "Valuation", "type": "array", "status": "optional" }, { "path": "Data.Product[].AssetBacked[].Valuation[]", "name": "Valuation[]", "type": "object", "status": "optional" }, { "path": "Data.Product[].AssetBacked[].Valuation[].Date", "name": "Date", "type": "string", "format": "date", "status": "optional", "description": "Date of the valuation." }, { "path": "Data.Product[].AssetBacked[].Valuation[].Amount", "name": "Amount", "type": "object", "status": "optional", "description": "This is the value of the last direct debit collection from the User 1 account." }, { "path": "Data.Product[].AssetBacked[].Valuation[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Product[].AssetBacked[].Valuation[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Product[].AssetBacked[].SupplementaryInformation", "name": "SupplementaryInformation", "type": "object", "status": "optional", "description": "Additional data or metadata not captured in the main fields, to provide further context." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer", "name": "OwnershipTransfer", "type": "object", "status": "optional", "description": "Details on how the asset will be transferred from the LFI to the customer." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.TransferOfOwnershipDate", "name": "TransferOfOwnershipDate", "type": "string", "format": "date", "status": "optional", "description": "Expected date when ownership will be transferred to the customer" }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.Type", "name": "Type", "type": "string", "enum": [ "Gift", "TokenPurchase", "Gradual", "SeparateSaleContract" ], "status": "mandatory", "description": "Method of ownership transfer." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.Method", "name": "Method", "type": "string", "enum": [ "EndOfLease", "Buyouts" ], "status": "optional", "description": "The event that triggers the ownership transfer event." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.TokenPurchaseAmount", "name": "TokenPurchaseAmount", "type": "object", "status": "optional", "description": "The amount and currency to be paid by the customer to the LFI at token purchase. Required when `Type` is `TokenPurchase`." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.TokenPurchaseAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.TokenPurchaseAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.BuyoutSchedule", "name": "BuyoutSchedule", "type": "object", "status": "optional", "description": "Amount and currency to be paid each period by the customer to buy out the bank's share. Applies to Diminishing Musharaka Islamic finance products. Required when `Type` is `Gradual`." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.BuyoutSchedule.Frequency", "name": "Frequency", "type": "string", "enum": [ "Weekly", "Fortnightly", "Monthly", "Quarterly", "HalfYearly", "Annual", "Other" ], "status": "mandatory", "description": "The frequency of the payments made by the customer to buy out the bank's share." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.BuyoutSchedule.BuyoutAmount", "name": "BuyoutAmount", "type": "object", "status": "mandatory", "description": "The buyout amount the customer must pay during each period." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.BuyoutSchedule.BuyoutAmount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.BuyoutSchedule.BuyoutAmount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.SaleAgreement", "name": "SaleAgreement", "type": "object", "status": "optional", "description": "Confirm the details of the sale contract to be executed after lease completion. Required when `Type` is `SeparateSaleContract`." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.SaleAgreement.Required", "name": "Required", "type": "boolean", "status": "mandatory", "description": "Boolean indicator to confirm whether a formal sale agreement is required for ownership transfer." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.SaleAgreement.Execution", "name": "Execution", "type": "string", "enum": [ "AtLeaseCompletion", "CustomerRequestPostLease" ], "status": "optional", "description": "Specifies when the sale contract is executed." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.SaleAgreement.Price", "name": "Price", "type": "object", "status": "optional", "description": "Represents the nominal or token purchase price agreed for the final transfer of the property." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.SaleAgreement.Price.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.SaleAgreement.Price.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.TransferConditions", "name": "TransferConditions", "type": "array", "status": "optional", "description": "Conditions that must be met before ownership can be transferred to the customer. The following\nvalues are allowed:\n\n* `AllLeasePaymentsCompleted``: All lease obligations must be fulfilled before the sale contract \n is executed.\n\n* `CustomerRequestRequired`: The customer must formally request the transfer of ownership via a \n gift after completing all lease payments. Applicable when the `Type` is `Gift`.\n\n* `SaleAgreementExecuted`: A separate sale agreement must be formally executed between the bank \n and the customer to transfer ownership at the end of the lease term. Applicable when the \n `Type` is `TokenPurchase`.\n\n* `AllBuyoutsCompleted`: Included when the customer has purchased all the banks shares in the \n property. Applicable when the `Type` is `Gradual`.\n\n* `IndependentSaleContractSigned`: A separate sale agreement must be signed before the legal \n transfer of ownership can be completed. Applicable when the `Type` is `SeparateSaleContract`.\n" }, { "path": "Data.Product[].AssetBacked[].OwnershipTransfer.TransferConditions[]", "name": "TransferConditions[]", "type": "string", "enum": [ "AllLeasePaymentsCompleted", "CustomerRequestRequired", "SaleAgreementExecuted", "AllBuyoutsCompleted", "IndependentSaleContractSigned" ], "status": "optional" }, { "path": "Data.Product[].RewardsBenefits", "name": "RewardsBenefits", "type": "array", "status": "optional", "description": "List of benefits and rewards associated with a product." }, { "path": "Data.Product[].RewardsBenefits[]", "name": "RewardsBenefits[]", "type": "object", "status": "optional", "description": "Rewards applicable to the banking product with confirmation of the current balance when applicable." }, { "path": "Data.Product[].RewardsBenefits[].Name", "name": "Name", "type": "string", "status": "mandatory", "description": "Name of the reward or benefit program." }, { "path": "Data.Product[].RewardsBenefits[].Description", "name": "Description", "type": "string", "status": "optional", "description": "Description of the reward or benefit program." }, { "path": "Data.Product[].RewardsBenefits[]", "name": "RewardsBenefits[]", "type": "object", "status": "optional", "description": "Cashback benefit or reward." }, { "path": "Data.Product[].RewardsBenefits[].Type", "name": "Type", "type": "string", "enum": [ "Cashback" ], "status": "mandatory" }, { "path": "Data.Product[].RewardsBenefits[].Balance", "name": "Balance", "type": "object", "status": "optional", "description": "This is the value of the last direct debit collection from the User 1 account." }, { "path": "Data.Product[].RewardsBenefits[].Balance.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Product[].RewardsBenefits[].Balance.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Product[].RewardsBenefits[].RewardBasis", "name": "RewardBasis", "type": "array", "status": "optional", "description": "Details how cashback can be earned by the customer." }, { "path": "Data.Product[].RewardsBenefits[].RewardBasis[]", "name": "RewardBasis[]", "type": "string", "status": "optional" }, { "path": "Data.Product[].RewardsBenefits[].FrequencyPaid", "name": "FrequencyPaid", "type": "string", "enum": [ "Daily", "Weekly", "Monthly", "Quarterly", "HalfYearly", "Annually", "UponRequest", "Other" ], "status": "optional", "description": "When the Cashback is paid to the customer." }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" } ] }, "/accounts/{AccountId}/parties": { "method": "GET", "summary": "Get Parties for an Account", "operationId": "PartiesByAccountId_read", "schemaRef": "#/components/schemas/AEReadParty2", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory", "description": "Primary data for the resource" }, { "path": "Data.AccountId", "name": "AccountId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "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)." }, { "path": "Data.Party", "name": "Party", "type": "array", "status": "mandatory" }, { "path": "Data.Party[]", "name": "Party[]", "type": "object", "status": "optional", "description": "Party Identity Assurance (Response) Schema \nBased on the [OpenID Connect for Identity Assurance 1.0 Specification](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html)\n" }, { "path": "Data.Party[].PartyId", "name": "PartyId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "description": "A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner." }, { "path": "Data.Party[].PartyNumber", "name": "PartyNumber", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "Number assigned by an agent to identify its customer." }, { "path": "Data.Party[].PartyType", "name": "PartyType", "type": "string", "enum": [ "Delegate", "Joint", "Sole" ], "status": "mandatory", "description": "Specifies the party type.\nEncoded with allowable values: \n\"Delegate\" - Used for business accounts when user has delegated authority to access the account , \n\"Joint\" - Party is a joint owner of the account \n\"Sole\" - Party is the sole owner of the account\n" }, { "path": "Data.Party[].PartyCategory", "name": "PartyCategory", "type": "string", "enum": [ "Retail", "SME", "Corporate" ], "status": "mandatory", "description": "Category of Party" }, { "path": "Data.Party[].AccountRole", "name": "AccountRole", "type": "string", "enum": [ "Administrator", "Beneficiary", "CustodianForMinor", "Granter", "LegalGuardian", "OtherParty", "PowerOfAttorney", "Principal", "Protector", "RegisteredShareholderName", "SecondaryOwner", "SeniorManagingOfficial", "Settlor", "SuccessorOnDeath" ], "status": "mandatory", "description": "Specifies the Party's role with respect to the related account. Allowed values \nare defined based on ISO 20022 definitions as follows:\n\n - Administrator: The party that administers the account and is not the \n account owner.\n - Beneficiary: Ultimate party that is entitled to either receive the benefits \n of the ownership of the account.\n - CustodianForMinor: Entity that holds the account on behalf of a legal \n minor. Although the account is registered under the name of the minor, \n the custodian retains control of the account.\n - Granter: Granter role in the hedge funds industry.\n - LegalGuardian: Party that has been appointed by a legal authority to act on \n behalf of a person judged to be incapacitated.\n - OtherParty: An other type of party. Used when a given account role cannot \n be mapped to the role defined at the LFI.\n - PowerOfAttorney: Power of attorney which is held by the party.\n - Principal: Party acts as principal for the account for trading purposes.\n - Protector: Person appointed under a trust instrument to direct or \n restrain the trustees in relation to their administration of an account \n held in trust. \n - RegisteredShareholderName: Party for which shares are to be registered,\n for share holding accounts only.\n - SecondaryOwner: Entity that is not the primary owner when the ownership of \n an investment account is split among several owners.\n - SeniorManagingOfficial: Party that makes, or participates in the making of, \n decisions that affect the whole, or a substantial part, of the business of \n a customer of a reporting entity or that has the capacity to affect \n significantly the financial standing of a customer of a reporting entity.\n - Settlor: Entity that creates a trust or contributes assets to the trust.\n - SuccessorOnDeath: Deceased's estate, or successor, to whom account \n ownership will be transferred upon the death of one of the \n owners.\n" }, { "path": "Data.Party[].VerifiedClaims", "name": "VerifiedClaims", "type": "array", "status": "mandatory", "description": "Container object containing entries for the trust framework and the evidence used to verify the claims" }, { "path": "Data.Party[].VerifiedClaims[]", "name": "VerifiedClaims[]", "type": "object", "status": "optional", "description": "Verified Claims\nContainer object containing entries for the trust framework and the evidence used to verify the claims\n[https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-representing-verified-claim](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-representing-verified-claim)\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification", "name": "Verification", "type": "object", "status": "optional", "description": "Verification\n[https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-verification-element](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-verification-element)\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.TrustFramework", "name": "TrustFramework", "type": "string", "enum": [ "Undefined" ], "status": "mandatory", "description": "Identifies the trust framework used for verification. This consists of a set of rules and standards and sets out requirements so that organisations know what ‘good’ identity verification looks like.\nTrust Frameworks: [https://bitbucket.org/openid/ekyc-ida/wiki/identifiers](https://bitbucket.org/openid/ekyc-ida/wiki/identifiers)" }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceLevel", "name": "AssuranceLevel", "type": "string", "status": "optional", "description": "Determines the assurance level associated with the User in the respective VerifiedClaims. The value range depends on the respective TrustFramework value.\nAssurance Level: [https://bitbucket.org/openid/ekyc-ida/wiki/identifiers](https://bitbucket.org/openid/ekyc-ida/wiki/identifiers)\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess", "name": "AssuranceProcess", "type": "object", "status": "optional", "description": "Determines the assurance process that was followed. This reflects how the evidence meets the requirements of the TrustFramework and AssuranceLevel. The factual record of the evidence and the procedures followed are recorded in the evidence element, this element is used to cross reference the evidence to the AssuranceLevel followed\nOpenID Connect for Identity Assurance 1.0: [https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-verification-element](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-verification-element) \n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.Policy", "name": "Policy", "type": "string", "status": "mandatory", "description": "Representing the standard or policy that was followed." }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.Procedure", "name": "Procedure", "type": "string", "status": "mandatory", "description": "Representing a specific procedure from the policy that was followed." }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails", "name": "AssuranceDetails", "type": "array", "status": "mandatory" }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[]", "name": "AssuranceDetails[]", "type": "object", "status": "optional", "description": "Denoting the details about how the evidence complies with the policy" }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].AssuranceType", "name": "AssuranceType", "type": "string", "status": "mandatory", "description": "String denoting which part of the assurance_process the evidence fulfils" }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].AssuranceClassification", "name": "AssuranceClassification", "type": "string", "status": "mandatory", "description": "String reflecting how the evidence has been classified or measured as required by the TrustFramework" }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].EvidenceRef", "name": "EvidenceRef", "type": "array", "status": "mandatory" }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].EvidenceRef[]", "name": "EvidenceRef[]", "type": "object", "status": "optional", "description": "Evidence being referred to" }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].EvidenceRef[].Txn", "name": "Txn", "type": "string", "status": "mandatory", "description": "Identifier referring to the txn used in the CheckDetails." }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].EvidenceRef[].EvidenceMetadata", "name": "EvidenceMetadata", "type": "object", "status": "mandatory", "description": "Object indicating any meta data about the evidence that is required by the AssuranceProcess in order to demonstrate compliance with the TrustFramework. It has the following sub-elements" }, { "path": "Data.Party[].VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].EvidenceRef[].EvidenceMetadata.EvidenceClassification", "name": "EvidenceClassification", "type": "string", "status": "mandatory" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Time", "name": "Time", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Party[].VerifiedClaims[].Verification.VerificationProcess", "name": "VerificationProcess", "type": "string", "status": "optional", "description": "Unique reference to the identity verification process as performed by the OP. Used for identifying and retrieving details in case of disputes or audits. Presence of this element might be required for certain trust frameworks.\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence", "name": "Evidence", "type": "object", "status": "optional", "description": "Document Evidence\n[https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-evidence-type-document](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-evidence-type-document)\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Type", "name": "Type", "type": "string", "enum": [ "document" ], "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.CheckDetails", "name": "CheckDetails", "type": "array", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.CheckDetails[]", "name": "CheckDetails[]", "type": "object", "status": "optional", "description": "Identifes the method used by PASP for checking the evidence for verification.\nRepresenting the checks done in relation to the evidence\nOpenID Connect for Identity Assurance 1.0: [https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-evidence-element](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-evidence-element) \n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.CheckDetails[].CheckMethod", "name": "CheckMethod", "type": "string", "status": "optional", "description": "Identifes the method used by PASP for checking the evidence for verification\nString representing the check done, this includes processes such as checking the authenticity of the document, or verifying the user's biometric against an identity document.\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.CheckDetails[].Organization", "name": "Organization", "type": "string", "status": "optional", "description": "String denoting the legal entity that performed the check. This SHOULD be included if the OP did not perform the check itself\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.CheckDetails[].Txn", "name": "Txn", "type": "string", "status": "optional", "description": "Identifier referring to the identity verification transaction. The OP MUST ensure that this is present when EvidenceRef element is used. The OP MUST ensure that the transaction identifier can be resolved into transaction details during an audit\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.CheckDetails[].Time", "name": "Time", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Verifier", "name": "Verifier", "type": "object", "status": "optional", "description": "Denoting the legal entity that performed the identity verification. This object SHOULD be included if the OP did not perform the identity verification itself. This object is retained for backward compatibility, implementers are recommended to use CheckDetails & Organization instead" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Verifier.Organization", "name": "Organization", "type": "string", "status": "mandatory", "description": "String denoting the organization which performed the verification on behalf of the OP." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Verifier.Txn", "name": "Txn", "type": "string", "status": "optional", "description": "Identifier referring to the identity verification transaction. The OP MUST ensure that the transaction identifier can be resolved into transaction details during an audit." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Time", "name": "Time", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails", "name": "DocumentDetails", "type": "object", "status": "optional", "description": "Representing the document used to perform the identity verification. " }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Type", "name": "Type", "type": "string", "enum": [ "passport", "driving_permit", "idcard", "residence_permit", "emirates_id" ], "status": "optional", "description": "The type of document used for evidence checking\n[https://bitbucket.org/openid/ekyc-ida/wiki/identifiers](https://bitbucket.org/openid/ekyc-ida/wiki/identifiers)\"\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.DocumentNumber", "name": "DocumentNumber", "type": "string", "status": "optional", "description": "The unique id number in the evidence used for verification checking" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.PersonalNumber", "name": "PersonalNumber", "type": "string", "status": "optional", "description": "An identifier that is assigned to the End-User and is not limited to being used in one document, for example a national identification number, personal identity number, citizen number, social security number, driver number, account number, customer number, licensee number, etc\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.SerialNumber", "name": "SerialNumber", "type": "string", "status": "optional", "description": "An identifier/number that identifies the document irrespective of any personalization information (this usually only applies to physical artifacts and is present before personalization).\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.CalendarType", "name": "CalendarType", "type": "string", "enum": [ "IslamicCalendar", "GregorianCalendar" ], "status": "optional", "description": "The type of calendar used for the date of issuance and date of expiry in the document evidence\nAllowable values:\n\"Islamic Calendar\"\n\"Gregorian Calendar\"\nBoth calendars must follow YYYY-MM-DD\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.DateOfIssuance", "name": "DateOfIssuance", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.DateOfExpiry", "name": "DateOfExpiry", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer", "name": "Issuer", "type": "object", "status": "optional", "description": "Containing information about the issuer of this document." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Name", "name": "Name", "type": "string", "status": "mandatory", "description": "Designation of the issuer of the document.\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address", "name": "Address", "type": "object", "status": "mandatory", "description": "Address properties based on ISO 20022 `PostalAddress27` definition" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.AddressType", "name": "AddressType", "type": "string", "enum": [ "Billing", "Business", "Correspondence", "DeliveryTo", "MailTo", "POBox", "Postal", "Permanent", "Residential", "Statement", "Other" ], "status": "optional", "description": "The type of address. Omitted if type not held." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.AddressLine", "name": "AddressLine", "type": "array", "status": "mandatory", "description": "Information that locates and identifies a specific address for a transaction entry, that is presented in free format text." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.AddressLine[]", "name": "AddressLine[]", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.BuildingNumber", "name": "BuildingNumber", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The unit, apartment, or villa number within a building or community" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.BuildingName", "name": "BuildingName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of the building or house." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.Floor", "name": "Floor", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "Floor or storey within a building." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.StreetName", "name": "StreetName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The name of the street or road where the property is located." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.DistrictName", "name": "DistrictName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The district, community, or neighbourhood where the property is located." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.PostBox", "name": "PostBox", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The P.O. Box number assigned to the recipient for mail delivery." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.TownName", "name": "TownName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of a built-up area, such as a town or city." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.CountrySubDivision", "name": "CountrySubDivision", "type": "string", "enum": [ "AbuDhabi", "Ajman", "Dubai", "Fujairah", "RasAlKhaimah", "Sharjah", "UmmAlQuwain" ], "status": "optional", "description": "Country subdivision, such as state or province. This is the Emirate where the address is registered." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.Country", "name": "Country", "type": "string", "pattern": "^[A-Z]{2}$", "status": "mandatory", "description": "The country associated with the address, represented using the ISO 3166-1 alpha-2 country code." }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.CountryCode", "name": "CountryCode", "type": "object", "status": "mandatory" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.CountryCode.CountryCode", "name": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "status": "mandatory", "description": "String denoting the country or supranational organization that issued the document as ISO 3166" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Jurisdiction", "name": "Jurisdiction", "type": "string", "status": "mandatory", "description": "String containing the name of the region(s)/state(s)/province(s)/municipality(ies) that issuer has jurisdiction over (if this information is not common knowledge or derivable from the address)\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Attachments", "name": "Attachments", "type": "object", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments", "name": "AEPartyIdentityEvidenceAttachments", "type": "array", "status": "mandatory", "description": "Attachments\n[https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-attachments](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-attachments)\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments[]", "name": "AEPartyIdentityEvidenceAttachments[]", "type": "object", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments[].Desc", "name": "Desc", "type": "string", "status": "mandatory", "description": "Description of the document. This can be the filename or just an explanation of the content.\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments[].ContentType", "name": "ContentType", "type": "string", "status": "mandatory", "description": "Content (MIME) type of the document \n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments[].Content", "name": "Content", "type": "string", "status": "mandatory", "description": "Base64 encoded representation of the document content\n" }, { "path": "Data.Party[].VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments[].Txn", "name": "Txn", "type": "string", "status": "mandatory", "description": "Identifier referring to the transaction\n" }, { "path": "Data.Party[].VerifiedClaims[].Claims", "name": "Claims", "type": "object", "status": "mandatory", "description": "Standard Claims: \n[https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims)\nIdentityAssurance Claims:\n[https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-claims](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-claims)\nAn LFI MUST provide both GivenName and Surname for a Retail customer\n" }, { "path": "Data.Party[].VerifiedClaims[].Claims.IdentityType", "name": "IdentityType", "type": "string", "enum": [ "Person" ], "status": "mandatory" }, { "path": "Data.Party[].VerifiedClaims[].Claims.FullName", "name": "FullName", "type": "string", "status": "mandatory", "description": "The full name of the account holder, as it appears on the account, as a single string. Used where LFIs hold the account name as a single value." }, { "path": "Data.Party[].VerifiedClaims[].Claims.GivenName", "name": "GivenName", "type": "string", "status": "mandatory", "description": "Given name of the Party. Given name (also called forename) is used to differentiate from the surname or family name." }, { "path": "Data.Party[].VerifiedClaims[].Claims.Surname", "name": "Surname", "type": "string", "status": "mandatory", "description": "Surname of the Party" }, { "path": "Data.Party[].VerifiedClaims[].Claims.MiddleName", "name": "MiddleName", "type": "string", "status": "optional", "description": "Middle name of the Party" }, { "path": "Data.Party[].VerifiedClaims[].Claims.Nickname", "name": "Nickname", "type": "string", "status": "optional", "description": "Nickname of the Party" }, { "path": "Data.Party[].VerifiedClaims[].Claims.EmiratesId", "name": "EmiratesId", "type": "string", "status": "mandatory", "description": "Emirates ID number of the Party" }, { "path": "Data.Party[].VerifiedClaims[].Claims.EmiratesIdExpiryDate", "name": "EmiratesIdExpiryDate", "type": "string", "format": "date", "status": "mandatory", "description": "Emirates ID card expiry date" }, { "path": "Data.Party[].VerifiedClaims[].Claims.DateOfBirth", "name": "DateOfBirth", "type": "string", "format": "date", "status": "optional", "description": "Date of birth of the Party" }, { "path": "Data.Party[].VerifiedClaims[].Claims.SourceOfIncome", "name": "SourceOfIncome", "type": "string", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.Salary", "name": "Salary", "type": "number", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.Nationality", "name": "Nationality", "type": "string", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress", "name": "ResidentialAddress", "type": "object", "status": "mandatory", "description": "Address properties based on ISO 20022 `PostalAddress27` definition" }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.AddressType", "name": "AddressType", "type": "string", "enum": [ "Billing", "Business", "Correspondence", "DeliveryTo", "MailTo", "POBox", "Postal", "Permanent", "Residential", "Statement", "Other" ], "status": "optional", "description": "The type of address. Omitted if type not held." }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.AddressLine", "name": "AddressLine", "type": "array", "status": "mandatory", "description": "Information that locates and identifies a specific address for a transaction entry, that is presented in free format text." }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.AddressLine[]", "name": "AddressLine[]", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.BuildingNumber", "name": "BuildingNumber", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The unit, apartment, or villa number within a building or community" }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.BuildingName", "name": "BuildingName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of the building or house." }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.Floor", "name": "Floor", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "Floor or storey within a building." }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.StreetName", "name": "StreetName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The name of the street or road where the property is located." }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.DistrictName", "name": "DistrictName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The district, community, or neighbourhood where the property is located." }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.PostBox", "name": "PostBox", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The P.O. Box number assigned to the recipient for mail delivery." }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.TownName", "name": "TownName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of a built-up area, such as a town or city." }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.CountrySubDivision", "name": "CountrySubDivision", "type": "string", "enum": [ "AbuDhabi", "Ajman", "Dubai", "Fujairah", "RasAlKhaimah", "Sharjah", "UmmAlQuwain" ], "status": "optional", "description": "Country subdivision, such as state or province. This is the Emirate where the address is registered." }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.Country", "name": "Country", "type": "string", "pattern": "^[A-Z]{2}$", "status": "mandatory", "description": "The country associated with the address, represented using the ISO 3166-1 alpha-2 country code." }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress", "name": "ResidentialAddress", "type": "object", "status": "mandatory" }, { "path": "Data.Party[].VerifiedClaims[].Claims.ResidentialAddress.AddressType", "name": "AddressType", "type": "string", "enum": [ "Residential" ], "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.MobileNumber", "name": "MobileNumber", "type": "string", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.Email", "name": "Email", "type": "string", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.MaritalStatus", "name": "MaritalStatus", "type": "string", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.Salutation", "name": "Salutation", "type": "string", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.Language", "name": "Language", "type": "string", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.EmployerName", "name": "EmployerName", "type": "string", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.EmploymentSinceDate", "name": "EmploymentSinceDate", "type": "string", "format": "date", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.PowerofAttorney", "name": "PowerofAttorney", "type": "boolean", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.SalaryTransfer", "name": "SalaryTransfer", "type": "boolean", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.Profession", "name": "Profession", "type": "string", "status": "optional" }, { "path": "Data.Party[].VerifiedClaims[].Claims.UpdatedAt", "name": "UpdatedAt", "type": "string", "format": "date-time", "status": "optional", "description": "The date and time at which the claims were last updated, in ISO 8601 format" }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" } ] }, "/parties": { "method": "GET", "summary": "Get Parties", "operationId": "Parties_read", "schemaRef": "#/components/schemas/AEReadParty4", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory" }, { "path": "Data.Party", "name": "Party", "type": "object", "status": "mandatory", "description": "Party Identity Assurance (Response) Schema \nBased on the [OpenID Connect for Identity Assurance 1.0 Specification](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html)\n" }, { "path": "Data.Party.PartyId", "name": "PartyId", "type": "string", "minLength": 1, "maxLength": 40, "status": "mandatory", "description": "A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner." }, { "path": "Data.Party.PartyNumber", "name": "PartyNumber", "type": "string", "minLength": 1, "maxLength": 35, "status": "optional", "description": "Number assigned by an agent to identify its customer." }, { "path": "Data.Party.PartyCategory", "name": "PartyCategory", "type": "string", "enum": [ "Retail", "SME", "Corporate" ], "status": "mandatory", "description": "Category of Party" }, { "path": "Data.Party.VerifiedClaims", "name": "VerifiedClaims", "type": "array", "status": "mandatory", "description": "Container object containing entries for the trust framework and the evidence used to verify the claims" }, { "path": "Data.Party.VerifiedClaims[]", "name": "VerifiedClaims[]", "type": "object", "status": "optional", "description": "Verified Claims\nContainer object containing entries for the trust framework and the evidence used to verify the claims\n[https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-representing-verified-claim](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-representing-verified-claim)\n" }, { "path": "Data.Party.VerifiedClaims[].Verification", "name": "Verification", "type": "object", "status": "optional", "description": "Verification\n[https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-verification-element](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-verification-element)\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.TrustFramework", "name": "TrustFramework", "type": "string", "enum": [ "Undefined" ], "status": "mandatory", "description": "Identifies the trust framework used for verification. This consists of a set of rules and standards and sets out requirements so that organisations know what ‘good’ identity verification looks like.\nTrust Frameworks: [https://bitbucket.org/openid/ekyc-ida/wiki/identifiers](https://bitbucket.org/openid/ekyc-ida/wiki/identifiers)" }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceLevel", "name": "AssuranceLevel", "type": "string", "status": "optional", "description": "Determines the assurance level associated with the User in the respective VerifiedClaims. The value range depends on the respective TrustFramework value.\nAssurance Level: [https://bitbucket.org/openid/ekyc-ida/wiki/identifiers](https://bitbucket.org/openid/ekyc-ida/wiki/identifiers)\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess", "name": "AssuranceProcess", "type": "object", "status": "optional", "description": "Determines the assurance process that was followed. This reflects how the evidence meets the requirements of the TrustFramework and AssuranceLevel. The factual record of the evidence and the procedures followed are recorded in the evidence element, this element is used to cross reference the evidence to the AssuranceLevel followed\nOpenID Connect for Identity Assurance 1.0: [https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-verification-element](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-verification-element) \n" }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.Policy", "name": "Policy", "type": "string", "status": "mandatory", "description": "Representing the standard or policy that was followed." }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.Procedure", "name": "Procedure", "type": "string", "status": "mandatory", "description": "Representing a specific procedure from the policy that was followed." }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails", "name": "AssuranceDetails", "type": "array", "status": "mandatory" }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[]", "name": "AssuranceDetails[]", "type": "object", "status": "optional", "description": "Denoting the details about how the evidence complies with the policy" }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].AssuranceType", "name": "AssuranceType", "type": "string", "status": "mandatory", "description": "String denoting which part of the assurance_process the evidence fulfils" }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].AssuranceClassification", "name": "AssuranceClassification", "type": "string", "status": "mandatory", "description": "String reflecting how the evidence has been classified or measured as required by the TrustFramework" }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].EvidenceRef", "name": "EvidenceRef", "type": "array", "status": "mandatory" }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].EvidenceRef[]", "name": "EvidenceRef[]", "type": "object", "status": "optional", "description": "Evidence being referred to" }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].EvidenceRef[].Txn", "name": "Txn", "type": "string", "status": "mandatory", "description": "Identifier referring to the txn used in the CheckDetails." }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].EvidenceRef[].EvidenceMetadata", "name": "EvidenceMetadata", "type": "object", "status": "mandatory", "description": "Object indicating any meta data about the evidence that is required by the AssuranceProcess in order to demonstrate compliance with the TrustFramework. It has the following sub-elements" }, { "path": "Data.Party.VerifiedClaims[].Verification.AssuranceProcess.AssuranceDetails[].EvidenceRef[].EvidenceMetadata.EvidenceClassification", "name": "EvidenceClassification", "type": "string", "status": "mandatory" }, { "path": "Data.Party.VerifiedClaims[].Verification.Time", "name": "Time", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Party.VerifiedClaims[].Verification.VerificationProcess", "name": "VerificationProcess", "type": "string", "status": "optional", "description": "Unique reference to the identity verification process as performed by the OP. Used for identifying and retrieving details in case of disputes or audits. Presence of this element might be required for certain trust frameworks.\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence", "name": "Evidence", "type": "object", "status": "optional", "description": "Document Evidence\n[https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-evidence-type-document](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-evidence-type-document)\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Type", "name": "Type", "type": "string", "enum": [ "document" ], "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.CheckDetails", "name": "CheckDetails", "type": "array", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.CheckDetails[]", "name": "CheckDetails[]", "type": "object", "status": "optional", "description": "Identifes the method used by PASP for checking the evidence for verification.\nRepresenting the checks done in relation to the evidence\nOpenID Connect for Identity Assurance 1.0: [https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-evidence-element](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-evidence-element) \n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.CheckDetails[].CheckMethod", "name": "CheckMethod", "type": "string", "status": "optional", "description": "Identifes the method used by PASP for checking the evidence for verification\nString representing the check done, this includes processes such as checking the authenticity of the document, or verifying the user's biometric against an identity document.\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.CheckDetails[].Organization", "name": "Organization", "type": "string", "status": "optional", "description": "String denoting the legal entity that performed the check. This SHOULD be included if the OP did not perform the check itself\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.CheckDetails[].Txn", "name": "Txn", "type": "string", "status": "optional", "description": "Identifier referring to the identity verification transaction. The OP MUST ensure that this is present when EvidenceRef element is used. The OP MUST ensure that the transaction identifier can be resolved into transaction details during an audit\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.CheckDetails[].Time", "name": "Time", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Verifier", "name": "Verifier", "type": "object", "status": "optional", "description": "Denoting the legal entity that performed the identity verification. This object SHOULD be included if the OP did not perform the identity verification itself. This object is retained for backward compatibility, implementers are recommended to use CheckDetails & Organization instead" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Verifier.Organization", "name": "Organization", "type": "string", "status": "mandatory", "description": "String denoting the organization which performed the verification on behalf of the OP." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Verifier.Txn", "name": "Txn", "type": "string", "status": "optional", "description": "Identifier referring to the identity verification transaction. The OP MUST ensure that the transaction identifier can be resolved into transaction details during an audit." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Time", "name": "Time", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails", "name": "DocumentDetails", "type": "object", "status": "optional", "description": "Representing the document used to perform the identity verification. " }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Type", "name": "Type", "type": "string", "enum": [ "passport", "driving_permit", "idcard", "residence_permit", "emirates_id" ], "status": "optional", "description": "The type of document used for evidence checking\n[https://bitbucket.org/openid/ekyc-ida/wiki/identifiers](https://bitbucket.org/openid/ekyc-ida/wiki/identifiers)\"\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.DocumentNumber", "name": "DocumentNumber", "type": "string", "status": "optional", "description": "The unique id number in the evidence used for verification checking" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.PersonalNumber", "name": "PersonalNumber", "type": "string", "status": "optional", "description": "An identifier that is assigned to the End-User and is not limited to being used in one document, for example a national identification number, personal identity number, citizen number, social security number, driver number, account number, customer number, licensee number, etc\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.SerialNumber", "name": "SerialNumber", "type": "string", "status": "optional", "description": "An identifier/number that identifies the document irrespective of any personalization information (this usually only applies to physical artifacts and is present before personalization).\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.CalendarType", "name": "CalendarType", "type": "string", "enum": [ "IslamicCalendar", "GregorianCalendar" ], "status": "optional", "description": "The type of calendar used for the date of issuance and date of expiry in the document evidence\nAllowable values:\n\"Islamic Calendar\"\n\"Gregorian Calendar\"\nBoth calendars must follow YYYY-MM-DD\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.DateOfIssuance", "name": "DateOfIssuance", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.DateOfExpiry", "name": "DateOfExpiry", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer", "name": "Issuer", "type": "object", "status": "optional", "description": "Containing information about the issuer of this document." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Name", "name": "Name", "type": "string", "status": "mandatory", "description": "Designation of the issuer of the document.\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address", "name": "Address", "type": "object", "status": "mandatory", "description": "Address properties based on ISO 20022 `PostalAddress27` definition" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.AddressType", "name": "AddressType", "type": "string", "enum": [ "Billing", "Business", "Correspondence", "DeliveryTo", "MailTo", "POBox", "Postal", "Permanent", "Residential", "Statement", "Other" ], "status": "optional", "description": "The type of address. Omitted if type not held." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.AddressLine", "name": "AddressLine", "type": "array", "status": "mandatory", "description": "Information that locates and identifies a specific address for a transaction entry, that is presented in free format text." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.AddressLine[]", "name": "AddressLine[]", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.BuildingNumber", "name": "BuildingNumber", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The unit, apartment, or villa number within a building or community" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.BuildingName", "name": "BuildingName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of the building or house." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.Floor", "name": "Floor", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "Floor or storey within a building." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.StreetName", "name": "StreetName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The name of the street or road where the property is located." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.DistrictName", "name": "DistrictName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The district, community, or neighbourhood where the property is located." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.PostBox", "name": "PostBox", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The P.O. Box number assigned to the recipient for mail delivery." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.TownName", "name": "TownName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of a built-up area, such as a town or city." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.CountrySubDivision", "name": "CountrySubDivision", "type": "string", "enum": [ "AbuDhabi", "Ajman", "Dubai", "Fujairah", "RasAlKhaimah", "Sharjah", "UmmAlQuwain" ], "status": "optional", "description": "Country subdivision, such as state or province. This is the Emirate where the address is registered." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Address.Country", "name": "Country", "type": "string", "pattern": "^[A-Z]{2}$", "status": "mandatory", "description": "The country associated with the address, represented using the ISO 3166-1 alpha-2 country code." }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.CountryCode", "name": "CountryCode", "type": "object", "status": "mandatory" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.CountryCode.CountryCode", "name": "CountryCode", "type": "string", "pattern": "^[A-Z]{2,2}$", "status": "mandatory", "description": "String denoting the country or supranational organization that issued the document as ISO 3166" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.DocumentDetails.Issuer.Jurisdiction", "name": "Jurisdiction", "type": "string", "status": "mandatory", "description": "String containing the name of the region(s)/state(s)/province(s)/municipality(ies) that issuer has jurisdiction over (if this information is not common knowledge or derivable from the address)\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Attachments", "name": "Attachments", "type": "object", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments", "name": "AEPartyIdentityEvidenceAttachments", "type": "array", "status": "mandatory", "description": "Attachments\n[https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-attachments](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-attachments)\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments[]", "name": "AEPartyIdentityEvidenceAttachments[]", "type": "object", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments[].Desc", "name": "Desc", "type": "string", "status": "mandatory", "description": "Description of the document. This can be the filename or just an explanation of the content.\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments[].ContentType", "name": "ContentType", "type": "string", "status": "mandatory", "description": "Content (MIME) type of the document \n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments[].Content", "name": "Content", "type": "string", "status": "mandatory", "description": "Base64 encoded representation of the document content\n" }, { "path": "Data.Party.VerifiedClaims[].Verification.Evidence.Attachments.AEPartyIdentityEvidenceAttachments[].Txn", "name": "Txn", "type": "string", "status": "mandatory", "description": "Identifier referring to the transaction\n" }, { "path": "Data.Party.VerifiedClaims[].Claims", "name": "Claims", "type": "object", "status": "mandatory", "description": "Standard Claims: \n[https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims)\nIdentityAssurance Claims:\n[https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-claims](https://openid.net/specs/openid-connect-4-identity-assurance-1_0.html#name-claims)\nAn LFI MUST provide both GivenName and Surname for a Retail customer\n" }, { "path": "Data.Party.VerifiedClaims[].Claims.IdentityType", "name": "IdentityType", "type": "string", "enum": [ "Person" ], "status": "mandatory" }, { "path": "Data.Party.VerifiedClaims[].Claims.FullName", "name": "FullName", "type": "string", "status": "mandatory", "description": "The full name of the account holder, as it appears on the account, as a single string. Used where LFIs hold the account name as a single value." }, { "path": "Data.Party.VerifiedClaims[].Claims.GivenName", "name": "GivenName", "type": "string", "status": "mandatory", "description": "Given name of the Party. Given name (also called forename) is used to differentiate from the surname or family name." }, { "path": "Data.Party.VerifiedClaims[].Claims.Surname", "name": "Surname", "type": "string", "status": "mandatory", "description": "Surname of the Party" }, { "path": "Data.Party.VerifiedClaims[].Claims.MiddleName", "name": "MiddleName", "type": "string", "status": "optional", "description": "Middle name of the Party" }, { "path": "Data.Party.VerifiedClaims[].Claims.Nickname", "name": "Nickname", "type": "string", "status": "optional", "description": "Nickname of the Party" }, { "path": "Data.Party.VerifiedClaims[].Claims.EmiratesId", "name": "EmiratesId", "type": "string", "status": "mandatory", "description": "Emirates ID number of the Party" }, { "path": "Data.Party.VerifiedClaims[].Claims.EmiratesIdExpiryDate", "name": "EmiratesIdExpiryDate", "type": "string", "format": "date", "status": "mandatory", "description": "Emirates ID card expiry date" }, { "path": "Data.Party.VerifiedClaims[].Claims.DateOfBirth", "name": "DateOfBirth", "type": "string", "format": "date", "status": "optional", "description": "Date of birth of the Party" }, { "path": "Data.Party.VerifiedClaims[].Claims.SourceOfIncome", "name": "SourceOfIncome", "type": "string", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.Salary", "name": "Salary", "type": "number", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.Nationality", "name": "Nationality", "type": "string", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress", "name": "ResidentialAddress", "type": "object", "status": "mandatory", "description": "Address properties based on ISO 20022 `PostalAddress27` definition" }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.AddressType", "name": "AddressType", "type": "string", "enum": [ "Billing", "Business", "Correspondence", "DeliveryTo", "MailTo", "POBox", "Postal", "Permanent", "Residential", "Statement", "Other" ], "status": "optional", "description": "The type of address. Omitted if type not held." }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.AddressLine", "name": "AddressLine", "type": "array", "status": "mandatory", "description": "Information that locates and identifies a specific address for a transaction entry, that is presented in free format text." }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.AddressLine[]", "name": "AddressLine[]", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.BuildingNumber", "name": "BuildingNumber", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The unit, apartment, or villa number within a building or community" }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.BuildingName", "name": "BuildingName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of the building or house." }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.Floor", "name": "Floor", "type": "string", "minLength": 1, "maxLength": 70, "status": "optional", "description": "Floor or storey within a building." }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.StreetName", "name": "StreetName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The name of the street or road where the property is located." }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.DistrictName", "name": "DistrictName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "The district, community, or neighbourhood where the property is located." }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.PostBox", "name": "PostBox", "type": "string", "minLength": 1, "maxLength": 16, "status": "optional", "description": "The P.O. Box number assigned to the recipient for mail delivery." }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.TownName", "name": "TownName", "type": "string", "minLength": 1, "maxLength": 140, "status": "optional", "description": "Name of a built-up area, such as a town or city." }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.CountrySubDivision", "name": "CountrySubDivision", "type": "string", "enum": [ "AbuDhabi", "Ajman", "Dubai", "Fujairah", "RasAlKhaimah", "Sharjah", "UmmAlQuwain" ], "status": "optional", "description": "Country subdivision, such as state or province. This is the Emirate where the address is registered." }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.Country", "name": "Country", "type": "string", "pattern": "^[A-Z]{2}$", "status": "mandatory", "description": "The country associated with the address, represented using the ISO 3166-1 alpha-2 country code." }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress", "name": "ResidentialAddress", "type": "object", "status": "mandatory" }, { "path": "Data.Party.VerifiedClaims[].Claims.ResidentialAddress.AddressType", "name": "AddressType", "type": "string", "enum": [ "Residential" ], "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.MobileNumber", "name": "MobileNumber", "type": "string", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.Email", "name": "Email", "type": "string", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.MaritalStatus", "name": "MaritalStatus", "type": "string", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.Salutation", "name": "Salutation", "type": "string", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.Language", "name": "Language", "type": "string", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.EmployerName", "name": "EmployerName", "type": "string", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.EmploymentSinceDate", "name": "EmploymentSinceDate", "type": "string", "format": "date", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.PowerofAttorney", "name": "PowerofAttorney", "type": "boolean", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.SalaryTransfer", "name": "SalaryTransfer", "type": "boolean", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.Profession", "name": "Profession", "type": "string", "status": "optional" }, { "path": "Data.Party.VerifiedClaims[].Claims.UpdatedAt", "name": "UpdatedAt", "type": "string", "format": "date-time", "status": "optional", "description": "The date and time at which the claims were last updated, in ISO 8601 format" }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" } ] }, "/accounts/{AccountId}/statements": { "method": "GET", "summary": "Get Statements", "operationId": "GetAccountAccountIdStatements", "schemaRef": "#/components/schemas/AEReadStatements", "fields": [ { "path": "Data", "name": "Data", "type": "object", "status": "mandatory" }, { "path": "Data.AccountId", "name": "AccountId", "type": "string", "status": "mandatory", "description": "\r\nA unique and immutable identifier produced by the LFI to identify the account resource.This identifier has no meaning to the account owner." }, { "path": "Data.AccountSubType", "name": "AccountSubType", "type": "string", "enum": [ "CurrentAccount", "Savings", "CreditCard", "Mortgage", "Finance" ], "status": "mandatory", "description": "Specifies the sub type of account (product family group). Supported values:\n\n* CurrentAccount\n\n* Savings\n\n* CreditCard\n\n* Mortgage\n\n* Finance" }, { "path": "Data.Statements", "name": "Statements", "type": "array", "status": "mandatory", "description": "Array containing details of periodic statements. Each statement includes key financial metrics, balances, summaries, and payment details for a specific statement cycle" }, { "path": "Data.Statements[]", "name": "Statements[]", "type": "object", "status": "optional" }, { "path": "Data.Statements[].StatementId", "name": "StatementId", "type": "string", "status": "mandatory", "description": "Unique identifier/reference for the statement" }, { "path": "Data.Statements[].StatementDate", "name": "StatementDate", "type": "string", "format": "date", "status": "mandatory", "description": "Date the statement was issued/generated" }, { "path": "Data.Statements[].OpeningDate", "name": "OpeningDate", "type": "string", "format": "date", "status": "mandatory", "description": "Start date of the statement period" }, { "path": "Data.Statements[].ClosingDate", "name": "ClosingDate", "type": "string", "format": "date", "status": "mandatory", "description": "End date of the statement period" }, { "path": "Data.Statements[].CreditLine", "name": "CreditLine", "type": "object", "status": "optional", "description": "This is the value of the last direct debit collection from the User 1 account." }, { "path": "Data.Statements[].CreditLine.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Statements[].CreditLine.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Statements[].OpeningBalance", "name": "OpeningBalance", "type": "object", "status": "mandatory", "description": "Object containing opening balance details" }, { "path": "Data.Statements[].OpeningBalance.CreditDebitIndicator", "name": "CreditDebitIndicator", "type": "string", "enum": [ "Credit", "Debit" ], "status": "mandatory", "description": "Indicates whether the closing balance is a credit or a debit" }, { "path": "Data.Statements[].OpeningBalance", "name": "OpeningBalance", "type": "object", "status": "mandatory" }, { "path": "Data.Statements[].OpeningBalance.Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "The value of the balance on account, incorporating `Amount` and `Currency`." }, { "path": "Data.Statements[].OpeningBalance.Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Statements[].OpeningBalance.Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Statements[].OpeningBalance.Components", "name": "Components", "type": "array", "status": "optional", "description": "Components of the stated balance, defined by the value of `BalanceCategory`, that reflects a portion of the stated balance." }, { "path": "Data.Statements[].OpeningBalance.Components[]", "name": "Components[]", "type": "object", "status": "optional" }, { "path": "Data.Statements[].OpeningBalance.Components[].BalanceCategory", "name": "BalanceCategory", "type": "string", "enum": [ "Principal", "Interest", "FeesAndCharges", "PastDue", "Profit", "Rental" ], "status": "mandatory" }, { "path": "Data.Statements[].OpeningBalance.Components[].Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "The value of the categorized balance, incorporating `Amount` and `Currency`." }, { "path": "Data.Statements[].OpeningBalance.Components[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Statements[].OpeningBalance.Components[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Statements[].ClosingBalance", "name": "ClosingBalance", "type": "object", "status": "mandatory", "description": "Object containing closing balance details" }, { "path": "Data.Statements[].ClosingBalance.CreditDebitIndicator", "name": "CreditDebitIndicator", "type": "string", "enum": [ "Credit", "Debit" ], "status": "mandatory", "description": "Indicates whether the closing balance is a credit or a debit" }, { "path": "Data.Statements[].ClosingBalance", "name": "ClosingBalance", "type": "object", "status": "mandatory" }, { "path": "Data.Statements[].ClosingBalance.Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "The value of the balance on account, incorporating `Amount` and `Currency`." }, { "path": "Data.Statements[].ClosingBalance.Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Statements[].ClosingBalance.Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Statements[].ClosingBalance.Components", "name": "Components", "type": "array", "status": "optional", "description": "Components of the stated balance, defined by the value of `BalanceCategory`, that reflects a portion of the stated balance." }, { "path": "Data.Statements[].ClosingBalance.Components[]", "name": "Components[]", "type": "object", "status": "optional" }, { "path": "Data.Statements[].ClosingBalance.Components[].BalanceCategory", "name": "BalanceCategory", "type": "string", "enum": [ "Principal", "Interest", "FeesAndCharges", "PastDue", "Profit", "Rental" ], "status": "mandatory" }, { "path": "Data.Statements[].ClosingBalance.Components[].Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "The value of the categorized balance, incorporating `Amount` and `Currency`." }, { "path": "Data.Statements[].ClosingBalance.Components[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Statements[].ClosingBalance.Components[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Statements[].Summary", "name": "Summary", "type": "array", "status": "mandatory", "description": "Array providing an aggregated summary of financial activities within the statement period, such as Purchase, Repayments, Fee, and Interest/Profit. Each object contains the total aggregated amount, currency, and the count of transactions for the corresponding SubTransactionType." }, { "path": "Data.Statements[].Summary[]", "name": "Summary[]", "type": "object", "status": "optional" }, { "path": "Data.Statements[].Summary[].CreditDebitIndicator", "name": "CreditDebitIndicator", "type": "string", "enum": [ "Credit", "Debit" ], "status": "mandatory", "description": "Indicates whether the summarized activity is a credit or a debit" }, { "path": "Data.Statements[].Summary[].TransactionType", "name": "TransactionType", "type": "string", "enum": [ "POS", "ECommerce", "ATM", "BillPayments", "LocalBankTransfer", "SameBankTransfer", "InternationalTransfer", "Teller", "Cheque", "Other" ], "status": "optional", "description": "Type of transaction activity." }, { "path": "Data.Statements[].Summary[].SubTransactionType", "name": "SubTransactionType", "type": "string", "enum": [ "Purchase", "Reversal", "Refund", "Withdrawal", "WithdrawalReversal", "Deposit", "DepositReversal", "MoneyTransfer", "Repayments", "Interest", "Fee", "Charges", "Profit", "Disbursement", "Adjustment", "Tax", "Rewards", "NotApplicable", "LeaseRepayment" ], "status": "mandatory" }, { "path": "Data.Statements[].Summary[].Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "This is the value of the last direct debit collection from the User 1 account." }, { "path": "Data.Statements[].Summary[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Statements[].Summary[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Statements[].Summary[].Count", "name": "Count", "type": "number", "status": "mandatory", "description": "Number of transactions or occurrences for the transaction type" }, { "path": "Data.Statements[].ExpectedNextStatement", "name": "ExpectedNextStatement", "type": "array", "status": "optional", "description": "Object containing projected finance charges or fees expected in the next statement cycle." }, { "path": "Data.Statements[].ExpectedNextStatement[]", "name": "ExpectedNextStatement[]", "type": "object", "status": "optional" }, { "path": "Data.Statements[].ExpectedNextStatement[].Type", "name": "Type", "type": "string", "enum": [ "Purchase", "Reversal", "Refund", "Withdrawal", "WithdrawalReversal", "Deposit", "DepositReversal", "MoneyTransfer", "Repayments", "Interest", "Fee", "Charges", "Profit", "Disbursement", "Adjustment", "Tax", "Rewards", "NotApplicable" ], "status": "optional", "description": "Statement type." }, { "path": "Data.Statements[].ExpectedNextStatement[].Amount", "name": "Amount", "type": "object", "status": "optional", "description": "Statement amount, according to `Type` value." }, { "path": "Data.Statements[].ExpectedNextStatement[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Statements[].ExpectedNextStatement[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Statements[].NextPayment", "name": "NextPayment", "type": "array", "status": "optional", "description": "Object containing details related to the next payment due" }, { "path": "Data.Statements[].NextPayment[]", "name": "NextPayment[]", "type": "object", "status": "optional" }, { "path": "Data.Statements[].NextPayment[].Date", "name": "Date", "type": "string", "format": "date", "status": "mandatory", "description": "Payment due date" }, { "path": "Data.Statements[].NextPayment[].Amount", "name": "Amount", "type": "object", "status": "mandatory", "description": "This is the value of the last direct debit collection from the User 1 account." }, { "path": "Data.Statements[].NextPayment[].Amount.Amount", "name": "Amount", "type": "string", "pattern": "^\\d{1,13}$|^\\d{1,13}\\.\\d{1,5}$", "status": "mandatory", "description": "A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217." }, { "path": "Data.Statements[].NextPayment[].Amount.Currency", "name": "Currency", "type": "string", "pattern": "^[A-Z]{3,3}$", "status": "mandatory", "description": "A 3 character alphabetic code allocated to a currency under an international currency identification scheme, as described in the latest edition of the international standard ISO 4217 'Codes for the representation of currencies and funds'." }, { "path": "Data.Statements[].NextPayment[].Type", "name": "Type", "type": "string", "enum": [ "Minimum", "Scheduled", "Estimated", "Other" ], "status": "optional", "description": "Type of payment - minimum, scheduled, estimated, or other" }, { "path": "Links", "name": "Links", "type": "object", "status": "mandatory", "description": "Links relevant to the resource" }, { "path": "Links.Self", "name": "Self", "type": "string", "format": "uri", "status": "mandatory", "description": "A link to the current resource" }, { "path": "Links.First", "name": "First", "type": "string", "format": "uri", "status": "optional", "description": "A link to the first page in a paginated result set" }, { "path": "Links.Prev", "name": "Prev", "type": "string", "format": "uri", "status": "optional", "description": "A link to the previous page in a paginated result set" }, { "path": "Links.Next", "name": "Next", "type": "string", "format": "uri", "status": "optional", "description": "A link to the next page in a paginated result set" }, { "path": "Links.Last", "name": "Last", "type": "string", "format": "uri", "status": "optional", "description": "A link to the last page in a paginated result set" }, { "path": "Meta", "name": "Meta", "type": "object", "status": "mandatory", "description": "Meta Data relevant to the resource" }, { "path": "Meta.TotalPages", "name": "TotalPages", "type": "integer", "format": "int32", "status": "mandatory", "description": "Total number of Pages where a result set is paginated" }, { "path": "Meta.FirstAvailableDateTime", "name": "FirstAvailableDateTime", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" }, { "path": "Meta.LastAvailableDateTime", "name": "LastAvailableDateTime", "type": "string", "format": "date-time", "status": "optional", "description": "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" } ] } } }