openapi: 3.0.0
info:
title: UAE Insurance API
description: '## UAE Open Finance Insurance API Specification'
version: v1.0-draft3
tags:
- name: Insurance Consents
- name: Insurance Policies
paths:
/insurance-consents:
get:
tags:
- Insurance Consents
operationId: InsuranceConsents_list
summary: Retrieve Insurance Consents by BaseConsentId
description: Retrieve all Insurance Consents that are linked to a given BaseConsentId
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/CustomerUserAgentx-customer-user-agent'
- $ref: '#/components/parameters/FapiAuthDatex-fapi-auth-date'
- $ref: '#/components/parameters/FapiCustomerIpAddressx-fapi-customer-ip-address'
- $ref: '#/components/parameters/FapiInterationIdx-fapi-interaction-id'
- $ref: '#/components/parameters/BaseConsentId'
responses:
'200':
description: The request has succeeded.
headerscontent:
x-fapi-interaction-idapplication/json; charset=utf-8:
requiredschema:
false description$ref: An RFC4122 UID used as a correlation id.'#/components/schemas/AEReadInsuranceConsents1'
application/json:
schema: schema:
type: string $ref: '#/components/schemas/AEReadInsuranceConsents1'
content: application/json; charset=utf-8jwt:
schema:
$ref: '#/components/schemas/OBReadInsuranceConsents1AEReadInsuranceConsents1Signed'
'400':
application/json: description: Bad request
schema: headers:
$ref: '#/components/schemas/OBReadInsuranceConsents1' x-fapi-interaction-id:
application/jwt:
schema:
$ref: '#/components/schemas/OBReadInsuranceConsents1Signed'
'400':
description: Bad request
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/jwt:
schema:
anyOf:
- $ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
- $ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
'401':
description: Unauthorized
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'403':
description: Forbidden
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/jwt:
schema:
$ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
'404':
description: Not found
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'405':
description: Method Not Allowed
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'406':
description: Not Acceptable
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'415':
description: Unsupported Media Type
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'429':
description: Too Many Requests
headers:
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'500':
description: Internal Server Error
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/jwt:
schema:
anyOf:
- $ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
- $ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
security:
- TPPOAuth2Security:
- openid
- insurance
/insurance-consents/{ConsentId}:
get:
tags:
- Insurance Consents
operationId: InsuranceConsentsByConsentId_read
summary: Retrieve an Insurance Consent
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/CustomerUserAgentx-customer-user-agent'
- $ref: '#/components/parameters/FapiAuthDatex-fapi-auth-date'
- $ref: '#/components/parameters/FapiCustomerIpAddressx-fapi-customer-ip-address'
- $ref: '#/components/parameters/FapiInterationIdx-fapi-interaction-id'
- $ref: '#/components/parameters/ConsentId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBReadInsuranceConsent1AEReadInsuranceConsent1'
application/json:
schema:
$ref: '#/components/schemas/OBReadInsuranceConsent1AEReadInsuranceConsent1'
application/jwt:
schema:
$ref: '#/components/schemas/OBReadInsuranceConsent1SignedAEReadInsuranceConsent1Signed'
'400':
description: Bad request
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/jwt:
schema:
anyOf:
- $ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
- $ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
'401':
description: Unauthorized
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'403':
description: Forbidden
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/jwt:
schema:
$ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
'404':
description: Not found
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'405':
description: Method Not Allowed
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'406':
description: Not Acceptable
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'415':
description: Unsupported Media Type
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'429':
description: Too Many Requests
headers:
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'500':
description: Internal Server Error
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/jwt:
schema:
anyOf:
- $ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
- $ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
security:
- TPPOAuth2Security:
- openid
- insurance
patch:
tags:
- Insurance Consents
operationId: >-
InsuranceConsentsByConsentId_unsignedRequestBodyUpdate_InsuranceConsentsByConsentId_signedRequestBodyUpdate
summary: Modify an Insurance Consent
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/CustomerUserAgentx-customer-user-agent'
- $ref: '#/components/parameters/FapiAuthDatex-fapi-auth-date'
- $ref: '#/components/parameters/FapiCustomerIpAddressx-fapi-customer-ip-address'
- $ref: '#/components/parameters/FapiInterationIdx-fapi-interaction-id'
- $ref: '#/components/parameters/ConsentId'
responses:
'204':
description: No content
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'400':
description: Bad request
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/jwt:
schema:
anyOf:
- $ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
- $ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
'401':
description: Unauthorized
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'403':
description: Forbidden
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/jwt:
schema:
$ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
'404':
description: Not found
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'405':
description: Method Not Allowed
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'406':
description: Not Acceptable
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'415':
description: Unsupported Media Type
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'429':
description: Too Many Requests
headers:
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'500':
description: Internal Server Error
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/jwt:
schema:
anyOf:
- $ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
- $ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
requestBody:
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBUpdateConsent1AEUpdateConsent1'
application/json:
schema:
$ref: '#/components/schemas/OBUpdateConsent1AEUpdateConsent1'
application/jwt:
schema:
$ref: '#/components/schemas/OBUpdateConsent1SignedAEUpdateConsent1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/insurance-policies:
get:
tags:
- Insurance Policies
operationId: InsurancePolicies_list
summary: Get insurance policies
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/CustomerUserAgentx-customer-user-agent'
- $ref: '#/components/parameters/FapiAuthDatex-fapi-auth-date'
- $ref: '#/components/parameters/FapiCustomerIpAddressx-fapi-customer-ip-address'
- $ref: '#/components/parameters/FapiInterationIdx-fapi-interaction-id'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBReadInsurancePolicies1AEReadInsurancePolicies1'
application/json:
schema:
$ref: '#/components/schemas/OBReadInsurancePolicies1AEReadInsurancePolicies1'
application/jwt:
schema:
$ref: '#/components/schemas/OBReadInsurancePolicies1SignedAEReadInsurancePolicies1Signed'
'400':
description: Bad request
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/jwt:
schema:
anyOf:
- $ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
- $ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
'401':
description: Unauthorized
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'403':
description: Forbidden
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/jwt:
schema:
$ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
'404':
description: Not found
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'405':
description: Method Not Allowed
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'406':
description: Not Acceptable
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'415':
description: Unsupported Media Type
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'429':
description: Too Many Requests
headers:
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'500':
description: Internal Server Error
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/jwt:
schema:
anyOf:
- $ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
- $ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
security:
- UserOAuth2Security:
- openid
- insurance
/insurance-policies/{InsurancePolicyId}:
get:
tags:
- Insurance Policies
operationId: InsurancePoliciesById_read
summary: Get insurance policy
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/CustomerUserAgentx-customer-user-agent'
- $ref: '#/components/parameters/FapiAuthDatex-fapi-auth-date'
- $ref: '#/components/parameters/FapiCustomerIpAddressx-fapi-customer-ip-address'
- $ref: '#/components/parameters/FapiInterationId'x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBReadInsurancePolicy1AEReadInsurancePolicy1'
application/json:
schema:
$ref: '#/components/schemas/OBReadInsurancePolicy1AEReadInsurancePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/OBReadInsurancePolicy1SignedAEReadInsurancePolicy1Signed'
'400':
description: Bad request
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/jwt:
schema:
anyOf:
- $ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
- $ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
'401':
description: Unauthorized
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'403':
description: Forbidden
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/jwt:
schema:
$ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
'404':
description: Not found
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'405':
description: Method Not Allowed
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'406':
description: Not Acceptable
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'415':
description: Unsupported Media Type
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'429':
description: Too Many Requests
headers:
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
'500':
description: Internal Server Error
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
application/jwt:
schema:
anyOf:
- $ref: '#/components/schemas/OBErrorResponseAEErrorResponse'
- $ref: '#/components/schemas/OBErrorSignedResponseAEErrorSignedResponse'
security:
- UserOAuth2Security:
- openid
- insurance
components:
parameters:
Authorization:
name: authorization
in: header
required: true
description: An authorization Token as per https://tools.ietf.org/html/rfc6750
schema:
type: string
BaseConsentId:
name: BaseConsentId
in: query
required: true
description: A base consent identifier that links to other consent resources
schema:
$ref: '#/components/schemas/uuid'
ConsentId:
name: ConsentId
in: path
required: true
description: Unique identifier for a given consent resource
schema:
$ref: '#/components/schemas/uuid'
InsurancePolicyId:
name: InsurancePolicyId
in: path
required: true
description: Unique identifier for CustomerUserAgenta given insurance policy
schema:
$ref: '#/components/schemas/uuid'
x-customer-user-agent:
name: x-customer-user-agent
in: header
required: false
description: Indicates the user-agent that the User is using.
schema:
type: string
FapiAuthDatex-fapi-auth-date:
name: x-fapi-auth-date
in: header
required: false
description: >-
The time when the User last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An
example is below:
Sun, 10 Sep 2017 19:43:31 UTC
schema:
type: string
pattern: >-
^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2}
(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4}
\d{2}:\d{2}:\d{2} (GMT|UTC)$
FapiCustomerIpAddressx-fapi-customer-ip-address:
name: x-fapi-customer-ip-address
in: header
required: false
description: The User's IP address if the User is currently logged in with the TPP.
schema:
type: string
FapiInterationIdx-fapi-interaction-id:
name: x-fapi-interaction-id
in: header
required: false
description: An RFC4122 UID used as a correlation id.
schema:
type: string
InsurancePolicyIdschemas:
nameAEAddOns:
InsurancePolicyId intype: pathobject
required:
true description: Unique- DriversPersonalAccident
identifier for a given insurance policy - PassengersPersonalAccident
schema: properties:
$ref: '#/components/schemas/uuid' schemasDriversPersonalAccident:
Address: type: objectboolean
required: description: Indicates whether driver accidental -coverage AddressLineis included
- PostalCodePassengersPersonalAccident:
- City type: boolean
- StateEmirate description: Indicates whether passenger accidental coverage -included
Country propertiesadditionalProperties: false
AEAdditionalInformation:
AddressLine: type: object
typerequired:
array - FirstTimeRegistration
items: - VehicleMortgage
type: string properties:
minItemsFirstTimeRegistration:
1 maxItemstype: 3boolean
PostalCodeVehicleMortgage:
type: stringnumber
City: description: Pending mortgage amount on the vehicle
type: string additionalProperties: false
StateEmirateAEAmountAndCurrency:
type: stringobject
required:
Country: - Currency
type: string - Amount
additionalProperties: false Amountproperties:
type: number Currency:
AmountAndCurrency: type$ref: object'#/components/schemas/CurrencyCode'
required: Amount:
- Currency $ref: '#/components/schemas/Amount'
- Amount description: >-
properties: The Currency: and Amount relating to the Payment, Refund or Request to
$ref: '#/components/schemas/CurrencyCode' Pay
Amount: additionalProperties: false
$refAEBaseConsentId:
'#/components/schemas/Amount' type: string
additionalProperties: false ClaimHistoryminLength: 1
typemaxLength: object128
requireddescription: >-
- NumberClaimsThe original ConsentId assigned by the TPP.
properties:
NumberClaims: It is used by the TPP for updating/renewing parameters associated type:with
integer long-lived consents.
format: int64 It must NumberApprovedClaims:be provided when long-lived consent parameters are
type: integer updated/renewed for a current consent that has not format:yet int64finished.
AEConsentId:
TotalClaimsAmount: type: string
$refminLength: '#/components/schemas/AmountAndCurrency'1
TotalApprovedClaimsAmountmaxLength: 128
description: >-
Unique identification assigned by the TPP to identify the $ref: '#/components/schemas/AmountAndCurrency'consent
additionalProperties: falseresource.
CommunicationPreferenceTypesAEConsentPermissions:
type: string
enum:
- HomeReadInsurancePoliciesMotor
description: >-
Mobile Specifies -the Otherpermitted insurance policy data types. CommunicationPreferences:
type: object This is a list of required:the data groups being consented by the User, and
- Type requested for -authorization PhoneNumberwith the LFI.
propertiesAEConsentPurpose:
Typetype: string
$refenum:
'#/components/schemas/CommunicationPreferenceTypes' - PhoneNumber:AccountAggregation
- PersonalFinanceManager
type: string additionalProperties:- falseCreditAssessment
ConsentStatusCode: - MotorInsuranceQuote
type: string - enum:EnterpriseFinancialManagement
- AuthorizedOther
AECustomerCommunicationDetails:
- AwaitingAuthorization type: object
- Rejectedrequired:
- RevokedCorrespondenceAddress
- ExpiredPermanentAddress
- SuspendedResidentialAddress
CurrencyCode: - CommunicationPreferences
type: string - Email
pattern: ^[A-Z]{3}$ properties:
First: typeCorrespondenceAddress:
string format: uri $ref: '#/components/schemas/Address'
description: A link to the firstPermanentAddress:
page in a paginated result set Last$ref: '#/components/schemas/Address'
type: string ResidentialAddress:
format: uri $ref: description: A link to the last page in a paginated result set'#/components/schemas/Address'
CommunicationPreferences:
LinksResource: type: array
type: object requireditems:
- Self $ref: '#/components/schemas/CommunicationPreferences'
properties: minItems: Self:1
$refmaxItems: '#/components/schemas/Self'3
FirstEmail:
$reftype: '#/components/schemas/First'string
PrevAlternativeEmail:
$reftype: '#/components/schemas/Prev'string
additionalProperties: false
Next: AEError:
$reftype: '#/components/schemas/Next' object
required:
Last: - Code
$ref: '#/components/schemas/Last' - Message
description: Links relevant toproperties:
the resource additionalPropertiesCode:
false LinksSelf: allOf:
type: object required: - $ref: '#/components/schemas/AEErrorCode'
- Self propertiesdescription: Low level textual error code, e.g., UAEOF.Field.Missing
Self: Message:
$ref: '#/components/schemas/Self' descriptiontype: Linksstring
relevant to the resource additionalPropertiesminLength: false
1
Meta: typemaxLength: object500
description: Metadata relevant to thedescription: resource>-
additionalProperties: false MetaTotalPages:A description of the error that type: object
occurred. e.g., 'A mandatory field
required: isn't -supplied' TotalPagesor 'RequestedExecutionDateTime must be in future'
properties: TotalPages: UAEOF doesn't standardise this field
$ref: '#/components/schemas/TotalPages' Path:
additionalProperties: false Next: type: string
type: string formatminLength: uri1
description: A link to themaxLength: next500
page in a paginated result set OBAddOnsdescription: >-
type: object Recommended required:but optional reference to the JSON Path of the -field
DriversPersonalAccident - PassengersPersonalAccident with error, properties:e.g., Data.Initiation.InstructedAmount.Currency
DriversPersonalAccidentUrl:
type: booleanstring
description: >-
Indicates whether driver accidental coverage is included URL to help remediate PassengersPersonalAccident:the problem, or provide more information, or
type: boolean to API Reference, description: Indicates whether passenger accidental coverage includedor help etc
description: Error
additionalProperties: false
OBAdditionalInformationAEErrorCode:
type: objectstring
requiredenum:
- FirstTimeRegistrationUAEOF.AccessToken.Unauthorized
- VehicleMortgageUAEOF.AccessToken.InvalidScope
properties: - UAEOF.Consent.Revoked
FirstTimeRegistration: - UAEOF.Consent.TransientAccountAccessFailure
type: boolean - UAEOF.Consent.AccountTemporarilyBlocked
VehicleMortgage:
- UAEOF.Consent.PermanentAccountAccessFailure
type: number- UAEOF.Consent.Invalid
- UAEOF.JWS.InvalidSignature
description: Pending mortgage amount on the vehicle - UAEOF.JWS.Malformed
additionalProperties: false - UAEOF.JWS.InvalidClaim
OBBaseConsentId: type: string- UAEOF.JWS.InvalidHeader
minLength: 1 - UAEOF.GenericRecoverableError
maxLength: 128 - UAEOF.GenericError
description: >- - UAEOF.JWE.DecryptionError
The original ConsentId assigned by the- TPPUAEOF.JWE.InvalidHeader
- UAEOF.Event.UnexpectedEvent
It is used by the TPP for updating/renewing parameters associated with- UAEOF.Body.InvalidFormat
long-lived consentsUAEOF.Resource.InvalidResourceId
- ItUAEOF.Resource.InvalidFormat
must be provided when long-lived consent parameters are - UAEOF.Consent.BusinessRuleViolation
AEErrorResponse:
updated/renewed for a current consenttype: thatobject
has not yet finished. required:
OBConsentId: type:- stringErrors
minLengthproperties:
1 maxLengthErrors:
128 description: >- type: array
Unique identification assigned by the TPPitems:
to identify the consent resource.
$ref: '#/components/schemas/AEError'
OBConsentPermissions: typeminItems: string1
enumdescription: >-
- ReadInsurancePoliciesMotorAn array of detail error codes, and description: >-
messages, and URLs to documentation
Specifies the permitted insuranceto policyhelp data typesremediation.
additionalProperties: false
This is aAEErrorSignedResponse:
list of the data groups being consentedtype: byobject
the User, and required:
requested for authorization with the- LFI.iss
OBConsentPurpose: - exp
type: string - enum:nbf
- AccountAggregationmessage
properties:
- PersonalFinanceManager iss:
- CreditAssessment type: string
- MotorInsuranceQuote description: >-
EnterpriseFinancialManagement - Other OBCustomerCommunicationDetails:
type: object
required:
- CorrespondenceAddress
- PermanentAddress
- ResidentialAddress
- CommunicationPreferences
- Email
properties:
CorrespondenceAddress:
$ref: '#/components/schemas/Address'
PermanentAddress:
$ref: '#/components/schemas/Address'
ResidentialAddress:
$ref: '#/components/schemas/Address'[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
CommunicationPreferencesexp:
type: arraynumber
itemsdescription: >-
$ref: '#/components/schemas/CommunicationPreferences'
minItems: 1
maxItems: 3
Email:
type: string
AlternativeEmail:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
typenbf:
string additionalProperties: false OBErrortype: number
type: object requireddescription: >-
- Code [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
- Message aud:
properties: type: Code:array
allOfitems:
- $reftype: '#/components/schemas/OBErrorCode'string
description: Low>-
level textual error code, e.g., UAEOF.Field.Missing Message:[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
typeiat:
string minLengthtype: 1number
maxLengthdescription: 500>-
description: >-[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
message:
A description of the error that occurred. e.g., 'A mandatory field $ref: '#/components/schemas/AEErrorResponse'
description: Signed error response payload
isn't supplied' or 'RequestedExecutionDateTimeadditionalProperties: mustfalse
be in future' AEHistoricalInformation:
type: object
UAEOF doesn't standardise thisproperties:
field PathAdditionalInsuranceInformation:
type: string
minLengthdescription: 1
Gap in car insurance or vehicle under TPL coverage
maxLength DrivingHistory:
500 type: integer
description: >- format: int64
Recommended but optional reference to the JSON Path ofdescription: theMore fieldthan 1 year of driving experience
with error, e.g., Data.Initiation.InstructedAmount.CurrencyTwelveMonthClaimHistory:
Url$ref: '#/components/schemas/ClaimHistory'
typeThirtySixMonthClaimHistory:
string description$ref: >-'#/components/schemas/ClaimHistory'
additionalProperties: false
URLAEIndividualCustomerDetails:
to help remediate the problem, or providetype: moreobject
information, or properties:
to APIGender:
Reference, or help etc descriptiontype: Errorstring
additionalProperties: false DateofBirth:
OBErrorCode: type: string
enum: format: date
MaritalStatus:
- UAEOF.AccessToken.Unauthorized type: string
- UAEOF.AccessToken.InvalidScope EducationBackground:
- UAEOF.Consent.Revoked type: string
- UAEOF.Consent.TransientAccountAccessFailure Nationality:
- UAEOF.Consent.AccountTemporarilyBlocked type: -string
UAEOF.Consent.PermanentAccountAccessFailure DualNationality:
- UAEOF.Consent.Invalid - UAEOF.JWS.InvalidSignaturetype: boolean
- UAEOF.JWS.MalformedSecondNationality:
- UAEOF.JWS.InvalidClaimtype: string
- UAEOF.JWS.InvalidHeaderSalutation:
- UAEOF.GenericRecoverableErrortype: string
- UAEOF.GenericErrorCityofBirth:
- UAEOF.JWE.DecryptionError type: string
- UAEOF.JWE.InvalidHeader CountryofBirth:
- UAEOF.Event.UnexpectedEvent type: string
- UAEOF.Body.InvalidFormat pattern: ^[A-Z]{2,2}$
- UAEOF.Resource.InvalidResourceId Religion:
- UAEOF.Resource.InvalidFormat type: string
- UAEOF.Consent.BusinessRuleViolation OBErrorResponseMothersMaidenName:
type: object type: string
required: SpouseName:
- Errors propertiestype: string
Errors SpouseDateofBirth:
type: arraystring
itemsformat: date
$refSpouseEmploymentDetails:
'#/components/schemas/OBError' minItemstype: 1string
description: >- SpouseContact:
An array of detailtype: errorstring
codes, and messages, and URLs to documentation NumberofChildren:
to help remediation. additionalPropertiestype: falseinteger
OBErrorSignedResponse: typeformat: objectint64
requiredadditionalProperties: false
AEInsurancePolicy:
- iss type: object
- exprequired:
- nbfPolicyType
- messagePolicyDetails
properties:
issPolicyType:
type$ref: string'#/components/schemas/AEPolicyTypes'
descriptionPolicyDetails:
>- [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)$ref: '#/components/schemas/AESupportedPolicyTypes'
additionalProperties: false
exp: AEInsurancePolicyInformation:
type: numberobject
required:
description: >- PolicyReference
- [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
IssueDateTime
- ExpiryDateTime
nbf: - PolicyType
type: number - CoverageAmount
description: >-- CoverageStartDateTime
- PolicyPremium
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)- PolicyHolderEmirates
properties:
audPolicyReference:
type$ref: array'#/components/schemas/PolicyReference'
itemsIssueDateTime:
type: string
descriptionformat: >-date-time
ExpiryDateTime:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)type: string
format: date-time
iatPolicyType:
type: numberstring
description: >-CoverageAmount:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)$ref: '#/components/schemas/AEAmountAndCurrency'
messageCoverageStartDateTime:
$reftype: '#/components/schemas/OBErrorResponse'string
description: Signed error response payloadformat: date-time
additionalProperties: false OBEventNotificationPolicyPremium:
type: object $ref: '#/components/schemas/AEAmountAndCurrency'
required: PolicyHolderEmirates:
- Webhook propertiestype: boolean
WebhookPreviousPolicy:
$ref: '#/components/schemas/OBWebhookPreviousPolicy'
additionalProperties: false
OBHistoricalInformationAEMotorInsurancePolicy:
type: object
propertiesrequired:
AdditionalInsuranceInformation:- InsurancePolicyId
- CustomerId
type: string - PolicyHolderName
description: Gap in car insurance or vehicle- underCustomerCommunicationDetails
TPL coverage - IndividualCustomerDetails
DrivingHistory: - VehicleInformation
type: integer - InsurancePolicyInformation
format: int64 properties:
descriptionInsurancePolicyId: More than
1 year of driving experience allOf:
TwelveMonthClaimHistory: - $ref: '#/components/schemas/ClaimHistoryuuid'
ThirtySixMonthClaimHistorydescription: Unique identifier for a given insurance policy
$ref: '#/components/schemas/ClaimHistory' CustomerId:
additionalProperties: false OBIndividualCustomerDetailstype: string
type: object description: >-
properties: Gender: Identifier that uniquely and consistently identifies the insurance
type: string DateofBirth: policy customer
typePolicyHolderName:
string formattype: datestring
MaritalStatusPolicyHolderShortName:
type: string
EducationBackgroundCategorySegment:
type: string
NationalityLocalBranch:
type: string
DualNationalityPrimaryLanguage:
type: booleanstring
SecondNationalityCustomerCommunicationDetails:
type$ref: string'#/components/schemas/AECustomerCommunicationDetails'
SalutationIndividualCustomerDetails:
type$ref: string'#/components/schemas/AEIndividualCustomerDetails'
CityofBirthVehicleInformation:
type$ref: string'#/components/schemas/AEVehicleInformation'
CountryofBirthInsurancePolicyInformation:
type: string$ref: '#/components/schemas/AEInsurancePolicyInformation'
HistoricalInformation:
pattern: ^[A-Z]{2,2}$$ref: '#/components/schemas/AEHistoricalInformation'
ReligionAddOns:
type$ref: string'#/components/schemas/AEAddOns'
MothersMaidenNameAdditionalInformation:
type$ref: string'#/components/schemas/AEAdditionalInformation'
additionalProperties: false
SpouseName: AEOnBehalfOf:
type: string object
properties:
SpouseDateofBirthTradingName:
type: string
formatdescription: Trading dateName
SpouseEmploymentDetailsLegalName:
type: string
SpouseContact description: Legal Name
typeIdentifierType:
string NumberofChildrenallOf:
type - $ref: integer'#/components/schemas/AEOnBehalfOfIdentifierType'
formatdescription: Identifier int64Type
additionalProperties: false Identifier:
OBInsurancePolicy: type: objectstring
required: description: Identifier
- PolicyType additionalProperties: false
- PolicyDetailsAEOnBehalfOfIdentifierType:
propertiestype: string
PolicyTypeenum:
- Other
$ref: '#/components/schemas/OBPolicyTypes' AEPatchConsent:
PolicyDetailstype: object
required:
$ref: '#/components/schemas/OBSupportedPolicyTypes' - Status
additionalProperties: false OBInsurancePolicyInformationproperties:
type: object Status:
requiredallOf:
- PolicyReference - $ref: '#/components/schemas/AEPatchConsentStatus1'
- IssueDateTime description: >-
ExpiryDateTime - PolicyType The Revoked status must only be set -if CoverageAmountthe current Consent Status is
- CoverageStartDateTime set to -either PolicyPremiumAuthorized or AwaitingAuthorization
- PolicyHolderEmirates RevokedBy:
properties: allOf:
PolicyReference: - $ref: '#/components/schemas/PolicyReferenceAERevokedByCode'
IssueDateTime: description: Denotes the Identifier of the revocation.
additionalProperties: false
type AEPatchConsentStatus1:
string type: string
formatenum:
date-time - Revoked
ExpiryDateTime: AEPolicyTypes:
type: string
enum:
format: date-time Motor
AEReadInsuranceConsent1:
PolicyTypetype: object
required:
type: string - Data
CoverageAmount: - Links
$ref: '#/components/schemas/AmountAndCurrency' - Meta
CoverageStartDateTime: properties:
typeData: string
format$ref: date-time'#/components/schemas/AEReadInsuranceConsent1Properties'
PolicyPremiumSubscription:
$ref: '#/components/schemas/AmountAndCurrencyEventNotification'
PolicyHolderEmiratesLinks:
type$ref: boolean'#/components/schemas/LinksSelf'
PreviousPolicyMeta:
$ref: '#/components/schemas/PreviousPolicyMeta'
additionalProperties: false
OBMotorInsurancePolicyAEReadInsuranceConsent1Properties:
type: object
required:
- InsurancePolicyIdConsentId
- CustomerIdPermissions
- PolicyHolderNameCreationDateTime
- CustomerCommunicationDetailsStatus
- IndividualCustomerDetailsStatusUpdateDateTime
properties:
- VehicleInformation ConsentId:
- InsurancePolicyInformation properties$ref: '#/components/schemas/AEConsentId'
InsurancePolicyId:
allOf:
BaseConsentId:
- $ref: '#/components/schemas/uuidAEBaseConsentId'
description: Unique identifier for a given insurance policyPermissions:
CustomerId:
type: stringarray
descriptionitems:
>- Identifier that uniquely and consistently identifies the insurance$ref: '#/components/schemas/AEConsentPermissions'
minItems: 1
policy customer PolicyHolderNameExpirationDateTime:
type: string
PolicyHolderShortName: format: date-time
type: string CategorySegmentdescription: >-
type: string Specified date and time the LocalBranch:
permissions will expire.
type: string If this is not PrimaryLanguage:populated, the permissions will be open ended.All
type: string dates in CustomerCommunicationDetails:the JSON payloads are represented in ISO 8601 date-time
$ref: '#/components/schemas/OBCustomerCommunicationDetails' IndividualCustomerDetails:format.
$ref: '#/components/schemas/OBIndividualCustomerDetails' All date-time fields in responses must VehicleInformation:include the timezone. An
$ref: '#/components/schemas/OBVehicleInformation' example is below:
InsurancePolicyInformation: $ref: '#/components/schemas/OBInsurancePolicyInformation'2017-04-05T10:43:07+00:00
HistoricalInformationOnBehalfOf:
$ref: '#/components/schemas/OBHistoricalInformationAEOnBehalfOf'
AddOnsPurpose:
$reftype: '#/components/schemas/OBAddOns'array
AdditionalInformationitems:
$ref: '#/components/schemas/OBAdditionalInformationAEConsentPurpose'
additionalProperties: false CreationDateTime:
OBOnBehalfOf: type: object
properties:
TradingName:string
typeformat: stringdate-time
description: >-
Trading Name LegalName: Date and time at which the resource was created.All dates in type:the
string description: LegalJSON Namepayloads are represented in ISO 8601 date-time format.
IdentifierType:
allOf: All date-time fields in responses must include the timezone. An
- $ref: '#/components/schemas/OBOnBehalfOfIdentifierType' example is descriptionbelow:
Identifier
Type Identifier: 2017-04-05T10:43:07+00:00
typeStatus:
string descriptionallOf:
Identifier additionalProperties: false - OBOnBehalfOfIdentifierType$ref: '#/components/schemas/ConsentStatusCode'
type: string description: Specifies the enum:status of consent resource in code form.
- Other OBPatchConsentStatusUpdateDateTime:
type: objectstring
required: format: date-time
- Status description: properties:>-
Status: Date and time at which the account allOf:resource status was updated. All
- $ref: '#/components/schemas/OBPatchConsentStatus1' dates in the JSON payloads are represented in ISO description:8601 >date-time
Theformat. RevokedAll statusdate-time mustfields onlyin beresponses setmust ifinclude the currenttimezone.
Consent Status is An example is set to either Authorized or AwaitingAuthorizationbelow: 2017-04-05T10:43:07+00:00
RevokedBy:
allOf:
- $ref: '#/components/schemas/OBRevokedByCodeAERevokedByCode'
description: Denotes the Identifier of the revocation.
additionalProperties: false
OBPatchConsentStatus1AEReadInsuranceConsent1Signed:
type: stringobject
enumrequired:
- Revokediss
OBPolicyTypes: - exp
type: string - enum:nbf
- message
Motor OBReadInsuranceConsent1properties:
type iss:
object requiredtype: string
- Datadescription: >-
- Links [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
- Meta exp:
properties: Datatype: number
$ref description: '#/components/schemas/OBReadInsuranceConsent1Properties'>-
Subscription: $ref: '#/components/schemas/OBEventNotification'[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
Linksnbf:
$reftype: '#/components/schemas/LinksSelf'number
Metadescription: >-
$ref: '#/components/schemas/Meta' [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
additionalProperties: false aud:
OBReadInsuranceConsent1Properties: type: array
object requireditems:
- ConsentId type: string
- BaseConsentId description: >-
- Permissions [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc- CreationDateTimeeditor.org/rfc/rfc7519#section-4.1.3)
iat:
- Status -type: StatusUpdateDateTimenumber
properties: description: >-
ConsentId: $ref: '#/components/schemas/OBConsentId'[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
BaseConsentIdmessage:
$ref: '#/components/schemas/OBBaseConsentIdAEReadInsuranceConsent1'
additionalProperties: false
Permissions: AEReadInsuranceConsents1:
type: arrayobject
required:
items: - Data
$ref: '#/components/schemas/OBConsentPermissions'
- Links
ExpirationDateTimeproperties:
typeData:
string formattype: date-timearray
descriptionitems:
>- Specified date and time the permissions will expire.
$ref: '#/components/schemas/AEReadInsuranceConsent1Properties'
Links:
If this is not populated, the permissions will be open ended.All
$ref: '#/components/schemas/LinksResource'
additionalProperties: false
AEReadInsuranceConsents1Signed:
type: object
dates in the JSON payloads arerequired:
represented in ISO 8601 date-time - iss
format. - exp
- nbf
All date-time fields in responses must include- themessage
timezone. An properties:
example is belowiss:
type: string
2017-04-05T10:43:07+00:00 OnBehalfOfdescription: >-
$ref: '#/components/schemas/OBOnBehalfOf' [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
Purposeexp:
type: arraynumber
itemsdescription: >-
$ref: '#/components/schemas/OBConsentPurpose'[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
CreationDateTimenbf:
type: string
format: date-timenumber
description: >-
Date and time at which the resource was created.All dates in the
JSON payloads are represented in ISO 8601 date-time format.[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
aud:
All date-time fields in responses must include the timezone. Antype: array
items:
example is below: type: string
2017-04-05T10:43:07+00:00
description: >-
Status: [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
allOf: iat:
- $reftype: '#/components/schemas/ConsentStatusCode'number
description: Specifies>-
the status of consent resource in code form. StatusUpdateDateTime:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
typemessage:
string format$ref: date-time'#/components/schemas/AEReadInsuranceConsents1'
additionalProperties: false
description: >- AEReadInsurancePolicies1:
type: object
Date and time atrequired:
which the account resource status was updated. All - Data
- Links
dates in the JSON payloads are represented in ISO- 8601Meta
date-time properties:
format. All date-timeData:
fields in responses must include the timezone. type: array
An example is belowitems:
2017-04-05T10:43:07+00:00 RevokedBy: $ref: '#/components/schemas/AEInsurancePolicy'
allOf: Links:
- $ref: '#/components/schemas/OBRevokedByCodeLinksResource'
Meta:
description: Denotes the Identifier of the revocation. $ref: '#/components/schemas/MetaTotalPages'
additionalProperties: false
OBReadInsuranceConsent1SignedAEReadInsurancePolicies1Signed:
type: object
required:
- iss
- exp
- nbf
- message
properties:
iss:
type: string
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
exp:
type: number
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
nbf:
type: number
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
aud:
type: array
items:
type: string
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
iat:
type: number
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
message:
$ref: '#/components/schemas/OBReadInsuranceConsent1AEReadInsurancePolicies1'
additionalProperties: false
OBReadInsuranceConsents1AEReadInsurancePolicy1:
type: object
required:
- Data
- Links
properties: - Meta
Dataproperties:
Data:
type: array $ref: '#/components/schemas/AEInsurancePolicy'
items: Links:
$ref: '#/components/schemas/OBReadInsuranceConsent1PropertiesLinksSelf'
LinksMeta:
$ref: '#/components/schemas/LinksResourceMetaTotalPages'
additionalProperties: false
OBReadInsuranceConsents1SignedAEReadInsurancePolicy1Signed:
type: object
required:
- iss
- exp
- nbf
- message
properties:
iss:
type: string
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
exp:
type: number
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
nbf:
type: number
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
aud:
type: array
items:
type: string
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
iat:
type: number
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
message:
$ref: '#/components/schemas/AEReadInsurancePolicy1'
additionalProperties: false
AERevokedByCode:
iattype: string
enum:
type: number - UAEOF.LFI
description: >- - UAEOF.TPP
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)- UAEOF.LFI.InitiatedByUser
- UAEOF.TPP.InitiatedByUser
message: AESupportedPolicyTypes:
$ref: '#/components/schemas/OBReadInsuranceConsents1AEMotorInsurancePolicy'
AEUpdateConsent1:
additionalProperties: false type: object
OBReadInsurancePolicies1required:
- Data
type properties:
object requiredData:
- Data $ref: '#/components/schemas/AEPatchConsent'
-Subscription:
Links - Meta$ref: '#/components/schemas/EventNotification'
propertiesdescription: Patch Account Access Consent
Data additionalProperties: false
AEUpdateConsent1Signed:
type: array object
required:
- iss
items: - exp
$ref: '#/components/schemas/OBInsurancePolicy' - nbf
Links: - message
$ref: '#/components/schemas/LinksResource'properties:
Metaiss:
$reftype: '#/components/schemas/MetaTotalPages'string
additionalProperties: false OBReadInsurancePolicies1Signeddescription: >-
type: object required:[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
-exp:
iss - exptype: number
- nbf description: >-
- message properties:[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
issnbf:
type: stringnumber
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.15](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)5)
aud:
type: array
expitems:
type: numberstring
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.43](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.43)
nbfiat:
type: number
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.56](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.56)
audmessage:
type$ref: array'#/components/schemas/AEUpdateConsent1'
itemsadditionalProperties: false
AEVehicleInformation:
type: stringobject
properties:
description: >- CarMake:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)type: string
iatCarModel:
type: number string
CarModelYear:
description: >- type: string
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)pattern: ^[0-9]{4}$
messageCarPurchaseDateTime:
$reftype: '#/components/schemas/OBReadInsurancePolicies1' string
additionalProperties: falseformat: date-time
OBReadInsurancePolicy1CarSpecification:
type: objectstring
required: EstimatedValue:
- Data type: integer
- Links format: int32
- Meta RegistrationDateTime:
properties: Datatype: string
$refformat: '#/components/schemas/OBInsurancePolicy'date-time
LinksChassisNumber:
$reftype: '#/components/schemas/LinksSelf'string
MetaEngineNumber:
$reftype: '#/components/schemas/MetaTotalPages'string
additionalProperties: false CountryofOrigin:
OBReadInsurancePolicy1Signed: type: string
object requiredVehicleColor:
- iss type: string
PlateNumber:
- exp type: string
- nbf PlateCode:
- message propertiestype: string
iss PlateCategory:
type: string
descriptionVehicleMileage:
>- type: [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)integer
expformat: int64
typeVehicleWeight:
number descriptiontype: >-integer
format: [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)int64
nbfTrafficCodeIssuingEmirate:
type: numberstring
descriptionTrafficIDNumber:
>- [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)type: string
audVehicleHistory:
type: array$ref: '#/components/schemas/VehicleHistory'
additionalProperties: false
itemsAEWebhook:
type: object
type required:
string - Url
description: >- - IsActive
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)properties:
iatUrl:
type: numberstring
description: >-
The TPP Callback URL being registered with the LFI
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6) IsActive:
message: type: boolean
$ref: '#/components/schemas/OBReadInsurancePolicy1' description: >-
additionalProperties: false OBRevokedByCode: The TPP specifying type:whether stringthe LFI should send (IsActive true) or
enum: - UAEOF.LFI not send (IsActive false) Webhook Notifications to -the UAEOF.TPP's Webhook
- UAEOF.LFI.InitiatedByUser URL
- UAEOF.TPP.InitiatedByUser description: A Webhook Subscription OBSupportedPolicyTypes:Schema
$refadditionalProperties: '#/components/schemas/OBMotorInsurancePolicy'false
OBUpdateConsent1Address:
type: object
required:
- DataAddressLine
properties: - PostalCode
Data: - City
$ref: '#/components/schemas/OBPatchConsent' - StateEmirate
Subscription: - Country
$ref: '#/components/schemas/OBEventNotification'
descriptionproperties:
Patch Account Access Consent additionalPropertiesAddressLine:
false OBUpdateConsent1Signed: type: objectarray
required: items:
- iss type: string
- exp -minItems: nbf1
- message maxItems: 3
properties: issPostalCode:
type: string
string
descriptionCity:
>- [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)type: string
expStateEmirate:
type: numberstring
Country:
description: >- type: string
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4) additionalProperties: false
nbfAmount:
type: number
type: number ClaimHistory:
type: object
description: >- required:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)- NumberClaims
properties:
audNumberClaims:
type: arrayinteger
items:format: int64
NumberApprovedClaims:
type: stringinteger
description: >-format: int64
TotalClaimsAmount:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3) $ref: '#/components/schemas/AEAmountAndCurrency'
iatTotalApprovedClaimsAmount:
type: number$ref: '#/components/schemas/AEAmountAndCurrency'
additionalProperties: false
descriptionCommunicationPreferenceTypes:
>- type: string
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6) enum:
- message:Home
- Mobile
$ref: '#/components/schemas/OBUpdateConsent1' additionalProperties:- falseOther
OBVehicleInformationCommunicationPreferences:
type: object
properties:required:
- Type
CarMake: - PhoneNumber
typeproperties:
string CarModelType:
type$ref: string'#/components/schemas/CommunicationPreferenceTypes'
CarModelYearPhoneNumber:
type: string
additionalProperties: false
pattern ConsentStatusCode:
^[0-9]{4}$ type: string
CarPurchaseDateTime: enum:
type: string - Authorized
format: date-time AwaitingAuthorization
CarSpecification: - Rejected
type:- stringRevoked
EstimatedValue:- Expired
- type:Suspended
integer CurrencyCode:
formattype: int32string
pattern: RegistrationDateTime:^[A-Z]{3}$
EventNotification:
type: stringobject
format: date-timerequired:
ChassisNumber:- Webhook
typeproperties:
string EngineNumberWebhook:
type$ref: string'#/components/schemas/AEWebhook'
additionalProperties: false
CountryofOrigin: First:
type: string
VehicleColorformat: uri
description: A link type:to stringthe first page in a paginated result set
PlateNumber: Last:
type: string
PlateCodeformat: uri
description: A link type:to stringthe last page in a paginated result set
PlateCategory: LinksResource:
type: object
string required:
VehicleMileage: - Self
type: integer properties:
formatSelf:
int64 VehicleWeight$ref: '#/components/schemas/Self'
typeFirst:
integer format$ref: int64'#/components/schemas/First'
TrafficCodeIssuingEmiratePrev:
type$ref: string'#/components/schemas/Prev'
TrafficIDNumberNext:
type$ref: string'#/components/schemas/Next'
VehicleHistoryLast:
$ref: '#/components/schemas/VehicleHistoryLast'
description: Links relevant to the resource
additionalProperties: false
OBWebhookLinksSelf:
type: object
requiredrequired:
- Self
properties:
Self:
- Url - IsActive$ref: '#/components/schemas/Self'
propertiesdescription: Links relevant to the resource
Url: additionalProperties: false
Meta:
type: string type: object
description: TheMetadata TPPrelevant Callbackto URLthe beingresource
registered with the LFI additionalProperties: false
IsActiveMetaTotalPages:
type: object
type: boolean required:
description: >- TotalPages
properties:
The TPP specifying whether theTotalPages:
LFI should send (IsActive true) or $ref: '#/components/schemas/TotalPages'
notadditionalProperties: sendfalse
(IsActive false) Webhook Notifications toNext:
the TPP's Webhook type: string
format: URLuri
description: A Webhooklink Subscriptionto Schemathe next page in a paginated result additionalProperties:set
false PolicyReference:
type: string
description: Insurance policy identifier issued by the insurer
Prev:
type: string
format: uri
description: A link to the previous page in a paginated result set
PreviousPolicy:
type: object
required:
- PolicyReference
- Insurer
- PolicyStartDateTime
- PolicyExpiryDateTime
properties:
PolicyReference:
$ref: '#/components/schemas/PolicyReference'
Insurer:
type: string
PolicyStartDateTime:
type: string
format: date-time
PolicyExpiryDateTime:
type: string
format: date-time
additionalProperties: false
Self:
type: string
format: uri
description: A link to the current resource
TotalPages:
type: integer
format: int32
minimum: 0
description: Total number of pages where a result set is paginated
VehicleHistory:
type: string
enum:
- Imported
- Modified
- DeclaredTotalLoss
uuid:
type: string
securitySchemes:
TPPOAuth2Security:
type: oauth2
description: >-
TPP confidential client authorization with the LFI to stage a consent.
**Please refer to [OpenID FAPI Security Profile 1.0 -Part 2
Advanced](https://openid.net/specs/openid-financial-api-part-2-1_0.html#authorization-server)
- 5.2.2 point 14 - shall authenticate the confidential client using one
of the following methods private_key_jwt and [OpenID Connect Core
1.0](https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication)
9. Client Authentication private_key_jwt**
flows:
clientCredentials:
tokenUrl: https://authserver.example/token
scopes:
openid: Activates OpenID Connect Support
accounts: Ability to read Accounts Information
insurance: Right to read insurance policies
UserOAuth2Security:
type: oauth2
description: >-
[OAuth2 PAR flow](https://datatracker.ietf.org/doc/html/rfc9126), it is
required when the User needs to perform SCA with the LFI when a TPP
wants to access an LFI resource owned by the User. **Please refer to
[OpenID FAPI Security Profile 1.0 -Part 2
Advanced](https://openid.net/specs/openid-financial-api-part-2-1_0.html#authorization-server)
- 5.2.2 point 14 - shall authenticate the confidential client using one
of the following methods private_key_jwt and [OpenID Connect Core
1.0](https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication)
9. Client Authentication private_key_jwt**
flows:
authorizationCode:
authorizationUrl: https://authserver.example/authorization
tokenUrl: https://authserver.example/token
scopes:
openid: Activates OpenID Connect Support
accounts: >-
Ability to read Accounts Information. This is a parameterized
scope with the ConsentId
insurance: >-
Right to read insurance policies based on authorization by the End
User
LFIWebhookSecurity:
type: http
description: >-
The LFI generates a Self Signed JWT Authorization Token for Client
Authentication with the TPP. **Please refer to Self-Signed JWT
Authorization Token Specification in the UAE Standard API User Guide**
scheme: bearer
bearerFormat: JWT
| 