openapi: 3.0.0
info:
title: MotorUAE Insurance API
description: '## UAE Open Finance Motor 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 content:$ref: '#/components/schemas/AEReadInsuranceConsents1'
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/jwtrequired: true
schema description: An RFC4122 UID used as $ref: '#/components/schemas/OBReadInsuranceConsents1Signed'
'400':
description: Bad request
headers:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a 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
'404': content:
description: Not found application/jwt:
headers: schema:
x-fapi-interaction-id: $ref: '#/components/schemas/AEErrorSignedResponse'
'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-access
/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
'404': content:
description: Not found application/jwt:
headers: schema:
x-fapi-interaction-id: required: $ref: '#/components/schemas/AEErrorSignedResponse'
'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-access
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
'404': content:
description: Not found application/jwt:
headers: schema:
x-fapi-interaction-id: $ref: '#/components/schemas/AEErrorSignedResponse'
'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-access
/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
'404': content:
description: Not found application/jwt:
headers: schema:
x-fapi-interaction-id: $ref: '#/components/schemas/AEErrorSignedResponse'
'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-access
/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/FapiInterationIdx-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
'404': content:
description: Not found application/jwt:
headers: schema:
x-fapi-interaction-id: $ref: '#/components/schemas/AEErrorSignedResponse'
'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-access
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'
CustomerUserAgentInsurancePolicyId:
name: x-customer-user-agentInsurancePolicyId
in: headerpath
required: falsetrue
description: IndicatesUnique theidentifier user-agentfor thata thegiven Userinsurance ispolicy
using. schema:
type$ref: string'#/components/schemas/uuid'
FapiAuthDatex-customer-user-agent:
name: x-fapicustomer-authuser-dateagent
in: header
required: false
description: >Indicates the user-agent that the User is using.
The time when theschema:
User last logged type: string
x-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:- UniqueDriversPersonalAccident
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 - Countryincluded
propertiesadditionalProperties: false
AddressLine:
AEAdditionalInformation:
type: arrayobject
itemsrequired:
- FirstTimeRegistration
type: string - minItems: 1VehicleMortgage
maxItems: 3properties:
PostalCodeFirstTimeRegistration:
type: stringboolean
CityVehicleMortgage:
type: stringnumber
StateEmirate: typedescription: stringPending mortgage amount on Country:
the vehicle
type: string additionalProperties: false
AmountAEAmountAndCurrency:
type: number
AmountAndCurrency:
type: object
required:
- Currency
- Amount
properties:
Currency:
$ref: '#/components/schemas/CurrencyCode'
Amount:
$ref: '#/components/schemas/Amount'
additionalPropertiesdescription: false>-
ClaimHistory: The Currency and type:Amount objectrelating to the Payment, Refund or Request required:to
-Pay
NumberClaims additionalProperties: false
- NumberApprovedClaims AEBaseConsentId:
-type: TotalClaimsAmountstring
minLength: 1
- TotalApprovedClaimsAmount propertiesmaxLength: 128
description: NumberClaims:>-
The original type:ConsentId integerassigned by the TPP.
format: int64 It is used by the TPP for NumberApprovedClaims:updating/renewing parameters associated with
type: integerlong-lived consents.
format:It int64must be provided when long-lived consent parameters are
TotalClaimsAmount: updated/renewed for a current $ref: '#/components/schemas/AmountAndCurrency'
consent that has not yet finished.
TotalApprovedClaimsAmountAEConsentId:
$reftype: '#/components/schemas/AmountAndCurrency'string
additionalPropertiesminLength: false1
CommunicationPreferenceTypes: typemaxLength: string128
enumdescription: >-
- HomeUnique identification assigned by the TPP to identify the -consent
Mobile resource.
- Other CommunicationPreferencesAEConsentPermissions:
type: objectstring
requiredenum:
- TypeReadInsurancePoliciesMotor
description: >-
PhoneNumber properties: Specifies the permitted insurance policy data types.
Type:
This is $ref: '#/components/schemas/CommunicationPreferenceTypes'
PhoneNumber:
a list of the data groups being consented by the User, and
requested type:for stringauthorization with the LFI.
additionalProperties AEConsentPurpose:
false CurrencyCodetype: string
type: string enum:
- AccountAggregation
pattern: ^[A-Z]{3}$- PersonalFinanceManager
First: - CreditAssessment
type: string - MotorInsuranceQuote
format: uri description:- AEnterpriseFinancialManagement
link to the first page in a paginated result- setOther
LastAECustomerCommunicationDetails:
type: stringobject
formatrequired:
uri description:- ACorrespondenceAddress
link to the last page in a paginated result- setPermanentAddress
LinksResource: - ResidentialAddress
type: object - required:CommunicationPreferences
- SelfEmail
properties:
SelfCorrespondenceAddress:
$ref: '#/components/schemas/SelfAddress'
FirstPermanentAddress:
$ref: '#/components/schemas/FirstAddress'
PrevResidentialAddress:
$ref: '#/components/schemas/PrevAddress'
NextCommunicationPreferences:
$reftype: '#/components/schemas/Next' array
items:
Last: $ref: '#/components/schemas/LastCommunicationPreferences'
descriptionminItems: Links1
relevant to the resource additionalPropertiesmaxItems: false3
LinksSelf: Email:
type: object requiredtype: string
- SelfAlternativeEmail:
properties: type: string
Self: additionalProperties: false
$refAEError:
'#/components/schemas/Self' descriptiontype: Linksobject
relevant to the resource required:
additionalProperties: false - MetaTotalPages:Code
type: object - Message
required: properties:
- TotalPages Code:
properties: allOf:
TotalPages: - $ref: '#/components/schemas/TotalPagesAEErrorCode'
additionalProperties: false description: Low Next:level textual error code, e.g., UAEOF.Field.Missing
type: string formatMessage:
uri description: A link totype: thestring
next page in a paginated result set minLength: OBAddOns:1
type: object maxLength: 500
required: description: >-
DriversPersonalAccident - PassengersPersonalAccident A description of the properties:
error that occurred. e.g., 'A mandatory field
DriversPersonalAccident: isn't supplied' or 'RequestedExecutionDateTime must be type:in booleanfuture'
description: Indicates whether driverUAEOF accidentaldoesn't coveragestandardise isthis includedfield
PassengersPersonalAccidentPath:
type: booleanstring
descriptionminLength: Indicates1
whether passenger accidental coverage included maxLength: 500
additionalProperties: false OBAdditionalInformation: description: >-
type: object required: Recommended but optional reference to the JSON Path -of FirstTimeRegistrationthe field
- VehicleMortgage with error, properties:e.g., Data.Initiation.InstructedAmount.Currency
FirstTimeRegistrationUrl:
type: string
boolean VehicleMortgagedescription: >-
type: number URL to help remediate the problem, or provide more description:information, Pendingor
mortgage amount on the vehicle additionalProperties: falseto API Reference, or help OBBaseConsentId:etc
typedescription: stringError
minLengthadditionalProperties: 1false
AEErrorCode:
maxLength: 128 type: string
description: >- enum:
The original ConsentId assigned by the TPP.- UAEOF.AccessToken.Unauthorized
- UAEOF.AccessToken.InvalidScope
It is used by the TPP for updating/renewing parameters associated with- UAEOF.Consent.Revoked
long-lived consentsUAEOF.Consent.TransientAccountAccessFailure
- ItUAEOF.Consent.AccountTemporarilyBlocked
must be provided when long-lived consent parameters are - UAEOF.Consent.PermanentAccountAccessFailure
updated/renewed for a current consent that has not yet finished.- UAEOF.Consent.Invalid
- UAEOF.JWS.InvalidSignature
OBConsentId: type: string- UAEOF.JWS.Malformed
minLength: 1 - UAEOF.JWS.InvalidClaim
maxLength: 128 - UAEOF.JWS.InvalidHeader
description: >- - UAEOF.GenericRecoverableError
Unique identification assigned by the TPP to identify- theUAEOF.GenericError
consent - resourceUAEOF.JWE.DecryptionError
OBConsentPermissions: - UAEOF.JWE.InvalidHeader
type: string enum:- UAEOF.Event.UnexpectedEvent
- UAEOF.Body.InvalidFormat
ReadInsurancePoliciesMotor description: >- UAEOF.Resource.InvalidResourceId
Specifies the permitted insurance policy data types.- UAEOF.Resource.InvalidFormat
- UAEOF.Consent.BusinessRuleViolation
ThisAEErrorResponse:
is a list of the data groupstype: beingobject
consented by the User, and required:
requested for authorization- withErrors
the LFI. OBConsentPurposeproperties:
type: string Errors:
enumtype: array
-items:
AccountAggregation - PersonalFinanceManager $ref: '#/components/schemas/AEError'
- CreditAssessment minItems: 1
- MotorInsuranceQuote description: >-
- EnterpriseFinancialManagement An array of detail error codes, and messages, -and OtherURLs to documentation
OBCustomerCommunicationDetails: to type:help objectremediation.
requiredadditionalProperties: false
AEErrorSignedResponse:
- CorrespondenceAddress type: object
- PermanentAddressrequired:
- ResidentialAddressiss
- CommunicationPreferencesexp
- Emailnbf
properties: - message
CorrespondenceAddressproperties:
iss:
$ref: '#/components/schemas/Address' PermanentAddresstype: string
$ref description: '#/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'[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
minItemsnbf:
1 maxItemstype: 3number
Email: description: >-
type: string AlternativeEmail:[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
aud:
type: string additionalPropertiestype: falsearray
OBError: typeitems:
object required: type: string
- Code description: >-
Message properties: Code:[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
allOfiat:
- $reftype: '#/components/schemas/OBErrorCode'number
description: Low>-
level textual error code, e.g., UAEOF.Field.Missing Message:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
type message:
string minLength$ref: 1'#/components/schemas/AEErrorResponse'
maxLengthdescription: 500Signed error response payload
descriptionadditionalProperties: >-false
AEHistoricalInformation:
type: Aobject
description of the error that occurred. e.g., 'A mandatory field properties:
AdditionalInsuranceInformation:
isn't supplied' or 'RequestedExecutionDateTime musttype: bestring
in future' description: Gap in car insurance UAEOFor doesn'tvehicle standardiseunder thisTPL fieldcoverage
PathDrivingHistory:
type: stringinteger
minLengthformat: 1int64
maxLengthdescription: 500More than 1 year of driving experience
description: >- TwelveMonthClaimHistory:
Recommended but optional reference to the JSON Path of the field$ref: '#/components/schemas/ClaimHistory'
ThirtySixMonthClaimHistory:
$ref: with error, e.g., Data.Initiation.InstructedAmount.Currency'#/components/schemas/ClaimHistory'
additionalProperties: false
UrlAEIndividualCustomerDetails:
type: stringobject
properties:
description: >- Gender:
URL to helptype: remediatestring
the problem, or provide more information, or DateofBirth:
totype: APIstring
Reference, or help etc descriptionformat: Errordate
additionalProperties: false MaritalStatus:
OBErrorCode: type: string
enum EducationBackground:
- UAEOF.AccessToken.Unauthorized type: string
- UAEOF.AccessToken.InvalidScope Nationality:
- UAEOF.Consent.Revoked type: string
- UAEOF.Consent.TransientAccountAccessFailure DualNationality:
- UAEOF.Consent.AccountTemporarilyBlocked type: boolean
- UAEOF.Consent.PermanentAccountAccessFailure SecondNationality:
- UAEOF.Consent.Invalid type: string
- UAEOF.JWS.InvalidSignature Salutation:
- UAEOF.JWS.Malformed type: string
- UAEOF.JWS.InvalidClaim CityofBirth:
- UAEOF.JWS.InvalidHeader type: string
- UAEOF.GenericRecoverableError CountryofBirth:
- UAEOF.GenericError type: string
- UAEOF.JWE.DecryptionError pattern: ^[A- UAEOF.JWE.InvalidHeaderZ]{2,2}$
Religion:
- UAEOF.Event.UnexpectedEvent - UAEOF.Body.InvalidFormattype: string
- UAEOF.Resource.InvalidResourceIdMothersMaidenName:
- UAEOF.Resource.InvalidFormat
type: string
- UAEOF.Consent.BusinessRuleViolation
SpouseName:
OBErrorResponse: type: objectstring
required: SpouseDateofBirth:
- Errors type: string
properties: Errorsformat: date
typeSpouseEmploymentDetails:
array itemstype: string
SpouseContact:
$ref: '#/components/schemas/OBError' type: string
minItems: 1 descriptionNumberofChildren:
>- An arraytype: ofinteger
detail error codes, and messages, and URLs to documentation format: int64
to help remediation.
additionalProperties: additionalProperties: false
OBErrorSignedResponseAEInsurancePolicy:
type: object
required:
- issPolicyType
- expPolicyDetails
properties:
- nbf PolicyType:
- message properties:$ref: '#/components/schemas/AEPolicyTypes'
issPolicyDetails:
type$ref: string'#/components/schemas/AESupportedPolicyTypes'
additionalProperties: false
descriptionAEInsurancePolicyInformation:
>- type: object
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)required:
- PolicyReference
- IssueDateTime
- ExpiryDateTime
- PolicyType
- exp:CoverageAmount
- CoverageStartDateTime
type: number - PolicyPremium
description: >- - PolicyHolderEmirates
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)properties:
nbfPolicyReference:
type: number$ref: '#/components/schemas/PolicyReference'
IssueDateTime:
description: >- type: string
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)format: date-time
audExpiryDateTime:
type: arraystring
itemsformat: date-time
PolicyType:
type: string
CoverageAmount:
description: >- $ref: '#/components/schemas/AEAmountAndCurrency'
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3) CoverageStartDateTime:
iattype: string
type format: numberdate-time
descriptionPolicyPremium:
>- [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'
messagePolicyHolderEmirates:
$reftype: '#/components/schemas/OBErrorResponse' boolean
descriptionPreviousPolicy: Signed error response payload
$ref: '#/components/schemas/PreviousPolicy'
additionalProperties: false
OBEventNotificationAEMotorInsurancePolicy:
type: object
required:
- WebhookInsurancePolicyId
properties: - CustomerId
Webhook: - PolicyHolderName
$ref: '#/components/schemas/OBWebhook'
- CustomerCommunicationDetails
additionalProperties: false - IndividualCustomerDetails
OBHistoricalInformation: type: object- VehicleInformation
properties: - InsurancePolicyInformation
AdditionalInsuranceInformation: properties:
typeInsurancePolicyId:
string descriptionallOf:
Gap in car insurance or vehicle under TPL coverage - $ref: '#/components/schemas/uuid'
DrivingHistory: description: Unique identifier type: integer
for a given insurance policy
formatCustomerId:
int64 descriptiontype: Morestring
than 1 year of driving experience description: >-
TwelveMonthClaimHistory: Identifier $ref: '#/components/schemas/ClaimHistory'
that uniquely and consistently identifies the insurance
ThirtySixMonthClaimHistory: policy customer
$ref: '#/components/schemas/ClaimHistory' additionalPropertiesPolicyHolderName:
false OBIndividualCustomerDetails: type: object
string
properties: GenderPolicyHolderShortName:
type: string
DateofBirthCategorySegment:
type: string
format: date-time
LocalBranch:
MaritalStatus: type: string
EducationBackgroundPrimaryLanguage:
type: string
NationalityCustomerCommunicationDetails:
type$ref: string'#/components/schemas/AECustomerCommunicationDetails'
DualNationalityIndividualCustomerDetails:
type$ref: boolean'#/components/schemas/AEIndividualCustomerDetails'
SecondNationalityVehicleInformation:
type$ref: string'#/components/schemas/AEVehicleInformation'
SalutationInsurancePolicyInformation:
type$ref: string'#/components/schemas/AEInsurancePolicyInformation'
CityofBirthHistoricalInformation:
type$ref: string'#/components/schemas/AEHistoricalInformation'
CountryofBirthAddOns:
type$ref: string'#/components/schemas/AEAddOns'
AdditionalInformation:
pattern: ^[A-Z]{2,2}$ $ref: '#/components/schemas/AEAdditionalInformation'
Religion: additionalProperties: false
typeAEOnBehalfOf:
string type: object
MothersMaidenName: properties:
typeTradingName:
string SpouseNametype: string
typedescription: Trading stringName
SpouseDateofBirthLegalName:
type: string
formatdescription: date-timeLegal Name
SpouseEmploymentDetailsIdentifierType:
typeallOf:
string - SpouseContact$ref: '#/components/schemas/AEOnBehalfOfIdentifierType'
type description: stringIdentifier Type
NumberofChildrenIdentifier:
type: integerstring
formatdescription: int64Identifier
additionalProperties: false
OBInsuranceAuthorizationDetailTypesAEOnBehalfOfIdentifierType:
type: string
enum:
- urn:openfinanceuae:insurance-access-consent:v1.0-draft3Other
OBInsurancePolicyAEPatchConsent:
type: object
required:
- PolicyTypeStatus
properties:
- PolicyDetails Status:
properties: PolicyTypeallOf:
- $ref: '#/components/schemas/OBPolicyTypesAEPatchConsentStatus1'
PolicyDetails: description: >-
$ref: '#/components/schemas/OBSupportedPolicyTypes' The Revoked status additionalProperties:must falseonly be set if the OBInsurancePolicyInformation:current Consent Status is
type: object required: set to either Authorized or AwaitingAuthorization
- IssueDate RevokedBy:
- ExpiryDate allOf:
- PolicyType - CoverageAmount$ref: '#/components/schemas/AERevokedByCode'
- CoverageStartDate description: Denotes the Identifier of the revocation.
- PolicyPremium additionalProperties: false
- PolicyHolderEmiratesAEPatchConsentStatus1:
propertiestype: string
IssueDateenum:
- Revoked
type: string AEPolicyTypes:
formattype: date-timestring
ExpiryDateenum:
- Motor
type: string AEReadInsuranceConsent1:
formattype: date-timeobject
PolicyTyperequired:
- Data
type: string - Links
CoverageAmount: $ref: '#/components/schemas/AmountAndCurrency'- Meta
CoverageStartDateproperties:
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
OBInsurnanceAuthorizationDetailConsentAEReadInsuranceConsent1Properties:
type: object
required:
- TypeConsentId
- ConsentPermissions
properties: - CreationDateTime
Type: - Status
$ref: '#/components/schemas/OBInsuranceAuthorizationDetailTypes'
- StatusUpdateDateTime
Consentproperties:
$refConsentId:
>- $ref: '#/components/schemas/OBInsurnanceAuthorizationDetailConsentPropertiesAEConsentId'
descriptionBaseConsentId:
>- Properties for creating an insurance access object in the$ref: '#/components/schemas/AEBaseConsentId'
Permissions:
authorization_details properties for the first consent type: array
additionalProperties: false OBInsurnanceAuthorizationDetailConsentPropertiesitems:
type: object required$ref: '#/components/schemas/AEConsentPermissions'
- ConsentId minItems: 1
- Permissions ExpirationDateTime:
properties: type: string
ConsentId: format: date-time
$ref: '#/components/schemas/OBConsentId' Permissionsdescription: >-
type: array Specified date and time the permissions will expire.
items: If $ref: '#/components/schemas/OBConsentPermissions'
allOf:
this is not populated, the permissions will be open ended.All
- $ref: '#/components/schemas/OBInsurnanceAuthorizationDetailProperties' dates in the JSON additionalProperties:payloads falseare represented in ISO 8601 OBInsurnanceAuthorizationDetailProperties:date-time
type: object format.
properties:
ConsentId: All date-time fields in responses must include $ref: '#/components/schemas/OBConsentId'
the timezone. An
BaseConsentId: example is below:
$ref: '#/components/schemas/OBBaseConsentId' Permissions:2017-04-05T10:43:07+00:00
typeOnBehalfOf:
array items$ref: '#/components/schemas/AEOnBehalfOf'
Purpose:
$ref: '#/components/schemas/OBConsentPermissions' type: array
minItems: 1 items:
ExpirationDateTime: type$ref: string'#/components/schemas/AEConsentPurpose'
CreationDateTime:
format: date-time type: string
description: >- format: date-time
Specified date and time the permissions will expire.description: >-
IfDate thisand istime notat populated,which the permissionsresource will be open endedwas created.All dates in the
dates in the JSON payloads are represented in ISO 8601 date-time
format.
All date-time fields in responses must include the timezone. An
example is below:
2017-04-05T10:43:07+00:00
Status:
OnBehalfOf allOf:
- $ref: '#/components/schemas/OBOnBehalfOfConsentStatusCode'
Purpose: description: Specifies the status of consent resource in code type:form.
array StatusUpdateDateTime:
items: type: string
$ref: '#/components/schemas/OBConsentPurpose' descriptionformat: Primarydate-time
data for the resource additionalPropertiesdescription: false>-
OBInsurnanceAuthorizationDetailReconsentProperties: type: objectDate and time at which the account required:resource status was updated. All
- ConsentId properties:dates in the JSON payloads are represented in ISO ConsentId:8601 date-time
$ref: '#/components/schemas/OBConsentId'
allOf:
format. All date-time fields in responses must include the timezone.
- $ref: '#/components/schemas/OBInsurnanceAuthorizationDetailProperties' An example is additionalPropertiesbelow: false2017-04-05T10:43:07+00:00
OBMotorInsurancePolicy: RevokedBy:
type: object requiredallOf:
- CustomerId - $ref: '#/components/schemas/AERevokedByCode'
- PolicyHolderName description: Denotes the -Identifier PolicyHolderShortNameof the revocation.
-additionalProperties: CustomerCommunicationDetailsfalse
AEReadInsuranceConsent1Signed:
- IndividualCustomerDetails type: object
- VehicleInformationrequired:
- InsurancePolicyInformationiss
properties: - exp
CustomerId: - nbf
type: string - message
PolicyHolderNameproperties:
iss:
type: string PolicyHolderShortNametype: string
type description: string>-
CategorySegment: type: string[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
LocalBranchexp:
type: stringnumber
PrimaryLanguage: 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)
CustomerCommunicationDetails: nbf:
$ref: '#/components/schemas/OBCustomerCommunicationDetails' type: number
IndividualCustomerDetails: description: >-
$ref: '#/components/schemas/OBIndividualCustomerDetails' VehicleInformation:[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
aud:
$ref: '#/components/schemas/OBVehicleInformation' InsurancePolicyInformationtype: array
$ref items:
'#/components/schemas/OBInsurancePolicyInformation' HistoricalInformation: type: string
$ref: '#/components/schemas/OBHistoricalInformation' description: >-
AddOns: $ref: '#/components/schemas/OBAddOns'[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
AdditionalInformationiat:
$reftype: '#/components/schemas/OBAdditionalInformation' number
additionalProperties: false description: >-
OBOnBehalfOf: type: object properties:[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
TradingNamemessage:
type$ref: string'#/components/schemas/AEReadInsuranceConsent1'
additionalProperties: false
description: Trading NameAEReadInsuranceConsents1:
type: object
LegalName: required:
type: string - Data
description: Legal Name- Links
IdentifierTypeproperties:
allOfData:
type: array
- $ref: '#/components/schemas/OBOnBehalfOfIdentifierType' items:
description: Identifier Type Identifier$ref: '#/components/schemas/AEReadInsuranceConsent1Properties'
typeLinks:
string description$ref: Identifier'#/components/schemas/LinksResource'
additionalProperties: false
OBOnBehalfOfIdentifierTypeAEReadInsuranceConsents1Signed:
type: stringobject
enumrequired:
- Otheriss
OBPatchConsent: - exp
type: object - required:nbf
- Statusmessage
properties:
Statusiss:
allOftype: string
description: >-
$ref: '#/components/schemas/OBPatchConsentStatus1' description: >-[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
exp:
The Revoked status must only be set iftype: thenumber
current Consent Status is description: >-
set to either Authorized or AwaitingAuthorization RevokedBy:[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
allOfnbf:
- $reftype: '#/components/schemas/OBRevokedBy'number
description: Denotes>-
the Identifier of the revocation. additionalProperties: false[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
OBPatchConsentStatus1: aud:
type: string enumtype: array
- Revoked OBPolicyTypesitems:
type: string enumtype: string
- Motor OBReadInsuranceConsent1description: >-
type: object required:[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
-iat:
Data - Linkstype: number
properties: description: >-
Data: $ref: '#/components/schemas/OBInsurnanceAuthorizationDetailConsent'
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
Links message:
$ref: '#/components/schemas/LinksSelfAEReadInsuranceConsents1'
additionalProperties: false
OBReadInsuranceConsent1SignedAEReadInsurancePolicies1:
type: object
required:
- issData
- expLinks
- nbfMeta
properties:
- message Data:
properties: isstype: array
typeitems:
string description$ref: >-'#/components/schemas/AEInsurancePolicy'
Links:
[https$ref: '#//www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)components/schemas/LinksResource'
Meta:
$ref: '#/components/schemas/MetaTotalPages'
additionalProperties: false
exp: AEReadInsurancePolicies1Signed:
type: numberobject
required:
description: >- - iss
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4) - exp
- nbf
- message
properties:
nbfiss:
type: numberstring
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.51](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.51)
audexp:
type: array
items:
number
type: string description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.34](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.34)
iatnbf:
type: number
description: >-
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.65](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.65)
messageaud:
$reftype: '#/components/schemas/OBReadInsuranceConsent1'array
additionalProperties: false OBReadInsuranceConsents1items:
type: object requiredtype: string
- Data description: >-
- Links properties:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
Data iat:
type: arraynumber
itemsdescription: >-
$ref: '#/components/schemas/OBInsurnanceAuthorizationDetailConsent' [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
Linksmessage:
$ref: '#/components/schemas/LinksResourceAEReadInsurancePolicies1'
additionalProperties: false
OBReadInsuranceConsents1SignedAEReadInsurancePolicy1:
type: object
required:
- issData
- expLinks
- nbfMeta
properties:
- message Data:
properties: iss$ref: '#/components/schemas/AEInsurancePolicy'
Links:
type: string $ref: '#/components/schemas/LinksSelf'
description: >- Meta:
[https$ref: '#//www.components/schemas/MetaTotalPages'
additionalProperties: false
AEReadInsurancePolicy1Signed:
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/OBReadInsuranceConsents1AEReadInsurancePolicy1'
additionalProperties: false
OBReadInsurancePolicies1AERevokedByCode:
type: objectstring
requiredenum:
- DataUAEOF.LFI
- LinksUAEOF.TPP
- Meta UAEOF.LFI.InitiatedByUser
- UAEOF.TPP.InitiatedByUser
properties AESupportedPolicyTypes:
$ref: Data:'#/components/schemas/AEMotorInsurancePolicy'
AEUpdateConsent1:
type: arrayobject
required:
items: - Data
$ref: '#/components/schemas/OBInsurancePolicy'properties:
LinksData:
$ref: '#/components/schemas/LinksResourceAEPatchConsent'
MetaSubscription:
$ref: '#/components/schemas/MetaTotalPagesEventNotification'
description: Patch Account Access Consent
additionalProperties: false
OBReadInsurancePolicies1SignedAEUpdateConsent1Signed:
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/OBReadInsurancePolicies1AEUpdateConsent1'
additionalProperties: false
OBReadInsurancePolicy1AEVehicleInformation:
type: object
requiredproperties:
- DataCarMake:
type: string
- Links CarModel:
- Meta propertiestype: string
DataCarModelYear:
$reftype: '#/components/schemas/OBInsurancePolicy'string
Linkspattern: ^[0-9]{4}$
CarPurchaseDateTime:
$ref: '#/components/schemas/LinksSelf' Metatype: string
$refformat: '#/components/schemas/MetaTotalPages'date-time
additionalProperties: false CarSpecification:
OBReadInsurancePolicy1Signed: type: objectstring
requiredEstimatedValue:
type: integer
- iss format: int32
- exp RegistrationDateTime:
- nbf type: string
- message propertiesformat: date-time
iss ChassisNumber:
type: string
descriptionEngineNumber:
>- [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)type: string
expCountryofOrigin:
type: numberstring
descriptionVehicleColor:
>- type: [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)string
nbfPlateNumber:
type: numberstring
descriptionPlateCode:
>- type: string
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5) PlateCategory:
type: string
audVehicleMileage:
type: arrayinteger
itemsformat: int64
VehicleWeight:
type: stringinteger
description: >-
format: int64
TrafficCodeIssuingEmirate:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)type: string
iatTrafficIDNumber:
type: numberstring
VehicleHistory:
description: >- $ref: '#/components/schemas/VehicleHistory'
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6) additionalProperties: false
AEWebhook:
message: type: object
$refrequired: '#/components/schemas/OBReadInsurancePolicy1'
additionalProperties:- falseUrl
OBRevokedBy: - IsActive
type: string properties:
enum: Url:
- UAEOF.LFI type: string
- UAEOF.TPP - UAEOF.LFI.InitiatedByUser
- UAEOF.TPP.InitiatedByUserdescription: The TPP Callback URL being registered with the LFI
OBSupportedPolicyTypes: IsActive:
$ref: '#/components/schemas/OBMotorInsurancePolicy' OBUpdateConsent1type: boolean
type: object description: >-
required: - Data The TPP specifying whether the LFI properties:should send (IsActive true) or
Data: not send (IsActive $ref: '#/components/schemas/OBPatchConsent'
false) Webhook Notifications to the TPP's Webhook
Subscription: $ref: '#/components/schemas/OBEventNotification'URL
description: PatchA AccountWebhook AccessSubscription ConsentSchema
additionalProperties: false
OBUpdateConsent1SignedAddress:
type: object
required:
- issAddressLine
- PostalCode
- expCity
- nbfStateEmirate
- messageCountry
properties:
issAddressLine:
type: stringarray
descriptionitems: >-
type: string
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)minItems: 1
maxItems: 3
expPostalCode:
type: numberstring
City:
descriptiontype: >-string
StateEmirate:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
type: string
Country:
type: string
nbfadditionalProperties: false
Amount:
type: number
ClaimHistory:
description: >-
type: object
required:
- NumberClaims
properties:
NumberClaims:
type: integer
format: int64
NumberApprovedClaims:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
type: integer
format: int64
TotalClaimsAmount:
$ref: '#/components/schemas/AEAmountAndCurrency'
TotalApprovedClaimsAmount:
$ref: '#/components/schemas/AEAmountAndCurrency'
additionalProperties: false
audCommunicationPreferenceTypes:
type: string
type: array enum:
- items:Home
- Mobile
type: string - Other
descriptionCommunicationPreferences:
>- type: object
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)required:
- iat:Type
- PhoneNumber
type: number properties:
description: >- Type:
[https$ref: '#//www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)components/schemas/CommunicationPreferenceTypes'
messagePhoneNumber:
$reftype: '#/components/schemas/OBUpdateConsent1'string
additionalProperties: false
OBVehicleInformationConsentStatusCode:
type: objectstring
enum:
properties:- Authorized
CarMake:- AwaitingAuthorization
- type:Rejected
string - CarModel:Revoked
- Expired
type: string - Suspended
CarModelYear: CurrencyCode:
type: string
pattern: ^[0A-9Z]{43}$
CarPurchaseDateEventNotification:
type: stringobject
format: date-timerequired:
CarSpecification:- Webhook
typeproperties:
string EstimatedValueWebhook:
type$ref: integer'#/components/schemas/AEWebhook'
additionalProperties: false
format: int32 First:
DateofRegistrationtype: string
format: uri
type: string description: A link to the first page format: date-time
in a paginated result set
ChassisNumberLast:
type: string
EngineNumberformat: uri
description: A link type:to stringthe last page in a paginated result set
CountryofOrigin: LinksResource:
type: stringobject
VehicleColorrequired:
- Self
type: string PlateNumberproperties:
Self:
type: string PlateCode$ref: '#/components/schemas/Self'
First:
type: string PlateCategory$ref: '#/components/schemas/First'
Prev:
type: string VehicleMileage$ref: '#/components/schemas/Prev'
typeNext: integer
format$ref: int64'#/components/schemas/Next'
VehicleWeightLast:
type$ref: integer'#/components/schemas/Last'
description: Links relevant to format:the int64resource
additionalProperties: false
TrafficCodeIssuingEmirate: LinksSelf:
type: stringobject
required:
TrafficIDNumber: - Self
typeproperties:
string VehicleHistorySelf:
$ref: '#/components/schemas/VehicleHistorySelf'
additionalPropertiesdescription: falseLinks relevant to the OBWebhook:resource
typeadditionalProperties: objectfalse
requiredMeta:
type: object
- Url description: Metadata relevant to -the IsActiveresource
propertiesadditionalProperties: false
UrlMetaTotalPages:
type: stringobject
description: The TPP Callback URL being registered withrequired:
the LFI - TotalPages
IsActive: properties:
type: boolean TotalPages:
description: >- $ref: '#/components/schemas/TotalPages'
additionalProperties: false
The TPP specifying whetherNext:
the LFI should send (IsActive true) ortype: string
format: uri
not send (IsActive false)description: WebhookA Notificationslink to the TPP'snext Webhookpage in a paginated result set
PolicyReference:
URL type: string
description: A Webhook Subscription Schema description: Insurance policy identifier issued by additionalProperties:the falseinsurer
Prev:
type: string
format: uri
description: A link to the previous page in a paginated result set
PreviousPolicy:
type: object
required:
- PolicyReference
- Insurer
- PolicyStartDatePolicyStartDateTime
- PolicyExpiryDatePolicyExpiryDateTime
properties:
PolicyReference:
type$ref: string'#/components/schemas/PolicyReference'
Insurer:
type: string
PolicyStartDatePolicyStartDateTime:
type: string
format: date-time
PolicyExpiryDatePolicyExpiryDateTime:
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: Meta Data relevant to the resourceTotal 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-access: 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-access: >-
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
| 