openapi: 3.0.0
info:
title: UAE Product API
description: UAE Open Finance Product API Specification
version: v1.2-draft1
contact:
email: contactus@cbuaeopenfinance@cbuae.gov.ae
tags:
- name: Products
description: Product resource
- name: Leads
description: ProductLead resourcesresource
paths:
/products:
get:
tags:
- ProductProducts
operationId: GetProducts
summary: Retrieve Products
description: Retrieve all Products
parameters:
- $ref: '#/components/parameters/Authorization'
- name: ProductCategory
in: query
description: Filter by product category
required: false
schema:
type: string
enum: [SavingsSavingsAccount, CurrentAccount, CreditCard, Loan, Mortgage]
- name: ShariaCompliantIsShariaCompliant
in: query
description: Filter by Sharia compliance
required: false
schema:
type: boolean
- name: LastUpdatedDateTime
in: query
description: Filter by last updated date time
required: false
schema:
type: string
format: date-time
- name: PageNumber
in: query
description: Page number to retrieve (starts from 1)
required: false
schema:
type: integer
minimum: 1
default: 1
- name: PageSize
in: query
description: Number of records per page
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 25100
- name: SortOrder
in: query
description: Order of sorting the results
required: false
schema:
type: string
enum: [ASCasc, DESCdesc]
default: ASCasc
- name: SortField
in: query
description: Field to sort the results by
required: false
schema:
type: string
enum: [LastUpdatedDateTime, ProductId]
default: LastUpdatedDateTime
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/ProductResponse'
"400":
$ref: "#/components/responses/400Error"
"401":
$ref: "#/components/responses/401Error"
"403":
$ref: "#/components/responses/403Error"
"405":
$ref: "#/components/responses/405Error"
"406":
$ref: "#/components/responses/406Error"
"415":
$ref: "#/components/responses/415Error"
"429":
$ref: "#/components/responses/429Error"
"500":
$ref: "#/components/responses/500Error"
security:
- TPPOAuth2Security:
- products
/leads:
post:
tags:
- Leads
summary: "Create a Lead"
description: |
Create a Lead
operationId: "CreateLead"
parameters:
- $ref: '#/components/parameters/Authorization'
requestBody:
description: |
Request Body
content:
application/json:
schema:
$ref: "#/components/schemas/LeadRequest"
responses:
"201":
$ref: "#/components/responses/201LeadResponse"
"400":
$ref: "#/components/responses/400Error"
"401":
$ref: "#/components/responses/401Error"
"403":
$ref: "#/components/responses/403Error"
"405":
$ref: "#/components/responses/405Error"
"406":
$ref: "#/components/responses/406Error"
"415":
$ref: "#/components/responses/415Error"
"429":
$ref: "#/components/responses/429Error"
"500":
$ref: "#/components/responses/500Error"
security:
- TPPOAuth2Security:
- products
components:
schemas:
AEError:
type: object
required:
- Code
- Message
properties:
Code:
allOf:
- $ref: '#/components/schemas/AEErrorCode'
description: Low level textual error code, e.g., Field.Missing
Message:
type: string
minLength: 1
maxLength: 500
description: >-
A description of the error that occurred. e.g., 'A mandatory field
isn't supplied' or 'RequestedExecutionDateTime must be in future'
UAEOF doesn't standardise this field
Path:
type: string
minLength: 1
maxLength: 500
description: >-
Recommended but optional reference to the JSON Path of the field
with error, e.g., Data.Initiation.InstructedAmount.Currency
Url:
type: string
description: >-
URL to help remediate the problem, or provide more information, or
to API Reference, or help etc
description: Error
additionalProperties: false
AEErrorCode:
type: string
enum:
- GenericError
AEErrorResponse:
type: object
required:
- Errors
properties:
Errors:
type: array
items:
$ref: '#/components/schemas/AEError'
minItems: 1
description: >-
An array of detail error codes, and messages, and URLs to documentation
to help remediation.
additionalProperties: false
ProductResponse:
type: object
requireddescription: |
- Product DataResponse
propertiesrequired:
- Data:
properties:
type: object Data:
required: description: |
- LFIId Products response
- LFIBrandIdtype: array
items:
- Product propertiestype: object
LFIIdrequired:
- type:LFIId
string - LFIBrandId:
type:- stringProducts
Productsproperties:
typeLFIId:
array itemstype: string
$ref: '#/components/schemas/Product'
Product description: The unique identifier for the LFI type:within objectthe CBUAE ecosystem
required: - ProductIdLFIBrandId:
- ProductName type: string
- ProductCategory properties: ProductIddescription: The unique identifier for the LFI Brand within the CBUAE type:ecosystem
string ProductName: Products:
type: string type: example:array
"Savings Account" ProductCategory: description: The Product array can type:contain stringone or more products associated to a single LFI
enum: [Savings, CurrentAccount, CreditCard, Loan, Mortgage] Descriptionitems:
type: string $ref: EffectiveFromDateTime:'#/components/schemas/Product'
Product:
type: object
string description: The Product information
format: date-time required:
EffectiveToDateTime: - ProductId
type: string - ProductName
format: date-time ProductCategory
LastUpdatedDateTimeproperties:
typeProductId:
string formattype: date-timestring
ShariaCompliant: description: A data holder specific unique identifier for this type:product. booleanThis identifier must be unique to a product but ShariaInformation:does not otherwise need to adhere to ID permanence guidelines.
type: "array" ProductName:
items: type: string
type: object description: The display name of the product.
properties: example: "Savings Account"
Type: ProductCategory:
type: string
description: The type of Description:Banking product
enum: [SavingsAccount, CurrentAccount, CreditCard, Loan, type:Mortgage]
string IsSalaryTransferRequiredDescription:
typedescription: booleanA human-readable description of the product that can be Links:displayed to the User for marketing and information purposes.
$ref: '#/components/schemas/Links' Eligibilitytype: string
EffectiveFromDateTime:
$ref: '#/components/schemas/Eligibility' Documentationdescription: The date and time from which this product is type: array
items:
$ref: '#/components/schemas/Document'effective (i.e. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate.
type: string
Channels: typeformat: arraydate-time
itemsEffectiveToDateTime:
$refdescription: '#/components/schemas/Channel'
Features:
type: arrayThe date and time at which this product will be retired and will no longer be offered. Used to enable the managed deprecation of products.
itemstype: string
$refformat: '#/components/schemas/Feature'date-time
LimitsLastUpdatedDateTime:
typedescription: arrayThe last date and time that the information for this product items:was changed (or the creation date for the product if it has never $ref: '#/components/schemas/Limit'been altered).
Feestype: string
type: array format: date-time
IsShariaCompliant:
itemstype: boolean
$ref: '#/components/schemas/Fee'description: Indicates whether the product is Sharia-compliant.
BenefitsShariaInformation:
type: arraystring
itemsdescription: The description of the Sharia compliance information.
$ref IsSalaryTransferRequired:
'#/components/schemas/Benefit' Producttype: boolean
$refdescription: '#/components/schemas/ProductDetails'
Links:
type: object
properties:Does the Consumer need to pay their salary into a current account provided by the LFI to be able to open this product.
ApplicationUriLinks:
type$ref: string'#/components/schemas/Links'
Eligibility:
format: uri KfsUri$ref: '#/components/schemas/Eligibility'
Channels:
type: string type: array
format: uri OverviewUriitems:
type: string $ref: '#/components/schemas/Channel'
formatProduct:
uri TermsUri$ref: '#/components/schemas/ProductDetails'
Links:
type description: stringLinks to the Product details
formattype: uriobject
FeesAndPricingUriproperties:
typeApplicationUri:
string formatdescription: uriA link to apply for ScheduleOfChargesUri:the product.
type: string
format: uri
EligibilityUriKfsUri:
typedescription: stringA link to the Key Facts Statement for format: uri
CardImageUri:the product
type: string
format: uri
Eligibility: OverviewUri:
type: object propertiesdescription: A link to a general overview of the product. ResidenceStatus:
type: arraystring
itemsformat: uri
TermsUri:
type: object description: A link to the Terms properties:and conditions for the product.
Typetype: string
format: uri
type: string FeesAndPricingUri:
enumdescription: [UaeResident, ExpatriatesResident, NonUaeResident]
A link to the Fees and Pricing for the product.
Description: type: string
typeformat: stringuri
EmploymentStatusScheduleOfChargesUri:
typedescription: arrayA link to the Schedule of Charges for the product.
items: type: string
type: object format: uri
properties: EligibilityUri:
Typedescription: A link to the Eligibility for the product.
type: string
format: uri
enum: [Salaried, NonSalaried, EligibleEmployer, SelfEmployed,CardImageUri:
Unemployed, MinimumSalary] description: A link to the Card Description:Image for the product.
type: string
CustomerType: format: uri
Eligibility:
type: array type: object
itemsdescription: |
The eligibility criteria type:for objectthe product.
properties:
properties: ResidenceStatus:
Typedescription: |
The residence statuses type:of stringthe User - that are eligible for the product.
enum: [Retail, SME, Corporate] type: "array"
Descriptionitems:
type: stringobject
AccountOwnership: properties:
type: array Type:
items: type: objectstring
properties: description: |
Type: The type of residence status eligible for type: stringthe product.
enum: [IndividualUaeResident, ExpatriatesResident, JointGCCNational, MultiNonUaeResident]
Description:
type: string
Age: description: |
type: array items: The description of the residence status eligible for type:the objectproduct.
propertiesexample: [
{
Type: Type: "UaeResident",
type: string Description: "A person who is enum: [MinimumAge, MaximumAge]
a resident of the United Arab Emirates."
Description: }
]
type: string EmploymentStatus:
Valuedescription: |
The employment statuses type:of numberthe User - that are eligible for the product.
AdditionalEligibility: type: array
items:
type: object
properties:
Type:
type: string
Description: description: |
type: string The Document:type of employment status eligible for the type:product.
object properties: Typeenum: [Salaried, NonSalaried, EligibleEmployer, SelfEmployed, Unemployed, MinimumSalary]
type: string Description:
enum: [Passport, IDCard, UtilityBill, BankStatement, Other] Descriptiontype: string
type: string Channeldescription: |
type: object properties: The description of the Type:employment status eligible for the product.
type: string CustomerType:
enum: [Phone, Internet, Mobile, Branch, ATM, RelationshipManager] description: |
Description: The customer types of the User - that are eligible type:for stringthe product.
Feature: type: objectarray
propertiesitems:
Typetype: object
type: string properties:
enum: [Feature1, Feature2, Feature3] Type:
Description: type: string
Limit: type: object description: |
properties: Type: The type of customer type: stringeligible for the product.
enum: [Limit1, Limit2, Limit3] enum: [Retail, SME, Corporate, New, Description:Existing]
type: string Description:
Value: type: string
number Fee: type: object description: |
properties: Type: The description of the customer type: stringeligible for the product.
enum AccountOwnership:
[Monetary, Percentage] Namedescription: |
type: string The account ownership types of the User - Description:that are eligible for the product.
type: string type: array
Unit: items:
type: string type: object
enum: [Amount, Percentage] Amountproperties:
type: number Type:
Percentage: type: numberstring
nullable: true description: |
UnitValue: type: number The type of account ownership eligible for nullable:the trueproduct.
MaximumUnitValue: enum: [Individual, Joint, type:Multi]
number nullable: true Description:
Currency: type: string
Benefit: type: object propertiesdescription: |
Type: The type:description stringof the account ownership eligible for the product.
enum: [Cashback, RewardPoints, TravelBenefits, LifeStyleBenefits, WelcomeGifts,Age:
Discounts, Protection] Namedescription: |
type: string The age of the User - Description:that are eligible for the product.
type: array
string Valueitems:
type: numberobject
ProductDetails: typeproperties:
object properties: Type:
CurrentAccount: $ref: '#/components/schemas/CurrentAccountDetails' type: string
Savings: $refdescription: '#/components/schemas/SavingsDetails'
The type of age eligibility criteria.
CreditCard: $refenum: '#/components/schemas/CreditCardDetails'
[MinimumAge, MaximumAge]
PersonalLoan: Description:
$ref: '#/components/schemas/PersonalLoanDetails' Mortgage: type: string
$ref: '#/components/schemas/MortgageDetails' ProfitSharingRatedescription: The description of the age eligibility criteria.
$ref: '#/components/schemas/ProfitSharingRateDetails' FinanceProfitRateValue:
$ref: '#/components/schemas/FinanceProfitRateDetails' CurrentAccountDetailstype: number
type: object properties: Typedescription: The value of the age eligibility criteria.
type: string enum: [Basic, Premium, Advanced]AdditionalEligibility:
OverdraftAvailabledescription: |
type: boolean Additional eligibility criteria for AdditionalInformation:the product.
type: array
items:
type: object
properties:
Type:
type: string
enum: [Additional1Student, UaeArmedForces, TimeInCountry, Additional2Other]
Decription: description: The type of eligibility criteria.
type: string SavingsDetailsDescription:
type: object properties: type: string
Type: typedescription: stringThe description of the eligibility criteria.
enumChannel:
[Savings1, Savings2] type: object
Description: description: |
type: string The channels through which the User can MinimumBalance:use the product.
$refproperties:
'#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0' AnnualReturnType:
type: numberstring
Features: description: |
type: array The type of channel through which items:
the User can use the product.
typeenum: object
[Phone, Internet, MobileApp, Branch, RelationshipManager, Other]
propertiesDescription:
type: string
Description description: |
The description of type: string
CreditCardDetails:
the channel through which the User can use the product.
typeProductDetails:
object propertiestype: object
description: Type:|
The product type: stringspecific details for the product.
enumproperties:
[Credit1, Credit2] DescriptionCurrentAccount:
type$ref: string'#/components/schemas/CurrentAccountDetails'
RateSavingsAccount:
type$ref: number'#/components/schemas/SavingsDetails'
FeaturesCreditCard:
type$ref: array'#/components/schemas/CreditCardDetails'
itemsPersonalLoan:
type$ref: object'#/components/schemas/PersonalLoanDetails'
Mortgage:
properties: $ref: '#/components/schemas/MortgageDetails'
Type ProfitSharingRate:
$ref: '#/components/schemas/ProfitSharingRateDetails'
type: string FinanceProfitRate:
$ref: '#/components/schemas/FinanceProfitRateDetails'
enum: [Insurance, FlexiblePaymentTerm, BalanceTransfer,CurrentAccountDetails:
CashBack] type: object
Descriptiondescription: |
The details specific to a current account type:product. stringWhen ProductCategory is "CurrentAccount" the CurrentAccount object must also be returned
Valueproperties:
Type:
type: number description: |
Fees: The type of current type:account arrayproduct.
itemstype: string
typeenum: object[Basic, Premium, Advanced, Other]
propertiesDescription:
type: string
Type: description: |
type: string The description of the current account product.
Name: IsOverdraftAvailable:
type: stringboolean
description: |
Description: Indicates whether the current account product has type:an stringoverdraft facility.
Documentation:
Value: type: array
typedescription: number|
Benefits: A list of documents that are required type:by arraythe LFI when applying for the current account product.
items: typeitems:
object propertiestype: object
description: Type:|
A document type:that stringis required by the LFI when applying for the current account product.
enum: [Cashback, RewardPoints, TravelBenefits, LifeStyleBenefits, WelcomeGifts, Discounts, Protection]properties:
NameType:
type: string
Description: description: |
type: string The type of document required by the LFI when applying for Value:the current account product.
type: number enum: [ApplicationForm,IDCard, Passport, PersonalLoanDetails:ResidenceVisa, ProofofAddress, UtilityBill, SalaryCertificate, SalarySlip, TradeLicence, BusinessOwnership, type:Other]
object properties: TypeDescription:
type: string Descriptiontype: string
type: string MaximumLoanAmountdescription: |
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0' The Tenure:description of the document required by the LFI when applying for type:the objectcurrent account product.
propertiesFeatures:
MinimumLoanTenuretype: array
typedescription: string|
MaximumLoanTenure:A list of features of the current account product.
type: string items:
CalculationMethod: type: object
type: string Ratedescription: |
type: object A feature of the current account product.
properties: Typeproperties:
typeType:
string Descriptiondescription: |
type: string The type of additional current account feature.
ReviewFrequency: type: string
IndicativeRate: enum: [IslamicBanking, IslamicFinance, DebitCard, MultipleCurrencies, DigitalWallet, ChequeBook, Cashback, ATMTransfers, FreeCashWithdrawal, FreeInternationalPayments, type: object
Contactless, CardlessATMWithdrawal, TellerTransactions, SMSNotifications, BillPayments, FundsTransfer, SalaryAdvance, WorldWideSupport, Other]
properties: Description:
From: description: |
type: string The description of the additional current account feature.
To: type: string
Fees:
ProfitRate: type: array
type: object description: |
properties: A list of fees associated with the current account product.
From: items:
type: stringobject
description: |
To: A fee associated with the current account type:product.
string AnnualPercentageRateRange: properties:
type: object Type:
properties: Fromtype: string
type: string description: |
To: The type of fee.
type: string FixedRatePeriod: enum: [MonthlyFees, AnnualFees, BalanceFallBelow, Overdraft, DomesticTransaction, ForeignTransaction, type: string
ATMWithdrawal, ChequeBook, ReplacementChequeBook, ReturnCheque, CardReplacement, AccountStatement, LetterIssued, Other]
DebtBurdenRatio: type Period:
string Features: type: string
type: array itemsdescription: |
type: object The period of the fee.
properties: Typeenum: [Daily, Monthly, Yearly, OneOff, Other]
type Name:
string Descriptiontype: string
type: string description: |
AdditionalInformation: The name of the fee.
type: array itemsDescription:
type: object type: string
properties: description: |
Type: The description of the type:fee.
string DescriptionUnit:
type: string
MortgageDetails: type: object description: |
properties: Type: The unit of type:the stringfee.
Description: enum: [Amount, Percentage]
type: string PlanName: Amount:
type: string CalculationMethod$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
type: string Percentage:
Structure: type: stringnumber
Rate: description: |
type: object properties: The percentage of the fee.
Type: UnitValue:
type: string type: number
enum: [Fixed, Variable, Hybrid] description: |
Description: type: string The value of the fee in the unit of the fee.
ReviewFrequency: typeMaximumUnitValue:
string IndicativeRate: type: number
type: object description: |
properties: The maximum value of the fee in From:the unit of the fee.
Limits:
type: string type: array
Todescription: |
A list of limits associated type: string
with the current account product.
ProfitRateitems:
type: object
propertiesdescription: |
A From:limit of the current account product.
typeproperties:
string ToType:
type: string
IndicativeAPR: typedescription: object|
properties: The type of limit.
From: typeenum: string[MinimumDeposit, MinimumBalance, MaximiumWithdrawal, MaximumCashATMWithdrawal, MaximumInternationalATMWithdrawal, RetailDomesticPurchase, RetailInternationalPurchase, TellerTransactions, Other]
To: Description:
type: string FixedRatePeriodtype: string
type: string description: |
MaximumLoanAmount: $ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0' The description of the MaximumLTV:limit.
type: string Value:
DownPayment: $reftype: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0' number
Tenure: description: |
type: object properties: The value of the limit.
MinimumLoanTenure: Benefits:
type: stringarray
description: |
MaximumLoanTenure: A list of type:benefits stringassociated with the current account ProfitSharingRateDetails:product.
type: object items:
properties: Typetype: object
type: string description: |
Description: A benefit associated type:with stringthe current account product.
Name: properties:
type: string MinimumDepositAmount Type:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0' type: string
AnnualReturn: type: number description: |
AnnualReturnOptions: type: array The type of benefit.
items: typeenum: object[Cashback, RewardPoints, AirMiles, AirportLounge, RoadSideAssistance, Parking, WelcomeGifts, Discounts, InsuranceProtection, PurchaseProtection, Dining, Cinema, Golf, properties:Other]
TypeName:
type: string
Description: description: |
type: string The name of the benefit.
InvestmentPeriod: type: object Description:
properties: type: string
Type: typedescription: string|
Description: The description of the benefit.
type: string AdditionalInformationValue:
type: array type: number
items: typedescription: object|
properties: The value of the benefit.
TypeSavingsDetails:
type: object
description: type:|
string The details specific to a savings account Description:product. When ProductCategory is "SavingsAccount" the SavingsAccount object must also be returned
typeproperties:
string FinanceProfitRateDetailsType:
type description: object|
properties: The type of Type:savings account product.
type: string
enum: [ProfitSharingRateSavings, OnlineSaver, TermDeposit, Notice, FinanceProfitRateOther]
Description:
typedescription: string|
CalculationMethod: The description of the savings account product.
type: string enumtype: [FlatRate,string
ReducingRate, Profit, Lease] RateMinimumBalance:
type$ref: number'#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
FrequencyAnnualReturn:
typedescription: string|
Tiers: The annual return of the savings account type:product arrayexpressed as a percentage.
items: $ref: '#/components/schemas/RateTier'type: number
AdditionalInformationDocumentation:
type: array
itemsdescription: |
type: objectA list of documents that are required by the LFI when applying for properties:the savings account product.
Typeitems:
type: object
type: string description: |
Description: A document that is required by the type:LFI stringwhen applying for the savings RateTier:account product.
type: object properties:
Type:
type: string type: string
Description: type: string description: |
Name: type: string The type of document required by the LFI Unit:when applying for the savings account product.
type: string enum: [BalanceApplicationForm,IDCard, LTVPassport, TimePeriod]ResidenceVisa, ProofofAddress, UtilityBill, SalaryCertificate, SalarySlip, TradeLicence, BusinessOwnership, Other]
MinimumTierValue: $ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
Description:
MaximumTierValue: $reftype: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'string
MinimumTierRate: description: |
type: string MaximumTierRate: The description of the type:document stringrequired by the LFI when applying for the product.
Condition: Features:
type: string AEActiveOrHistoricCurrencyAndAmount_0: type: array
type: object requireddescription: |
- Amount A list of features of -the Currencysavings account product.
description: >- items:
This is the value of the amount in the currencytype: object
properties: description: |
Amount: $ref: '#/components/schemas/AEActiveCurrencyAndAmount_SimpleType' A feature of the savings account product.
Currency: $refproperties: '#/components/schemas/ActiveOrHistoricCurrencyCode_0'
additionalProperties: false AEActiveCurrencyAndAmount_SimpleTypeType:
description: >- Atype: numberstring
of monetary units specified in an active currency where the description: |
unit of currency is explicit and compliant with ISO 4217. type: string The type of feature.
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ ActiveOrHistoricCurrencyCode_0: descriptionenum: >-
Identification of the currency in which the account is held. A code[IslamicBanking, IslamicFinance, DebitCard, MultipleCurrencies, ATMCard, FreeATMAccess, ChequeBook, CardlessChequeDeposit, CounterTransactions, MoneyTransfer, NoLockIn, SMSNotifications, Other]
Description:
allocated to a currency under an international currency identification type: string
scheme, as described in the latest edition of the international standard description: ISO|
4217 'Codes for the representation of currencies and funds'. type: string The description of the feature.
pattern: ^[A-Z]{3,3}$ exampleFees:
AED LeadRequest: type: "object"array
additionalProperties description: false|
required: A list of -fees "Data"associated with the savings account product.
properties: Dataitems:
type: "object"
additionalPropertiesdescription: false|
required: A fee associated with the savings account product.
- Name properties:
- Email propertiesType:
Email: type: string
typedescription: |
string format: emailThe type of fee.
description: Email address of the account holder
PhoneNumber:enum: [MonthlyFees, AnnualFees, BalanceFallBelow, DomesticTransaction, ForeignTransaction, ATMWithdrawal, ChequeBook, ReplacementChequeBook, ReturnCheque, CardReplacement, AccountStatement, LetterIssued, AccountClosure, Other]
typePeriod:
string pattern: ^\+[1-9]\d{1,14}$type: string
description: Phone|
number in E.164 format Name: The period of the fee.
$ref: '#/components/schemas/AEUserName' enum: [Daily, Monthly, Yearly, OneOff, Other]
EmiratesId: Name:
type: string descriptiontype: Emirates IDstring
number of the Party Nationalitydescription: |
type: string The name of the fee.
ResidentialAddress: Description:
$ref: '#/components/schemas/AEPartyIdentityAddressClaim' LeadInformationtype: string
type: string description: |
ProductCategories: The description of the fee.
type: array itemsUnit:
type: objectstring
propertiesdescription: |
Type: The unit of the fee.
typeenum: string[Amount, Percentage]
Amount:
enum: [Savings, CurrentAccount, CreditCard, Loan, Mortgage] $ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
description: Properties to request a the Confirmation of Payee LeadResponsePercentage:
type: "object" additionalProperties: false type: number
required: - "Data"description: |
properties: Data: The percentage of the fee.
type: "object" additionalPropertiesUnitValue:
false required: type: number
- LeadId description: |
- Name - Email The value of the fee in the unit of the fee.
properties: LeadIdMaximumUnitValue:
type: number
string description: Unique|
identifier for the lead Email: The maximum value of the fee in the unit of the fee.
type: string Limits:
format: email type: array
description: Email|
address of the account holder A list of limits associated PhoneNumber:with the savings account product.
typeitems:
string pattern: ^\+[1-9]\d{1,14}$
type: object
description: Phone|
number in E.164 format A limit Name:of the savings account product.
$ref properties:
'#/components/schemas/AEUserName' EmiratesIdType:
type: string
description: Emirates|
ID number of the Party Nationality: The type of limit.
type: string enum: [MinimumOpeningBalance, MaximumBalance, MaximiumWithdrawal, MaximumCashATMWithdrawal, MaximumInternationalATMWithdrawal, MaximumTellerTransactions, Other]
ResidentialAddress: $refDescription:
'#/components/schemas/AEPartyIdentityAddressClaim' LeadInformation: type: string
type: string description: |
ProductCategories: The description of type:the arraylimit.
itemsValue:
type: objectnumber
propertiesdescription: |
Type:
The value of the limit.
Benefits:
type: stringarray
description: |
enum: [Savings, CurrentAccount, CreditCard,A Loan,list Mortgage]of benefits associated with the savings account product.
description: Properties to request a the Confirmation ofitems:
Payee AEUserName: oneOftype: object
- $ref: '#/components/schemas/AEPersonalAccountName' description: |
- $ref: '#/components/schemas/AEBusinessAccountName' AEPersonalAccountName: A benefit associated with the type:savings objectaccount product.
required: properties:
- GivenName - LastName properties:
Type:
GivenName: type: string
minLength: 1 description: |
maxLength: 70 description:The >-type of benefit.
The given or first name of the account holder, as understood by the
enum: [Cashback, DiscountOffers, RewardPoints, InsuranceProtection, LoyaltyMembership, ComplementaryServices, Other]
Debtor Name:
LastName: type: string
minLength: 1 description: |
maxLength: 70 description: >- The name of the benefit.
The family or surname of the account holder,Description:
as understood by the Debtortype: string
description: The properties required to verify a personal account description: |
additionalProperties: false AEBusinessAccountName: type: object The description of the benefit.
required: - BusinessName Value:
properties: BusinessName: type: number
type: string minLengthdescription: 1|
maxLength: 140 The value of the description:benefit.
The business name ofCreditCardDetails:
the account holder, as understood by thetype: Debtorobject
description: The|
properties required to verify a business account The details specific to a additionalProperties:credit falsecard product. When ProductCategory is AEPartyIdentityAddressClaim:"CreditCard" the CreditCard object must also be type:returned
object requiredproperties:
-Type:
Formatted - StreetAddressdescription: |
- Locality The type of the credit -card Regionproduct.
- PostalCode enum: [Visa, Mastercard, AmericanExpress, Diners, Other]
- Country propertiestype: string
Formatted Description:
typedescription: string|
description: | The description of the credit card product.
The address number and street claimtype: thatstring
has been verified. Rate:
StreetAddress: description: |
type: string The description:Annual |Percentage Rate (APR) that is displayed as the main rate.
The address street claim that has beentype: verified.number
LocalityDocumentation:
type: stringarray
description: >|
TheA addresslist localityof (village, town, city etc) claim that has been
documents that are required by the LFI when applying for the credit card product.
verified. items:
Region: type: object
type: string description: |
The address regionA claimdocument that hasis beenrequired verified.by the LFI when applying for the credit card PostalCode:product.
$ref: '#/components/schemas/PostalCode'
properties:
Country: Type:
$ref: '#/components/schemas/CountryCode' description: > type: Address object as per OpenID Connect Core 1.0 Address Claimstring
description: |
The type of document required by the LFI when applying for the product.
enum: [ApplicationForm, IDCard, Passport, ResidenceVisa, ProofofAddress, UtilityBill, BankStatement, SalaryCertificate, SalarySlip, TradeLicence, UndatedSecurityCheque, BusinessOwnership, Other]
Description:
type: string
description: |
The description of the document required by the LFI when applying for the product.
Features:
type: array
description: |
A list of features of the credit card product.
items:
type: object
description: |
A feature of the credit card product.
properties:
Type:
type: string
description: |
The type of feature.
enum: [IslamicBanking, IslamicFinance, AdditionalCards, CoBrandedCard, BalanceTransfer, CashWithdrawal, InternationalPayments, FlexiblePaymentTerm, InstalmentPaymentPlans, InsuranceProtection, CreditShield, CardControl, PersonalisedCardDesign, Other]
Description:
type: string
description: |
The description of the feature.
Fees:
type: array
description: |
A list of fees associated with the credit card product.
items:
type: object
description: |
A fee associated with the credit card product.
properties:
Type:
type: string
description: |
The type of fee.
enum: [AnnualFee, CashAdvance, LatePayment, BalanceTransfer, ForeignTransaction, OverLimit, CardReplacement, CardStatement, SalesVoucherCopy, LetterIssued, Other]
Period:
type: string
description: |
The period of the fee.
enum: [Daily, Monthly, Yearly, OneOff, Other]
Name:
type: string
description: |
The name of the fee.
Description:
type: string
description: |
The description of the fee.
Unit:
type: string
description: |
The unit of the fee.
enum: [Amount, Percentage]
Amount:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
Percentage:
type: number
description: |
The percentage of the fee.
UnitValue:
type: number
description: |
The value of the fee in the unit of the fee.
MaximumUnitValue:
type: number
description: |
The maximum value of the fee in the unit of the fee.
Limits:
type: array
description: |
A list of limits associated with the credit card product.
items:
type: object
description: |
A limit of the credit card product.
properties:
Type:
type: string
description: |
The type of limit.
enum: [MinimumCreditLimit, MaximumCreditLimit, MinimumRequiredCreditScore, MinimumSpend, MaximumCashATMWithdrawal, MaximumInternationalATMWithdrawal, Other]
Description:
type: string
description: |
The description of the limit.
Value:
type: number
description: |
The value of the limit.
Benefits:
type: array
description: |
A list of benefits associated with the credit card product.
items:
type: object
description: |
A benefit associated with the credit card product.
properties:
Type:
type: string
description: |
The type of benefit.
enum: [Cashback, RewardPoints, AirMiles, AirportLounge, AirportPickUps, RoadSideAssistance, WelcomeGifts, ShoppingDiscounts, DiningDiscounts, LoyaltyMembership, InsuranceProtection, PurchaseProtection, ConciergeServices, ValetParking, Cinema, Golf, Gym, Spa, BeachPoolAccess, Other]
Name:
type: string
description: |
The name of the benefit.
Description:
type: string
description: |
The description of the benefit.
Value:
type: number
description: |
The value of the benefit.
PersonalLoanDetails:
type: object
properties:
Type:
description: |
The type of the personal loan product. When ProductCategory is "PersonalLoan" the PersonalLoan object must also be returned
type: string
enum: [PersonalFinance, DebtSettlement, EducationFinance, TravelFinance, BoatFinance, Other]
Description:
description: |
The description of the personal loan product.
type: string
MinimumLoanAmount:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
MaximumLoanAmount:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
Tenure:
type: object
description: |
The tenure of the personal loan product.
properties:
MinimumLoanTenure:
description: |
The minimum loan tenure in months.
type: number
MaximumLoanTenure:
description: |
The maximum loan tenure in months.
type: number
CalculationMethod:
type: string
enum: [FlatRate, ReducingRate, Profit, Lease]
description: |
For conventional home loans confirmation of the method to calculate payments and how interest is charged. The options are:
FlatRate - Interest is calculated on the full principal amount for the entire loan tenure.
ReducingRate - Interest is calculated only on the outstanding principal balance after each repayment.
For Shariah compliant home loans confirmation of the method to calculate payments. The options are:
Profit
Lease
Rate:
type: object
description: |
Confirmation of the rates range that will be applied to the home finance.
properties:
Type:
type: string
enum: [Fixed, Variable, Hybrid]
description: |
Confirmation whether the rate is a Fixed rate, Variable rate or a Hybrid rate that is fixed for initial years and variable thereafter.
Description:
type: string
description: |
The description of the rate.
ReviewFrequency:
type: string
description: |
When the rate is Variable the frequency the rate is reviewed against base index.
IndicativeRate:
type: object
description: |
For conventional personal loans confirmation of the indicative rate covering the minimum (From) and maximum (To) rate range.
properties:
From:
type: number
description: |
The minimum rate.
To:
type: number
description: |
The maximum rate.
ProfitRate:
type: object
description: |
the Profit Rate covering the starting rate from up to the maximum Profit Rate that could apply depending upon the Product type, the type of the property and the amount of Finance availed in relation to the market price of the property.
properties:
From:
type: number
description: |
The minimum rate.
To:
type: number
description: |
The maximum rate.
AnnualPercentageRateRange:
type: object
description: |
Annual Percentage Rate (APR) covering the minimum and maximum APR range. The indicative APR range includes applicable interest, fees and charges of the product, expressed as an annualised rate.
properties:
From:
type: number
description: |
The minimum APR.
To:
type: number
description: |
The maximum APR.
FixedRatePeriod:
description: Must be populated when the Rate Type is Fixed to confirm the period the rate will be fixed for.
type: string
DebtBurdenRatio:
type: string
description: |
If applicable, the maximum percentage DBR value based on the total debt / total income calculation.
DBR is the ratio of the Customer’s total monthly outgoing payments (including instalments towards their loans and credit cards), to their total income.
Documentation:
type: array
description: |
A list of documents that are required by the LFI when applying for the personal loan product.
items:
type: object
description: |
A document that is required by the LFI when applying for the personal loan product.
properties:
Type:
type: string
description: |
The type of document required by the LFI when applying for the product.
enum: [ApplicationForm, IDCard, Passport, ResidenceVisa, ProofofAddress, UtilityBill, BankStatement, SalaryCertificate, SalarySlip, UndatedSecurityCheque, ProofofBusinessOwnership, TradeLicence, MemorandumofAssociation, BusinessOwnership, Other]
Description:
type: string
description: |
The description of the document required by the LFI when applying for the product.
Features:
type: array
description: |
A list of features of the personal loan product.
items:
type: object
description: |
A feature of the personal loan product.
properties:
Type:
type: string
description: |
The type of feature.
enum: [IslamicBanking, IslamicFinance, QuickApproval, FreeDebitCard, FreeCreditCard, FlexibleRepaymentPeriods, BuyOut, TransferPersonalLoan, LoanConsolidation, LoanTopUp, RevolvingOverdraft, DefermentFacility, LifeInsurance, Guarantor, Other]
Description:
type: string
description: |
The description of the feature.
Limits:
type: array
description: |
A list of limits associated with the personal loan product.
items:
type: object
description: |
A limit of the personal loan product.
properties:
Type:
type: string
description: |
The type of limit.
enum: [MinimumRequiredCreditScore, MaximumOverpayment, Other]
Description:
type: string
description: |
The description of the limit.
Value:
type: number
description: |
The value of the limit.
Fees:
type: array
description: |
A list of fees associated with the personal loan product.
items:
type: object
description: |
A fee associated with the personal loan product.
properties:
Type:
type: string
description: |
The type of fee.
enum: [Processing, LoanCancellation, PartialPayment, LatePayment, EarlySettlement, FinalSettlement, Other]
Period:
type: string
description: |
The period of the fee.
enum: [Daily, Monthly, Yearly, OneOff, Other]
Name:
type: string
description: |
The name of the fee.
Description:
type: string
description: |
The description of the fee.
Unit:
type: string
description: |
The unit of the fee.
enum: [Amount, Percentage]
Amount:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
Percentage:
type: number
description: |
The percentage of the fee.
UnitValue:
type: number
description: |
The value of the fee in the unit of the fee.
MaximumUnitValue:
type: number
description: |
The maximum value of the fee in the unit of the fee.
Benefits:
type: array
description: |
A list of benefits associated with the personal loan product.
items:
type: object
description: |
A benefit associated with the personal loan product.
properties:
Type:
type: string
description: |
The type of benefit.
enum: [Other]
Name:
type: string
description: |
The name of the benefit.
Description:
type: string
description: |
The description of the benefit.
Value:
type: number
description: |
The value of the benefit.
AdditionalInformation:
type: array
description: |
A list of additional information about the personal loan product.
items:
type: object
properties:
Type:
type: string
enum: [Other]
description: |
The type of personal loan additional information.
Description:
type: string
description: |
The description of the personal loan additional information.
MortgageDetails:
type: object
description: |
The details specific to a mortgage product. When ProductCategory is "Mortgage" the Mortgage object must also be returned
properties:
Type:
type: string
enum: [FixedRate, VariableRate, HybridRate, IslamicHomeLoan, Offset, Other]
description: |
The type of mortgage product.
Description:
type: string
description: |
The description of the mortgage product.
CalculationMethod:
type: string
enum: [FlatRate, ReducingRate, Profit, Lease]
description: |
For conventional home loans confirmation of the method to calculate payments and how interest is charged. The options are:
FlatRate - Interest is calculated on the full principal amount for the entire loan tenure.
ReducingRate - Interest is calculated only on the outstanding principal balance after each repayment.
For Shariah compliant home loans confirmation of the method to calculate payments. The options are:
Profit
Lease
Structure:
type: string
description: |
When the home loan is Shariah compliant, confirmation of the Islamic finance model that is used for the housing finance.
Rate:
type: object
description: |
Rate information for the mortgage product.
properties:
Type:
type: string
enum: [Fixed, Variable, Hybrid]
description: |
Confirmation whether the rate is a Fixed rate, Variable rate or a Hybrid rate that is fixed for initial years and variable thereafter.
Description:
type: string
description: |
The description of the rate.
ReviewFrequency:
description: When the rate is Variable the frequency the rate is reviewed against base index.
type: string
IndicativeRate:
type: object
description: The indicative rate covering the minimum (From) and maximum (To) rate range.
properties:
From:
description: The minimum rate.
type: number
To:
description: The maximum rate.
type: number
ProfitRate:
type: object
description: |
the Profit Rate covering the starting rate from up to the maximum Profit Rate that could apply depending upon the Product type, the type of the property and the amount of Finance availed in relation to the market price of the property.
properties:
From:
type: number
description: |
The minimum rate.
To:
type: number
description: |
The maximum rate.
IndicativeAPR:
type: object
description: |
The indicative APR covering the minimum (From) and maximum (To) rate range.
properties:
From:
type: number
description: |
The minimum rate.
To:
type: number
description: |
The maximum rate.
FixedRatePeriod:
type: string
description: |
Must be populated when the Rate Type is Fixed to confirm the period the rate will be fixed for.
MinimumLoanAmount:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
MaximumLoanAmount:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
MaximumLTV:
type: number
description: The maximum Loan-to-Value (LTV) allowed. Where a different LTV applies for each residency type the individual value must be provided.
DownPayment:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
RepaymentTenure:
type: object
description: |
The maximum repayment tenure for the mortgage product.
properties:
MinimumLoanTenure:
type: number
description: |
The minimum loan tenure in months.
MaximumLoanTenure:
type: number
description: |
The maximum loan tenure in months.
Documentation:
type: array
description: |
A list of documents that are required by the LFI when applying for the mortgage product.
items:
type: object
description: |
A document that is required by the LFI when applying for the mortgage product.
properties:
Type:
type: string
description: |
The type of document required by the LFI when applying for the product.
enum: [ApplicationForm, IDCard, Passport, ResidenceVisa, EmploymentProof, ProofofAddress, UtilityBill, BankStatement, SalaryCertificate, SalarySlip, TradeLicence, BusinessOwnership, PropertyOwnership, SalesandPurchaseAgreement, DeveloperLicense, TitleDeed, NoObjectionCertificate, ValuationReport, MortgageStatement, Other]
Description:
type: string
description: |
The description of the document required by the LFI when applying for the product.
Features:
type: array
description: |
A list of features of the mortgage product.
items:
type: object
description: |
A feature of the mortgage product.
properties:
Type:
type: string
description: |
The type of feature.
enum: [IslamicBanking, IslamicFinance, OnlineApplication, PreApproval, LifeInsurance, PropertyInsurance, GracePeriod, Overpayments, Redraw, FreeCreditCard, FreePropertyValuation, BuyOut, TopUp, InstalmentDeferment, EquityRelease, NoDeveloperRestriction, Guarantor, Other]
Description:
type: string
description: |
The description of the feature.
Fees:
type: array
description: |
A list of fees associated with the mortgage product.
items:
type: object
description: |
A fee associated with the mortgage product.
properties:
Type:
type: string
description: |
The type of fee.
enum: [Processing, LatePayment, EarlySettlement, FinalSettlement, LetterIssued, Other]
Period:
type: string
description: |
The period of the fee.
enum: [Daily, Monthly, Yearly, OneOff, Other]
Name:
type: string
description: |
The name of the fee.
Description:
type: string
description: |
The description of the fee.
Unit:
type: string
description: |
The unit of the fee.
enum: [Amount, Percentage]
Amount:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
Percentage:
type: number
description: |
The percentage of the fee.
UnitValue:
type: number
description: |
The value of the fee in the unit of the fee.
MaximumUnitValue:
type: number
description: |
The maximum value of the fee in the unit of the fee.
Limits:
type: array
description: |
A list of limits associated with the mortgage product.
items:
type: object
description: |
A limit associated with the mortgage product.
properties:
Type:
type: string
description: |
The type of limit.
enum: [MinimumRequiredCreditScore, MaximumOverpayment, Other]
Description:
type: string
description: |
The description of the limit.
Value:
type: number
description: |
The value of the limit.
Benefits:
type: array
description: |
A list of benefits associated with the mortgage product.
items:
type: object
description: |
A benefit associated with the mortgage product.
properties:
Type:
type: string
description: |
The type of benefit.
enum: [Other]
Name:
type: string
description: |
The name of the benefit.
Description:
type: string
description: |
The description of the benefit.
Value:
type: number
description: |
The value of the benefit.
ProfitSharingRateDetails:
type: object
properties:
Name:
type: string
description: |
The name of the profit sharing rate.
Description:
type: string
description: |
The description of the profit sharing rate.
MinimumDepositAmount:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
AnnualReturn:
type: number
description: |
The annual return of the profit sharing rate.
AnnualReturnOptions:
type: array
description: |
The annual return options of the profit sharing rate.
items:
type: object
properties:
Name:
type: string
description: |
The name of the annual return option.
Description:
type: string
description: |
The description of the annual return option.
InvestmentPeriod:
type: object
description: |
The investment period of the profit sharing rate.
properties:
Name:
type: string
description: |
The type of investment period.
Description:
type: string
description: |
The description of the investment period.
AdditionalInformation:
type: array
description: |
The additional information of the profit sharing rate.
items:
type: object
properties:
Type:
type: string
enum: [Other]
description: |
The type of additional information.
Description:
type: string
description: |
The description of the additional information.
FinanceProfitRateDetails:
type: object
description: |
The details specific to a finance profit rate.
properties:
Name:
type: string
description: |
The name of the finance profit rate.
Description:
type: string
description: |
The description of the finance profit rate.
CalculationMethod:
type: string
enum: [FlatRate, ReducingRate, Profit, Lease]
description: |
For conventional home loans confirmation of the method to calculate payments and how interest is charged. The options are:
FlatRate - Interest is calculated on the full principal amount for the entire loan tenure.
ReducingRate - Interest is calculated only on the outstanding principal balance after each repayment.
For Shariah compliant home loans confirmation of the method to calculate payments. The options are:
Profit
Lease
Rate:
type: number
description: |
The rate of the finance profit rate product.
Frequency:
type: string
description: |
The frequency of the finance profit rate product.
Tiers:
type: array
description: |
The tiers of the finance profit rate product.
items:
$ref: '#/components/schemas/RateTier'
AdditionalInformation:
type: array
description: |
The additional information of the finance profit rate product.
items:
type: object
properties:
Type:
type: string
enum: [Other]
description: |
The type of additional information.
Description:
type: string
description: |
The description of the additional information.
RateTier:
type: object
description: |
The tier of the finance profit rate product.
properties:
Type:
description: |
The type of the tier.
type: string
Description:
type: string
description: |
The description of the tier.
Name:
type: string
description: |
The name of the tier.
Unit:
type: string
enum: [Balance, LTV, TimePeriod]
description: |
The unit of the tier.
MinimumTierValue:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
MaximumTierValue:
$ref: '#/components/schemas/AEActiveOrHistoricCurrencyAndAmount_0'
MinimumTierRate:
type: number
description: |
The minimum rate of the tier.
MaximumTierRate:
type: number
description: |
The maximum rate of the tier.
Condition:
type: string
description: |
The conditions of the tier.
AEActiveOrHistoricCurrencyAndAmount_0:
type: object
required:
- Amount
- Currency
description: >-
This is the value of the amount in the currency
properties:
Amount:
$ref: '#/components/schemas/AEActiveCurrencyAndAmount_SimpleType'
Currency:
$ref: '#/components/schemas/ActiveOrHistoricCurrencyCode_0'
additionalProperties: false
AEActiveCurrencyAndAmount_SimpleType:
description: >-
A number of monetary units specified in an active currency where the
unit of currency is explicit and compliant with ISO 4217.
type: string
pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
ActiveOrHistoricCurrencyCode_0:
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'.
type: string
pattern: ^[A-Z]{3,3}$
example: AED
LeadRequest:
type: "object"
additionalProperties: false
description: |
The request to create a lead.
required:
- "Data"
properties:
Data:
type: "object"
additionalProperties: false
description: |
The data for the lead request.
required:
- Name
- Email
properties:
Email:
type: string
format: email
description: Email address of the account holder
PhoneNumber:
type: string
pattern: ^\+[1-9]\d{1,14}$
description: Phone number in E.164 format
Name:
$ref: '#/components/schemas/AEUserName'
EmiratesId:
type: string
description: Emirates ID number of the Party
Nationality:
type: string
description: Nationality of the Party
ResidentialAddress:
$ref: '#/components/schemas/AEPartyIdentityAddressClaim'
LeadInformation:
type: string
ProductCategories:
type: array
items:
type: object
properties:
Type:
type: string
enum: [SavingsAccount, CurrentAccount, CreditCard, Loan, Mortgage]
LeadResponse:
type: "object"
additionalProperties: false
required:
- "Data"
properties:
Data:
type: "object"
description: |
The data for the lead response.
additionalProperties: false
required:
- LeadId
- Name
- Email
properties:
LeadId:
type: string
description: Unique identifier for the lead
Email:
type: string
format: email
description: Email address of the account holder
PhoneNumber:
type: string
pattern: ^\+[1-9]\d{1,14}$
description: Phone number in E.164 format
Name:
$ref: '#/components/schemas/AEUserName'
EmiratesId:
type: string
description: Emirates ID number of the Party
Nationality:
type: string
ResidentialAddress:
$ref: '#/components/schemas/AEPartyIdentityAddressClaim'
LeadInformation:
type: string
ProductCategories:
type: array
items:
type: object
properties:
Type:
type: string
enum: [SavingsAccount, CurrentAccount, CreditCard, Loan, Mortgage]
AEUserName:
oneOf:
- $ref: '#/components/schemas/AEPersonalAccountName'
- $ref: '#/components/schemas/AEPersonalAccountFullName'
- $ref: '#/components/schemas/AEBusinessAccountName'
description: |
The name of the account holder.
AEPersonalAccountName:
type: object
required:
- GivenName
- LastName
properties:
GivenName:
type: string
minLength: 1
maxLength: 70
description: >-
The given or first name of the lead
LastName:
type: string
minLength: 1
maxLength: 70
description: >-
The family or surname of the lead
description: The name of a personal account
additionalProperties: false
AEPersonalAccountFullName:
type: object
required:
- FullName
properties:
FullName:
type: string
minLength: 1
maxLength: 140
description: >-
The full name of the lead
description: The full name of a personal account
additionalProperties: false
AEBusinessAccountName:
type: object
required:
- BusinessName
properties:
BusinessName:
type: string
minLength: 1
maxLength: 140
description: The business name of the lead
description: The name of a business account
additionalProperties: false
AEPartyIdentityAddressClaim:
type: object
properties:
AddressLine:
type: array
items:
description: >-
Information that locates and identifies a specific address, as
defined by postal services, presented in free format text.
This may be duplicated in other fields in the address object.
type: string
minLength: 1
maxLength: 70
minItems: 0
maxItems: 7
Locality:
type: string
description: >
The address locality (village, town, city etc) claim that has been
verified.
Region:
type: string
description: |
The address region claim that has been verified.
PostalCode:
$ref: '#/components/schemas/PostalCode'
Country:
$ref: '#/components/schemas/CountryCode'
description: >
Address object as per OpenID Connect Core 1.0 Address Claim
[https://openid.net/specs/openid-connect-core-1_0.html#AddressClaim](https://openid.net/specs/openid-connect-core-1_0.html#AddressClaim)
additionalProperties: false
CountryCode:
type: object
required:
- CountryCode
properties:
CountryCode:
type: string
pattern: [https://openid.net/specs/openid-connect-core-1_0.html#AddressClaim](https://openid.net/specs/openid-connect-core-1_0.html#AddressClaim)^[A-Z]{2,2}$
description: Nation with its own government, occupying a particular territory.
additionalProperties: false
PostalCode:
type: object
required:
- PostalCode
additionalPropertiesproperties:
false CountryCodePostalCode:
type: string
object requiredminLength: 5
- CountryCode maxLength: 5
properties: description: >-
CountryCode: type:Identifier stringconsisting of a group of letters and/or numbers that is
pattern: ^[A-Z]{2,2}$ added description:to Nationa withpostal itsaddress ownto government,assist occupyingthe asorting particularof territorymail.
responses:
additionalProperties 201LeadResponse:
false PostalCodedescription: "Lead Response"
type content:
object required:application/json:
schema:
- PostalCode properties$ref: "#/components/schemas/LeadResponse"
403Error:
PostalCode description: Forbidden
headers:
type: string x-fapi-interaction-id:
minLength: 5 description: An RFC4122 UID used as a maxLength:correlation 5id.
descriptionrequired: >-true
schema:
Identifier consisting of a group of letters and/or numbers that is type: string
content:
added to a postal address to assist the sorting of mail.application/json; charset=utf-8:
responses: 201LeadResponseschema:
description: "Lead Response" $ref: '#/components/schemas/AEErrorResponse'
content: application/json:
schema:
$ref: "'#/components/schemas/LeadResponse"AEErrorResponse'
403Error405Error:
description: ForbiddenMethod Not Allowed
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
406Error:
content:
description: Not Acceptable
headers:
application/json; charset=utf-8 x-fapi-interaction-id:
schemadescription: An RFC4122 UID used as a correlation id.
$ref: '#/components/schemas/AEErrorResponse' application/json:required: true
schema:
$reftype: '#/components/schemas/AEErrorResponse'string
405Error415Error:
description: MethodUnsupported NotMedia AllowedType
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
406Error429Error:
description: Too NotMany AcceptableRequests
headers:
Retry-After:
description: Number in seconds to wait
schema:
type: integer
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true schema:
type: string
415Error500Error:
description: UnsupportedInternal MediaServer TypeError
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
schema type: string
content:
application/json; charset=utf-8:
typeschema:
string 429Error: description$ref: Too Many Requests'#/components/schemas/AEErrorResponse'
headersapplication/json:
Retry-After schema:
description: Number in seconds to wait$ref: '#/components/schemas/AEErrorResponse'
401Error:
schemadescription: Unauthorized
typeheaders:
integer x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
500Error400Error:
description: InternalBad Server Errorrequest
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
required: true
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
401Error:
description: Unauthorized
headers:
x-fapi-interaction-id:
description: An RFC4122 UID used as a correlation id.
'
parameters:
requiredAuthorization:
true name: authorization
schema: in: header
required: true
type: string 400Errordescription: An authorization Token as per description: Bad requesthttps://tools.ietf.org/html/rfc6750
headersschema:
x-fapi-interaction-idtype: string
securitySchemes:
TPPOAuth2Security:
description: An RFC4122 UID used astype: aoauth2
correlation id. description: >-
required: true TPP confidential client authorization with the LFI to schema:stage a consent.
**Please refer type:to string[OpenID FAPI Security Profile 1.0 -Part 2
content: application/json; charset=utf-8:Advanced](https://openid.net/specs/openid-financial-api-part-2-1_0.html#authorization-server)
- 5.2.2 point schema:14 - shall authenticate the confidential client using one
$ref: '#/components/schemas/AEErrorResponse' of the following methods private_key_jwt application/json:
and [OpenID Connect Core
schema:1.0](https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication)
9. Client Authentication $ref: '#/components/schemas/AEErrorResponse'private_key_jwt**
parameters: flows:
Authorization: nameclientCredentials:
authorization in: header tokenUrl: https://authserver.example/token
required: true descriptionscopes:
An authorization Token as per https://tools.ietf.org/html/rfc6750 schemaproducts: Right to access leads and products resources
type: string
servers:
- url: /open-finance/product/v1.2-draft1
|
