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.
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/OBReadInsuranceConsents1AEReadInsuranceConsents1'
application/json:
schema:
$ref: '#/components/schemas/OBReadInsuranceConsents1AEReadInsuranceConsents1'
application/jwt:
schema:
$ref: '#/components/schemas/OBReadInsuranceConsents1SignedAEReadInsuranceConsents1Signed'
'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/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
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'
CustomerUserAgentInsurancePolicyId:
name: x-customer-user-agentInsurancePolicyId
in: headerpath
required: falsetrue
description: IndicatesUnique theidentifier user-agentfor thata thegiven User is using.insurance policy
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 the User lastschema:
logged in with the TPP. type: string
All dates in the HTTP headers are represented 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: string
number
StateEmirate: typedescription: stringPending mortgage amount on Country:
type: stringthe vehicle
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 propertiesadditionalProperties: false
AEBaseConsentId:
NumberClaims: type: string
typeminLength: integer1
maxLength: 128
format: int64 description: >-
NumberApprovedClaims: The original ConsentId assigned by the TPP.
type: integer It is used by format:the int64TPP for updating/renewing parameters associated with
TotalClaimsAmount: long-lived consents.
$ref: '#/components/schemas/AmountAndCurrency' It must be provided when TotalApprovedClaimsAmount:long-lived consent parameters are
$ref: '#/components/schemas/AmountAndCurrency'
additionalProperties: falseupdated/renewed for a current consent that has not yet finished.
CommunicationPreferenceTypesAEConsentId:
type: string
minLength: 1
enum maxLength: 128
description: >-
Home Unique identification - Mobile
assigned by the TPP to identify the consent
- Otherresource.
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: false
ConsentStatusCode AEConsentPurpose:
type: string
enum:
- AuthorizedAccountAggregation
- AwaitingAuthorizationPersonalFinanceManager
- RejectedCreditAssessment
- RevokedMotorInsuranceQuote
- ExpiredEnterpriseFinancialManagement
- SuspendedOther
CurrencyCodeAECustomerCommunicationDetails:
type: stringobject
patternrequired:
^[A-Z]{3}$ First: - CorrespondenceAddress
type: string - PermanentAddress
format: uri description:- AResidentialAddress
link to the first page in a paginated result set - CommunicationPreferences
Last: - type:Email
string properties:
format: uri descriptionCorrespondenceAddress:
A link to the last page in a paginated result set
LinksResource:$ref: '#/components/schemas/Address'
typePermanentAddress:
object required: $ref: '#/components/schemas/Address'
- Self ResidentialAddress:
properties: Self:
$ref: '#$ref: '#/components/schemas/SelfAddress'
FirstCommunicationPreferences:
$reftype: '#/components/schemas/First' array
Previtems:
$ref: '#/components/schemas/PrevCommunicationPreferences'
Next minItems: 1
$ref maxItems: '#/components/schemas/Next'3
LastEmail:
$reftype: '#/components/schemas/Last'string
description: Links relevant to the resourceAlternativeEmail:
type: string
additionalProperties: false
LinksSelfAEError:
type: object
required:
- Code
Self properties: - Message
Selfproperties:
$refCode:
'#/components/schemas/Self' description: Links relevant toallOf:
the resource additionalProperties: false - Meta:$ref: '#/components/schemas/AEErrorCode'
type: object description: Low level textual description:error Metadata relevant to the resourcecode, e.g., UAEOF.Field.Missing
additionalPropertiesMessage: false
MetaTotalPages: type: objectstring
required: minLength: 1
maxLength: 500
- TotalPages propertiesdescription: >-
TotalPages: A description of the error that $ref: '#/components/schemas/TotalPages'
occurred. e.g., 'A mandatory field
additionalProperties: false Next: isn't supplied' or 'RequestedExecutionDateTime must be type:in stringfuture'
format: uri UAEOF description: A link to the next page in a paginated result set
doesn't standardise this field
Path:
OBAddOns: type: string
object required: minLength: 1
- DriversPersonalAccident maxLength: 500
- PassengersPersonalAccident propertiesdescription: >-
DriversPersonalAccident: Recommended but optional reference to the JSON type:Path booleanof the field
description: Indicates whether driver accidentalwith coverage is includederror, e.g., Data.Initiation.InstructedAmount.Currency
PassengersPersonalAccidentUrl:
type: booleanstring
description: Indicates>-
whether passenger accidental coverage included additionalProperties: falseURL to help remediate the OBAdditionalInformation:problem, or provide more information, or
type: object required: to API Reference, or help etc
- FirstTimeRegistration description: Error
- VehicleMortgage additionalProperties: false
properties: AEErrorCode:
FirstTimeRegistrationtype: string
enum:
type: boolean - UAEOF.AccessToken.Unauthorized
VehicleMortgage: - UAEOF.AccessToken.InvalidScope
type: number - UAEOF.Consent.Revoked
description: Pending mortgage amount on the vehicle- UAEOF.Consent.TransientAccountAccessFailure
additionalProperties: false- UAEOF.Consent.AccountTemporarilyBlocked
OBBaseConsentId: - UAEOF.Consent.PermanentAccountAccessFailure
type: string minLength: 1- UAEOF.Consent.Invalid
maxLength: 128- UAEOF.JWS.InvalidSignature
description: >- - UAEOF.JWS.Malformed
The original ConsentId assigned by the TPP.- UAEOF.JWS.InvalidClaim
- UAEOF.JWS.InvalidHeader
It is used by the TPP for updating/renewing parameters- associatedUAEOF.GenericRecoverableError
with long-lived consentsUAEOF.GenericError
- UAEOF.JWE.DecryptionError
It must be provided when long-lived consentUAEOF.JWE.InvalidHeader
parameters are - updated/renewed for a current consent that has not yet finished.UAEOF.Event.UnexpectedEvent
- UAEOF.Body.InvalidFormat
OBConsentId: - UAEOF.Resource.InvalidResourceId
type: string minLength: 1- UAEOF.Resource.InvalidFormat
maxLength: 128- UAEOF.Consent.BusinessRuleViolation
descriptionAEErrorResponse:
>- type: object
Unique identification assigned by the TPPrequired:
to identify the consent - Errors
resource. OBConsentPermissionsproperties:
type: string Errors:
enum: type: array
- ReadInsurancePoliciesMotor descriptionitems:
>- Specifies the permitted insurance policy data types.$ref: '#/components/schemas/AEError'
minItems: 1
This is a list of the datadescription: groups>-
being consented by the User, and An array of detail error codes, requestedand formessages, authorizationand withURLs theto LFI.documentation
OBConsentPurpose: to help remediation.
type: string additionalProperties: false
enum: AEErrorSignedResponse:
- AccountAggregation type: object
- PersonalFinanceManagerrequired:
- CreditAssessmentiss
- MotorInsuranceQuoteexp
- EnterpriseFinancialManagementnbf
- Othermessage
OBCustomerCommunicationDetails: properties:
type: object requirediss:
- CorrespondenceAddress type: string
- PermanentAddress description: >-
- ResidentialAddress - CommunicationPreferences[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
exp:
- Email propertiestype: number
CorrespondenceAddress: $ref: '#/components/schemas/Address'description: >-
PermanentAddress: $ref: '#/components/schemas/Address'
ResidentialAddress:
$ref: '#/components/schemas/Address'[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
CommunicationPreferencesnbf:
type: arraynumber
itemsdescription: >-
$ref: '#/components/schemas/CommunicationPreferences'[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
minItemsaud:
1 maxItemstype: 3array
Email: type: string
items:
AlternativeEmail: type: string
additionalProperties: false OBErrordescription: >-
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)
- Code iat:
- Message type: number
properties: Codedescription: >-
allOf:
[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/OBErrorCodeAEErrorResponse'
description: LowSigned error levelresponse textualpayload
error code, e.g., UAEOF.Field.Missing additionalProperties: false
MessageAEHistoricalInformation:
type: object
type: string properties:
minLengthAdditionalInsuranceInformation:
1 maxLengthtype: 500string
description: >-Gap in car insurance or vehicle under TPL coverage
A description of the errorDrivingHistory:
that occurred. e.g., 'A mandatory field type: integer
isn't supplied' or 'RequestedExecutionDateTime mustformat: beint64
in future' description: More than 1 year UAEOFof doesn'tdriving standardiseexperience
this field PathTwelveMonthClaimHistory:
type$ref: string'#/components/schemas/ClaimHistory'
minLengthThirtySixMonthClaimHistory:
1 maxLength$ref: 500'#/components/schemas/ClaimHistory'
additionalProperties: false
description: >- AEIndividualCustomerDetails:
type: object
Recommended but optional reference toproperties:
the JSON Path of the field Gender:
with error, e.g., Data.Initiation.InstructedAmount.Currencytype: string
UrlDateofBirth:
type: string
descriptionformat: >-date
MaritalStatus:
URL to help remediate thetype: problem,string
or provide more information, or EducationBackground:
to API Reference,type: orstring
help etc descriptionNationality:
Error additionalProperties: false type: string
OBErrorCode: typeDualNationality:
string enum: type: boolean
- UAEOF.AccessToken.Unauthorized SecondNationality:
- UAEOF.AccessToken.InvalidScope type: string
- UAEOF.Consent.Revoked Salutation:
- UAEOF.Consent.TransientAccountAccessFailure type: string
- UAEOF.Consent.AccountTemporarilyBlocked CityofBirth:
- UAEOF.Consent.PermanentAccountAccessFailure type: string
- UAEOF.Consent.Invalid CountryofBirth:
- UAEOF.JWS.InvalidSignature type: string
- UAEOF.JWS.Malformed pattern: ^[A- UAEOF.JWS.InvalidClaimZ]{2,2}$
Religion:
- UAEOF.JWS.InvalidHeader type: -string
UAEOF.GenericRecoverableError MothersMaidenName:
- UAEOF.GenericError - UAEOF.JWE.DecryptionErrortype: string
- UAEOF.JWE.InvalidHeaderSpouseName:
- UAEOF.Event.UnexpectedEvent
type: string
- UAEOF.Body.InvalidFormat SpouseDateofBirth:
- UAEOF.Resource.InvalidResourceId type: string
- UAEOF.Resource.InvalidFormat
format: date
- UAEOF.Consent.BusinessRuleViolation SpouseEmploymentDetails:
OBErrorResponse: type: string
object requiredSpouseContact:
type: string
- Errors propertiesNumberofChildren:
Errors type: integer
type format: arrayint64
additionalProperties: false
items AEInsurancePolicy:
type: object
$ref: '#/components/schemas/OBError'required:
- PolicyType
- PolicyDetails
minItems properties:
1 descriptionPolicyType:
>- An array of detail error codes, and messages, and URLs to documentation$ref: '#/components/schemas/AEPolicyTypes'
PolicyDetails:
to help remediation.$ref: '#/components/schemas/AESupportedPolicyTypes'
additionalProperties: false
OBErrorSignedResponseAEInsurancePolicyInformation:
type: object
required:
- issPolicyReference
- expIssueDateTime
- nbfExpiryDateTime
- messagePolicyType
properties:- CoverageAmount
iss: - CoverageStartDateTime
type:- stringPolicyPremium
- PolicyHolderEmirates
description: >- properties:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1) PolicyReference:
$ref: '#/components/schemas/PolicyReference'
expIssueDateTime:
type: numberstring
descriptionformat: >date-time
ExpiryDateTime:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)type: string
format: date-time
nbfPolicyType:
type: number string
CoverageAmount:
description$ref: >-'#/components/schemas/AEAmountAndCurrency'
CoverageStartDateTime:
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5) type: string
audformat: date-time
typePolicyPremium:
array items:$ref: '#/components/schemas/AEAmountAndCurrency'
PolicyHolderEmirates:
type: string type: boolean
description: >- PreviousPolicy:
[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/PreviousPolicy'
additionalProperties: false
iat: AEMotorInsurancePolicy:
type: object
number required:
description: >- InsurancePolicyId
- CustomerId
[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
- PolicyHolderName
message: - CustomerCommunicationDetails
$ref: '#/components/schemas/OBErrorResponse'- IndividualCustomerDetails
description: Signed error- responseVehicleInformation
payload additionalProperties: false- InsurancePolicyInformation
OBEventNotification: properties:
type: object requiredInsurancePolicyId:
- Webhook
properties:
allOf:
Webhook: - $ref: '#/components/schemas/OBWebhookuuid'
additionalProperties: false description: Unique OBHistoricalInformation:identifier for a given insurance policy
type: object CustomerId:
properties: AdditionalInsuranceInformationtype: string
type description: string>-
description: Gap inIdentifier carthat insuranceuniquely orand vehicleconsistently underidentifies TPLthe coverageinsurance
DrivingHistory: policy customer
type: integer PolicyHolderName:
format: int64 type: string
descriptionPolicyHolderShortName:
More than 1 year of driving experience type: string
TwelveMonthClaimHistory CategorySegment:
$reftype: '#/components/schemas/ClaimHistory'string
ThirtySixMonthClaimHistoryLocalBranch:
$reftype: '#/components/schemas/ClaimHistory'string
additionalProperties: false PrimaryLanguage:
OBIndividualCustomerDetails: type: string
object propertiesCustomerCommunicationDetails:
Gender $ref: '#/components/schemas/AECustomerCommunicationDetails'
IndividualCustomerDetails:
type: string DateofBirth$ref: '#/components/schemas/AEIndividualCustomerDetails'
typeVehicleInformation:
string format$ref: date'#/components/schemas/AEVehicleInformation'
MaritalStatusInsurancePolicyInformation:
type$ref: string'#/components/schemas/AEInsurancePolicyInformation'
EducationBackgroundHistoricalInformation:
type$ref: string'#/components/schemas/AEHistoricalInformation'
NationalityAddOns:
type$ref: string'#/components/schemas/AEAddOns'
DualNationalityAdditionalInformation:
type$ref: boolean'#/components/schemas/AEAdditionalInformation'
additionalProperties: false
SecondNationality: AEOnBehalfOf:
type: stringobject
Salutationproperties:
TradingName:
type: string CityofBirthtype: string
type: string description: Trading Name
CountryofBirthLegalName:
type: string
patterndescription: ^[A-Z]{2,2}$ Legal Name
ReligionIdentifierType:
typeallOf:
string - MothersMaidenName:$ref: '#/components/schemas/AEOnBehalfOfIdentifierType'
typedescription: stringIdentifier Type
SpouseNameIdentifier:
type: string
description: Identifier
SpouseDateofBirthadditionalProperties: false
AEOnBehalfOfIdentifierType:
type: string
enum:
format: date - Other
SpouseEmploymentDetailsAEPatchConsent:
type: object
type: string required:
SpouseContact: - Status
typeproperties:
string NumberofChildrenStatus:
typeallOf:
integer - format$ref: int64'#/components/schemas/AEPatchConsentStatus1'
additionalProperties: false description: >-
OBInsurancePolicy: type: object The Revoked status required:must only be set if the current Consent Status -is
PolicyType - PolicyDetails set to either Authorized or properties:AwaitingAuthorization
PolicyTypeRevokedBy:
$refallOf:
'#/components/schemas/OBPolicyTypes' PolicyDetails: - $ref: '#/components/schemas/OBSupportedPolicyTypes'AERevokedByCode'
description: Denotes the Identifier of the revocation.
additionalProperties: false
OBInsurancePolicyInformationAEPatchConsentStatus1:
type: objectstring
requiredenum:
- PolicyReference Revoked
AEPolicyTypes:
type: string
- IssueDateTimeenum:
- ExpiryDateTimeMotor
AEReadInsuranceConsent1:
- PolicyType type: object
- CoverageAmountrequired:
- CoverageStartDateTimeData
- PolicyPremiumLinks
- PolicyHolderEmiratesMeta
properties:
PolicyReferenceData:
$ref: '#/components/schemas/PolicyReferenceAEReadInsuranceConsent1Properties'
IssueDateTimeSubscription:
type$ref: string'#/components/schemas/EventNotification'
Links:
format: date-time ExpiryDateTime$ref: '#/components/schemas/LinksSelf'
typeMeta: string
format$ref: date-time'#/components/schemas/Meta'
additionalProperties: false
PolicyType: AEReadInsuranceConsent1Properties:
type: stringobject
CoverageAmountrequired:
- ConsentId
$ref: '#/components/schemas/AmountAndCurrency' - Permissions
CoverageStartDateTime: - CreationDateTime
type: string - Status
format: date-time - StatusUpdateDateTime
PolicyPremium: $ref: '#/components/schemas/AmountAndCurrency'properties:
PolicyHolderEmiratesConsentId:
type$ref: boolean'#/components/schemas/AEConsentId'
PreviousPolicyBaseConsentId:
$ref: '#/components/schemas/PreviousPolicyAEBaseConsentId'
additionalProperties: false Permissions:
OBMotorInsurancePolicy: type: array
object requireditems:
- InsurancePolicyId $ref: '#/components/schemas/AEConsentPermissions'
- CustomerId minItems: 1
- PolicyHolderName ExpirationDateTime:
- CustomerCommunicationDetails type: string
- IndividualCustomerDetails format: date-time
VehicleInformation description: >-
InsurancePolicyInformation properties: Specified date and time InsurancePolicyId:the permissions will expire.
allOf: If this is not populated, the permissions -will $ref: '#/components/schemas/uuid'
be open ended.All
description: Unique identifier fordates ain giventhe insuranceJSON policypayloads are represented in ISO 8601 date-time
CustomerId: format. type:
string
description: >-
All date-time fields in responses must include the timezone. An
Identifier that uniquely and consistently identifiesexample theis insurancebelow:
policy customer 2017-04-05T10:43:07+00:00
PolicyHolderNameOnBehalfOf:
type$ref: string'#/components/schemas/AEOnBehalfOf'
PolicyHolderShortNamePurpose:
type: stringarray
CategorySegmentitems:
type$ref: string'#/components/schemas/AEConsentPurpose'
LocalBranchCreationDateTime:
type: string
PrimaryLanguage format: date-time
typedescription: string>-
CustomerCommunicationDetails: Date and time at which the resource was $ref: '#/components/schemas/OBCustomerCommunicationDetails'
created.All dates in the
IndividualCustomerDetails: JSON payloads are represented in $ref: '#/components/schemas/OBIndividualCustomerDetails'
ISO 8601 date-time format.
VehicleInformation: All date-time fields $ref: '#/components/schemas/OBVehicleInformation'
in responses must include the timezone. An
InsurancePolicyInformation: example is $refbelow:
'#/components/schemas/OBInsurancePolicyInformation'
HistoricalInformation: 2017-04-05T10:43:07+00:00
$refStatus:
'#/components/schemas/OBHistoricalInformation' AddOnsallOf:
- $ref: '#/components/schemas/OBAddOnsConsentStatusCode'
AdditionalInformation description: Specifies the status of consent resource in code form.
$ref: '#/components/schemas/OBAdditionalInformation' additionalPropertiesStatusUpdateDateTime:
false OBOnBehalfOf: type: objectstring
properties: format: date-time
TradingName: description: >-
type: string Date and description:time Tradingat Namewhich the account resource status was updated. All
LegalName: type:dates stringin the JSON payloads are represented in ISO 8601 date-time
description: Legal Name IdentifierType:format. All date-time fields in responses must include the timezone.
allOf: An example -is $ref: '#/components/schemas/OBOnBehalfOfIdentifierType'below: 2017-04-05T10:43:07+00:00
RevokedBy:
description: Identifier Type allOf:
Identifier: - type$ref: string'#/components/schemas/AERevokedByCode'
description: Denotes the Identifier of the revocation.
additionalProperties: false
OBOnBehalfOfIdentifierTypeAEReadInsuranceConsent1Signed:
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:
allOf:
- $ref: '#/components/schemas/OBRevokedByCode'[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4)
description: Denotes the Identifier of the revocation.nbf:
additionalPropertiestype: falsenumber
OBPatchConsentStatus1: typedescription: string>-
enum: [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5)
- Revoked OBPolicyTypesaud:
type: string type: array
enum: items:
- Motor OBReadInsuranceConsent1: type: objectstring
required: description: >-
- Data - Links[https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3)
iat:
- Meta propertiestype: number
Datadescription: >-
$ref: '#/components/schemas/OBReadInsuranceConsent1Properties' [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6)
Subscriptionmessage:
$ref: '#/components/schemas/OBEventNotificationAEReadInsuranceConsent1'
additionalProperties: false
Links: AEReadInsuranceConsents1:
$reftype: '#/components/schemas/LinksSelf'object
required:
Meta: - Data
$ref: '#/components/schemas/Meta' - Links
additionalProperties: false OBReadInsuranceConsent1Propertiesproperties:
type Data:
object requiredtype: array
- ConsentId items:
- BaseConsentId $ref: '#/components/schemas/AEReadInsuranceConsent1Properties'
- Permissions Links:
- CreationDateTime $ref: '#/components/schemas/LinksResource'
- Status additionalProperties: false
- StatusUpdateDateTimeAEReadInsuranceConsents1Signed:
propertiestype: object
required:
ConsentId: - iss
$ref: '#/components/schemas/OBConsentId' - exp
BaseConsentId: - nbf
$ref: '#/components/schemas/OBBaseConsentId' - message
Permissions: properties:
typeiss:
array itemstype: string
$refdescription: '#/components/schemas/OBConsentPermissions'>-
ExpirationDateTime: [https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1](https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1)
type exp:
string formattype: date-timenumber
description: >-
Specified date and time the permissions will expire.
If this is not populated, the permissions will be open ended.All
dates in the JSON payloads are represented in ISO 8601 date-time
format.
All date-time fields in responses must include the timezone. An
example is below:
2017-04-05T10:43:07+00:00
OnBehalfOf:
$ref: '#/components/schemas/OBOnBehalfOf'
Purpose:
type: array
items:
$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
| 