openapi: 3.0.0
info:
title: UAE Insurance API
description: '## UAE Open Finance Insurance API Specification'
version: v2.0-draft1
x-logo:
url: altareq-logo.png
tags:
- name: Insurance Consents
description: Insurance Consent Operations
- name: Employment Insurance Quotes
description: Employment Insurance Quotes Operations
- name: Employment Insurance Data Sharing
description: Employment Insurance Data Sharing Operations
- name: Health Insurance Quotes
description: Health Insurance Quotes Operations
- name: Health Insurance Data Sharing
description: Health Insurance Data Sharing Operations
- name: Home Insurance Quotes
description: Home Insurance Quotes Operations
- name: Home Insurance Data Sharing
description: Home Insurance Data Sharing Operations
- name: Life Insurance Quotes
description: Life Insurance Quotes Operations
- name: Life Insurance Data Sharing
description: Life Insurance Data Sharing Operations
- name: Motor Insurance Quotes
description: Motor Insurance Quotes Operations
- name: Motor Insurance Data Sharing
description: Motor Insurance Data Sharing Operations
- name: Renters Insurance Quotes
description: Renters Insurance Quotes Operations
- name: Renters Insurance Data Sharing
description: Renters Insurance Data Sharing Operations
- name: Travel Insurance Quotes
description: Travel Insurance Quotes Operations
- name: Travel Insurance Data Sharing
description: Travel Insurance Data Sharing Operations
paths:
/employment-insurance-policies:
post:
operationId: >-
EmploymentInsuranceCreatePolicy_unsignedRequest_EmploymentInsuranceCreatePolicy_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a employment insurance policy based on a quote previously created
by the
LFI. The TPP will send the `QuoteId` that has been saved by the LFI,
together with
any additional data that is required to create the insurance policy. The
LFI will then invoke their BAU process to create the insurance policy.
After the policy initiation request has been sent the User will be
redirected to
the LFI to complete the creation of the insurance policy.
summary: Create aan employment insurance policy
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
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/AEInsuranceCreatePolicyResponse1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Employment Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
get:
operationId: EmploymentInsurancePolicies_list
summary: Retrieve employment insurance policies
description: >-
Retrieve all insurance policies to which access has been granted by the
User
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-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/AEReadInsurancePolicies1'
application/json:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Employment Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/employment-insurance-policies/{InsurancePolicyId}:
get:
operationId: EmploymentInsurancePoliciesById_read
summary: Retrieve a employment insurance policy
description: >-
Retrieve an insurance policy for a given insurance policy identifier
value, based
on data clusters granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadEmploymentInsurancePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEReadEmploymentInsurancePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadEmploymentInsurancePolicy1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Employment Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/employment-insurance-policies/{InsurancePolicyId}/payment-details:
get:
operationId: EmploymentInsurancePolicyByIdBankAccountDetails_read
summary: Retrieve employment insurance policy payment details
description: >-
Retrieve payment details for a given employment insurance policy, based
on data clusters
granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/json:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Employment Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/employment-insurance-quotes:
post:
operationId: >-
CreateEmploymentInsuranceQuote_unsignedRequest_CreateEmploymentInsuranceQuote_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a employment insurance quote. Data can be sourced using data
shared by an
existing LFI using the `Quote` data cluster.
summary: Create aan employment insurance quote
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
anyOf:
- $ref: >-
#/components/schemas/AECreateEmploymentInsuranceQuoteResponse1
- $ref: >-
#/components/schemas/AECreateEmploymentInsuranceQuoteResponse1Signed
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Employment Insurance Quotes
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateEmploymentInsuranceQuote1'
- $ref: '#/components/schemas/AECreateEmploymentInsuranceQuote1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/employment-insurance-quotes/{QuoteId}:
get:
operationId: EmploymentInsuranceGetQuoteByQuoteId_read
summary: Retrieve a quote
description: >-
Retrieve the properties of a quote, using the quote identifier returned
by the
`post /employment-insurance-quotes` operation.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
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/AEReadEmploymentInsuranceQuote1'
application/json:
schema:
$ref: '#/components/schemas/AEReadEmploymentInsuranceQuote1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadEmploymentInsuranceQuote1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Employment Insurance Quotes
security:
- TPPOAuth2Security:
- openid
- insurance
/employment-insurance-quotes/{QuoteId}/status:
patch:
operationId: >-
EmploymentInsurancePatchQuoteByQuoteId_unsignedRequest_EmploymentInsurancePatchQuoteByQuoteId_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
description: >-
Update the quote status to `Accepted` in readiness to send the quote
data to
create a new insurance policy. The TPP must update the status to
Accepted before
retrieving any additional data through their Data Sharing permissions,
to include
in the new insurance policy request.
summary: Update the quote status
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: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Employment Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/json:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/jwt:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/health-insurance-policies:
post:
operationId: >-
HealthInsuranceCreatePolicy_unsignedRequest_HealthInsuranceCreatePolicy_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a health insurance policy based on a quote previously created by
the
LFI. The TPP will send the `QuoteId` that has been saved by the LFI,
together with
any additional data that is required to create the insurance policy. The
LFI will then invoke their BAU process to create the insurance policy.
After the policy initiation request has been sent the User will be
redirected to
the LFI to complete the creation of the insurance policy.
summary: Create a health insurance policy
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
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/AEInsuranceCreatePolicyResponse1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Health Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
get:
operationId: HealthInsurancePolicies_list
summary: Retrieve health insurance policies
description: >-
Retrieve all insurance policies to which access has been granted by the
User
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-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/AEReadInsurancePolicies1'
application/json:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Health Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/health-insurance-policies/{InsurancePolicyId}:
get:
operationId: HealthInsurancePoliciesById_read
summary: Retrieve a health insurance policy
description: >-
Retrieve an insurance policy for a given insurance policy identifier
value, based
on data clusters granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadHealthInsurancePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEReadHealthInsurancePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadHealthInsurancePolicy1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Health Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/health-insurance-policies/{InsurancePolicyId}/payment-details:
get:
operationId: HealthInsurancePolicyByIdBankAccountDetails_read
summary: Retrieve health insurance policy payment details
description: >-
Retrieve payment details for a given health insurance policy, based on
data clusters
granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/json:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Health Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/health-insurance-quotes:
post:
operationId: >-
CreateHealthInsuranceQuote_unsignedRequest_CreateHealthInsuranceQuote_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a health insurance quote. Data can be sourced using data shared
by an
existing LFI using the `Quote` data cluster.
summary: Create a health insurance quote
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateHealthInsuranceQuoteResponse1'
- $ref: >-
#/components/schemas/AECreateHealthInsuranceQuoteResponse1Signed
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Health Insurance Quotes
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateHealthInsuranceQuote1'
- $ref: '#/components/schemas/AECreateHealthInsuranceQuote1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/health-insurance-quotes/{QuoteId}:
get:
operationId: HealthInsuranceGetQuoteByQuoteId_read
summary: Retrieve a quote
description: >-
Retrieve the properties of a quote, using the quote identifier returned
by the
`post /health-insurance-quotes` operation.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
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/AEReadHealthInsuranceQuote1'
application/json:
schema:
$ref: '#/components/schemas/AEReadHealthInsuranceQuote1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadHealthInsuranceQuote1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Health Insurance Quotes
security:
- TPPOAuth2Security:
- openid
- insurance
/health-insurance-quotes/{QuoteId}/status:
patch:
operationId: >-
HealthInsurancePatchQuoteByQuoteId_unsignedRequest_HealthInsurancePatchQuoteByQuoteId_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
description: >-
Update the quote status to `Accepted` in readiness to send the quote
data to
create a new insurance policy. The TPP must update the status to
Accepted before
retrieving any additional data through their Data Sharing permissions,
to include
in the new insurance policy request.
summary: Update the quote status
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: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Health Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/json:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/jwt:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/home-insurance-policies:
post:
operationId: >-
HomeInsuranceCreatePolicy_unsignedRequest_HomeInsuranceCreatePolicy_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a home insurance policy based on a quote previously created by
the
LFI. The TPP will send the `QuoteId` that has been saved by the LFI,
together with
any additional data that is required to create the insurance policy. The
LFI will then invoke their BAU process to create the insurance policy.
After the policy initiation request has been sent the User will be
redirected to
the LFI to complete the creation of the insurance policy.
summary: Create a home insurance policy
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
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/AEInsuranceCreatePolicyResponse1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Home Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
get:
operationId: HomeInsurancePolicies_list
summary: Retrieve home insurance policies
description: >-
Retrieve all insurance policies to which access has been granted by the
User
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-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/AEReadInsurancePolicies1'
application/json:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Home Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/home-insurance-policies/{InsurancePolicyId}:
get:
operationId: HomeInsurancePoliciesById_read
summary: Retrieve a home insurance policy
description: >-
Retrieve an insurance policy for a given insurance policy identifier
value, based
on data clusters granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadHomeInsurancePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEReadHomeInsurancePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadHomeInsurancePolicy1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Home Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/home-insurance-policies/{InsurancePolicyId}/payment-details:
get:
operationId: HomeInsurancePolicyByIdBankAccountDetails_read
summary: Retrieve home insurance policy payment details
description: >-
Retrieve payment details for a given home insurance policy, based on
data clusters
granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/json:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Home Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/home-insurance-quotes:
post:
operationId: >-
CreateHomeInsuranceQuote_unsignedRequest_CreateHomeInsuranceQuote_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a home insurance quote. Data can be sourced using data shared by
an
existing LFI using the `Quote` data cluster.
summary: Create a home insurance quote
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateHomeInsuranceQuoteResponse1'
- $ref: >-
#/components/schemas/AECreateHomeInsuranceQuoteResponse1Signed
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Home Insurance Quotes
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateHomeInsuranceQuote1'
- $ref: '#/components/schemas/AECreateHomeInsuranceQuote1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/home-insurance-quotes/{QuoteId}:
get:
operationId: HomeInsuranceGetQuoteByQuoteId_read
summary: Retrieve a quote
description: >-
Retrieve the properties of a quote, using the quote identifier returned
by the
`post /home-insurance-quotes` operation.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
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/AEReadHomeInsuranceQuote1'
application/json:
schema:
$ref: '#/components/schemas/AEReadHomeInsuranceQuote1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadHomeInsuranceQuote1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Home Insurance Quotes
security:
- TPPOAuth2Security:
- openid
- insurance
/home-insurance-quotes/{QuoteId}/status:
patch:
operationId: >-
HomeInsurancePatchQuoteByQuoteId_unsignedRequest_HomeInsurancePatchQuoteByQuoteId_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
description: >-
Update the quote status to `Accepted` in readiness to send the quote
data to
create a new insurance policy. The TPP must update the status to
Accepted before
retrieving any additional data through their Data Sharing permissions,
to include
in the new insurance policy request.
summary: Update the quote status
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: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Home Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/json:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/jwt:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/insurance-consents:
get:
operationId: InsuranceConsents_list
summary: Retrieve consents by BaseConsentId
description: Retrieve all consents that are linked to a given `BaseConsentId`
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/BaseConsentId'
responses:
'200':
description: The request has succeeded.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadInsuranceConsents1'
application/json:
schema:
$ref: '#/components/schemas/AEReadInsuranceConsents1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadInsuranceConsents1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Insurance Consents
security:
- TPPOAuth2Security:
- openid
- insurance
/insurance-consents/{ConsentId}:
get:
operationId: InsuranceConsentsByConsentId_read
summary: Retrieve a consent
description: Retrieve a consent for a given `ConsentId`
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-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/AEReadInsuranceConsent1'
application/json:
schema:
$ref: '#/components/schemas/AEReadInsuranceConsent1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadInsuranceConsent1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Insurance Consents
security:
- TPPOAuth2Security:
- openid
- insurance
patch:
operationId: >-
InsuranceConsentsByConsentId_unsignedRequestBodyUpdate_InsuranceConsentsByConsentId_signedRequestBodyUpdate
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/ConsentId'
description: Modify a consent for a given `ConsentId`
summary: Modify a consent
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: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Insurance Consents
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEUpdateConsent1Update'
application/json:
schema:
$ref: '#/components/schemas/AEUpdateConsent1Update'
application/jwt:
schema:
$ref: '#/components/schemas/AEUpdateConsent1SignedUpdate'
security:
- TPPOAuth2Security:
- openid
- insurance
/life-insurance-policies:
post:
operationId: >-
LifeInsuranceCreatePolicy_unsignedRequest_LifeInsuranceCreatePolicy_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a life insurance policy based on a quote previously created by
the
LFI. The TPP will send the `QuoteId` that has been saved by the LFI,
together with
any additional data that is required to create the insurance policy. The
LFI will then invoke their BAU process to create the insurance policy.
After the policy initiation request has been sent the User will be
redirected to
the LFI to complete the creation of the insurance policy.
summary: Create a life insurance policy
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
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/AEInsuranceCreatePolicyResponse1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Life Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
get:
operationId: LifeInsurancePolicies_list
summary: Retrieve life insurance policies
description: >-
Retrieve all insurance policies to which access has been granted by the
User
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-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/AEReadInsurancePolicies1'
application/json:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Life Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/life-insurance-policies/{InsurancePolicyId}:
get:
operationId: LifeInsurancePoliciesById_read
summary: Retrieve a life insurance policy
description: >-
Retrieve an insurance policy for a given insurance policy identifier
value, based
on data clusters granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadLifeInsurancePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEReadLifeInsurancePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadLifeInsurancePolicy1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Life Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/life-insurance-policies/{InsurancePolicyId}/payment-details:
get:
operationId: LifeInsurancePolicyByIdBankAccountDetails_read
summary: Retrieve life insurance policy payment details
description: >-
Retrieve payment details for a given life insurance policy, based on
data clusters
granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/json:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Life Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/life-insurance-quotes:
post:
operationId: >-
CreateLifeInsuranceQuote_unsignedRequest_CreateLifeInsuranceQuote_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a life insurance quote. Data can be sourced using data shared by
an
existing LFI using the `Quote` data cluster.
summary: Create a life insurance quote
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateLifeInsuranceQuoteResponse1'
- $ref: >-
#/components/schemas/AECreateLifeInsuranceQuoteResponse1Signed
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Life Insurance Quotes
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateLifeInsuranceQuote1'
- $ref: '#/components/schemas/AECreateLifeInsuranceQuote1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/life-insurance-quotes/{QuoteId}:
get:
operationId: LifeInsuranceGetQuoteByQuoteId_read
summary: Retrieve a quote
description: >-
Retrieve the properties of a quote, using the quote identifier returned
by the
`post /life-insurance-quotes` operation.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
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/AEReadLifeInsuranceQuote1'
application/json:
schema:
$ref: '#/components/schemas/AEReadLifeInsuranceQuote1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadLifeInsuranceQuote1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Life Insurance Quotes
security:
- TPPOAuth2Security:
- openid
- insurance
/life-insurance-quotes/{QuoteId}/status:
patch:
operationId: >-
LifeInsurancePatchQuoteByQuoteId_unsignedRequest_LifeInsurancePatchQuoteByQuoteId_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
description: >-
Update the quote status to `Accepted` in readiness to send the quote
data to
create a new insurance policy. The TPP must update the status to
Accepted before
retrieving any additional data through their Data Sharing permissions,
to include
in the new insurance policy request.
summary: Update the quote status
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: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Life Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/json:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/jwt:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/motor-insurance-policies:
post:
operationId: >-
MotorInsuranceCreatePolicy_signedRequest_MotorInsuranceCreatePolicy_unsignedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create an employment insurance policy based on a quote previously
created by the
LFI. The TPP will send the `QuoteId` that has been saved by the LFI,
together with
any additional data that is required to create the insurance policy. The
LFI will then invoke their BAU process to create the insurance policy.
After the policy initiation request has been sent the User will be
redirected to
the LFI to complete the creation of the insurance policy.
summary: Create a motor insurance policy
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
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/AEInsuranceCreatePolicyResponse1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Motor Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
get:
operationId: MotorInsurancePolicies_list
summary: Retrieve motor insurance policies
description: >-
Retrieve all insurance policies to which access has been granted by the
User
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-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/AEReadInsurancePolicies1'
application/json:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Motor Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/motor-insurance-policies/{InsurancePolicyId}:
get:
operationId: MotorInsurancePoliciesById_read
summary: Retrieve a motor insurance policy
description: >-
Retrieve an insurance policy for a given insurance policy identifier
value, based
on data clusters granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadMotorInsurancePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEReadMotorInsurancePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadMotorInsurancePolicy1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Motor Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/motor-insurance-policies/{InsurancePolicyId}/payment-details:
get:
operationId: MotorInsurancePolicyByIdBankAccountDetails_read
summary: Retrieve motor insurance policy payment details
description: >-
Retrieve payment details for a given motor insurance policy, based on
data clusters
granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/json:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Motor Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/motor-insurance-quotes:
post:
operationId: >-
CreateMotorInsuranceQuote_unsignedRequest_CreateMotorInsuranceQuote_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a motor insurance quote. Data can be sourced using data shared by
an
existing LFI using a `Quote` data cluster.
summary: Create a motor insurance quote
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateMotorInsuranceQuoteResponse1'
- $ref: >-
#/components/schemas/AECreateMotorInsuranceQuoteResponse1Signed
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Motor Insurance Quotes
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateMotorInsuranceQuote1'
- $ref: '#/components/schemas/AECreateMotorInsuranceQuote1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/motor-insurance-quotes/{QuoteId}:
get:
operationId: MotorInsuranceGetQuoteByQuoteId_read
summary: Retrieve a quote
description: >-
Retrieve the properties of a quote, using the quote identifier returned
by the
`post /motor-insurance-quotes` operation.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
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/AEReadMotorInsuranceQuote1'
application/json:
schema:
$ref: '#/components/schemas/AEReadMotorInsuranceQuote1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadMotorInsuranceQuote1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Motor Insurance Quotes
security:
- TPPOAuth2Security:
- openid
- insurance
/motor-insurance-quotes/{QuoteId}/status:
patch:
operationId: >-
MotorInsurancePatchQuoteByQuoteId_unsignedRequest_MotorInsurancePatchQuoteByQuoteId_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
description: >-
Update the quote status to `Accepted` in readiness to send the quote
data to
create a new insurance policy. The TPP must update the status to
Accepted before
retrieving any additional data through their Data Sharing permissions,
to include
in the new insurance policy request.
summary: Update the quote status
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: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Motor Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/json:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/jwt:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/renters-insurance-policies:
post:
operationId: >-
RentersInsuranceCreatePolicy_unsignedRequest_RentersInsuranceCreatePolicy_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a renters insurance policy based on a quote previously created by
the
LFI. The TPP will send the `QuoteId` that has been saved by the LFI,
together with
any additional data that is required to create the insurance policy. The
LFI will then invoke their BAU process to create the insurance policy.
After the policy initiation request has been sent the User will be
redirected to
the LFI to complete the creation of the insurance policy.
summary: Create a renters insurance policy
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
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/AEInsuranceCreatePolicyResponse1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Renters Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
get:
operationId: RentersInsurancePolicies_list
summary: Retrieve renters insurance policies
description: >-
Retrieve all insurance policies to which access has been granted by the
User
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-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/AEReadInsurancePolicies1'
application/json:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Renters Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/renters-insurance-policies/{InsurancePolicyId}:
get:
operationId: RentersInsurancePoliciesById_read
summary: Retrieve a renters insurance policy
description: >-
Retrieve an insurance policy for a given insurance policy identifier
value, based
on data clusters granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadRentersInsurancePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEReadRentersInsurancePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadRentersInsurancePolicy1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Renters Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/renters-insurance-policies/{InsurancePolicyId}/payment-details:
get:
operationId: RentersInsurancePolicyByIdBankAccountDetails_read
summary: Retrieve renters insurance policy payment details
description: >-
Retrieve payment details for a given renters insurance policy, based on
data clusters
granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/json:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Renters Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/renters-insurance-quotes:
post:
operationId: >-
CreateRentersInsuranceQuote_unsignedRequest_CreateRentersInsuranceQuote_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a renters insurance quote. Data can be sourced using data shared
by an
existing LFI using the `Quote` data cluster.
summary: Create a renters insurance quote
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
anyOf:
- $ref: >-
#/components/schemas/AECreateRentersInsuranceQuoteResponse1
- $ref: >-
#/components/schemas/AECreateRentersInsuranceQuoteResponse1Signed
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Renters Insurance Quotes
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateRentersInsuranceQuote1'
- $ref: '#/components/schemas/AECreateRentersInsuranceQuote1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/renters-insurance-quotes/{QuoteId}:
get:
operationId: RentersInsuranceGetQuoteByQuoteId_read
summary: Retrieve a quote
description: >-
Retrieve the properties of a quote, using the quote identifier returned
by the
`post /renters-insurance-quotes` operation.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
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/AEReadRentersInsuranceQuote1'
application/json:
schema:
$ref: '#/components/schemas/AEReadRentersInsuranceQuote1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadRentersInsuranceQuote1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Renters Insurance Quotes
security:
- TPPOAuth2Security:
- openid
- insurance
/renters-insurance-quotes/{QuoteId}/status:
patch:
operationId: >-
RentersInsurancePatchQuoteByQuoteId_unsignedRequest_RentersInsurancePatchQuoteByQuoteId_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
description: >-
Update the quote status to `Accepted` in readiness to send the quote
data to
create a new insurance policy. The TPP must update the status to
Accepted before
retrieving any additional data through their Data Sharing permissions,
to include
in the new insurance policy request.
summary: Update the quote status
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: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Renters Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/json:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/jwt:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/travel-insurance-policies:
post:
operationId: >-
TravelInsuranceCreatePolicy_unsignedRequest_TravelInsuranceCreatePolicy_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a travel insurance policy based on a quote previously created by
the
LFI. The TPP will send the `QuoteId` that has been saved by the LFI,
together with
any additional data that is required to create the insurance policy. The
LFI will then invoke their BAU process to create the insurance policy.
After the policy initiation request has been sent the User will be
redirected to
the LFI to complete the creation of the insurance policy.
summary: Create a travel insurance policy
responses:
'202':
description: >-
The request has been accepted for processing, but processing has not
yet completed.
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/AEInsuranceCreatePolicyResponse1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicyResponse1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Travel Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEInsuranceCreatePolicy1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
get:
operationId: TravelInsurancePolicies_list
summary: Retrieve travel insurance policies
description: >-
Retrieve all insurance policies to which access has been granted by the
User
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-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/AEReadInsurancePolicies1'
application/json:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadInsurancePolicies1'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Travel Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/travel-insurance-policies/{InsurancePolicyId}:
get:
operationId: TravelInsurancePoliciesById_read
summary: Retrieve a travel insurance policy
description: >-
Retrieve an insurance policy for a given insurance policy identifier
value, based
on data clusters granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadTravelInsurancePolicy1'
application/json:
schema:
$ref: '#/components/schemas/AEReadTravelInsurancePolicy1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadTravelInsurancePolicy1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Travel Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/travel-insurance-policies/{InsurancePolicyId}/payment-details:
get:
operationId: TravelInsurancePolicyByIdBankAccountDetails_read
summary: Retrieve travel insurance policy payment details
description: >-
Retrieve payment details for a given travel insurance policy, based on
data clusters
granted by the User.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/InsurancePolicyId'
responses:
'200':
description: The request has succeeded.
headers:
x-fapi-interaction-id:
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/json:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadPaymentDetails1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Travel Insurance Data Sharing
security:
- UserOAuth2Security:
- openid
- insurance
/travel-insurance-quotes:
post:
operationId: >-
CreateTravelInsuranceQuote_unsignedRequest_CreateTravelInsuranceQuote_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
description: >-
Create a travel insurance quote. Data can be sourced using data shared
by an
existing LFI using the `Quote` data cluster.
summary: Create a travel insurance quote
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateTravelInsuranceQuoteResponse1'
- $ref: >-
#/components/schemas/AECreateTravelInsuranceQuoteResponse1Signed
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Travel Insurance Quotes
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/AECreateTravelInsuranceQuote1'
- $ref: '#/components/schemas/AECreateTravelInsuranceQuote1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
/travel-insurance-quotes/{QuoteId}:
get:
operationId: TravelInsuranceGetQuoteByQuoteId_read
summary: Retrieve a quote
description: >-
Retrieve the properties of a quote, using the quote identifier returned
by the
`post /travel-insurance-quotes` operation.
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
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/AEReadTravelInsuranceQuote1'
application/json:
schema:
$ref: '#/components/schemas/AEReadTravelInsuranceQuote1'
application/jwt:
schema:
$ref: '#/components/schemas/AEReadTravelInsuranceQuote1Signed'
'400':
description: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Travel Insurance Quotes
security:
- TPPOAuth2Security:
- openid
- insurance
/travel-insurance-quotes/{QuoteId}/status:
patch:
operationId: >-
TravelInsurancePatchQuoteByQuoteId_unsignedRequest_TravelInsurancePatchQuoteByQuoteId_signedRequest
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/x-customer-user-agent'
- $ref: '#/components/parameters/x-fapi-auth-date'
- $ref: '#/components/parameters/x-fapi-customer-ip-address'
- $ref: '#/components/parameters/x-fapi-interaction-id'
- $ref: '#/components/parameters/QuoteId'
description: >-
Update the quote status to `Accepted` in readiness to send the quote
data to
create a new insurance policy. The TPP must update the status to
Accepted before
retrieving any additional data through their Data Sharing permissions,
to include
in the new insurance policy request.
summary: Update the quote status
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: The server could not understand the request due to invalid syntax.
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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
'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:
x-fapi-interaction-id:
required: true
description: An RFC4122 UID used as a correlation id.
schema:
type: string
retry-after:
required: true
description: Number in seconds to wait
schema:
type: integer
format: int64
'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/AEErrorResponse'
application/json:
schema:
$ref: '#/components/schemas/AEErrorResponse'
tags:
- Travel Insurance Quotes
requestBody:
required: true
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/json:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1'
application/jwt:
schema:
$ref: '#/components/schemas/AEUpdateQuoteStatus1Signed'
security:
- TPPOAuth2Security:
- openid
- insurance
components:
parameters:
Authorization:
name: authorization
in: header
required: true
description: An Access 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'
explode: false
ConsentId:
name: ConsentId
in: path
required: true
description: Unique identifier for a given consent resource
schema:
$ref: '#/components/schemas/uuid'
InsurancePolicyId:
name: InsurancePolicyId
in: path
required: true
description: Unique identifier for a given insurance policy
schema:
$ref: '#/components/schemas/uuid'
QuoteId:
name: QuoteId
in: path
required: true
description: Unique identifier for a given quote
schema:
$ref: '#/components/schemas/uuid'
x-customer-user-agent:
name: x-customer-user-agent
in: header
required: false
description: Indicates the user-agent that the User is using.
schema:
type: string
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)$
x-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
x-fapi-interaction-id:
name: x-fapi-interaction-id
in: header
required: false
description: An RFC4122 UID used as a correlation ID.
schema:
type: string
schemas:
AEAmountAndCurrency:
type: object
required:
- Currency
- Amount
properties:
Currency:
$ref: '#/components/schemas/CurrencyCode'
Amount:
$ref: '#/components/schemas/Amount'
description: >-
The Currency and Amount relating to the Payment, Refund or Request to
Pay
additionalProperties: false
AEConsentPermissions:
type: string
enum:
- EmploymentInsuranceDataSharingPolicies
- EmploymentInsuranceDataSharingCustomerBasic
- EmploymentInsuranceDataSharingCustomerDetail
- EmploymentInsuranceDataSharingCustomerPaymentDetails
- EmploymentInsuranceDataSharingProduct
- EmploymentInsuranceDataSharingTransactions
- EmploymentInsuranceQuote
- HealthInsuranceDataSharingPolicies
- HealthInsuranceDataSharingCustomerBasic
- HealthInsuranceDataSharingCustomerDetail
- HealthInsuranceDataSharingCustomerPaymentDetails
- HealthInsuranceDataSharingProduct
- HealthInsuranceDataSharingTransactions
- HealthInsuranceQuote
- HomeInsuranceDataSharingPolicies
- HomeInsuranceDataSharingCustomerBasic
- HomeInsuranceDataSharingCustomerDetail
- HomeInsuranceDataSharingCustomerPaymentDetails
- HomeInsuranceDataSharingProduct
- HomeInsuranceDataSharingTransactions
- HomeInsuranceQuote
- LifeInsuranceDataSharingPolicies
- LifeInsuranceDataSharingCustomerBasic
- LifeInsuranceDataSharingCustomerDetail
- LifeInsuranceDataSharingCustomerPaymentDetails
- LifeInsuranceDataSharingProduct
- LifeInsuranceDataSharingTransactions
- LifeInsuranceQuote
- MotorInsuranceDataSharingPolicies
- MotorInsuranceDataSharingCustomerBasic
- MotorInsuranceDataSharingCustomerDetail
- MotorInsuranceDataSharingCustomerPaymentDetails
- MotorInsuranceDataSharingProduct
- MotorInsuranceDataSharingTransactions
- MotorInsuranceQuote
- RentersInsuranceDataSharingPolicies
- RentersInsuranceDataSharingCustomerBasic
- RentersInsuranceDataSharingCustomerDetail
- RentersInsuranceDataSharingCustomerPaymentDetails
- RentersInsuranceDataSharingProduct
- RentersInsuranceDataSharingTransactions
- RentersInsuranceQuote
- TravelInsuranceDataSharingPolicies
- TravelInsuranceDataSharingCustomerBasic
- TravelInsuranceDataSharingCustomerDetail
- TravelInsuranceDataSharingCustomerPaymentDetails
- TravelInsuranceDataSharingProduct
- TravelInsuranceDataSharingTransactions
- TravelInsuranceQuote
AEConsentPurpose:
type: string
enum:
- InsurancePolicyAggregation
- PersonalFinanceManager
- CreditAssessment
- MotorInsuranceQuote
- EnterpriseFinancialManagement
- Other
description: Reason for consenting to insurance policy access
AEConsentStatusCode:
type: string
enum:
- Authorized
- AwaitingAuthorization
- Rejected
- Revoked
- Expired
- Suspended
AECreateEmploymentInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateEmploymentInsuranceRequestProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateEmploymentInsuranceQuote1Signed:
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/AECreateEmploymentInsuranceQuote1'
additionalProperties: false
AECreateEmploymentInsuranceQuoteResponse1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: >-
#/components/schemas/AECreateEmploymentInsuranceQuoteResponseProperties
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateEmploymentInsuranceQuoteResponse1Signed:
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/AEReadEmploymentInsurancePolicy1'
additionalProperties: false
AECreateEmploymentInsuranceQuoteResponseProperties:
type: object
required:
- QuoteId
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
additionalProperties: false
AECreateEmploymentInsuranceRequestProperties:
type: object
required:
- QuoteReference
- Customer
- Product
- Transactions
properties:
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
Customer:
$ref: '#/components/schemas/AEEmploymentInsuranceQuoteCustomerData'
Product:
$ref: '#/components/schemas/AEEmploymentInsuranceQuoteProductData'
Transactions:
$ref: '#/components/schemas/AEEmploymentInsuranceQuoteTransactionData'
additionalProperties: false
AECreateHealthInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateHealthInsuranceRequestProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateHealthInsuranceQuote1Signed:
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/AECreateHealthInsuranceQuote1'
additionalProperties: false
AECreateHealthInsuranceQuoteResponse1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateHealthInsuranceQuoteResponseProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateHealthInsuranceQuoteResponse1Signed:
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/AEReadHealthInsurancePolicy1'
additionalProperties: false
AECreateHealthInsuranceQuoteResponseProperties:
type: object
required:
- QuoteId
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
additionalProperties: false
AECreateHealthInsuranceRequestProperties:
type: object
required:
- QuoteReference
- Customer
- Product
- Transactions
- Other
properties:
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
Customer:
$ref: '#/components/schemas/AEHealthInsuranceQuotePropertiesCustomerData'
Product:
$ref: '#/components/schemas/AEHealthInsuranceQuotePropertiesProductData'
Transactions:
$ref: '#/components/schemas/AEHealthInsuranceQuotePropertiesTransactionData'
Other:
$ref: '#/components/schemas/AEHealthInsuranceQuoteOtherData'
MedicalHistory:
allOf:
- $ref: '#/components/schemas/AEHealthInsuranceQuoteMedicalHistory'
description: >-
Medical history not included in shared data from LFI and collected
by TPP under the
terms of the TPP license
additionalProperties: false
AECreateHomeInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateHomeInsuranceRequestProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateHomeInsuranceQuote1Signed:
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/AECreateHomeInsuranceQuote1'
additionalProperties: false
AECreateHomeInsuranceQuoteResponse1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateHomeInsuranceQuoteResponseProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateHomeInsuranceQuoteResponse1Signed:
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/AEReadHomeInsurancePolicy1'
additionalProperties: false
AECreateHomeInsuranceQuoteResponseProperties:
type: object
required:
- QuoteId
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
additionalProperties: false
AECreateHomeInsuranceRequestProperties:
type: object
required:
- QuoteReference
- Customer
- Product
- Transactions
- Other
properties:
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
Customer:
$ref: '#/components/schemas/AEHomeInsuranceQuoteCustomerData'
Product:
$ref: '#/components/schemas/AEHomeInsuranceQuoteProductData'
Transactions:
$ref: '#/components/schemas/AEHomeInsuranceQuoteTransactionData'
Other:
$ref: '#/components/schemas/AEHomeInsuranceQuoteOtherData'
additionalProperties: false
AECreateLifeInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateLifeInsuranceRequestProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateLifeInsuranceQuote1Signed:
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/AECreateLifeInsuranceQuote1'
additionalProperties: false
AECreateLifeInsuranceQuoteResponse1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateLifeInsuranceQuoteResponseProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateLifeInsuranceQuoteResponse1Signed:
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/AEReadLifeInsurancePolicy1'
additionalProperties: false
AECreateLifeInsuranceQuoteResponseProperties:
type: object
required:
- QuoteId
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
additionalProperties: false
AECreateLifeInsuranceRequestProperties:
type: object
required:
- QuoteReference
- Customer
- Product
- Transactions
- Other
properties:
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
Customer:
$ref: '#/components/schemas/AELifeInsuranceQuoteCustomerData'
Product:
$ref: '#/components/schemas/AELifeInsuranceQuoteProductData'
Transactions:
$ref: '#/components/schemas/AELifeInsuranceQuoteTransactionData'
Other:
$ref: '#/components/schemas/AELifeInsuranceQuoteOtherData'
additionalProperties: false
AECreateMotorInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEMotorInsuranceQuoteProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateMotorInsuranceQuote1Signed:
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/AECreateMotorInsuranceQuote1'
additionalProperties: false
AECreateMotorInsuranceQuoteResponse1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateMotorInsuranceQuoteResponseProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateMotorInsuranceQuoteResponse1Signed:
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/AEReadMotorInsurancePolicy1'
additionalProperties: false
AECreateMotorInsuranceQuoteResponseProperties:
type: object
required:
- QuoteId
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
additionalProperties: false
AECreateRentersInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateRentersInsuranceRequestProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateRentersInsuranceQuote1Signed:
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/AECreateRentersInsuranceQuote1'
additionalProperties: false
AECreateRentersInsuranceQuoteResponse1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateRentersInsuranceQuoteResponseProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateRentersInsuranceQuoteResponse1Signed:
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/AEReadRentersInsurancePolicy1'
additionalProperties: false
AECreateRentersInsuranceQuoteResponseProperties:
type: object
required:
- QuoteId
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
additionalProperties: false
AECreateRentersInsuranceRequestProperties:
type: object
required:
- QuoteReference
- Customer
- Product
- Transactions
- Other
properties:
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
Customer:
$ref: '#/components/schemas/AERentersInsuranceQuoteCustomerData'
Product:
$ref: '#/components/schemas/AERentersInsuranceQuoteProductData'
Transactions:
$ref: '#/components/schemas/AERentersInsuranceQuoteTransactionData'
Other:
$ref: '#/components/schemas/AERentersInsuranceQuoteOtherData'
additionalProperties: false
AECreateTravelInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateTravelInsuranceRequestProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateTravelInsuranceQuote1Signed:
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/AECreateTravelInsuranceQuote1'
additionalProperties: false
AECreateTravelInsuranceQuoteResponse1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AECreateTravelInsuranceQuoteResponseProperties'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AECreateTravelInsuranceQuoteResponse1Signed:
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/AEReadTravelInsurancePolicy1'
additionalProperties: false
AECreateTravelInsuranceQuoteResponseProperties:
type: object
required:
- QuoteId
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
additionalProperties: false
AECreateTravelInsuranceRequestProperties:
type: object
required:
- QuoteReference
- Customer
- Product
- Transactions
- Other
properties:
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
Customer:
$ref: '#/components/schemas/AETravelInsuranceQuoteCustomerData'
Product:
$ref: '#/components/schemas/AETravelInsuranceQuoteProductData'
Transactions:
$ref: '#/components/schemas/AETravelInsuranceQuoteTransactionData'
Other:
$ref: '#/components/schemas/AETravelInsuranceQuoteOtherData'
additionalProperties: false
AECustomerPrimaryLanguage:
type: string
enum:
- English
- Arabic
- Other
description: Primary language spoken by the insurance policy customer
AEEmploymentInsuranceClaims:
type: object
required:
- NumberOfClaimsLast12Months
- NumberOfApprovedClaimsLast12Months
- TotalValueOfClaimsLast12Months
- TotalValueOfApprovedClaimsLast12Months
- NumberOfClaimsLast36Months
- NumberOfApprovedClaimsLast36Months
- TotalValueOfClaimsLast36Months
- TotalValueOfApprovedClaimsLast36Months
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
- Claim2Date
- Claim2DescriptionIeServicesClaimed
- Claim2Status
- Claim2Amount
- DeductibleAmount2
- Claim3Date
- Claim3DescriptionIeServicesClaimed
- Claim3Status
- Claim3Amount
- DeductibleAmount3
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
NumberOfClaimsLast36Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
Claim2Date:
type: string
description: dd/mm/yyyy
Claim2DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim2Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim2Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount2:
type: string
description: Only numeric answers allowed (in AED)
Claim3Date:
type: string
description: dd/mm/yyyy
Claim3DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim3Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim3Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount3:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEEmploymentInsuranceCustomerData:
type: object
required:
- CustomerId
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
LegalCriminalRecord:
allOf:
- $ref: '#/components/schemas/AEEmploymentInsuranceLegalCriminalRecord'
description: Legal and criminal record for the customer
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
additionalProperties: false
AEEmploymentInsuranceLegalCriminalRecord:
type: object
required:
- CriminalConviction
- RecordsOfSanctionsImposed
- RecordsOfArrests
- RecordsOfCourtAppearancesAndOutcomes
properties:
CriminalConviction:
type: boolean
description: Indicates whether the proposer has been a criminal conviction
RecordsOfSanctionsImposed:
type: string
minLength: 1
maxLength: 5000
description: Record of sanction as a string or an attachment, base64-encoded
RecordsOfArrests:
type: string
minLength: 1
maxLength: 5000
description: Record of arrests as a string or an attachment, base64-encoded
RecordsOfCourtAppearancesAndOutcomes:
type: string
minLength: 1
maxLength: 5000
description: >-
Record of court appears as a string or an attachment,
base64-encoded
additionalProperties: false
AEEmploymentInsurancePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- AdditionalCoverageOptions
- PolicyLimits
- PolicyExclusions
- PolicyRenewalDate1
- PolicyRenewalDate2
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Building Insurance, Contents
Insurance, Both)
AdditionalCoverageOptions:
type: string
description: >-
Select from drop-down list (e.g., Accidental Damage, Personal
Belongings Outside Home, Alternative Accomodation)
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AEEmploymentInsurancePolicyProperties1:
type: object
required:
- InsurancePolicyId
properties:
InsurancePolicyId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given insurance policy
Customer:
$ref: '#/components/schemas/AEEmploymentInsuranceCustomerData'
Product:
$ref: '#/components/schemas/AEEmploymentInsuranceProductData'
Transactions:
$ref: '#/components/schemas/AEEmploymentInsuranceTransactionData'
additionalProperties: false
AEEmploymentInsurancePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEEmploymentInsuranceProductData:
type: object
properties:
Policy:
$ref: '#/components/schemas/AEEmploymentInsurancePolicy'
additionalProperties: false
AEEmploymentInsuranceQuote:
type: object
required:
- QuoteId
- QuoteReference
- status
- Customer
- Product
- Transactions
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
status:
$ref: '#/components/schemas/AEInsuranceQuoteStatusCodes'
Customer:
$ref: '#/components/schemas/AEEmploymentInsuranceQuoteCustomerData'
Product:
$ref: '#/components/schemas/AEEmploymentInsuranceQuoteProductData'
Transactions:
$ref: '#/components/schemas/AEEmploymentInsuranceQuoteTransactionData'
additionalProperties: false
AEEmploymentInsuranceQuoteBackgroundInformation:
type: object
required:
- Gender
- DateOfBirth
- Nationality
- Salutation
- CountryOfBirth
- CityOfBirth
properties:
Gender:
type: string
description: Male/Female
DateOfBirth:
type: string
description: dd/mm/yyyy
Nationality:
type: string
description: Select from list
Salutation:
type: string
description: Mr./ Ms./ Mrs./ Dr./ Other
CountryOfBirth:
type: string
description: Select from list
CityOfBirth:
type: string
description: Select from list generated based on previous selection
additionalProperties: false
AEEmploymentInsuranceQuoteClaims:
type: object
required:
- NumberOfClaimsLast12Months
- NumberOfApprovedClaimsLast12Months
- TotalValueOfClaimsLast12Months
- TotalValueOfApprovedClaimsLast12Months
- NumberOfClaimsLast36Months
- NumberOfApprovedClaimsLast36Months
- TotalValueOfClaimsLast36Months
- TotalValueOfApprovedClaimsLast36Months
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
- Claim2Date
- Claim2DescriptionIeServicesClaimed
- Claim2Status
- Claim2Amount
- DeductibleAmount2
- Claim3Date
- Claim3DescriptionIeServicesClaimed
- Claim3Status
- Claim3Amount
- DeductibleAmount3
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
NumberOfClaimsLast36Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
Claim2Date:
type: string
description: dd/mm/yyyy
Claim2DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim2Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim2Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount2:
type: string
description: Only numeric answers allowed (in AED)
Claim3Date:
type: string
description: dd/mm/yyyy
Claim3DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim3Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim3Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount3:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEEmploymentInsuranceQuoteCustomerData:
type: object
required:
- FullName
- PrimaryLanguage
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddressProperties'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
Communication:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: >-
#/components/schemas/AEEmploymentInsuranceQuoteBackgroundInformation
description: Customer background information
LegalCriminalRecord:
allOf:
- $ref: '#/components/schemas/AEEmploymentInsuranceLegalCriminalRecord'
description: Legal and criminal record for the customer
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
additionalProperties: false
AEEmploymentInsuranceQuotePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- AdditionalCoverageOptions
- PolicyLimits
- PolicyExclusions
- PolicyRenewalDate1
- PolicyRenewalDate2
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Building Insurance, Contents
Insurance, Both)
AdditionalCoverageOptions:
type: string
description: >-
Select from drop-down list (e.g., Accidental Damage, Personal
Belongings Outside Home, Alternative Accomodation)
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AEEmploymentInsuranceQuotePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEEmploymentInsuranceQuoteProductData:
type: object
properties:
Policy:
$ref: '#/components/schemas/AEEmploymentInsuranceQuotePolicy'
additionalProperties: false
AEEmploymentInsuranceQuoteTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AEEmploymentInsuranceQuotePremium'
Claims:
$ref: '#/components/schemas/AEEmploymentInsuranceQuoteClaims'
additionalProperties: false
AEEmploymentInsuranceTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AEEmploymentInsurancePremium'
Claims:
$ref: '#/components/schemas/AEEmploymentInsuranceClaims'
additionalProperties: false
AEError:
type: object
required:
- Code
- Message
properties:
Code:
allOf:
- $ref: '#/components/schemas/AEErrorCode'
description: Low level textual error code, e.g., UAEOF.Field.Missing
Message:
type: string
minLength: 1
maxLength: 500
description: >-
A description of the error that occurred. e.g., 'A mandatory field
isn't supplied' or 'RequestedExecutionDateTime must be in future'
UAEOF doesn't standardise this field
Path:
type: string
minLength: 1
maxLength: 500
description: >-
Recommended but optional reference to the JSON Path of the field
with error, e.g., Data.Initiation.InstructedAmount.Currency
Url:
type: string
description: >-
URL to help remediate the problem, or provide more information, or
to API Reference, or help etc
description: Error
additionalProperties: false
AEErrorCode:
type: string
enum:
- AccessToken.Unauthorized
- AccessToken.InvalidScope
- Consent.Revoked
- Consent.TransientAccountAccessFailure
- Consent.AccountTemporarilyBlocked
- Consent.PermanentAccountAccessFailure
- Consent.Invalid
- JWS.InvalidSignature
- JWS.Malformed
- JWS.InvalidClaim
- JWS.InvalidHeader
- GenericRecoverableError
- GenericError
- JWE.DecryptionError
- JWE.InvalidHeader
- Event.UnexpectedEvent
- Body.InvalidFormat
- Resource.InvalidResourceId
- Resource.InvalidFormat
- Consent.BusinessRuleViolation
AEErrorResponse:
type: object
required:
- Errors
properties:
Errors:
type: array
items:
$ref: '#/components/schemas/AEError'
minItems: 1
description: >-
An array of detail error codes, and messages, and URLs to documentation
to help remediation.
additionalProperties: false
AEHealthInsuranceBeneficiaries:
type: object
required:
- PolicyBeneficiariesNames
- PolicyBeneficiariesRelationshipToTheHolder
- PolicyBeneficiariesPhoneNumbers
- PolicyBeneficiariesEmailAddresses
properties:
PolicyBeneficiariesNames:
type: string
description: Free-form
PolicyBeneficiariesRelationshipToTheHolder:
type: string
description: Spouse/ Child/ Parent/ Sibling/ Friend/ Other
PolicyBeneficiariesPhoneNumbers:
type: string
description: Area code selection option and 9-10 additional digits permissible
PolicyBeneficiariesEmailAddresses:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
additionalProperties: false
AEHealthInsuranceBenefitPayouts:
type: object
required:
- BenefitPayoutDate1
- BenefitPayoutAmount1
- BenefitPayoutDate2
- BenefitPayoutAmount2
properties:
BenefitPayoutDate1:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEHealthInsuranceClaims:
type: object
required:
- NumberOfClaimsLast12Months
- NumberOfApprovedClaimsLast12Months
- TotalValueOfClaimsLast12Months
- TotalValueOfApprovedClaimsLast12Months
- NumberOfClaimsLast36Months
- NumberOfApprovedClaimsLast36Months
- TotalValueOfClaimsLast36Months
- TotalValueOfApprovedClaimsLast36Months
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
- Claim2Date
- Claim2DescriptionIeServicesClaimed
- Claim2Status
- Claim2Amount
- DeductibleAmount2
- Claim3Date
- Claim3DescriptionIeServicesClaimed
- Claim3Status
- Claim3Amount
- DeductibleAmount3
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
NumberOfClaimsLast36Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
Claim2Date:
type: string
description: dd/mm/yyyy
Claim2DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim2Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim2Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount2:
type: string
description: Only numeric answers allowed (in AED)
Claim3Date:
type: string
description: dd/mm/yyyy
Claim3DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim3Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim3Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount3:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEHealthInsuranceCustomerData:
type: object
required:
- CustomerId
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
ResidentialAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer residential address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
GeneralMedicalInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceGeneralMedicalInformation'
description: General medical information for the customer
MedicalHistory:
allOf:
- $ref: '#/components/schemas/AEInsuranceMedicalHistory'
description: Detailed medical information for the customer
additionalProperties: false
AEHealthInsuranceDependentsCoveredUnderPolicyIfAny:
type: object
required:
- Dependent1Name
- Dependent1Relationship
- Dependent1Gender
- Dependent1DateOfBirth
- Dependent1MaritalStatus
- Dependent1EducationBackground
- Dependent1Nationality
- Dependent1Salutation
- Dependent1CountryOfBirth
- Dependent1ProfessionIfApplicable
- Dependent1ProfessionDescriptionIfApplicable
- Dependent1EmployerNameIfApplicable
- Dependent1EmployerAddressIfApplicable
- Dependent1EmploymentTypeIfApplicable
- Dependent1EmploymentLocationIfApplicable
- Dependent1NatureOfBusinessIfApplicable
- Dependent1DesignationIfApplicable
- Dependent1SourceOfIncomeIfApplicable
- Dependent1IncomeCurrencyIfApplicable
- Dependent1MonthlyIncomeIfApplicable
- Dependent1AnnualIncomeIfApplicable
- Dependent1EmploymentStartDateIfApplicable
- Dependent1EidNumber
- Dependent1EidExpiryDate
- Dependent1PassportNumber
- Dependent1PassportIssueCountry
- Dependent1PassportIssueDate
- Dependent1PassportExpiryDate
- Dependent1VisaNumber
- Dependent1VisaIssueCountry
- Dependent1VisaIssueDate
- Dependent1VisaExpiryDate
- Dependent1Height
- Dependent1Weight
- Dependent1PrimaryCarePhysicianName
- Dependent1PrimaryCarePhysicianAddress
- Dependent1PrimaryCarePhysicianPhoneNumber
- Dependent1PrimaryCarePhysicianEmailAddress
- Dependent1BloodExamResults
- Dependent1UrinalysisResults
- Dependent1BloodPressureReadings
- Dependent1RecordOfDentalVisitsAndIssues
- Dependent1VisionExamResults
- Dependent1PreexistingMedicalConditions
- Dependent1DiagnosesWithChronicIllnesses
- Dependent1MajorSurgeries
- Dependent1MedicationsTaken
- Dependent1MedicalDevicesUsed
- Dependent1RecordOfHospitilizations
- Dependent1RecordOfTreatmentForMentalHealthIssues
- Dependent1Allergies
- Dependent1GeneticHereditaryConditions
- Dependent1DiagnosesOfInfectiousDiaseses
- Dependent1DiagnosesOfReproductiveDiaseses
- Dependent1RecordOfDiagnosticTestsWithAbnormalResults
- Dependent1ImmunizationVaccinationRecords
- Dependent1TobaccoConsumptionHabits
- Dependent1AlcoholConsumptionHabits
- Dependent1EngagementInRegularPhysicalExercise
- Dependent1SpecificDietsFollowedDietaryRestrictions
- Dependent1HistoryOfChronicIllnessInTheFamily
- Dependent2Name
properties:
Dependent1Name:
type: string
description: Free-form
Dependent1Relationship:
type: string
description: Spouse/ Child/ Parent/ Sibling/ Friend/ Other
Dependent1Gender:
type: string
description: Male/Female
Dependent1DateOfBirth:
type: string
description: dd/mm/yyyy
Dependent1MaritalStatus:
type: string
description: Married/Single
Dependent1EducationBackground:
type: string
description: High School/ Bachelor's/ Masters/ PhD/ Other
Dependent1Nationality:
type: string
description: Select from list
Dependent1Salutation:
type: string
description: Mr./ Ms./ Mrs./ Dr./ Other
Dependent1CountryOfBirth:
type: string
description: Select from list generated based on previous selection
Dependent1ProfessionIfApplicable:
type: string
description: Free-form
Dependent1ProfessionDescriptionIfApplicable:
type: string
description: Free-form
Dependent1EmployerNameIfApplicable:
type: string
description: Free-form (or company name in case of self-employment)
Dependent1EmployerAddressIfApplicable:
type: string
description: Free-form (or company name in case of self-employment)
Dependent1EmploymentTypeIfApplicable:
type: string
description: >-
Select from list of options (e.g., Employed, Self-Employed, Retired,
Unemployed)
Dependent1EmploymentLocationIfApplicable:
type: string
description: Free-form
Dependent1NatureOfBusinessIfApplicable:
type: string
description: Select from list of categories (e.g., Law, Finance, Medicine)
Dependent1DesignationIfApplicable:
type: string
description: Free-form
Dependent1SourceOfIncomeIfApplicable:
type: string
description: Free-form (e.g. salary / dividends from ownership)
Dependent1IncomeCurrencyIfApplicable:
type: string
description: Select from a list of options (e.g., AED, USD, SAR)
Dependent1MonthlyIncomeIfApplicable:
type: string
description: Only numeric answers allowed
Dependent1AnnualIncomeIfApplicable:
type: string
description: Only numeric answers allowed
Dependent1EmploymentStartDateIfApplicable:
type: string
description: dd/mm/yyyy
Dependent1EidNumber:
type: string
description: Only 15 digits permissible
Dependent1EidExpiryDate:
type: string
description: dd/mm/yyyy
Dependent1PassportNumber:
type: string
description: Select from list
Dependent1PassportIssueCountry:
type: string
description: Only numeric answers allowed
Dependent1PassportIssueDate:
type: string
description: dd/mm/yyyy
Dependent1PassportExpiryDate:
type: string
description: dd/mm/yyyy
Dependent1VisaNumber:
type: string
description: Only numeric answers allowed
Dependent1VisaIssueCountry:
type: string
description: Select from list
Dependent1VisaIssueDate:
type: string
description: dd/mm/yyyy
Dependent1VisaExpiryDate:
type: string
description: dd/mm/yyyy
Dependent1Height:
type: string
description: Only numeric answers allowed (in m)
Dependent1Weight:
type: string
description: Only numeric answers allowed (in kg)
Dependent1PrimaryCarePhysicianName:
type: string
description: Free-form
Dependent1PrimaryCarePhysicianAddress:
type: string
description: Spouse/ Child/ Parent/ Sibling/ Friend/ Other
Dependent1PrimaryCarePhysicianPhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
Dependent1PrimaryCarePhysicianEmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
Dependent1BloodExamResults:
type: string
description: Date of exam, free-form insertion of results
Dependent1UrinalysisResults:
type: string
description: Date of exam, free-form insertion of results
Dependent1BloodPressureReadings:
type: string
description: Record of systolic number over diastolic number readings
Dependent1RecordOfDentalVisitsAndIssues:
type: string
description: >-
Date of visit and list of issues selected from drop-down (e.g.,
cavities, wisdom tooth pain)
Dependent1VisionExamResults:
type: string
description: >-
Date of visit, +/- vision reading in each eye, and list of issues
from drop-down
Dependent1PreexistingMedicalConditions:
type: string
description: List of conditions from drop-down (e.g., diabetes, asthma)
Dependent1DiagnosesWithChronicIllnesses:
type: string
description: >-
List of illnesses from drop-down (e.g., heart disease, stroke, lung
cancer)
Dependent1MajorSurgeries:
type: string
description: Free-form
Dependent1MedicationsTaken:
type: string
description: Free-form
Dependent1MedicalDevicesUsed:
type: string
description: Free-form
Dependent1RecordOfHospitilizations:
type: string
description: Date of visit, reason for visit, diagnosis
Dependent1RecordOfTreatmentForMentalHealthIssues:
type: string
description: Date of treatment, diagnosis
Dependent1Allergies:
type: string
description: Free-form
Dependent1GeneticHereditaryConditions:
type: string
description: >-
List of conditions from drop-down (e.g., down syndrome, sickle cell
anemia)
Dependent1DiagnosesOfInfectiousDiaseses:
type: string
description: List of diseases from drop-down (e.g., HIV, AIDS, Hepatitis)
Dependent1DiagnosesOfReproductiveDiaseses:
type: string
description: List of diseases from drop-down (e.g., infertility, gonorrhea)
Dependent1RecordOfDiagnosticTestsWithAbnormalResults:
type: string
description: >-
Date of test, type of test from drop-down (e.g., colonscopy),
description of results
Dependent1ImmunizationVaccinationRecords:
type: string
description: >-
Multiple selections from drop-down list (e.g., chickenpox,
influenza, Hepatitis A)
Dependent1TobaccoConsumptionHabits:
type: string
description: >-
No tobacco/ Occasional tobacco / Monthly user / Weekly user / Daily
user
Dependent1AlcoholConsumptionHabits:
type: string
description: >-
No alcohol/ Occasional alcohol / Monthly user / Weekly user / Daily
user
Dependent1EngagementInRegularPhysicalExercise:
type: string
description: None / Monthly / Weekly / Daily
Dependent1SpecificDietsFollowedDietaryRestrictions:
type: string
description: Free-form
Dependent1HistoryOfChronicIllnessInTheFamily:
type: string
description: >-
List of illnesses from drop-down (e.g., heart disease, stroke, lung
cancer)
Dependent2Name:
type: string
description: Free-form
additionalProperties: false
AEHealthInsuranceIfItsRenewal:
type: object
required:
- ForDubaiPoliciesSalaryBand
- MajorSurgeries
- Identification
properties:
ForDubaiPoliciesSalaryBand:
type: string
description: Placeholder
MajorSurgeries:
type: string
description: Major Surgeries
Identification:
type: string
description: Placeholder
additionalProperties: false
AEHealthInsuranceOtherAdditionalInformation:
type: object
required:
- SalaryForEmployeeSponsor
- PregnancyDeclarations
properties:
SalaryForEmployeeSponsor:
type: string
description: Placeholder
PregnancyDeclarations:
type: string
description: Placeholder
additionalProperties: false
AEHealthInsuranceOtherData:
type: object
properties:
DependentsCoveredUnderPolicyIfAny:
$ref: >-
#/components/schemas/AEHealthInsuranceDependentsCoveredUnderPolicyIfAny
IfItsRenewal:
$ref: '#/components/schemas/AEHealthInsuranceIfItsRenewal'
OtherAdditionalInformation:
$ref: '#/components/schemas/AEHealthInsuranceOtherAdditionalInformation'
SponsorDetails:
$ref: '#/components/schemas/AEHealthInsuranceSponsorDetails'
additionalProperties: false
AEHealthInsurancePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- PolicyLimits
- PolicyExclusions
- CoverageAmount
- CoverageStartDate
- CoverageEndDate
- PolicyRenewalDate1
- PolicyRenewalDate2
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
CoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AEHealthInsurancePolicyProperties1:
type: object
required:
- InsurancePolicyId
properties:
InsurancePolicyId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given insurance policy
Customer:
$ref: '#/components/schemas/AEHealthInsuranceCustomerData'
Product:
$ref: '#/components/schemas/AEHealthInsuranceProductData'
Transactions:
$ref: '#/components/schemas/AEHealthInsuranceTransactionData'
Other:
$ref: '#/components/schemas/AEHealthInsuranceOtherData'
additionalProperties: false
AEHealthInsurancePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEHealthInsurancePreviousPolicies:
type: object
required:
- PreviousInsuranceCompany1
- PreviousPolicyId1
- PurchaseDate
- RenewalDate1
- RenewalDate2
- PremiumAmount
- DeductibleAmountIfAny
- CoverageType
- AdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- AdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- TerminationDate
- ReasonForCancellation
- RefundAmountIfAny
- SurrenderDateIfApplicable
- SurrenderAmountIfApplicable
- ReasonForSurrender
- CashValueOfPolicyPaidToPolicyholder
- PreviousInsuranceCompany2
- RenewalDate1_0
- PremiumAmount_0
- DeductibleAmountIfAny_0
- CoverageType_0
- TerminationDate_0
- ReasonForCancellation_0
- RefundAmountIfAny_0
properties:
PreviousInsuranceCompany1:
type: string
description: Free-form
PreviousPolicyId1:
type: string
description: Depends on insurance company
PurchaseDate:
type: string
description: dd/mm/yyyy
RenewalDate1:
type: string
description: dd/mm/yyyy
RenewalDate2:
type: string
description: dd/mm/yyyy
PremiumAmount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
AdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
AdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
TerminationDate:
type: string
description: dd/mm/yyyy
ReasonForCancellation:
type: string
description: Free-form
RefundAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
SurrenderDateIfApplicable:
type: string
description: dd/mm/yyyy
SurrenderAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
ReasonForSurrender:
type: string
description: Free-form
CashValueOfPolicyPaidToPolicyholder:
type: string
description: Only numeric answers allowed (in AED)
PreviousInsuranceCompany2:
type: string
description: Free-form
RenewalDate1_0:
type: string
description: dd/mm/yyyy
PremiumAmount_0:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny_0:
type: string
description: Only numeric answers allowed (in AED)
CoverageType_0:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
TerminationDate_0:
type: string
description: dd/mm/yyyy
ReasonForCancellation_0:
type: string
description: Free-form
RefundAmountIfAny_0:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEHealthInsuranceProductData:
type: object
properties:
Policy:
$ref: '#/components/schemas/AEHealthInsurancePolicy'
Beneficiaries:
$ref: '#/components/schemas/AEHealthInsuranceBeneficiaries'
additionalProperties: false
AEHealthInsuranceQuote:
type: object
required:
- QuoteId
- QuoteReference
- status
- Customer
- Product
- Transactions
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
status:
$ref: '#/components/schemas/AEInsuranceQuoteStatusCodes'
Customer:
$ref: '#/components/schemas/AEHealthInsuranceQuotePropertiesCustomerData'
Product:
$ref: '#/components/schemas/AEHealthInsuranceQuotePropertiesProductData'
Transactions:
$ref: '#/components/schemas/AEHealthInsuranceQuotePropertiesTransactionData'
additionalProperties: false
AEHealthInsuranceQuoteBeneficiaries:
type: object
required:
- PolicyBeneficiariesNames
- PolicyBeneficiariesRelationshipToTheHolder
- PolicyBeneficiariesPhoneNumbers
- PolicyBeneficiariesEmailAddresses
properties:
PolicyBeneficiariesNames:
type: string
description: Free-form
PolicyBeneficiariesRelationshipToTheHolder:
type: string
description: Spouse/ Child/ Parent/ Sibling/ Friend/ Other
PolicyBeneficiariesPhoneNumbers:
type: string
description: Area code selection option and 9-10 additional digits permissible
PolicyBeneficiariesEmailAddresses:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
additionalProperties: false
AEHealthInsuranceQuoteClaims:
type: object
required:
- NumberOfClaimsLast12Months
- NumberOfApprovedClaimsLast12Months
- TotalValueOfClaimsLast12Months
- TotalValueOfApprovedClaimsLast12Months
- NumberOfClaimsLast36Months
- NumberOfApprovedClaimsLast36Months
- TotalValueOfClaimsLast36Months
- TotalValueOfApprovedClaimsLast36Months
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
- Claim2Date
- Claim2DescriptionIeServicesClaimed
- Claim2Status
- Claim2Amount
- DeductibleAmount2
- Claim3Date
- Claim3DescriptionIeServicesClaimed
- Claim3Status
- Claim3Amount
- DeductibleAmount3
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
NumberOfClaimsLast36Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
Claim2Date:
type: string
description: dd/mm/yyyy
Claim2DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim2Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim2Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount2:
type: string
description: Only numeric answers allowed (in AED)
Claim3Date:
type: string
description: dd/mm/yyyy
Claim3DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim3Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim3Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount3:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEHealthInsuranceQuoteDependentsCoveredUnderPolicyIfAny:
type: object
required:
- Dependent1Name
- Dependent1Relationship
- Dependent1Gender
- Dependent1DateOfBirth
- Dependent1MaritalStatus
- Dependent1EducationBackground
- Dependent1Nationality
- Dependent1Salutation
- Dependent1CountryOfBirth
- Dependent1ProfessionIfApplicable
- Dependent1ProfessionDescriptionIfApplicable
- Dependent1EmployerNameIfApplicable
- Dependent1EmployerAddressIfApplicable
- Dependent1EmploymentTypeIfApplicable
- Dependent1EmploymentLocationIfApplicable
- Dependent1NatureOfBusinessIfApplicable
- Dependent1DesignationIfApplicable
- Dependent1SourceOfIncomeIfApplicable
- Dependent1IncomeCurrencyIfApplicable
- Dependent1MonthlyIncomeIfApplicable
- Dependent1AnnualIncomeIfApplicable
- Dependent1EmploymentStartDateIfApplicable
- Dependent1EidNumber
- Dependent1EidExpiryDate
- Dependent1PassportNumber
- Dependent1PassportIssueCountry
- Dependent1PassportIssueDate
- Dependent1PassportExpiryDate
- Dependent1VisaNumber
- Dependent1VisaIssueCountry
- Dependent1VisaIssueDate
- Dependent1VisaExpiryDate
- Dependent1Height
- Dependent1Weight
- Dependent1PrimaryCarePhysicianName
- Dependent1PrimaryCarePhysicianAddress
- Dependent1PrimaryCarePhysicianPhoneNumber
- Dependent1PrimaryCarePhysicianEmailAddress
- Dependent1BloodExamResults
- Dependent1UrinalysisResults
- Dependent1BloodPressureReadings
- Dependent1RecordOfDentalVisitsAndIssues
- Dependent1VisionExamResults
- Dependent1PreexistingMedicalConditions
- Dependent1DiagnosesWithChronicIllnesses
- Dependent1MajorSurgeries
- Dependent1MedicationsTaken
- Dependent1MedicalDevicesUsed
- Dependent1RecordOfHospitilizations
- Dependent1RecordOfTreatmentForMentalHealthIssues
- Dependent1Allergies
- Dependent1GeneticHereditaryConditions
- Dependent1DiagnosesOfInfectiousDiaseses
- Dependent1DiagnosesOfReproductiveDiaseses
- Dependent1RecordOfDiagnosticTestsWithAbnormalResults
- Dependent1ImmunizationVaccinationRecords
- Dependent1TobaccoConsumptionHabits
- Dependent1AlcoholConsumptionHabits
- Dependent1EngagementInRegularPhysicalExercise
- Dependent1SpecificDietsFollowedDietaryRestrictions
- Dependent1HistoryOfChronicIllnessInTheFamily
- Dependent2Name
properties:
Dependent1Name:
type: string
description: Free-form
Dependent1Relationship:
type: string
description: Spouse/ Child/ Parent/ Sibling/ Friend/ Other
Dependent1Gender:
type: string
description: Male/Female
Dependent1DateOfBirth:
type: string
description: dd/mm/yyyy
Dependent1MaritalStatus:
type: string
description: Married/Single
Dependent1EducationBackground:
type: string
description: High School/ Bachelor's/ Masters/ PhD/ Other
Dependent1Nationality:
type: string
description: Select from list
Dependent1Salutation:
type: string
description: Mr./ Ms./ Mrs./ Dr./ Other
Dependent1CountryOfBirth:
type: string
description: Select from list generated based on previous selection
Dependent1ProfessionIfApplicable:
type: string
description: Free-form
Dependent1ProfessionDescriptionIfApplicable:
type: string
description: Free-form
Dependent1EmployerNameIfApplicable:
type: string
description: Free-form (or company name in case of self-employment)
Dependent1EmployerAddressIfApplicable:
type: string
description: Free-form (or company name in case of self-employment)
Dependent1EmploymentTypeIfApplicable:
type: string
description: >-
Select from list of options (e.g., Employed, Self-Employed, Retired,
Unemployed)
Dependent1EmploymentLocationIfApplicable:
type: string
description: Free-form
Dependent1NatureOfBusinessIfApplicable:
type: string
description: Select from list of categories (e.g., Law, Finance, Medicine)
Dependent1DesignationIfApplicable:
type: string
description: Free-form
Dependent1SourceOfIncomeIfApplicable:
type: string
description: Free-form (e.g. salary / dividends from ownership)
Dependent1IncomeCurrencyIfApplicable:
type: string
description: Select from a list of options (e.g., AED, USD, SAR)
Dependent1MonthlyIncomeIfApplicable:
type: string
description: Only numeric answers allowed
Dependent1AnnualIncomeIfApplicable:
type: string
description: Only numeric answers allowed
Dependent1EmploymentStartDateIfApplicable:
type: string
description: dd/mm/yyyy
Dependent1EidNumber:
type: string
description: Only 15 digits permissible
Dependent1EidExpiryDate:
type: string
description: dd/mm/yyyy
Dependent1PassportNumber:
type: string
description: Select from list
Dependent1PassportIssueCountry:
type: string
description: Only numeric answers allowed
Dependent1PassportIssueDate:
type: string
description: dd/mm/yyyy
Dependent1PassportExpiryDate:
type: string
description: dd/mm/yyyy
Dependent1VisaNumber:
type: string
description: Only numeric answers allowed
Dependent1VisaIssueCountry:
type: string
description: Select from list
Dependent1VisaIssueDate:
type: string
description: dd/mm/yyyy
Dependent1VisaExpiryDate:
type: string
description: dd/mm/yyyy
Dependent1Height:
type: string
description: Only numeric answers allowed (in m)
Dependent1Weight:
type: string
description: Only numeric answers allowed (in kg)
Dependent1PrimaryCarePhysicianName:
type: string
description: Free-form
Dependent1PrimaryCarePhysicianAddress:
type: string
description: Spouse/ Child/ Parent/ Sibling/ Friend/ Other
Dependent1PrimaryCarePhysicianPhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
Dependent1PrimaryCarePhysicianEmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
Dependent1BloodExamResults:
type: string
description: Date of exam, free-form insertion of results
Dependent1UrinalysisResults:
type: string
description: Date of exam, free-form insertion of results
Dependent1BloodPressureReadings:
type: string
description: Record of systolic number over diastolic number readings
Dependent1RecordOfDentalVisitsAndIssues:
type: string
description: >-
Date of visit and list of issues selected from drop-down (e.g.,
cavities, wisdom tooth pain)
Dependent1VisionExamResults:
type: string
description: >-
Date of visit, +/- vision reading in each eye, and list of issues
from drop-down
Dependent1PreexistingMedicalConditions:
type: string
description: List of conditions from drop-down (e.g., diabetes, asthma)
Dependent1DiagnosesWithChronicIllnesses:
type: string
description: >-
List of illnesses from drop-down (e.g., heart disease, stroke, lung
cancer)
Dependent1MajorSurgeries:
type: string
description: Free-form
Dependent1MedicationsTaken:
type: string
description: Free-form
Dependent1MedicalDevicesUsed:
type: string
description: Free-form
Dependent1RecordOfHospitilizations:
type: string
description: Date of visit, reason for visit, diagnosis
Dependent1RecordOfTreatmentForMentalHealthIssues:
type: string
description: Date of treatment, diagnosis
Dependent1Allergies:
type: string
description: Free-form
Dependent1GeneticHereditaryConditions:
type: string
description: >-
List of conditions from drop-down (e.g., down syndrome, sickle cell
anemia)
Dependent1DiagnosesOfInfectiousDiaseses:
type: string
description: List of diseases from drop-down (e.g., HIV, AIDS, Hepatitis)
Dependent1DiagnosesOfReproductiveDiaseses:
type: string
description: List of diseases from drop-down (e.g., infertility, gonorrhea)
Dependent1RecordOfDiagnosticTestsWithAbnormalResults:
type: string
description: >-
Date of test, type of test from drop-down (e.g., colonscopy),
description of results
Dependent1ImmunizationVaccinationRecords:
type: string
description: >-
Multiple selections from drop-down list (e.g., chickenpox,
influenza, Hepatitis A)
Dependent1TobaccoConsumptionHabits:
type: string
description: >-
No tobacco/ Occasional tobacco / Monthly user / Weekly user / Daily
user
Dependent1AlcoholConsumptionHabits:
type: string
description: >-
No alcohol/ Occasional alcohol / Monthly user / Weekly user / Daily
user
Dependent1EngagementInRegularPhysicalExercise:
type: string
description: None / Monthly / Weekly / Daily
Dependent1SpecificDietsFollowedDietaryRestrictions:
type: string
description: Free-form
Dependent1HistoryOfChronicIllnessInTheFamily:
type: string
description: >-
List of illnesses from drop-down (e.g., heart disease, stroke, lung
cancer)
Dependent2Name:
type: string
description: Free-form
additionalProperties: false
AEHealthInsuranceQuoteGeneralMedicalInformation:
type: object
required:
- Height
- Weight
- PrimaryCarePhysicianName
properties:
Height:
type: string
description: Only numeric answers allowed (in m)
Weight:
type: string
description: Only numeric answers allowed (in kg)
PrimaryCarePhysicianName:
type: string
description: Free-form
additionalProperties: false
AEHealthInsuranceQuoteMedicalHistory:
type: object
required:
- BloodExamResults
- UrinalysisResults
- BloodPressureReadings
- RecordOfDentalVisitsAndIssues
- VisionExamResults
- PreexistingMedicalConditions
- DiagnosesWithChronicIllnesses
- MajorSurgeries
- MedicationsTaken
- MedicalDevicesUsed
- RecordOfHospitilizations
- RecordOfTreatmentForMentalHealthIssues
- Allergies
- GeneticHereditaryConditions
- DiagnosesOfInfectiousDiaseses
- DiagnosesOfReproductiveDiseases
- RecordOfDiagnosticTestsWithAbnormalResults
- ImmunizationVaccinationRecord
- TobaccoConsumptionHabits
- AlcoholConsumptionHabits
- EngagementInRegularPhysicalExercise
- SpecificDietsFollowedDietaryRestrictions
- HistoryOfChronicIllnessInTheFamily
properties:
BloodExamResults:
type: string
description: Date of exam, free-form insertion of results
UrinalysisResults:
type: string
description: Date of exam, free-form insertion of results
BloodPressureReadings:
type: string
description: Record of systolic number over diastolic number readings
RecordOfDentalVisitsAndIssues:
type: string
description: >-
Date of visit and list of issues selected from drop-down (e.g.,
cavities, wisdom tooth pain)
VisionExamResults:
type: string
description: >-
Date of visit, +/- vision reading in each eye, and list of issues
from drop-down
PreexistingMedicalConditions:
type: string
description: List of conditions from drop-down (e.g., diabetes, asthma)
DiagnosesWithChronicIllnesses:
type: string
description: >-
List of illnesses from drop-down (e.g., heart disease, stroke, lung
cancer)
MajorSurgeries:
type: string
description: Free-form
MedicationsTaken:
type: string
description: Free-form
MedicalDevicesUsed:
type: string
description: Free-form
RecordOfHospitilizations:
type: string
description: Date of visit, reason for visit, diagnosis
RecordOfTreatmentForMentalHealthIssues:
type: string
description: Date of treatment, diagnosis
Allergies:
type: string
description: Free-form
GeneticHereditaryConditions:
type: string
description: >-
List of conditions from drop-down (e.g., down syndrome, sickle cell
anemia)
DiagnosesOfInfectiousDiaseses:
type: string
description: List of diseases from drop-down (e.g., HIV, AIDS, Hepatitis)
DiagnosesOfReproductiveDiseases:
type: string
description: List of diseases from drop-down (e.g., infertility, gonorrhea)
RecordOfDiagnosticTestsWithAbnormalResults:
type: string
description: >-
Date of test, type of test from drop-down (e.g., colonscopy),
description of results
ImmunizationVaccinationRecord:
type: string
description: >-
Multiple selections from drop-down list (e.g., chickenpox,
influenza, Hepatitis A)
TobaccoConsumptionHabits:
type: string
description: >-
No tobacco/ Occasional tobacco / Monthly user / Weekly user / Daily
user
AlcoholConsumptionHabits:
type: string
description: >-
No alcohol/ Occasional alcohol / Monthly user / Weekly user / Daily
user
EngagementInRegularPhysicalExercise:
type: string
description: None / Monthly / Weekly / Daily
SpecificDietsFollowedDietaryRestrictions:
type: string
description: Free-form
HistoryOfChronicIllnessInTheFamily:
type: string
description: >-
List of illnesses from drop-down (e.g., heart disease, stroke, lung
cancer)
additionalProperties: false
AEHealthInsuranceQuoteOtherData:
type: object
properties:
DependentsCoveredUnderPolicyIfAny:
$ref: >-
#/components/schemas/AEHealthInsuranceQuoteDependentsCoveredUnderPolicyIfAny
additionalProperties: false
AEHealthInsuranceQuotePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- PolicyLimits
- PolicyExclusions
- CoverageAmount
- CoverageStartDate
- CoverageEndDate
- PolicyRenewalDate1
- PolicyRenewalDate2
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
CoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AEHealthInsuranceQuotePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
additionalProperties: false
AEHealthInsuranceQuotePreviousPolicies:
type: object
required:
- PreviousInsuranceCompany1
- PreviousPolicyId1
- PurchaseDate
- RenewalDate1
- RenewalDate2
- PremiumAmount
- DeductibleAmountIfAny
- CoverageType
- AdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- AdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- ReasonForCancellation
- RefundAmountIfAny
- SurrenderAmountIfApplicable
- ReasonForSurrender
- CashValueOfPolicyPaidToPolicyholder
- PreviousInsuranceCompany2
- RenewalDate1_0
- PremiumAmount_0
- DeductibleAmountIfAny_0
- CoverageType_0
properties:
PreviousInsuranceCompany1:
type: string
description: Free-form
PreviousPolicyId1:
type: string
description: Depends on insurance company
PurchaseDate:
type: string
description: dd/mm/yyyy
RenewalDate1:
type: string
description: dd/mm/yyyy
RenewalDate2:
type: string
description: dd/mm/yyyy
PremiumAmount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
AdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
AdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
ReasonForCancellation:
type: string
description: Free-form
RefundAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
SurrenderAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
ReasonForSurrender:
type: string
description: Free-form
CashValueOfPolicyPaidToPolicyholder:
type: string
description: Only numeric answers allowed (in AED)
PreviousInsuranceCompany2:
type: string
description: Free-form
RenewalDate1_0:
type: string
description: dd/mm/yyyy
PremiumAmount_0:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny_0:
type: string
description: Only numeric answers allowed (in AED)
CoverageType_0:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
additionalProperties: false
AEHealthInsuranceQuotePropertiesCustomerData:
type: object
required:
- CustomerId
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
ResidentialAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer residential address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
GeneralMedicalInformation:
allOf:
- $ref: >-
#/components/schemas/AEHealthInsuranceQuoteGeneralMedicalInformation
description: General medical information for the customer
additionalProperties: false
AEHealthInsuranceQuotePropertiesProductData:
type: object
properties:
Policy:
$ref: '#/components/schemas/AEHealthInsuranceQuotePolicy'
Beneficiaries:
$ref: '#/components/schemas/AEHealthInsuranceQuoteBeneficiaries'
additionalProperties: false
AEHealthInsuranceQuotePropertiesTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AEHealthInsuranceQuotePremium'
Claims:
$ref: '#/components/schemas/AEHealthInsuranceQuoteClaims'
PreviousPolicies:
$ref: '#/components/schemas/AEHealthInsuranceQuotePreviousPolicies'
additionalProperties: false
AEHealthInsuranceSponsorDetails:
type: object
required:
- VisaTypeinvestoremployeeselfSponsoredDependents
properties:
VisaTypeinvestoremployeeselfSponsoredDependents:
type: string
description: Placeholder
additionalProperties: false
AEHealthInsuranceTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AEHealthInsurancePremium'
BenefitPayouts:
$ref: '#/components/schemas/AEHealthInsuranceBenefitPayouts'
Claims:
$ref: '#/components/schemas/AEHealthInsuranceClaims'
PreviousPolicies:
$ref: '#/components/schemas/AEHealthInsurancePreviousPolicies'
additionalProperties: false
AEHomeInsuranceClaims:
type: object
required:
- NumberOfClaimsLast12Months
- NumberOfApprovedClaimsLast12Months
- TotalValueOfClaimsLast12Months
- TotalValueOfApprovedClaimsLast12Months
- NumberOfClaimsLast36Months
- NumberOfApprovedClaimsLast36Months
- TotalValueOfClaimsLast36Months
- TotalValueOfApprovedClaimsLast36Months
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
- Claim2Date
- Claim2DescriptionIeServicesClaimed
- Claim2Status
- Claim2Amount
- DeductibleAmount2
- Claim3Date
- Claim3DescriptionIeServicesClaimed
- Claim3Status
- Claim3Amount
- DeductibleAmount3
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
NumberOfClaimsLast36Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
Claim2Date:
type: string
description: dd/mm/yyyy
Claim2DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim2Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim2Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount2:
type: string
description: Only numeric answers allowed (in AED)
Claim3Date:
type: string
description: dd/mm/yyyy
Claim3DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim3Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim3Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount3:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEHomeInsuranceCustomerData:
type: object
required:
- CustomerId
- FullName
- PrimaryLanguage
- CommunicationPreferences
- InsuredPropertyDetails
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
ResidentialAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer residential address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
InsuredPropertyDetails:
$ref: '#/components/schemas/AEHomeInsuranceInsuredPropertyDetails'
additionalProperties: false
AEHomeInsuranceEmergencyContacts:
type: object
required:
- EmergencyContact1Name
- EmergencyContact1Relationship
- EmergencyContact1PhoneNumber
- EmergencyContact1EmailAddress
- PrimaryLanguage
properties:
EmergencyContact1Name:
type: string
description: Free-form
EmergencyContact1Relationship:
type: string
description: Free-form
EmergencyContact1PhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
EmergencyContact1EmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
PrimaryLanguage:
type: string
description: English / Arabic / Other - English only
additionalProperties: false
AEHomeInsuranceInsuredPropertyDetails:
type: object
required:
- PropertyInformation
- PropertySafetyAndSecurityFeatures
properties:
Address:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: >-
Insured property address. Only required if insured property is
different to permanent address
PropertyInformation:
allOf:
- $ref: '#/components/schemas/AEHomeInsuranceInsuredPropertyInformation'
description: Insured property details
PropertySafetyAndSecurityFeatures:
allOf:
- $ref: >-
#/components/schemas/AEHomeInsuranceInsuredPropertySafetyAndSecurityFeatures
description: Safety features of insured property
additionalProperties: false
AEHomeInsuranceInsuredPropertyInformation:
type: object
required:
- TypeOfHome
- UsageByApplicant
- NumberOfCurrentOccupants
- PropertyCondition
- YearOfConstruction
- NumberOfFloors
- TotalBuiltupArea
- NumberOfBedrooms
- NumberOfBathrooms
- ConstructionType
- RoofType
- FoundationType
- ExteriorWalls
- AdditionalStructuresSelectAllThatAreApplicable
- PresenceOfBasement
- PresenceOfAttic
- TypeOfHeatingSystem
- AgeOfHeatingSystem
- TypeOfCoolingSystem
- AgeOfCoolingSystem
- PropertyMarketValue
- MostRecentAppraisalValue
- PurchasePriceIfApplicable
- DateOfPurchaseIfApplicable
- ValueOfFurniture
- ValueOfElectronics
- ValueOfJewelry
- ValueOfAppliances
- ValueOfOtherValuables
- OwnershipStatus
- MortgageLenderNameIfApplicable
- MortgageAccountNumberIfApplicable
- MonthlyMortgageRentPaymentIfApplicable
- RemainingBalanceOnMortgageIfApplicable
properties:
TypeOfHome:
type: string
description: >-
Select from a list of options (e.g., Apartment, Villa, Townhouse,
Other)
UsageByApplicant:
type: string
description: >-
Select from a list of options (e.g., Primary Residence, Secondary
Residence, Rental Property, Vacant Property, Other)
NumberOfCurrentOccupants:
type: string
description: Only numeric answers allowed
PropertyCondition:
type: string
description: >-
Select from a list of options (e.g., Excellent, Good, Fair, Poor) -
verified by insurance company
YearOfConstruction:
type: string
description: Drop-down selections (1900-present year)
NumberOfFloors:
type: string
description: Only numeric answers allowed
TotalBuiltupArea:
type: string
description: Only numeric answers allowed (in sqm)
NumberOfBedrooms:
type: string
description: Only numeric answers allowed
NumberOfBathrooms:
type: string
description: Only numeric answers allowed
ConstructionType:
type: string
description: Select from a list of options (e.g., Concrete, Wood, Mixed, Other)
RoofType:
type: string
description: Select from a list of options (e.g., Tile, Shingle, Metal)
FoundationType:
type: string
description: Select from a list of options (e.g., Slab, Crawl Space, Basement)
ExteriorWalls:
type: string
description: >-
Select from a list of options (e.g., Brick, Stone, Concrete, Stucco,
Wood)
AdditionalStructuresSelectAllThatAreApplicable:
type: string
description: Select from a list of options (e.g., Garage, Shed, Pool)
PresenceOfBasement:
type: string
description: Yes/No
PresenceOfAttic:
type: string
description: Yes/No
TypeOfHeatingSystem:
type: string
description: Select from a list of options (e.g., Gas, Electric, Oil)
AgeOfHeatingSystem:
type: string
description: Only numeric answers allowed (in years)
TypeOfCoolingSystem:
type: string
description: >-
Select from a list of options (e.g., Central, Window, Portable,
Other)
AgeOfCoolingSystem:
type: string
description: Only numeric answers allowed (in years)
PropertyMarketValue:
type: string
description: Only numeric answers allowed (in AED)
MostRecentAppraisalValue:
type: string
description: Only numeric answers allowed (in AED)
PurchasePriceIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
DateOfPurchaseIfApplicable:
type: string
description: dd/mm/yyyy
ValueOfFurniture:
type: string
description: Only numeric answers allowed (in AED)
ValueOfElectronics:
type: string
description: Only numeric answers allowed (in AED)
ValueOfJewelry:
type: string
description: Only numeric answers allowed (in AED)
ValueOfAppliances:
type: string
description: Only numeric answers allowed (in AED)
ValueOfOtherValuables:
type: string
description: Only numeric answers allowed (in AED)
OwnershipStatus:
type: string
description: Select from a list of options (e.g., Owned, Mortgaged, Rented)
MortgageLenderNameIfApplicable:
type: string
description: Free-form
MortgageAccountNumberIfApplicable:
type: string
description: Only numeric answers allowed
MonthlyMortgageRentPaymentIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
RemainingBalanceOnMortgageIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEHomeInsuranceInsuredPropertySafetyAndSecurityFeatures:
type: object
required:
- DistanceFromShoreline
- DistanceAboveSeaLevel
- InDesignatedFloodZone
- WaterLeakDetectionSystems
- BurglarAlarm
- SurveillanceCameras
- DoorCamera
- SecurityGuards
- SmokeDetectors
- FireExtinguishers
- SprinklerSystem
- DeadboltLocks
- WindowLocks
properties:
DistanceFromShoreline:
type: string
description: Only numeric answers allowed (in km)
DistanceAboveSeaLevel:
type: string
description: Only numeric answers allowed (in m)
InDesignatedFloodZone:
type: string
description: Yes/No
WaterLeakDetectionSystems:
type: string
description: Yes/No
BurglarAlarm:
type: string
description: Yes/No
SurveillanceCameras:
type: string
description: Yes/No
DoorCamera:
type: string
description: Yes/No
SecurityGuards:
type: string
description: Yes/No
SmokeDetectors:
type: string
description: Yes/No
FireExtinguishers:
type: string
description: Yes/No
SprinklerSystem:
type: string
description: Yes/No
DeadboltLocks:
type: string
description: Yes/No
WindowLocks:
type: string
description: Yes/No
additionalProperties: false
AEHomeInsuranceOtherAdditionalInformation:
type: object
required:
- BuildingName
- NameOfBuilding
- ValuablePersonalPortableItems
- PersonalBelongingsUpToInAed
- PortableEquipmentsUpToInAed
- SingleItemExceedsTenPercentSumInsured
- SingleItemPortableEquipmentDetails
- HouseMaidPersonalAccidentRequired
- MakaniNo
- Latitude
- Longitude
- PlotNo
- VillaFlatNo
- AreYouUaeResident
properties:
BuildingName:
type: string
description: >-
Select from list for e.g. Building Name and if option Others is
selected then Building Name to be provided as below.
NameOfBuilding:
type: string
description: Free-form, Text field
ValuablePersonalPortableItems:
type: boolean
description: >-
Selection Yes or No. If selected as Yes then contents SI to
mandatory to provide.
PersonalBelongingsUpToInAed:
type: integer
format: int64
description: Only numeric answers allowed.
PortableEquipmentsUpToInAed:
type: integer
format: int64
description: Only numeric answers allowed.
SingleItemExceedsTenPercentSumInsured:
type: string
description: |2-
If yes then below information to be provided as multiple line items.
1. Category (Furniture, Electronics, Carpet, Other).
2. Description of Item.
3. Value.
SingleItemPortableEquipmentDetails:
type: array
items:
type: string
description: |2
If yes then below information to be provided as multiple line items.
1. Item (Jewellery, Fine Art, Antiques / Ornaments, Other).
2. Description of Item.
3. Categor (Valuables, Personal Belongings, Portable Equipments).
4. Value.
Notes:
* In the questionnaire this was for single items exceeding AED 25000
* Is a list of items
HouseMaidPersonalAccidentRequired:
type: boolean
description: |2-
If yes then below information to be provided as multiple line items.
1. Name.
2.Age (In Years).
Notes: In the questionnaire this was limited to AED 30000
MakaniNo:
type: string
description: Free-form, Text field
Latitude:
type: string
description: Only numeric answers allowed. Format to be used as XX.XXXXXX
Longitude:
type: string
description: Only numeric answers allowed. Format to be used as XX.XXXXXX
PlotNo:
type: string
description: Free-form, Text field
VillaFlatNo:
type: string
description: Free-form, Text field
AreYouUaeResident:
type: boolean
description: >-
If yes then EID number to be provided else Passport number to be
provided
additionalProperties: false
AEHomeInsuranceOtherData:
type: object
properties:
EmergencyContacts:
$ref: '#/components/schemas/AEHomeInsuranceEmergencyContacts'
OtherAdditionalInformation:
$ref: '#/components/schemas/AEHomeInsuranceOtherAdditionalInformation'
additionalProperties: false
AEHomeInsurancePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- AdditionalCoverageOptions
- PolicyLimits
- PolicyExclusions
- BuildingCoverageAmount
- ContentsCoverageAmount
- CoverageStartDate
- CoverageEndDate
- PolicyRenewalDate1
- PolicyRenewalDate2
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Building Insurance, Contents
Insurance, Both)
AdditionalCoverageOptions:
type: string
description: >-
Select from drop-down list (e.g., Accidental Damage, Personal
Belongings Outside Home, Alternative Accomodation)
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
BuildingCoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
ContentsCoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AEHomeInsurancePolicyProperties1:
type: object
required:
- InsurancePolicyId
properties:
InsurancePolicyId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given insurance policy
Customer:
$ref: '#/components/schemas/AEHomeInsuranceCustomerData'
Product:
$ref: '#/components/schemas/AEHomeInsuranceProductData'
Transactions:
$ref: '#/components/schemas/AEHomeInsuranceTransactionData'
Other:
$ref: '#/components/schemas/AEHomeInsuranceOtherData'
additionalProperties: false
AEHomeInsurancePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEHomeInsurancePreviousPolicies:
type: object
required:
- PreviousInsuranceCompany1
- PreviousPolicyId1
- PurchaseDate
- RenewalDate1
- RenewalDate2
- PremiumAmount
- DeductibleAmountIfAny
- CoverageType
- AdjustmentDate1IfAny
- PreviousInsuranceCompany2
- PreviousPolicyId2
- PurchaseDate_0
- RenewalDate1_0
- RenewalDate2_0
- PremiumAmount_0
- DeductibleAmountIfAny_0
- CoverageType_0
- AdjustmentDate1IfAny_0
properties:
PreviousInsuranceCompany1:
type: string
description: Free-form
PreviousPolicyId1:
type: string
description: Depends on insurance company
PurchaseDate:
type: string
description: dd/mm/yyyy
RenewalDate1:
type: string
description: dd/mm/yyyy
RenewalDate2:
type: string
description: dd/mm/yyyy
PremiumAmount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
AdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PreviousInsuranceCompany2:
type: string
description: Free-form
PreviousPolicyId2:
type: string
description: Depends on insurance company
PurchaseDate_0:
type: string
description: dd/mm/yyyy
RenewalDate1_0:
type: string
description: dd/mm/yyyy
RenewalDate2_0:
type: string
description: dd/mm/yyyy
PremiumAmount_0:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny_0:
type: string
description: Only numeric answers allowed (in AED)
CoverageType_0:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
AdjustmentDate1IfAny_0:
type: string
description: dd/mm/yyyy
additionalProperties: false
AEHomeInsuranceProductData:
type: object
properties:
Policy:
$ref: '#/components/schemas/AEHomeInsurancePolicy'
additionalProperties: false
AEHomeInsuranceQuote:
type: object
required:
- QuoteId
- QuoteReference
- status
- Customer
- Product
- Transactions
- Other
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
status:
$ref: '#/components/schemas/AEInsuranceQuoteStatusCodes'
Customer:
$ref: '#/components/schemas/AEHomeInsuranceQuoteCustomerData'
Product:
$ref: '#/components/schemas/AEHomeInsuranceQuoteProductData'
Transactions:
$ref: '#/components/schemas/AEHomeInsuranceQuoteTransactionData'
Other:
$ref: '#/components/schemas/AEHomeInsuranceQuoteOtherData'
additionalProperties: false
AEHomeInsuranceQuoteClaims:
type: object
required:
- NumberOfClaimsLast12Months
- NumberOfApprovedClaimsLast12Months
- TotalValueOfClaimsLast12Months
- TotalValueOfApprovedClaimsLast12Months
- NumberOfClaimsLast36Months
- NumberOfApprovedClaimsLast36Months
- TotalValueOfClaimsLast36Months
- TotalValueOfApprovedClaimsLast36Months
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
- Claim2Date
- Claim2DescriptionIeServicesClaimed
- Claim2Status
- Claim2Amount
- DeductibleAmount2
- Claim3Date
- Claim3DescriptionIeServicesClaimed
- Claim3Status
- Claim3Amount
- DeductibleAmount3
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
NumberOfClaimsLast36Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
Claim2Date:
type: string
description: dd/mm/yyyy
Claim2DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim2Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim2Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount2:
type: string
description: Only numeric answers allowed (in AED)
Claim3Date:
type: string
description: dd/mm/yyyy
Claim3DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim3Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim3Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount3:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEHomeInsuranceQuoteCustomerData:
type: object
required:
- FullName
- PrimaryLanguage
- CommunicationPreferences
- InsuredPropertyDetails
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
ResidentialAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer residential address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
InsuredPropertyDetails:
$ref: '#/components/schemas/AEHomeInsuranceInsuredPropertyDetails'
additionalProperties: false
AEHomeInsuranceQuoteEmergencyContacts:
type: object
required:
- EmergencyContact1Name
- EmergencyContact1Relationship
- EmergencyContact1PhoneNumber
- EmergencyContact1EmailAddress
- PrimaryLanguage
properties:
EmergencyContact1Name:
type: string
description: Free-form
EmergencyContact1Relationship:
type: string
description: Free-form
EmergencyContact1PhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
EmergencyContact1EmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
PrimaryLanguage:
type: string
description: English / Arabic / Other - English only
additionalProperties: false
AEHomeInsuranceQuoteOtherAdditionalInformation:
type: object
required:
- BuildingName
- NameOfBuilding
- ValuablePersonalPortableItems
- PersonalBelongingsUpToInAed
- PortableEquipmentsUpToInAed
- SingleItemExceedsTenPercentSumInsured
- SingleItemPortableEquipmentDetails
- HouseMaidPersonalAccidentRequired
properties:
BuildingName:
type: string
description: >-
Select from list for e.g. Building Name and if option Others is
selected then Building Name to be provided as below.
NameOfBuilding:
type: string
description: Free-form, Text field
ValuablePersonalPortableItems:
type: boolean
description: >-
Selection Yes or No. If selected as Yes then contents SI to
mandatory to provide.
PersonalBelongingsUpToInAed:
type: integer
format: int64
description: Only numeric answers allowed.
PortableEquipmentsUpToInAed:
type: integer
format: int64
description: Only numeric answers allowed.
SingleItemExceedsTenPercentSumInsured:
type: string
description: |2-
If yes then below information to be provided as multiple line items.
1. Category (Furniture, Electronics, Carpet, Other).
2. Description of Item.
3. Value.
SingleItemPortableEquipmentDetails:
type: array
items:
type: string
description: |2
If yes then below information to be provided as multiple line items.
1. Item (Jewellery, Fine Art, Antiques / Ornaments, Other).
2. Description of Item.
3. Categor (Valuables, Personal Belongings, Portable Equipments).
4. Value.
Notes:
* In the questionnaire this was for single items exceeding AED 25000
* Is a list of items
HouseMaidPersonalAccidentRequired:
type: boolean
description: |2-
If yes then below information to be provided as multiple line items.
1. Name.
2.Age (In Years).
Notes: In the questionnaire this was limited to AED 30000
additionalProperties: false
AEHomeInsuranceQuoteOtherData:
type: object
properties:
EmergencyContacts:
$ref: '#/components/schemas/AEHomeInsuranceQuoteEmergencyContacts'
OtherAdditionalInformation:
$ref: '#/components/schemas/AEHomeInsuranceQuoteOtherAdditionalInformation'
additionalProperties: false
AEHomeInsuranceQuotePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- AdditionalCoverageOptions
- PolicyLimits
- PolicyExclusions
- BuildingCoverageAmount
- ContentsCoverageAmount
- CoverageStartDate
- CoverageEndDate
- PolicyRenewalDate1
- PolicyRenewalDate2
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Building Insurance, Contents
Insurance, Both)
AdditionalCoverageOptions:
type: string
description: >-
Select from drop-down list (e.g., Accidental Damage, Personal
Belongings Outside Home, Alternative Accomodation)
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
BuildingCoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
ContentsCoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AEHomeInsuranceQuotePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AEHomeInsuranceQuotePreviousPolicies:
type: object
required:
- PreviousInsuranceCompany1
- PremiumAmount
- DeductibleAmountIfAny
- CoverageType
- PreviousInsuranceCompany2
properties:
PreviousInsuranceCompany1:
type: string
description: Free-form
PremiumAmount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
PreviousInsuranceCompany2:
type: string
description: Free-form
additionalProperties: false
AEHomeInsuranceQuoteProductData:
type: object
properties:
Policy:
$ref: '#/components/schemas/AEHomeInsuranceQuotePolicy'
additionalProperties: false
AEHomeInsuranceQuoteTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AEHomeInsuranceQuotePremium'
Claims:
$ref: '#/components/schemas/AEHomeInsuranceQuoteClaims'
PreviousPolicies:
$ref: '#/components/schemas/AEHomeInsuranceQuotePreviousPolicies'
additionalProperties: false
AEHomeInsuranceTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AEHomeInsurancePremium'
Claims:
$ref: '#/components/schemas/AEHomeInsuranceClaims'
PreviousPolicies:
$ref: '#/components/schemas/AEHomeInsurancePreviousPolicies'
additionalProperties: false
AEInsuranceAccountSchemeName:
type: string
enum:
- AccountNumber
- IBAN
description: Name of the identification scheme for the account
AEInsuranceAdditionalCompensationDetails:
type: object
required:
- Description
- Value
properties:
Description:
type: string
minLength: 1
maxLength: 140
description: Description of compensation
Value:
type: number
format: decimal
description: Value of compensation in AED
additionalProperties: false
AEInsuranceAddress:
type: object
required:
- AddressLine
- PostCode
- TownName
- CountrySubDivision
- Country
properties:
AddressLine:
type: array
items:
$ref: '#/components/schemas/AEInsuranceAddressLine'
minItems: 1
maxItems: 3
description: Address line in free format text
PostCode:
type: string
minLength: 1
maxLength: 16
description: Postal code
TownName:
type: string
minLength: 1
maxLength: 140
description: Name of a built-up area, such as a town or city
CountrySubDivision:
type: string
minLength: 1
maxLength: 35
description: Country subdivision, such as state or province
Country:
type: string
pattern: '[A-Z]{2}'
description: Country based on ISO 3166-1 alpha-2 code
description: Address information based on ISO 20022
additionalProperties: false
AEInsuranceAddressLine:
type: string
minLength: 1
maxLength: 70
AEInsuranceAddressProperties:
type: object
required:
- PostCode
- TownName
- CountrySubDivision
- Country
properties:
PostCode:
type: string
minLength: 1
maxLength: 16
description: Postal code
TownName:
type: string
minLength: 1
maxLength: 140
description: Name of a built-up area, such as a town or city
CountrySubDivision:
type: string
minLength: 1
maxLength: 35
description: Country subdivision, such as state or province
Country:
type: string
pattern: '[A-Z]{2}'
description: Country based on ISO 3166-1 alpha-2 code
description: Core insurance address properties
additionalProperties: false
AEInsuranceBankIdentification:
type: object
properties:
BICFI:
type: string
pattern: ^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}$
description: Bank Identification Code (BIC)
Name:
type: string
minLength: 1
maxLength: 140
description: Bank Name
Identification:
type: string
minLength: 1
maxLength: 140
description: Branch Name
additionalProperties: false
AEInsuranceCashAccount:
type: object
required:
- Identification
- SchemeName
- Name
properties:
Identification:
type: string
minLength: 1
maxLength: 34
description: Account identification
SchemeName:
$ref: '#/components/schemas/AEInsuranceAccountSchemeName'
Name:
type: string
minLength: 1
maxLength: 70
description: Account Name
additionalProperties: false
AEInsuranceClaimDetails:
type: object
required:
- ClaimDate
- Description
- Status
- ClaimAmount
properties:
ClaimDate:
type: string
format: date
description: Date on which claim submitted
Description:
type: string
minLength: 1
maxLength: 140
description: Claim description
Status:
allOf:
- $ref: '#/components/schemas/AEInsuranceClaimStatus'
description: Claim status
ClaimAmount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Claim amount and currency
DeductibleAmount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Deductible amount and currency
description: Individual claim detail
additionalProperties: false
AEInsuranceClaimStatus:
type: string
enum:
- Submitted
- Authorized
- Rejected
- Pending
- Completed
AEInsuranceClaimSummary:
type: object
required:
- NumberClaims
properties:
NumberClaims:
type: integer
format: int64
description: Number of claims in period
NumberApprovedClaims:
type: integer
format: int64
description: Number of approved claims in period
TotalClaimsAmount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Total amount of claims in period
TotalApprovedClaimsAmount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Total amount of approved claims in period
additionalProperties: false
AEInsuranceCommunicationPreferenceTypes:
type: string
enum:
- Home
- Mobile
- Other
description: Phone communication preference types
AEInsuranceCommunicationPreferences:
type: object
required:
- PhoneNumbers
- EmailAddress
properties:
PhoneNumbers:
type: array
items:
$ref: '#/components/schemas/AEInsurancePhoneCommunicationPreferences'
minItems: 1
maxItems: 3
description: >-
Phone numbers, qualified by type of phone number, in preference
order
EmailAddress:
$ref: '#/components/schemas/AEInsuranceEmail'
AlternativeEmailAddress:
$ref: '#/components/schemas/AEInsuranceEmail'
additionalProperties: false
AEInsuranceCountryCode:
type: string
pattern: '[A-Z]{2}'
AEInsuranceCreatePolicy1:
type: object
required:
- Data
properties:
Data:
$ref: '#/components/schemas/AEInsuranceCreatePolicyData1'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEInsuranceCreatePolicy1Signed:
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/AEInsuranceCreatePolicyData1'
additionalProperties: false
AEInsuranceCreatePolicyData1:
type: object
required:
- QuoteId
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
example: 47409fec-4b04-4356-b3a1-6f5508524a5a
description: Unique identifier for a quote created by an LFI
PaymentDetails:
allOf:
- $ref: '#/components/schemas/AEInsurancePaymentDetails'
description: >-
Customer payment details that can optionally provided by the TPP,
based on data
retrieved from an insurance
SupplementaryData:
$ref: '#/components/schemas/AEInsuranceSupplementaryData'
additionalProperties: false
AEInsuranceCreatePolicyResponse1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEInsuranceInsurancePolicyResponseData1'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEInsuranceCreatePolicyResponse1Signed:
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/AEInsuranceCreatePolicyResponse1'
additionalProperties: false
AEInsuranceCustomerBackgroundInformation:
type: object
required:
- Gender
- DateOfBirth
- MaritalStatus
- Nationality
- Salutation
properties:
Gender:
allOf:
- $ref: '#/components/schemas/AEInsuranceGender'
description: Gender
DateOfBirth:
type: string
format: date
description: Date of birth
MaritalStatus:
allOf:
- $ref: '#/components/schemas/AEInsuranceMaritalStatus'
description: Martial status
EducationBackground:
allOf:
- $ref: '#/components/schemas/AEInsuranceEducationBackground'
description: Education background
Nationality:
allOf:
- $ref: '#/components/schemas/AEInsuranceCountryCode'
description: Nationality, based on ISO 3166-1 alpha-2 code
SecondNationality:
allOf:
- $ref: '#/components/schemas/AEInsuranceCountryCode'
description: >-
Second nationality, based on ISO 3166-1 alpha-2 code. Presence of
second nationality indicates customer is dual national
Salutation:
allOf:
- $ref: '#/components/schemas/AEInsuranceSalutation'
description: Customer salutation
CountryOfBirth:
allOf:
- $ref: '#/components/schemas/AEInsuranceCountryCode'
description: Country of birth
PlaceOfBirth:
type: string
minLength: 1
maxLength: 140
description: Place of birth
Religion:
allOf:
- $ref: '#/components/schemas/AEInsuranceReligion'
description: Religion
MotherMaidenName:
type: string
minLength: 1
maxLength: 140
description: Mother's maiden name
SpouseName:
type: string
minLength: 1
maxLength: 140
description: Spouse name
SpouseDateOfBirth:
type: string
format: date
description: Spouse date of birth
SpouseEmploymentDetails:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentStatus'
description: Spouse employment details
SpousePhoneNumber:
allOf:
- $ref: '#/components/schemas/AEInsurancePhoneCommunicationPreferences'
description: Spouse phone number
NumberOfDependents:
type: integer
format: int64
description: Number of dependents
additionalProperties: false
AEInsuranceEducationBackground:
type: string
enum:
- HighSchool
- Undergraduate
- Postgraduate
- Doctorate
- Other
AEInsuranceEmail:
type: string
AEInsuranceEmirate:
type: string
enum:
- AbuDhabi
- Ajman
- Dubai
- Fujairah
- RasAlKhaimah
- Sharjah
- UmmAlQuwain
AEInsuranceEmploymentDetails:
type: object
properties:
Profession:
type: string
minLength: 1
maxLength: 70
description: Profession
ProfessionDescription:
type: string
minLength: 1
maxLength: 140
description: Profession description
EmployerName:
type: string
minLength: 1
maxLength: 70
description: Employer name
EmployerAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Employer address
EmploymentStatus:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentStatus'
description: Employment status
EmploymentStartDate:
type: string
format: date
description: Employment start date
EmploymentLocation:
type: string
minLength: 1
maxLength: 70
description: Employment location
NatureOfEmployerBusiness:
type: string
minLength: 1
maxLength: 140
description: Nature of employer business
Designation:
type: string
SourceOfIncome:
type: string
minLength: 1
maxLength: 70
description: Source of income as a free form description
IncomeCurrency:
type: string
pattern: '[A-Z]{3}'
description: Income currency
MonthlyIncome:
type: number
format: decimal
description: Monthly income in AED
AnnualIncome:
type: number
format: decimal
description: Annual income in AED
AdditionalCompensation:
allOf:
- $ref: '#/components/schemas/AEInsuranceAdditionalCompensationDetails'
description: Additional Compensation
additionalProperties: false
AEInsuranceEmploymentStatus:
type: string
enum:
- Employed
- SelfEmployed
- Unemployed
- Retired
- Other
AEInsuranceGender:
type: string
enum:
- Male
- Female
- Other
AEInsuranceGeneralMedicalInformation:
type: object
required:
- Height
- Weight
- PrimaryCarePhysicianName
- PrimaryCarePhysicianAddress
- PrimaryCarePhysicianPhoneNumber
- PrimaryCarePhysicianEmailAddress
properties:
Height:
type: string
description: Only numeric answers allowed (in m)
Weight:
type: string
description: Only numeric answers allowed (in kg)
PrimaryCarePhysicianName:
type: string
description: Free-form
PrimaryCarePhysicianAddress:
type: string
description: Free-form
PrimaryCarePhysicianPhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
PrimaryCarePhysicianEmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
additionalProperties: false
AEInsuranceIdentificationDetails:
type: object
properties:
EmiratesIdNumber:
type: string
pattern: ^784-?[0-9]{4}-?[0-9]{7}-?[0-9]{1}$
description: Emirates identification number
EmiratesIdExpiryDate:
type: string
format: date
description: Emirates ID expiry date
PassportIssueCountry:
allOf:
- $ref: '#/components/schemas/AEInsuranceCountryCode'
pattern: ^[A-Z]{2,2}$
description: Passport issuing country code
PassportNumber:
type: string
pattern: ^[A-Z0-9]+$
description: Passport number
PassportIssueDate:
type: string
format: date
description: Passport issue date
PassportExpiryDate:
type: string
format: date
description: Passport expiry date
VisaNumber:
type: string
pattern: ^[0-9]+$
description: Visa number
VisaIssueCountry:
allOf:
- $ref: '#/components/schemas/AEInsuranceCountryCode'
pattern: ^[A-Z]{2,2}$
description: Visa issuing country code
VisaIssueDate:
type: string
format: date
description: Visa issue date
VisaExpiryDate:
type: string
format: date
description: Visa expiry date
additionalProperties: false
AEInsuranceInsurancePolicyResponseData1:
type: object
required:
- InsurancePolicyId
properties:
InsurancePolicyId:
allOf:
- $ref: '#/components/schemas/uuid'
example: d330c5bb-0889-4596-86bb-17cc9a4a17b5
description: Unique identifier for a given insurance policy
additionalProperties: false
AEInsuranceMaritalStatus:
type: string
enum:
- Single
- Married
- Divorced
- Widowed
- Separated
- Other
AEInsuranceMedicalHistory:
type: object
required:
- BloodExamResults
- UrinalysisResults
- BloodPressureReadings
- RecordOfDentalVisitsAndIssues
- VisionExamResults
- PreexistingMedicalConditions
- DiagnosesWithChronicIllnesses
- MajorSurgeries
- MedicationsTaken
- MedicalDevicesUsed
- RecordOfHospitilizations
- RecordOfTreatmentForMentalHealthIssues
- Allergies
- GeneticHereditaryConditions
- DiagnosesOfInfectiousDiaseses
- DiagnosesOfReproductiveDiseases
- RecordOfDiagnosticTestsWithAbnormalResults
- ImmunizationVaccinationRecord
- TobaccoConsumptionHabits
- AlcoholConsumptionHabits
- EngagementInRegularPhysicalExercise
- SpecificDietsFollowedDietaryRestrictions
- HistoryOfChronicIllnessInTheFamily
properties:
BloodExamResults:
type: string
description: Date of exam, free-form insertion of results
UrinalysisResults:
type: string
description: Date of exam, free-form insertion of results
BloodPressureReadings:
type: string
description: Record of systolic number over diastolic number readings
RecordOfDentalVisitsAndIssues:
type: string
description: >-
Date of visit and list of issues selected from drop-down (e.g.,
cavities, wisdom tooth pain)
VisionExamResults:
type: string
description: >-
Date of visit, +/- vision reading in each eye, and list of issues
from drop-down
PreexistingMedicalConditions:
type: string
description: List of conditions from drop-down (e.g., diabetes, asthma)
DiagnosesWithChronicIllnesses:
type: string
description: >-
List of illnesses from drop-down (e.g., heart disease, stroke, lung
cancer)
MajorSurgeries:
type: string
description: Free-form
MedicationsTaken:
type: string
description: Free-form
MedicalDevicesUsed:
type: string
description: Free-form
RecordOfHospitilizations:
type: string
description: Date of visit, reason for visit, diagnosis
RecordOfTreatmentForMentalHealthIssues:
type: string
description: Date of treatment, diagnosis
Allergies:
type: string
description: Free-form
GeneticHereditaryConditions:
type: string
description: >-
List of conditions from drop-down (e.g., down syndrome, sickle cell
anemia)
DiagnosesOfInfectiousDiaseses:
type: string
description: List of diseases from drop-down (e.g., HIV, AIDS, Hepatitis)
DiagnosesOfReproductiveDiseases:
type: string
description: List of diseases from drop-down (e.g., infertility, gonorrhea)
RecordOfDiagnosticTestsWithAbnormalResults:
type: string
description: >-
Date of test, type of test from drop-down (e.g., colonscopy),
description of results
ImmunizationVaccinationRecord:
type: string
description: >-
Multiple selections from drop-down list (e.g., chickenpox,
influenza, Hepatitis A)
TobaccoConsumptionHabits:
type: string
description: >-
No tobacco/ Occasional tobacco / Monthly user / Weekly user / Daily
user
AlcoholConsumptionHabits:
type: string
description: >-
No alcohol/ Occasional alcohol / Monthly user / Weekly user / Daily
user
EngagementInRegularPhysicalExercise:
type: string
description: None / Monthly / Weekly / Daily
SpecificDietsFollowedDietaryRestrictions:
type: string
description: Free-form
HistoryOfChronicIllnessInTheFamily:
type: string
description: >-
List of illnesses from drop-down (e.g., heart disease, stroke, lung
cancer)
additionalProperties: false
AEInsurancePaymentDetails:
type: object
required:
- Account
- Bank
properties:
Account:
allOf:
- $ref: '#/components/schemas/AEInsuranceCashAccount'
description: Properties of the customer bank account
Bank:
allOf:
- $ref: '#/components/schemas/AEInsuranceBankIdentification'
description: Properties of the bank and branch of the account-holder bank
AccountType:
type: string
minLength: 1
maxLength: 35
description: Account Type
additionalProperties: false
AEInsurancePhoneCommunicationPreferences:
type: object
required:
- Type
- Identification
properties:
Type:
$ref: '#/components/schemas/AEInsuranceCommunicationPreferenceTypes'
Identification:
$ref: '#/components/schemas/AEInsurancePhoneNumber'
additionalProperties: false
AEInsurancePhoneNumber:
type: string
AEInsurancePolicies1:
type: object
required:
- Policies
properties:
Policies:
type: array
items:
$ref: '#/components/schemas/AEInsurancePolicyProperties'
additionalProperties: false
AEInsurancePolicyProperties:
type: object
required:
- InsurancePolicyId
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
properties:
InsurancePolicyId:
allOf:
- $ref: '#/components/schemas/uuid'
example: d330c5bb-0889-4596-86bb-17cc9a4a17b5
description: Unique identifier for a given insurance policy
PolicyNumber:
type: string
description: >-
The insurance policy number or reference as defined by the LFI and
understood by the
User
PolicyIssueDate:
type: string
format: date
description: The date on which the policy was issued
PolicyExpiryDate:
type: string
format: date
description: The date on which the policy expires
additionalProperties: false
AEInsuranceQuoteStatusCodes:
type: string
enum:
- Available
- Completed
- Accepted
- Expired
- Rejected
description: Quote lifecycle status codes
AEInsuranceReligion:
type: string
enum:
- Christian
- Muslim
- Jewish
- Hindu
- Buddhist
- Other
AEInsuranceSalutation:
type: string
enum:
- Mr
- Mrs
- Ms
- Miss
- Dr
- Prof
- Other
AEInsuranceSupplementaryData:
type: object
description: >-
Additional data sent by the TPP to finalise the quote ready for
completion by the User
at the LFI
additionalProperties: false
AELifeInsuranceAssetsAndLiabilities:
type: object
required:
- FinancialDependents
- ListOfAssets
- ValueOfAssets
- ListOfLiabilities
- ValueOfLiabilities
- CreditScore
- RecordOfCreditHistory
- RetirementSavingsValue
- ListOfDebtObligations
- ListOfInvestmentPortfoliosMaintained
- ValueOfInvestmentPortfoliosMaintained
properties:
FinancialDependents:
type: string
description: Free-form (names)
ListOfAssets:
type: string
description: Free-form
ValueOfAssets:
type: string
description: Numeric values only (in AED), associated with each listed asset
ListOfLiabilities:
type: string
description: Free-form
ValueOfLiabilities:
type: string
description: Numeric values only (in AED), associated with each listed liability
CreditScore:
type: string
description: Numeric values between 300 and 900 only
RecordOfCreditHistory:
type: string
description: >-
Free-form list of previously-held credit cards and loans with value
and descriptions
RetirementSavingsValue:
type: string
description: Numeric values only (in AED)
ListOfDebtObligations:
type: string
description: >-
Free-form list of credit cards and loans with value and descriptions
associated with each
ListOfInvestmentPortfoliosMaintained:
type: string
description: Free-form list of investment portfolios
ValueOfInvestmentPortfoliosMaintained:
type: string
description: >-
Numeric values only (in AED), associated with each investment
portfolio
additionalProperties: false
AELifeInsuranceBeneficiaries:
type: object
required:
- PolicyBeneficiariesNames
- PolicyBeneficiariesRelationshipToTheHolder
- PolicyBeneficiariesPhoneNumbers
- PolicyBeneficiariesEmailAddresses
properties:
PolicyBeneficiariesNames:
type: string
description: Free-form
PolicyBeneficiariesRelationshipToTheHolder:
type: string
description: Spouse/ Child/ Parent/ Sibling/ Friend/ Other
PolicyBeneficiariesPhoneNumbers:
type: string
description: Area code selection option and 9-10 additional digits permissible
PolicyBeneficiariesEmailAddresses:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
additionalProperties: false
AELifeInsuranceBenefitPayouts:
type: object
required:
- BenefitPayoutDate1
- BenefitPayoutAmount1
- BenefitPayoutDate2
- BenefitPayoutAmount2
properties:
BenefitPayoutDate1:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceClaims:
type: object
required:
- NumberOfClaimsLast12Months
- NumberOfApprovedClaimsLast12Months
- TotalValueOfClaimsLast12Months
- TotalValueOfApprovedClaimsLast12Months
- NumberOfClaimsLast36Months
- NumberOfApprovedClaimsLast36Months
- TotalValueOfClaimsLast36Months
- TotalValueOfApprovedClaimsLast36Months
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
- Claim2Date
- Claim2DescriptionIeServicesClaimed
- Claim2Status
- Claim2Amount
- DeductibleAmount2
- Claim3Date
- Claim3DescriptionIeServicesClaimed
- Claim3Status
- Claim3Amount
- DeductibleAmount3
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
NumberOfClaimsLast36Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
Claim2Date:
type: string
description: dd/mm/yyyy
Claim2DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim2Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim2Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount2:
type: string
description: Only numeric answers allowed (in AED)
Claim3Date:
type: string
description: dd/mm/yyyy
Claim3DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim3Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim3Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount3:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceCustomerData:
type: object
required:
- CustomerId
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
ResidentialAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer residential address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
InsuredPropertyAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: >-
Insured property address. Only required if different to permanent
address
AssetsAndLiabilities:
$ref: '#/components/schemas/AELifeInsuranceAssetsAndLiabilities'
ExistingInsurancePolicies:
$ref: '#/components/schemas/AELifeInsuranceExistingInsurancePolicies'
Legal:
$ref: '#/components/schemas/AELifeInsuranceLegal'
MilitaryService:
$ref: '#/components/schemas/AELifeInsuranceMilitaryService'
HobbiesAndActivities:
$ref: '#/components/schemas/AELifeInsuranceHobbiesAndActivities'
Travel:
$ref: '#/components/schemas/AELifeInsuranceTravel'
GeneralMedicalInformation:
$ref: '#/components/schemas/AEInsuranceGeneralMedicalInformation'
MedicalHistory:
$ref: '#/components/schemas/AEInsuranceMedicalHistory'
additionalProperties: false
AELifeInsuranceEmergencyContacts:
type: object
required:
- EmergencyContact1Name
- EmergencyContact1Relationship
- EmergencyContact1PhoneNumber
- EmergencyContact1EmailAddress
- EmergencyContact2Name
- EmergencyContact2Relationship
- EmergencyContact2PhoneNumber
- EmergencyContact2EmailAddress
- BillingAddress
- PermanentAddress
- ResidentialAddress
- Communication
- BackgroundAndFamily
- Employment
- Identification
- AssetsAndLiabilities
- ExistingInsurancePolicies
- Legal
- MilitaryService
- HobbiesAndActivities
- Travel
- GeneralMedicalInformation
- MedicalHistory
- BankInformation
- ProductInformation
- Policy
- Beneficiaries
- LoanAgainstPolicy
- TransactionInformation
- Premium
- LoanIfApplicable
- BenefitPayouts
- Claims
- PreviousPolicies
- Other
- EmergencyContacts
properties:
EmergencyContact1Name:
type: string
description: Free-form
EmergencyContact1Relationship:
type: string
description: Free-form
EmergencyContact1PhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
EmergencyContact1EmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
EmergencyContact2Name:
type: string
description: Free-form
EmergencyContact2Relationship:
type: string
description: Free-form
EmergencyContact2PhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
EmergencyContact2EmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
BillingAddress:
type: string
description: Placholder
PermanentAddress:
type: string
description: Placholder
ResidentialAddress:
type: string
description: Placholder
Communication:
type: string
description: Placholder
BackgroundAndFamily:
type: string
description: Placholder
Employment:
type: string
description: Placholder
Identification:
type: string
description: Placholder
AssetsAndLiabilities:
type: string
description: Placholder
ExistingInsurancePolicies:
type: string
description: Placholder
Legal:
type: string
description: Placholder
MilitaryService:
type: string
description: Placholder
HobbiesAndActivities:
type: string
description: Placholder
Travel:
type: string
description: Placholder
GeneralMedicalInformation:
type: string
description: Placholder
MedicalHistory:
type: string
description: Placholder
BankInformation:
type: string
description: Placholder
ProductInformation:
type: string
description: Placholder
Policy:
type: string
description: Placholder
Beneficiaries:
type: string
description: Placholder
LoanAgainstPolicy:
type: string
description: Placholder
TransactionInformation:
type: string
description: Placholder
Premium:
type: string
description: Placholder
LoanIfApplicable:
type: string
description: Placholder
BenefitPayouts:
type: string
description: Placholder
Claims:
type: string
description: Placholder
PreviousPolicies:
type: string
description: Placholder
Other:
type: string
description: Placholder
EmergencyContacts:
type: string
description: Placholder
additionalProperties: false
AELifeInsuranceExistingInsurancePolicies:
type: object
required:
- TypeOfExistingInsurancePolicies
- ListOfExistingInsurancePolicies
- CoverageAmountOfExistingInsurancePolicies
properties:
TypeOfExistingInsurancePolicies:
type: string
description: Select from drop-down list (e.g., Life, Health, Motor)
ListOfExistingInsurancePolicies:
type: string
description: Free-form
CoverageAmountOfExistingInsurancePolicies:
type: string
description: Numeric values only (in AED)
additionalProperties: false
AELifeInsuranceHobbiesAndActivities:
type: object
properties:
HobbiesAndActivities:
type: string
description: Free-form
HighRiskActivities:
type: string
description: Free-form
additionalProperties: false
AELifeInsuranceLegal:
type: object
required:
- RecordsOfSanctionsImposed
- RecordsOfArrests
- RecordsOfDivorces
- RecordsOfCourtApperancesAndOutcomes
- PowerOfAttorneyDetails
properties:
RecordsOfSanctionsImposed:
type: string
description: Free-form with option for pdf attachment
RecordsOfArrests:
type: string
description: Free-form with option for pdf attachment
RecordsOfDivorces:
type: string
description: Free-form with option for pdf attachment
RecordsOfCourtApperancesAndOutcomes:
type: string
description: Free-form with option for pdf attachment
PowerOfAttorneyDetails:
type: string
description: Free-form with option for pdf attachment
additionalProperties: false
AELifeInsuranceLoanAgainstPolicy:
type: object
required:
- ValueOfLoanAgainstPolicyIfApplicable
properties:
ValueOfLoanAgainstPolicyIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceLoanIfApplicable:
type: object
required:
- LoanDateIfApplicable
- LoanAmountIfApplicable
- InterestRateIfApplicable
- RepaymentScheduleIfApplicable
- OutstandingLoanBalanceIfApplicable
properties:
LoanDateIfApplicable:
type: string
description: dd/mm/yyyy
LoanAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
InterestRateIfApplicable:
type: string
description: Only numeric answers allowed (%)
RepaymentScheduleIfApplicable:
type: string
description: Only numeric answers allowed (in years)
OutstandingLoanBalanceIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceMilitaryService:
type: object
required:
- MilitaryService
properties:
MilitaryService:
type: boolean
description: Indicator of whether the customer has undertaken military service
ActiveService:
type: boolean
description: Indicator of whether customer in is active military service
CountryOfService:
type: string
description: Select from list
DurationOfService:
type: string
description: Select number of years and months from drop-downs
Rank:
type: string
description: Select from drop-down (e.g., General, Lieutenant, Commander)
additionalProperties: false
AELifeInsuranceOtherData:
type: object
properties:
EmergencyContacts:
$ref: '#/components/schemas/AELifeInsuranceEmergencyContacts'
additionalProperties: false
AELifeInsurancePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- PolicyLimits
- PolicyExclusions
- CoverageAmount
- CoverageStartDate
- CoverageEndDate
- PolicyRenewalDate1
- PolicyRenewalDate2
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
CoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AELifeInsurancePolicyProperties1:
type: object
required:
- InsurancePolicyId
properties:
InsurancePolicyId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given insurance policy
Customer:
$ref: '#/components/schemas/AELifeInsuranceCustomerData'
Product:
$ref: '#/components/schemas/AELifeInsuranceProductData'
Transactions:
$ref: '#/components/schemas/AELifeInsuranceTransactionData'
Other:
$ref: '#/components/schemas/AELifeInsuranceOtherData'
additionalProperties: false
AELifeInsurancePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsurancePreviousPolicies:
type: object
required:
- PreviousInsuranceCompany1
- PreviousPolicyId1
- PurchaseDate
- RenewalDate1
- RenewalDate2
- PremiumAmount
- DeductibleAmountIfAny
- CoverageType
- AdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- AdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- LoanDateIfApplicable
- LoanAmountIfApplicable
- InterestRateIfApplicable
- RepaymentScheduleIfApplicable
- OutstandingLoanBalanceIfApplicable
- BenefitPayoutDate1
- BenefitPayoutAmount1
- BenefitPayoutDate2
- BenefitPayoutAmount2
- TerminationDate
- ReasonForCancellation
- RefundAmountIfAny
- SurrenderDateIfApplicable
- SurrenderAmountIfApplicable
- ReasonForSurrender
- CashValueOfPolicyPaidToPolicyholder
- PreviousInsuranceCompany2
- PreviousPolicyId2
- PurchaseDate_0
- RenewalDate1_0
- RenewalDate2_0
- PremiumAmount_0
- DeductibleAmountIfAny_0
- CoverageType_0
- AdjustmentDate1IfAny_0
- PremiumAdjustment1IfAny_0
- CoverageAdjustment1IfAny_0
- ReasonForAdjustment1IfAny_0
- AdjustmentDate2IfAny_0
- PremiumAdjustment2IfAny_0
- CoverageAdjustment2IfAny_0
- ReasonForAdjustment2IfAny_0
- LoanDateIfApplicable_0
- LoanAmountIfApplicable_0
- InterestRateIfApplicable_0
- RepaymentScheduleIfApplicable_0
- OutstandingLoanBalanceIfApplicable_0
- BenefitPayoutDate1_0
- BenefitPayoutAmount1_0
- BenefitPayoutDate2_0
- BenefitPayoutAmount2_0
- TerminationDate_0
- ReasonForCancellation_0
- RefundAmountIfAny_0
- SurrenderDateIfApplicable_0
- SurrenderAmountIfApplicable_0
- ReasonForSurrender_0
- CashValueOfPolicyPaidToPolicyholder_0
properties:
PreviousInsuranceCompany1:
type: string
description: Free-form
PreviousPolicyId1:
type: string
description: Depends on insurance company
PurchaseDate:
type: string
description: dd/mm/yyyy
RenewalDate1:
type: string
description: dd/mm/yyyy
RenewalDate2:
type: string
description: dd/mm/yyyy
PremiumAmount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
AdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
AdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
LoanDateIfApplicable:
type: string
description: dd/mm/yyyy
LoanAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
InterestRateIfApplicable:
type: string
description: Only numeric answers allowed (%)
RepaymentScheduleIfApplicable:
type: string
description: Only numeric answers allowed (in years)
OutstandingLoanBalanceIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate1:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2:
type: string
description: Only numeric answers allowed (in AED)
TerminationDate:
type: string
description: dd/mm/yyyy
ReasonForCancellation:
type: string
description: Free-form
RefundAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
SurrenderDateIfApplicable:
type: string
description: dd/mm/yyyy
SurrenderAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
ReasonForSurrender:
type: string
description: Free-form
CashValueOfPolicyPaidToPolicyholder:
type: string
description: Only numeric answers allowed (in AED)
PreviousInsuranceCompany2:
type: string
description: Free-form
PreviousPolicyId2:
type: string
description: Depends on insurance company
PurchaseDate_0:
type: string
description: dd/mm/yyyy
RenewalDate1_0:
type: string
description: dd/mm/yyyy
RenewalDate2_0:
type: string
description: dd/mm/yyyy
PremiumAmount_0:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny_0:
type: string
description: Only numeric answers allowed (in AED)
CoverageType_0:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
AdjustmentDate1IfAny_0:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny_0:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny_0:
type: string
description: Free-form
ReasonForAdjustment1IfAny_0:
type: string
description: Free-form
AdjustmentDate2IfAny_0:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny_0:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny_0:
type: string
description: Free-form
ReasonForAdjustment2IfAny_0:
type: string
description: Free-form
LoanDateIfApplicable_0:
type: string
description: dd/mm/yyyy
LoanAmountIfApplicable_0:
type: string
description: Only numeric answers allowed (in AED)
InterestRateIfApplicable_0:
type: string
description: Only numeric answers allowed (%)
RepaymentScheduleIfApplicable_0:
type: string
description: Only numeric answers allowed (in years)
OutstandingLoanBalanceIfApplicable_0:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate1_0:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1_0:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2_0:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2_0:
type: string
description: Only numeric answers allowed (in AED)
TerminationDate_0:
type: string
description: dd/mm/yyyy
ReasonForCancellation_0:
type: string
description: Free-form
RefundAmountIfAny_0:
type: string
description: Only numeric answers allowed (in AED)
SurrenderDateIfApplicable_0:
type: string
description: dd/mm/yyyy
SurrenderAmountIfApplicable_0:
type: string
description: Only numeric answers allowed (in AED)
ReasonForSurrender_0:
type: string
description: Free-form
CashValueOfPolicyPaidToPolicyholder_0:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceProductData:
type: object
properties:
Policy:
$ref: '#/components/schemas/AELifeInsurancePolicy'
Beneficiaries:
$ref: '#/components/schemas/AELifeInsuranceBeneficiaries'
LoanAgainstPolicy:
$ref: '#/components/schemas/AELifeInsuranceLoanAgainstPolicy'
additionalProperties: false
AELifeInsuranceQuote:
type: object
required:
- QuoteId
- QuoteReference
- status
- Customer
- Product
- Transactions
- Other
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
status:
$ref: '#/components/schemas/AEInsuranceQuoteStatusCodes'
Customer:
$ref: '#/components/schemas/AELifeInsuranceQuoteCustomerData'
Product:
$ref: '#/components/schemas/AELifeInsuranceQuoteProductData'
Transactions:
$ref: '#/components/schemas/AELifeInsuranceQuoteTransactionData'
Other:
$ref: '#/components/schemas/AELifeInsuranceQuoteOtherData'
additionalProperties: false
AELifeInsuranceQuoteBeneficiaries:
type: object
required:
- PolicyBeneficiariesNames
- PolicyBeneficiariesRelationshipToTheHolder
- PolicyBeneficiariesPhoneNumbers
- PolicyBeneficiariesEmailAddresses
properties:
PolicyBeneficiariesNames:
type: string
description: Free-form
PolicyBeneficiariesRelationshipToTheHolder:
type: string
description: Spouse/ Child/ Parent/ Sibling/ Friend/ Other
PolicyBeneficiariesPhoneNumbers:
type: string
description: Area code selection option and 9-10 additional digits permissible
PolicyBeneficiariesEmailAddresses:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
additionalProperties: false
AELifeInsuranceQuoteBenefitPayouts:
type: object
required:
- BenefitPayoutDate1
- BenefitPayoutAmount1
- BenefitPayoutDate2
- BenefitPayoutAmount2
properties:
BenefitPayoutDate1:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceQuoteClaims:
type: object
required:
- NumberOfClaimsLast12Months
- NumberOfApprovedClaimsLast12Months
- TotalValueOfClaimsLast12Months
- TotalValueOfApprovedClaimsLast12Months
- NumberOfClaimsLast36Months
- NumberOfApprovedClaimsLast36Months
- TotalValueOfClaimsLast36Months
- TotalValueOfApprovedClaimsLast36Months
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
- Claim2Date
- Claim2DescriptionIeServicesClaimed
- Claim2Status
- Claim2Amount
- DeductibleAmount2
- Claim3Date
- Claim3DescriptionIeServicesClaimed
- Claim3Status
- Claim3Amount
- DeductibleAmount3
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
NumberOfClaimsLast36Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
Claim2Date:
type: string
description: dd/mm/yyyy
Claim2DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim2Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim2Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount2:
type: string
description: Only numeric answers allowed (in AED)
Claim3Date:
type: string
description: dd/mm/yyyy
Claim3DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim3Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim3Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount3:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceQuoteCustomerData:
type: object
required:
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
ResidentialAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer residential address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
InsuredPropertyAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: >-
Insured property address. Only required if different to permanent
address
AssetsAndLiabilities:
$ref: '#/components/schemas/AELifeInsuranceAssetsAndLiabilities'
ExistingInsurancePolicies:
$ref: '#/components/schemas/AELifeInsuranceExistingInsurancePolicies'
Legal:
$ref: '#/components/schemas/AELifeInsuranceLegal'
MilitaryService:
$ref: '#/components/schemas/AELifeInsuranceMilitaryService'
HobbiesAndActivities:
$ref: '#/components/schemas/AELifeInsuranceHobbiesAndActivities'
Travel:
$ref: '#/components/schemas/AELifeInsuranceTravel'
GeneralMedicalInformation:
$ref: '#/components/schemas/AEInsuranceGeneralMedicalInformation'
additionalProperties: false
AELifeInsuranceQuoteEmergencyContacts:
type: object
required:
- EmergencyContact1Name
- EmergencyContact1Relationship
- EmergencyContact1PhoneNumber
- EmergencyContact1EmailAddress
- EmergencyContact2Name
- EmergencyContact2Relationship
- EmergencyContact2PhoneNumber
- EmergencyContact2EmailAddress
- BillingAddress
- PermanentAddress
- ResidentialAddress
- Communication
- BackgroundAndFamily
- Employment
- Identification
- AssetsAndLiabilities
- ExistingInsurancePolicies
- Legal
- MilitaryService
- HobbiesAndActivities
- Travel
- GeneralMedicalInformation
- MedicalHistory
- BankInformation
- ProductInformation
- Policy
- Beneficiaries
- LoanAgainstPolicy
- TransactionInformation
- Premium
- LoanIfApplicable
- BenefitPayouts
- Claims
- PreviousPolicies
- Other
- EmergencyContacts
properties:
EmergencyContact1Name:
type: string
description: Free-form
EmergencyContact1Relationship:
type: string
description: Free-form
EmergencyContact1PhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
EmergencyContact1EmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
EmergencyContact2Name:
type: string
description: Free-form
EmergencyContact2Relationship:
type: string
description: Free-form
EmergencyContact2PhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
EmergencyContact2EmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
BillingAddress:
type: string
description: Placholder
PermanentAddress:
type: string
description: Placholder
ResidentialAddress:
type: string
description: Placholder
Communication:
type: string
description: Placholder
BackgroundAndFamily:
type: string
description: Placholder
Employment:
type: string
description: Placholder
Identification:
type: string
description: Placholder
AssetsAndLiabilities:
type: string
description: Placholder
ExistingInsurancePolicies:
type: string
description: Placholder
Legal:
type: string
description: Placholder
MilitaryService:
type: string
description: Placholder
HobbiesAndActivities:
type: string
description: Placholder
Travel:
type: string
description: Placholder
GeneralMedicalInformation:
type: string
description: Placholder
MedicalHistory:
type: string
description: Placholder
BankInformation:
type: string
description: Placholder
ProductInformation:
type: string
description: Placholder
Policy:
type: string
description: Placholder
Beneficiaries:
type: string
description: Placholder
LoanAgainstPolicy:
type: string
description: Placholder
TransactionInformation:
type: string
description: Placholder
Premium:
type: string
description: Placholder
LoanIfApplicable:
type: string
description: Placholder
BenefitPayouts:
type: string
description: Placholder
Claims:
type: string
description: Placholder
PreviousPolicies:
type: string
description: Placholder
Other:
type: string
description: Placholder
EmergencyContacts:
type: string
description: Placholder
additionalProperties: false
AELifeInsuranceQuoteLoanAgainstPolicy:
type: object
required:
- ValueOfLoanAgainstPolicyIfApplicable
properties:
ValueOfLoanAgainstPolicyIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceQuoteLoanIfApplicable:
type: object
required:
- LoanDateIfApplicable
- LoanAmountIfApplicable
- InterestRateIfApplicable
- RepaymentScheduleIfApplicable
- OutstandingLoanBalanceIfApplicable
properties:
LoanDateIfApplicable:
type: string
description: dd/mm/yyyy
LoanAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
InterestRateIfApplicable:
type: string
description: Only numeric answers allowed (%)
RepaymentScheduleIfApplicable:
type: string
description: Only numeric answers allowed (in years)
OutstandingLoanBalanceIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceQuoteOtherData:
type: object
properties:
EmergencyContacts:
$ref: '#/components/schemas/AELifeInsuranceQuoteEmergencyContacts'
additionalProperties: false
AELifeInsuranceQuotePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- PolicyLimits
- PolicyExclusions
- CoverageAmount
- CoverageStartDate
- CoverageEndDate
- PolicyRenewalDate1
- PolicyRenewalDate2
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
CoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AELifeInsuranceQuotePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceQuotePreviousPolicies:
type: object
required:
- PreviousInsuranceCompany1
- PreviousPolicyId1
- PurchaseDate
- RenewalDate1
- RenewalDate2
- PremiumAmount
- DeductibleAmountIfAny
- CoverageType
- AdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- AdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- LoanDateIfApplicable
- LoanAmountIfApplicable
- InterestRateIfApplicable
- RepaymentScheduleIfApplicable
- OutstandingLoanBalanceIfApplicable
- BenefitPayoutDate1
- BenefitPayoutAmount1
- BenefitPayoutDate2
- BenefitPayoutAmount2
- TerminationDate
- ReasonForCancellation
- RefundAmountIfAny
- SurrenderDateIfApplicable
- SurrenderAmountIfApplicable
- ReasonForSurrender
- CashValueOfPolicyPaidToPolicyholder
- PreviousInsuranceCompany2
- PreviousPolicyId2
- PurchaseDate_0
- RenewalDate1_0
- RenewalDate2_0
- PremiumAmount_0
- DeductibleAmountIfAny_0
- CoverageType_0
- AdjustmentDate1IfAny_0
- PremiumAdjustment1IfAny_0
- CoverageAdjustment1IfAny_0
- ReasonForAdjustment1IfAny_0
- AdjustmentDate2IfAny_0
- PremiumAdjustment2IfAny_0
- CoverageAdjustment2IfAny_0
- ReasonForAdjustment2IfAny_0
- LoanDateIfApplicable_0
- LoanAmountIfApplicable_0
- InterestRateIfApplicable_0
- RepaymentScheduleIfApplicable_0
- OutstandingLoanBalanceIfApplicable_0
- BenefitPayoutDate1_0
- BenefitPayoutAmount1_0
- BenefitPayoutDate2_0
- BenefitPayoutAmount2_0
- TerminationDate_0
- ReasonForCancellation_0
- RefundAmountIfAny_0
- SurrenderDateIfApplicable_0
- SurrenderAmountIfApplicable_0
- ReasonForSurrender_0
- CashValueOfPolicyPaidToPolicyholder_0
properties:
PreviousInsuranceCompany1:
type: string
description: Free-form
PreviousPolicyId1:
type: string
description: Depends on insurance company
PurchaseDate:
type: string
description: dd/mm/yyyy
RenewalDate1:
type: string
description: dd/mm/yyyy
RenewalDate2:
type: string
description: dd/mm/yyyy
PremiumAmount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
AdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
AdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
LoanDateIfApplicable:
type: string
description: dd/mm/yyyy
LoanAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
InterestRateIfApplicable:
type: string
description: Only numeric answers allowed (%)
RepaymentScheduleIfApplicable:
type: string
description: Only numeric answers allowed (in years)
OutstandingLoanBalanceIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate1:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2:
type: string
description: Only numeric answers allowed (in AED)
TerminationDate:
type: string
description: dd/mm/yyyy
ReasonForCancellation:
type: string
description: Free-form
RefundAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
SurrenderDateIfApplicable:
type: string
description: dd/mm/yyyy
SurrenderAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
ReasonForSurrender:
type: string
description: Free-form
CashValueOfPolicyPaidToPolicyholder:
type: string
description: Only numeric answers allowed (in AED)
PreviousInsuranceCompany2:
type: string
description: Free-form
PreviousPolicyId2:
type: string
description: Depends on insurance company
PurchaseDate_0:
type: string
description: dd/mm/yyyy
RenewalDate1_0:
type: string
description: dd/mm/yyyy
RenewalDate2_0:
type: string
description: dd/mm/yyyy
PremiumAmount_0:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny_0:
type: string
description: Only numeric answers allowed (in AED)
CoverageType_0:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
AdjustmentDate1IfAny_0:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny_0:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny_0:
type: string
description: Free-form
ReasonForAdjustment1IfAny_0:
type: string
description: Free-form
AdjustmentDate2IfAny_0:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny_0:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny_0:
type: string
description: Free-form
ReasonForAdjustment2IfAny_0:
type: string
description: Free-form
LoanDateIfApplicable_0:
type: string
description: dd/mm/yyyy
LoanAmountIfApplicable_0:
type: string
description: Only numeric answers allowed (in AED)
InterestRateIfApplicable_0:
type: string
description: Only numeric answers allowed (%)
RepaymentScheduleIfApplicable_0:
type: string
description: Only numeric answers allowed (in years)
OutstandingLoanBalanceIfApplicable_0:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate1_0:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1_0:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2_0:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2_0:
type: string
description: Only numeric answers allowed (in AED)
TerminationDate_0:
type: string
description: dd/mm/yyyy
ReasonForCancellation_0:
type: string
description: Free-form
RefundAmountIfAny_0:
type: string
description: Only numeric answers allowed (in AED)
SurrenderDateIfApplicable_0:
type: string
description: dd/mm/yyyy
SurrenderAmountIfApplicable_0:
type: string
description: Only numeric answers allowed (in AED)
ReasonForSurrender_0:
type: string
description: Free-form
CashValueOfPolicyPaidToPolicyholder_0:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AELifeInsuranceQuoteProductData:
type: object
properties:
Policy:
$ref: '#/components/schemas/AELifeInsuranceQuotePolicy'
Beneficiaries:
$ref: '#/components/schemas/AELifeInsuranceQuoteBeneficiaries'
LoanAgainstPolicy:
$ref: '#/components/schemas/AELifeInsuranceQuoteLoanAgainstPolicy'
additionalProperties: false
AELifeInsuranceQuoteTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AELifeInsuranceQuotePremium'
LoanIfApplicable:
$ref: '#/components/schemas/AELifeInsuranceQuoteLoanIfApplicable'
BenefitPayouts:
$ref: '#/components/schemas/AELifeInsuranceQuoteBenefitPayouts'
Claims:
$ref: '#/components/schemas/AELifeInsuranceQuoteClaims'
PreviousPolicies:
$ref: '#/components/schemas/AELifeInsuranceQuotePreviousPolicies'
additionalProperties: false
AELifeInsuranceTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AELifeInsurancePremium'
LoanIfApplicable:
$ref: '#/components/schemas/AELifeInsuranceLoanIfApplicable'
BenefitPayouts:
$ref: '#/components/schemas/AELifeInsuranceBenefitPayouts'
Claims:
$ref: '#/components/schemas/AELifeInsuranceClaims'
PreviousPolicies:
$ref: '#/components/schemas/AELifeInsurancePreviousPolicies'
additionalProperties: false
AELifeInsuranceTravel:
type: object
required:
- TravelHistoryInclToHighRiskRegions
properties:
TravelHistoryInclToHighRiskRegions:
type: string
description: Select multiple countries from drop-down list
additionalProperties: false
AEMotorInsuranceBenefitPayout:
type: object
required:
- Amount
- Date
properties:
Amount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Benefit payout amount and currency
Date:
type: string
format: date
description: Benefit payout date
description: Benefit payout
additionalProperties: false
AEMotorInsuranceCustomerData:
type: object
required:
- CustomerId
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
ResidentialAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer residential address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
additionalProperties: false
AEMotorInsuranceLoanDetails:
type: object
required:
- LoanAmount
- LoanStartDate
- LoanInterestRate
- RepaymentSchedule
- OutstandingLoanBalance
properties:
LoanAmount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Loan amount and currency
LoanStartDate:
type: string
format: date
description: Loan start date
LoanInterestRate:
type: number
description: Loan interest rate
RepaymentSchedule:
type: string
minLength: 1
maxLength: 16
description: Repayment frequency
OutstandingLoanBalance:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Outstanding loan balance
description: Loan details
additionalProperties: false
AEMotorInsurancePolicyAdjustments:
type: object
required:
- Date
properties:
Date:
type: string
format: date
description: Date of adjustment
PremiumAdjustment:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Premium adjustment amount and currency
CoverageAdjustment:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Coverage adjustment amount and currency
Reason:
type: string
minLength: 1
maxLength: 140
description: Reason for adjustment
description: Policy adjustments
additionalProperties: false
AEMotorInsurancePolicyProperties:
type: object
required:
- PolicyReference
- IssueDateTime
- ExpiryDateTime
- CoverageType
- PolicyLimits
- PolicyExclusions
- CoverageAmount
- CoverageStartDate
- CoverageEndDate
properties:
PolicyReference:
$ref: '#/components/schemas/PolicyReference'
IssueDateTime:
type: string
format: date
description: Date when the policy was issued
ExpiryDateTime:
type: string
format: date
description: Date when the policy expires
CoverageType:
type: string
minLength: 1
maxLength: 170
description: Freeform text that describes coverage as specified by the insurer
PolicyLimits:
type: string
minLength: 1
maxLength: 350
description: Policy limits as free form text
PolicyExclusions:
type: string
minLength: 1
maxLength: 350
description: Policy exclusions as free form text
CoverageAmount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Coverage amount and currency
CoverageStartDate:
type: string
format: date
description: Date when the coverage starts
CoverageEndDate:
type: string
format: date
description: Date when the coverage ends
PreviousPolicyInformation:
allOf:
- $ref: '#/components/schemas/AEMotorInsurancePreviousPolicy'
description: Details of previous policy held by the insurer
DriversPersonalAccidentIncluded:
type: boolean
description: >-
Indicates whether the policy includes personal accident coverage for
the driver
PassengersPersonalAccidentIncluded:
type: boolean
description: >-
Indicates whether the policy includes personal accident coverage for
the passengers
additionalProperties: false
AEMotorInsurancePolicyProperties1:
type: object
required:
- InsurancePolicyId
properties:
InsurancePolicyId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given insurance policy
Customer:
$ref: '#/components/schemas/AEMotorInsuranceCustomerData'
Product:
$ref: '#/components/schemas/AEMotorInsuranceProductData'
Transactions:
$ref: '#/components/schemas/AEMotorInsuranceTransactionData'
additionalProperties: false
AEMotorInsurancePreviousPolicy:
type: object
required:
- Insurer
- PolicyStartDate
- PolicyExpiryDate
properties:
Insurer:
type: string
description: Previous issuer
PolicyStartDate:
type: string
format: date
description: Previous policy start date
PolicyExpiryDate:
type: string
format: date
description: Previous policy expiry date
PreviousClaims:
type: array
items:
$ref: '#/components/schemas/PreviousClaims'
description: >-
Claims on previous policy. If there are no claims on the policy then
this property is not required
additionalProperties: false
AEMotorInsurancePreviousPolicyDetails:
type: object
required:
- InsuranceCompanyName
- PolicyReference
- PurchaseDate
- minItems
- maxItems
- CoverageType
properties:
InsuranceCompanyName:
type: string
minLength: 1
maxLength: 140
description: Previous insurer
PolicyReference:
type: string
minLength: 1
maxLength: 70
description: Previous policy reference
PurchaseDate:
type: string
format: date
description: Previous policy start date
minItems:
type: number
enum:
- 1
description: Previous policy renewal dates, up to two renewals
maxItems:
type: number
enum:
- 2
RenewalDate:
type: array
items:
type: string
format: date
DeductibleAmount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Deductible amount and currency
CoverageType:
type: string
minLength: 1
maxLength: 35
description: Policy coverage type
Adjustments:
type: array
items:
$ref: '#/components/schemas/AEMotorInsurancePolicyAdjustments'
minItems: 1
maxItems: 2
description: >-
Policy adjustments recorded on the policy. Omit if no adjustments
made
Loan:
allOf:
- $ref: '#/components/schemas/AEMotorInsuranceLoanDetails'
description: Loan details
BenefitPayouts:
type: array
items:
$ref: '#/components/schemas/AEMotorInsuranceBenefitPayout'
description: Benefit payout details
TerminationDate:
type: string
format: date
description: Policy termination date
ReasonforCancellation:
type: string
minLength: 1
maxLength: 140
description: Reason for policy termination
RefundAmount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Refund amount and currency
SurrenderDate:
type: string
format: date
description: Surrender date
SurrenderAmount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Surrender amount and currency
ReasonforSurrender:
type: string
description: Reason for surrender
CashValueofPolicyPaidtoPolicyholder:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Cash value of policy paid to policyholder
description: Previous policy details
additionalProperties: false
AEMotorInsuranceProductData:
type: object
required:
- InsuredVehicle
- Policy
properties:
InsuredVehicle:
$ref: '#/components/schemas/AEMotorInsuranceVehicle'
Policy:
$ref: '#/components/schemas/AEMotorInsurancePolicyProperties'
additionalProperties: false
AEMotorInsuranceQuote:
type: object
required:
- QuoteId
- QuoteReference
- status
- Customer
- Product
- Transactions
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
status:
$ref: '#/components/schemas/AEInsuranceQuoteStatusCodes'
Customer:
$ref: '#/components/schemas/AEMotorInsuranceQuotePropertiesCustomer'
Product:
$ref: '#/components/schemas/AEMotorInsuranceQuotePropertiesProduct'
Transactions:
$ref: '#/components/schemas/AEMotorInsuranceQuotePropertiesTransactions'
additionalProperties: false
AEMotorInsuranceQuoteAddons:
type: object
required:
- DriversPersonalAccident
- PassengersPersonalAccident
properties:
DriversPersonalAccident:
type: string
description: Driver accidental coverage included?
PassengersPersonalAccident:
type: string
description: Passenger accidental coverage included?
additionalProperties: false
AEMotorInsuranceQuoteBackgroundInformation:
type: object
required:
- Gender
- DateOfBirth
- MaritalStatus
- Nationality
- Salutation
properties:
Gender:
type: string
description: Male/Female
DateOfBirth:
type: string
description: dd/mm/yyyy
MaritalStatus:
type: string
description: Married/Single
Nationality:
type: string
description: Select from list
Salutation:
type: string
description: Mr./ Ms./ Mrs./ Dr./ Other
additionalProperties: false
AEMotorInsuranceQuoteClaims:
type: object
required:
- NumberOfClaimsLast12Months
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
additionalProperties: false
AEMotorInsuranceQuoteEmployment:
type: object
required:
- Profession
properties:
Profession:
type: string
description: Free-form
additionalProperties: false
AEMotorInsuranceQuoteIdentification:
type: object
required:
- EidNumber
- EidExpiryDate
- PassportIssueCountry
- PassportNumber
- UaeDrivingLicenseNumber
- UaeDrivingLicenseIssueDate
- UaeDrivingLicenseIssuingEmirate
- MulkiyaCard
- HomeCountryDrivingLicenseNumber
properties:
EidNumber:
type: string
description: Only 15 digits permissible
EidExpiryDate:
type: string
description: dd/mm/yyyy
PassportIssueCountry:
type: string
description: Select from list
PassportNumber:
type: string
description: Only numeric answers allowed
UaeDrivingLicenseNumber:
type: string
description: Only 7 digits permissible
UaeDrivingLicenseIssueDate:
type: string
description: dd/mm/yyyy
UaeDrivingLicenseIssuingEmirate:
type: string
description: Select from drop-down list (e.g., Dubai, Ajman, Abu Dhabi)
MulkiyaCard:
type: string
description: pdf attachment
HomeCountryDrivingLicenseNumber:
type: string
description: Free-form
additionalProperties: false
AEMotorInsuranceQuoteInsuredVehicle:
type: object
required:
- CarMake
- CarModel
- CarModelYear
- CarPurchaseDate
- CarSpecification
- EstimatedValue
- DateOfRegistration
- VehiclePassingCertificate
- DealersQuote
- ChassisNumber
- EngineNumber
- CountryOfOrigin
- VehicleColor
- PlateNumber
- PlateCode
- VehicleMileage
- VehicleWeight
- TrafficCodeIssuingEmirate
- TrafficIdNumber
- VehicleHistory
- DrivingHistory
- FirstTimeRegistration
- VehicleMortgage
properties:
CarMake:
type: string
description: Drop-down list of car makes (e.g., Toyota, Lexus, Honda)
CarModel:
type: string
description: Drop-down list of models based on previous selection
CarModelYear:
type: string
description: Drop-down selections (1900-present year)
CarPurchaseDate:
type: string
description: dd/mm/yyyy
CarSpecification:
type: string
description: Drop-down selections (Light vehicle, truck, etc.)
EstimatedValue:
type: string
description: Only numeric answers allowed (in AED)
DateOfRegistration:
type: string
description: dd/mm/yyyy
VehiclePassingCertificate:
type: string
description: pdf attachment
DealersQuote:
type: string
description: quote from dealer reflecting all costs (out-the-door price)
ChassisNumber:
type: string
description: Only numeric answers allowed
EngineNumber:
type: string
description: Only numeric answers allowed
CountryOfOrigin:
type: string
description: Select from list
VehicleColor:
type: string
description: Select from list
PlateNumber:
type: string
description: Free-form
PlateCode:
type: string
description: Free-form
VehicleMileage:
type: string
description: Only numeric answers allowed (in km)
VehicleWeight:
type: string
description: Only numeric answers allowed (in kg)
TrafficCodeIssuingEmirate:
type: string
description: Select from drop-down list (e.g., Dubai, Ajman, Abu Dhabi)
TrafficIdNumber:
type: string
description: Only numeric answers allowed
VehicleHistory:
type: string
description: Vehicle imported / modified / declared as total loss before
DrivingHistory:
type: string
description: More than 1 year of driving experience
FirstTimeRegistration:
type: string
description: Yes/No
VehicleMortgage:
type: string
description: Pending mortgage amount on the vehicle
additionalProperties: false
AEMotorInsuranceQuoteOtherAdditionalInformation:
type: object
required:
- CylinderCapacity
- EngineCapacity
- VehicleTrim
- EngineSize
- Transmission
- Region
- AgencyRepairYN
- AaaCoverYN
- NoOfPassengersInclDriver
- HomeCountryDrivingExperienceInYears
- VehicleUsage
properties:
CylinderCapacity:
type: string
description: Only numeric answers allowed for e.g. 4,6,8 etc.
EngineCapacity:
type: string
description: Only numeric answers allowed. Mandatory incase of Motor Cycles.
VehicleTrim:
type: string
description: Free-form, Text field
EngineSize:
type: string
description: Free-form, Text field
Transmission:
type: string
description: Free-form, Text field
Region:
type: string
description: Free-form, Text field for e.g. GCC or Non-GCC
AgencyRepairYN:
type: string
description: Selection Yes or No
AaaCoverYN:
type: string
description: Selection Yes or No
NoOfPassengersInclDriver:
type: string
description: Only numeric answers allowed.
HomeCountryDrivingExperienceInYears:
type: string
description: Select from list for e.g. < 2 Years, > 2 Years.
VehicleUsage:
type: string
description: Select from list for e.g. Private Vehicle, Commercial Vehicle
additionalProperties: false
AEMotorInsuranceQuotePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- PolicyLimits
- PolicyExclusions
- CoverageAmount
- CoverageStartDate
- CoverageEndDate
- PolicyRenewalDate1
- PolicyRenewalDate2
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
CoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AEMotorInsuranceQuotePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
additionalProperties: false
AEMotorInsuranceQuoteProperties:
type: object
required:
- QuoteReference
- Customer
- Product
- Transactions
properties:
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
Customer:
$ref: '#/components/schemas/AEMotorInsuranceQuotePropertiesCustomer'
Product:
$ref: '#/components/schemas/AEMotorInsuranceQuotePropertiesProduct'
Transactions:
$ref: '#/components/schemas/AEMotorInsuranceQuotePropertiesTransactions'
additionalProperties: false
AEMotorInsuranceQuotePropertiesCustomer:
type: object
required:
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
ResidentialAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer residential address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
$ref: '#/components/schemas/AEMotorInsuranceQuoteBackgroundInformation'
EmploymentInformation:
$ref: '#/components/schemas/AEMotorInsuranceQuoteEmployment'
IdentityInformation:
$ref: '#/components/schemas/AEMotorInsuranceQuoteIdentification'
additionalProperties: false
AEMotorInsuranceQuotePropertiesProduct:
type: object
properties:
InsuredVehicle:
$ref: '#/components/schemas/AEMotorInsuranceQuoteInsuredVehicle'
Policy:
$ref: '#/components/schemas/AEMotorInsuranceQuotePolicy'
additionalProperties: false
AEMotorInsuranceQuotePropertiesTransactions:
type: object
properties:
Premium:
$ref: '#/components/schemas/AEMotorInsuranceQuotePremium'
Claims:
$ref: '#/components/schemas/AEMotorInsuranceQuoteClaims'
Addons:
$ref: '#/components/schemas/AEMotorInsuranceQuoteAddons'
OtherAdditionalInformation:
$ref: '#/components/schemas/AEMotorInsuranceQuoteOtherAdditionalInformation'
additionalProperties: false
AEMotorInsuranceTransactionData:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- OutstandingPremiumBalance
properties:
PolicyPremiumValue:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Policy premium value
PolicyPremiumPaymentPeriod:
type: string
minLength: 1
maxLength: 35
description: Policy premium payment period as defined by the insurer
OutstandingPremiumBalance:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Outstanding premium balance
TwelveMonthClaimSummary:
allOf:
- $ref: '#/components/schemas/AEInsuranceClaimSummary'
description: Summary of claims in last twelve months
ThirtySixMonthClaimSummary:
allOf:
- $ref: '#/components/schemas/AEInsuranceClaimSummary'
description: Summary of claims in last thirty-six months
Loan:
allOf:
- $ref: '#/components/schemas/AEMotorInsuranceLoanDetails'
description: Loan details
BenefitPayouts:
type: array
items:
$ref: '#/components/schemas/AEMotorInsuranceBenefitPayout'
description: Benefit payout details
Claims:
type: array
items:
$ref: '#/components/schemas/AEInsuranceClaimDetails'
minItems: 1
maxItems: 3
description: >-
Indivdual claim details, maximim of three claims returned in
response. Omit if no claims made
PreviousPolicies:
type: array
items:
$ref: '#/components/schemas/AEMotorInsurancePreviousPolicyDetails'
minItems: 1
maxItems: 2
description: Previous policy details
description: Insurance transaction information
additionalProperties: false
AEMotorInsuranceVehicle:
type: object
properties:
Make:
type: string
minLength: 1
maxLength: 70
description: Vehicle make
Model:
type: string
minLength: 1
maxLength: 140
description: Vehicle model
ModelYear:
type: string
pattern: ^[0-9]{4}$
description: Vehicle model year
PurchaseDate:
type: string
format: date
description: Vehicle purchase date
Specification:
type: string
minLength: 1
maxLength: 140
description: Vehicle specification
EstimatedValue:
type: integer
format: int32
description: Vehicle estimated value
RegistrationDate:
type: string
format: date
description: Vehicle registration date
VehicleIdentificationNumber:
type: string
minLength: 1
maxLength: 35
description: Vehicle Identification Number (VIN or chassis number)
EngineNumber:
type: string
description: Vehicle engine number
CountryofOrigin:
allOf:
- $ref: '#/components/schemas/AEInsuranceCountryCode'
description: Vehicle registration country based on ISO 3166-1 alpha-2 code
Color:
type: string
description: Vehicle color
PlateNumber:
type: string
minLength: 1
maxLength: 16
description: Vehicle plate number
PlateCode:
type: string
minLength: 1
maxLength: 16
description: Vehicle plate code
VehicleMileage:
type: integer
format: int64
description: Vehicle mileage to nearest kilometer
VehicleWeight:
type: integer
format: int64
description: Vehicle weight to nearest kilograms
TrafficCodeIssuingEmirate:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmirate'
description: Emirate that issued the traffic code for the vehicle
TrafficIdentificationNumber:
type: string
minLength: 1
maxLength: 35
description: Traffic identification number
VehicleHistory:
allOf:
- $ref: '#/components/schemas/VehicleHistory'
description: Indicator of vehicle history
FirstTimeRegistration:
type: boolean
description: First time vehicle was registered
VehicleFinance:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Vehicle finance amount and currency
additionalProperties: false
AEOnBehalfOf:
type: object
properties:
TradingName:
type: string
description: Trading Name
LegalName:
type: string
description: Legal Name
IdentifierType:
allOf:
- $ref: '#/components/schemas/AEOnBehalfOfIdentifierType'
description: Identifier Type
Identifier:
type: string
description: Identifier
additionalProperties: false
AEOnBehalfOfIdentifierType:
type: string
enum:
- Other
AEPatchConsentStatus1:
type: string
enum:
- Revoked
AEPatchConsentUpdate:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/AEPatchConsentStatus1'
description: >-
The Revoked status must only be set if the current Consent Status is
set to either Authorized or AwaitingAuthorization
RevokedBy:
allOf:
- $ref: '#/components/schemas/AERevokedByCode'
description: Denotes the Identifier of the revocation.
additionalProperties: false
AEReadEmploymentInsurancePolicy1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEEmploymentInsurancePolicyProperties1'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadEmploymentInsurancePolicy1Signed:
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/AEReadEmploymentInsurancePolicy1'
additionalProperties: false
AEReadEmploymentInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEEmploymentInsuranceQuote'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadEmploymentInsuranceQuote1Signed:
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/AEReadEmploymentInsurancePolicy1'
additionalProperties: false
AEReadHealthInsurancePolicy1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEHealthInsurancePolicyProperties1'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadHealthInsurancePolicy1Signed:
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/AEReadHealthInsurancePolicy1'
additionalProperties: false
AEReadHealthInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEHealthInsuranceQuote'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadHealthInsuranceQuote1Signed:
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/AEReadHealthInsurancePolicy1'
additionalProperties: false
AEReadHomeInsurancePolicy1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEHomeInsurancePolicyProperties1'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadHomeInsurancePolicy1Signed:
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/AEReadHomeInsurancePolicy1'
additionalProperties: false
AEReadHomeInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEHomeInsuranceQuote'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadHomeInsuranceQuote1Signed:
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/AEReadHomeInsurancePolicy1'
additionalProperties: false
AEReadInsuranceConsent1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEReadInsuranceConsent1Properties'
Subscription:
$ref: '#/components/schemas/EventNotification'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadInsuranceConsent1Properties:
type: object
required:
- ConsentId
- Permissions
- ExpirationDateTime
- CreationDateTime
- Status
- StatusUpdateDateTime
properties:
ConsentId:
$ref: '#/components/schemas/uuid'
BaseConsentId:
$ref: '#/components/schemas/uuid'
Permissions:
type: array
items:
$ref: '#/components/schemas/AEConsentPermissions'
minItems: 1
description: >
Specifies the permitted insurance policy data types.
This is a list of the data groups being consented by the User, and
requested for authorization with the LFI.
The data clusters use a consistent pattern across each insurance
type:
* Policies: Allows the policies to be listed, with limited
information.
* CustomerBasic: Customer information such as name, address, and
contact details.
* CustomerDetail: Customer identity information such as Emirates ID.
* CustomerPaymentDetails: The payment details a customer uses to pay
their policy
* Product: The attributes of the insurance product provided under
the policy.
* Transactions: Details of the transactions such as premium payments
and claims.
* Quote: All information required to generate a quote.
ExpirationDateTime:
type: string
format: date-time
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/AEOnBehalfOf'
Purpose:
type: array
items:
$ref: '#/components/schemas/AEConsentPurpose'
CreationDateTime:
type: string
format: date-time
description: >-
Date and time at which the resource was created. All dates in the
JSON payloads are represented in ISO 8601 date-time format.
All date-time fields in responses must include the timezone, as
shown in this example: 2017-04-05T10:43:07+00:00
Status:
allOf:
- $ref: '#/components/schemas/AEConsentStatusCode'
description: Specifies the status of consent resource in code form.
StatusUpdateDateTime:
type: string
format: date-time
description: >-
Date and time at which the account resource status was updated. All
dates in the JSON payloads are represented in ISO 8601 date-time
format.
All date-time fields in responses must include the timezone, as
shown in this example: 2017-04-05T10:43:07+00:00
RevokedBy:
allOf:
- $ref: '#/components/schemas/AERevokedByCode'
description: Denotes the Identifier of the revocation.
additionalProperties: false
AEReadInsuranceConsent1Signed:
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/AEReadInsuranceConsent1'
additionalProperties: false
AEReadInsuranceConsents1:
type: object
required:
- Data
- Links
properties:
Data:
type: array
items:
$ref: '#/components/schemas/AEReadInsuranceConsent1Properties'
Links:
$ref: '#/components/schemas/LinksResource'
additionalProperties: false
AEReadInsuranceConsents1Signed:
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/AEReadInsuranceConsents1'
additionalProperties: false
AEReadInsurancePolicies1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEInsurancePolicies1'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadLifeInsurancePolicy1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AELifeInsurancePolicyProperties1'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadLifeInsurancePolicy1Signed:
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/AEReadLifeInsurancePolicy1'
additionalProperties: false
AEReadLifeInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AELifeInsuranceQuote'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadLifeInsuranceQuote1Signed:
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/AEReadLifeInsurancePolicy1'
additionalProperties: false
AEReadMotorInsurancePolicy1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEMotorInsurancePolicyProperties1'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadMotorInsurancePolicy1Signed:
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/AEReadMotorInsurancePolicy1'
additionalProperties: false
AEReadMotorInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEMotorInsuranceQuote'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadMotorInsuranceQuote1Signed:
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/AEReadMotorInsurancePolicy1'
additionalProperties: false
AEReadPaymentDetails1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AEInsurancePaymentDetails'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadPaymentDetails1Signed:
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/AEReadPaymentDetails1'
additionalProperties: false
AEReadRentersInsurancePolicy1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AERentersInsurancePolicyProperties1'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadRentersInsurancePolicy1Signed:
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/AEReadRentersInsurancePolicy1'
additionalProperties: false
AEReadRentersInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AERentersInsuranceQuote'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadRentersInsuranceQuote1Signed:
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/AEReadRentersInsurancePolicy1'
additionalProperties: false
AEReadTravelInsurancePolicy1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AETravelInsurancePolicyProperties1'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadTravelInsurancePolicy1Signed:
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/AEReadTravelInsurancePolicy1'
additionalProperties: false
AEReadTravelInsuranceQuote1:
type: object
required:
- Data
- Links
- Meta
properties:
Data:
$ref: '#/components/schemas/AETravelInsuranceQuote'
Links:
$ref: '#/components/schemas/LinksSelf'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEReadTravelInsuranceQuote1Signed:
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/AEReadTravelInsurancePolicy1'
additionalProperties: false
AERentersInsuranceClaims:
type: object
required:
- NumberOfClaimsLast12Months
- NumberOfApprovedClaimsLast12Months
- TotalValueOfClaimsLast12Months
- TotalValueOfApprovedClaimsLast12Months
- NumberOfClaimsLast36Months
- NumberOfApprovedClaimsLast36Months
- TotalValueOfClaimsLast36Months
- TotalValueOfApprovedClaimsLast36Months
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
NumberOfClaimsLast36Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AERentersInsuranceCustomerData:
type: object
required:
- CustomerId
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
Communication:
$ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
InsuredPropertyInformation:
$ref: '#/components/schemas/AERentersInsuranceInsuredPropertyInformation'
InsuredPropertyDetails:
$ref: '#/components/schemas/AERentersInsurancePropertyDetails'
InsuredPropertyContents:
$ref: '#/components/schemas/AERentersInsurancePropertyContents'
HighValueFurnitureItems:
$ref: '#/components/schemas/AERentersInsuranceHighValueFurnitureItems'
HighValueElectronics:
$ref: '#/components/schemas/AERentersInsuranceHighValueElectronics'
HighValueJewelry:
$ref: '#/components/schemas/AERentersInsuranceHighValueJewelry'
HighValueAppliances:
$ref: '#/components/schemas/AERentersInsuranceHighValueAppliances'
OtherHighValueItems:
$ref: '#/components/schemas/AERentersInsuranceOtherHighValueItems'
additionalProperties: false
AERentersInsuranceEmergencyContacts:
type: object
required:
- EmergencyContact1Name
- EmergencyContact1Relationship
- EmergencyContact1PhoneNumber
- EmergencyContact1EmailAddress
properties:
EmergencyContact1Name:
type: string
description: Free-form
EmergencyContact1Relationship:
type: string
description: Free-form
EmergencyContact1PhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
EmergencyContact1EmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
additionalProperties: false
AERentersInsuranceHighValueAppliances:
type: object
required:
- DetailedInventoryOfAppliances
- ValueOfAppliances
- PhotographicOrDocumentaryEvidenceOfAppliances
- ReceiptsProofOfPurchaseForAppliances
- DetailedInventoryOfAntiques
- ValueOfAntiques
- LatestAppraisalReports
- PhotographicOrDocumentaryEvidenceOfAntiques
- ReceiptsProofOfPurchaseForAntiques
- DetailedInventoryOfArt
- ValueOfArt
- LatestAppraisalReports_0
- PhotographicOrDocumentaryEvidenceOfArt
- ReceiptsProofOfPurchaseForArt
properties:
DetailedInventoryOfAppliances:
type: string
description: >-
Free-form (applicants instructed to list as much detail as possible,
including makes, models, and serial numbers if applicable)
ValueOfAppliances:
type: string
description: Only numeric answers allowed (in AED)
PhotographicOrDocumentaryEvidenceOfAppliances:
type: string
description: pdf, jpg attachments
ReceiptsProofOfPurchaseForAppliances:
type: string
description: pdf, jpg attachments
DetailedInventoryOfAntiques:
type: string
description: >-
Free-form (applicants instructed to list as much detail as possible,
including makes, models, and serial numbers if applicable)
ValueOfAntiques:
type: string
description: Only numeric answers allowed (in AED)
LatestAppraisalReports:
type: string
description: pdf
PhotographicOrDocumentaryEvidenceOfAntiques:
type: string
description: pdf, jpg attachments
ReceiptsProofOfPurchaseForAntiques:
type: string
description: pdf, jpg attachments
DetailedInventoryOfArt:
type: string
description: >-
Free-form (applicants instructed to list as much detail as possible,
including makes, models, and serial numbers if applicable)
ValueOfArt:
type: string
description: Only numeric answers allowed (in AED)
LatestAppraisalReports_0:
type: string
description: pdf
PhotographicOrDocumentaryEvidenceOfArt:
type: string
description: pdf, jpg attachments
ReceiptsProofOfPurchaseForArt:
type: string
description: pdf, jpg attachments
additionalProperties: false
AERentersInsuranceHighValueElectronics:
type: object
required:
- DetailedInventoryOfElectronics
- ValueOfElectronics
- PhotographicOrDocumentaryEvidenceOfElectronics
- ReceiptsProofOfPurchaseForElectronics
properties:
DetailedInventoryOfElectronics:
type: string
description: >-
Free-form (applicants instructed to list as much detail as possible,
including makes, models, and serial numbers if applicable)
ValueOfElectronics:
type: string
description: Only numeric answers allowed (in AED)
PhotographicOrDocumentaryEvidenceOfElectronics:
type: string
description: pdf, jpg attachments
ReceiptsProofOfPurchaseForElectronics:
type: string
description: pdf, jpg attachments
additionalProperties: false
AERentersInsuranceHighValueFurnitureItems:
type: object
required:
- DetailedInventoryOfFurnitureItems
- ValueOfFurnitureItems
- PhotographicOrDocumentaryEvidenceOfFurnitureItems
- ReceiptsProofOfPurchaseForFurnitureItems
properties:
DetailedInventoryOfFurnitureItems:
type: string
description: >-
Free-form (applicants instructed to list as much detail as possible,
including makes, models, and serial numbers if applicable)
ValueOfFurnitureItems:
type: string
description: Only numeric answers allowed (in AED)
PhotographicOrDocumentaryEvidenceOfFurnitureItems:
type: string
description: pdf, jpg attachments
ReceiptsProofOfPurchaseForFurnitureItems:
type: string
description: pdf, jpg attachments
additionalProperties: false
AERentersInsuranceHighValueJewelry:
type: object
required:
- DetailedInventoryOfJewelry
- ValueOfJewelry
- PhotographicOrDocumentaryEvidenceOfJewelry
- ReceiptsProofOfPurchaseForJewelry
properties:
DetailedInventoryOfJewelry:
type: string
description: >-
Free-form (applicants instructed to list as much detail as possible,
including makes, models, and serial numbers if applicable)
ValueOfJewelry:
type: string
description: Only numeric answers allowed (in AED)
PhotographicOrDocumentaryEvidenceOfJewelry:
type: string
description: pdf, jpg attachments
ReceiptsProofOfPurchaseForJewelry:
type: string
description: pdf, jpg attachments
additionalProperties: false
AERentersInsuranceInsuredPropertyInformation:
type: object
required:
- AddressLine1
- AddressLine2
- AddressLine3
- PostalCode
- Country
- StateEmirate
- City
properties:
AddressLine1:
type: string
description: Free-form
AddressLine2:
type: string
description: Free-form
AddressLine3:
type: string
description: Free-form
PostalCode:
type: string
description: Only numeric answers allowed
Country:
type: string
description: Select from list
StateEmirate:
type: string
description: Select from list generated based on previous selection
City:
type: string
description: Select from list generated based on previous selection
additionalProperties: false
AERentersInsuranceOtherData:
type: object
properties:
EmergencyContacts:
$ref: '#/components/schemas/AERentersInsuranceEmergencyContacts'
additionalProperties: false
AERentersInsuranceOtherHighValueItems:
type: object
required:
- DetailedInventoryOfOtherItems
- ValueOfOtherItems
- PhotographicOrDocumentaryEvidenceOfOtherItems
- ReceiptsProofOfPurchaseForOtherItems
properties:
DetailedInventoryOfOtherItems:
type: string
description: >-
Free-form (applicants instructed to list as much detail as possible,
including makes, models, and serial numbers if applicable)
ValueOfOtherItems:
type: string
description: Only numeric answers allowed (in AED)
PhotographicOrDocumentaryEvidenceOfOtherItems:
type: string
description: pdf, jpg attachments
ReceiptsProofOfPurchaseForOtherItems:
type: string
description: pdf, jpg attachments
additionalProperties: false
AERentersInsurancePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- AdditionalCoverageOptions
- PolicyLimits
- PolicyExclusions
- BuildingCoverageAmount
- ContentsCoverageAmount
- CoverageStartDate
- CoverageEndDate
- PolicyRenewalDate1
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Building Insurance, Contents
Insurance, Both)
AdditionalCoverageOptions:
type: string
description: >-
Select from drop-down list (e.g., Accidental Damage, Personal
Belongings Outside Home, Alternative Accomodation)
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
BuildingCoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
ContentsCoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AERentersInsurancePolicyProperties1:
type: object
required:
- InsurancePolicyId
properties:
InsurancePolicyId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given insurance policy
Customer:
$ref: '#/components/schemas/AERentersInsuranceCustomerData'
Product:
$ref: '#/components/schemas/AERentersInsuranceProductData'
Transactions:
$ref: '#/components/schemas/AERentersInsuranceTransactionData'
Other:
$ref: '#/components/schemas/AERentersInsuranceOtherData'
additionalProperties: false
AERentersInsurancePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AERentersInsurancePreviousPolicies:
type: object
required:
- PreviousInsuranceCompany1
- PreviousPolicyId1
- PremiumAmount
- DeductibleAmountIfAny
- CoverageType
properties:
PreviousInsuranceCompany1:
type: string
description: Free-form
PreviousPolicyId1:
type: string
description: Depends on insurance company
PremiumAmount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
additionalProperties: false
AERentersInsuranceProductData:
type: object
properties:
Policy:
$ref: '#/components/schemas/AERentersInsurancePolicy'
additionalProperties: false
AERentersInsurancePropertyContents:
type: object
required:
- TotalEstimatedValueOfPersonalContentsInRentalProperty
properties:
TotalEstimatedValueOfPersonalContentsInRentalProperty:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AERentersInsurancePropertyDetails:
type: object
required:
- TypeOfHome
- UsageByApplicant
- LeaseStartDate
- LeaseEndDate
- AnnualRentPayment
- LandlordPropertyManagementCompanyName
- LandlordPropertyManagementCompanyPhoneNumber
- NumberOfCurrentOccupants
- FurnishingStatusAtLeaseStartDate
- PropertyCondition
- YearOfConstruction
- NumberOfFloors
- TotalBuiltupArea
- NumberOfBedrooms
- NumberOfBathrooms
- ConstructionType
- RoofType
- FoundationType
- ExteriorWalls
- AdditionalStructuresSelectAllThatAreApplicable
- PresenceOfBasement
- PresenceOfAttic
- TypeOfHeatingSystem
- AgeOfHeatingSystem
- TypeOfCoolingSystem
- AgeOfCoolingSystem
- PropertySafetyAndSecurityFeatures
- DistanceFromShoreline
- DistanceAboveSeaLevel
- InDesignatedFloodZone
- WaterLeakDetectionSystems
- BurglarAlarm
- SurveillanceCameras
- DoorCamera
- SecurityGuards
- SmokeDetectors
- FireExtinguishers
- SprinklerSystem
- DeadboltLocks
- WindowLocks
properties:
TypeOfHome:
type: string
description: >-
Select from a list of options (e.g., Apartment, Villa, Townhouse,
Other)
UsageByApplicant:
type: string
description: >-
Select from a list of options (e.g., Primary Residence, Secondary
Residence, Other)
LeaseStartDate:
type: string
description: dd/mm/yyyy
LeaseEndDate:
type: string
description: dd/mm/yyyy
AnnualRentPayment:
type: string
description: Only numeric answers allowed (in AED)
LandlordPropertyManagementCompanyName:
type: string
description: Free-form
LandlordPropertyManagementCompanyPhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
NumberOfCurrentOccupants:
type: string
description: Only numeric answers allowed
FurnishingStatusAtLeaseStartDate:
type: string
description: >-
Select from a list of options (e.g., Furnished, Unfurnished,
Semi-Furnished)
PropertyCondition:
type: string
description: >-
Select from a list of options (e.g., Excellent, Good, Fair, Poor) -
verified by insurance company
YearOfConstruction:
type: string
description: Drop-down selections (1900-present year)
NumberOfFloors:
type: string
description: Only numeric answers allowed
TotalBuiltupArea:
type: string
description: Only numeric answers allowed (in sqm)
NumberOfBedrooms:
type: string
description: Only numeric answers allowed
NumberOfBathrooms:
type: string
description: Only numeric answers allowed
ConstructionType:
type: string
description: Select from a list of options (e.g., Concrete, Wood, Mixed, Other)
RoofType:
type: string
description: Select from a list of options (e.g., Tile, Shingle, Metal)
FoundationType:
type: string
description: Select from a list of options (e.g., Slab, Crawl Space, Basement)
ExteriorWalls:
type: string
description: >-
Select from a list of options (e.g., Brick, Stone, Concrete, Stucco,
Wood)
AdditionalStructuresSelectAllThatAreApplicable:
type: string
description: Select from a list of options (e.g., Garage, Shed, Pool)
PresenceOfBasement:
type: string
description: Yes/No
PresenceOfAttic:
type: string
description: Yes/No
TypeOfHeatingSystem:
type: string
description: Select from a list of options (e.g., Gas, Electric, Oil)
AgeOfHeatingSystem:
type: string
description: Only numeric answers allowed (in years)
TypeOfCoolingSystem:
type: string
description: >-
Select from a list of options (e.g., Central, Window, Portable,
Other)
AgeOfCoolingSystem:
type: string
description: Only numeric answers allowed (in years)
PropertySafetyAndSecurityFeatures:
type: string
description: X
DistanceFromShoreline:
type: string
description: Only numeric answers allowed (in km)
DistanceAboveSeaLevel:
type: string
description: Only numeric answers allowed (in m)
InDesignatedFloodZone:
type: string
description: Yes/No
WaterLeakDetectionSystems:
type: string
description: Yes/No
BurglarAlarm:
type: string
description: Yes/No
SurveillanceCameras:
type: string
description: Yes/No
DoorCamera:
type: string
description: Yes/No
SecurityGuards:
type: string
description: Yes/No
SmokeDetectors:
type: string
description: Yes/No
FireExtinguishers:
type: string
description: Yes/No
SprinklerSystem:
type: string
description: Yes/No
DeadboltLocks:
type: string
description: Yes/No
WindowLocks:
type: string
description: Yes/No
additionalProperties: false
AERentersInsuranceQuote:
type: object
required:
- QuoteId
- QuoteReference
- status
- Customer
- Product
- Transactions
- Other
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
status:
$ref: '#/components/schemas/AEInsuranceQuoteStatusCodes'
Customer:
$ref: '#/components/schemas/AERentersInsuranceQuoteCustomerData'
Product:
$ref: '#/components/schemas/AERentersInsuranceQuoteProductData'
Transactions:
$ref: '#/components/schemas/AERentersInsuranceQuoteTransactionData'
Other:
$ref: '#/components/schemas/AERentersInsuranceQuoteOtherData'
additionalProperties: false
AERentersInsuranceQuoteClaims:
type: object
required:
- NumberOfClaimsLast12Months
- NumberOfApprovedClaimsLast12Months
- TotalValueOfClaimsLast12Months
- TotalValueOfApprovedClaimsLast12Months
- NumberOfClaimsLast36Months
- NumberOfApprovedClaimsLast36Months
- TotalValueOfClaimsLast36Months
- TotalValueOfApprovedClaimsLast36Months
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
properties:
NumberOfClaimsLast12Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast12Months:
type: string
description: Only numeric answers allowed (in AED)
NumberOfClaimsLast36Months:
type: string
description: Only numeric answers allowed
NumberOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed
TotalValueOfClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
TotalValueOfApprovedClaimsLast36Months:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AERentersInsuranceQuoteCustomerData:
type: object
required:
- CustomerId
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
Communication:
$ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
InsuredPropertyInformation:
$ref: '#/components/schemas/AERentersInsuranceInsuredPropertyInformation'
InsuredPropertyDetails:
$ref: '#/components/schemas/AERentersInsurancePropertyDetails'
additionalProperties: false
AERentersInsuranceQuoteEmergencyContacts:
type: object
required:
- EmergencyContact1Name
- EmergencyContact1Relationship
- EmergencyContact1PhoneNumber
- EmergencyContact1EmailAddress
properties:
EmergencyContact1Name:
type: string
description: Free-form
EmergencyContact1Relationship:
type: string
description: Free-form
EmergencyContact1PhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
EmergencyContact1EmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
additionalProperties: false
AERentersInsuranceQuoteOtherData:
type: object
properties:
EmergencyContacts:
$ref: '#/components/schemas/AERentersInsuranceQuoteEmergencyContacts'
additionalProperties: false
AERentersInsuranceQuotePolicy:
type: object
required:
- PolicyNumber
- PolicyIssueDate
- PolicyExpiryDate
- CoverageType
- AdditionalCoverageOptions
- PolicyLimits
- PolicyExclusions
- BuildingCoverageAmount
- ContentsCoverageAmount
- CoverageStartDate
- CoverageEndDate
- PolicyRenewalDate1
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- PreviousPolicyInsurer
- PreviousPolicyStartDate
- PreviousPolicyExpiryDate
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
PolicyIssueDate:
type: string
description: dd/mm/yyyy
PolicyExpiryDate:
type: string
description: dd/mm/yyyy
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Building Insurance, Contents
Insurance, Both)
AdditionalCoverageOptions:
type: string
description: >-
Select from drop-down list (e.g., Accidental Damage, Personal
Belongings Outside Home, Alternative Accomodation)
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
BuildingCoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
ContentsCoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
PreviousPolicyInsurer:
type: string
description: Free-form
PreviousPolicyStartDate:
type: string
description: dd/mm/yyyy
PreviousPolicyExpiryDate:
type: string
description: dd/mm/yyyy
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AERentersInsuranceQuotePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: Select from drop-down list (e.g., Monthly, Bi-annually, Annually)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AERentersInsuranceQuotePreviousPolicies:
type: object
required:
- PreviousInsuranceCompany1
- PreviousPolicyId1
- PremiumAmount
- DeductibleAmountIfAny
- CoverageType
properties:
PreviousInsuranceCompany1:
type: string
description: Free-form
PreviousPolicyId1:
type: string
description: Depends on insurance company
PremiumAmount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
additionalProperties: false
AERentersInsuranceQuoteProductData:
type: object
properties:
Policy:
$ref: '#/components/schemas/AERentersInsuranceQuotePolicy'
additionalProperties: false
AERentersInsuranceQuoteTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AERentersInsuranceQuotePremium'
Claims:
$ref: '#/components/schemas/AERentersInsuranceQuoteClaims'
PreviousPolicies:
$ref: '#/components/schemas/AERentersInsuranceQuotePreviousPolicies'
additionalProperties: false
AERentersInsuranceTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AERentersInsurancePremium'
Claims:
$ref: '#/components/schemas/AERentersInsuranceClaims'
PreviousPolicies:
$ref: '#/components/schemas/AERentersInsurancePreviousPolicies'
additionalProperties: false
AERevokedByCode:
type: string
enum:
- LFI
- TPP
- LFI.InitiatedByUser
- TPP.InitiatedByUser
AETravelInsuranceBenefitPayouts:
type: object
required:
- BenefitPayoutDate1
- BenefitPayoutAmount1
- BenefitPayoutDate2
- BenefitPayoutAmount2
properties:
BenefitPayoutDate1:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AETravelInsuranceClaims:
type: object
required:
- TotalNumberOfClaims
- TotalNumberOfApprovedClaims
- TotalValueOfApprovedClaims
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
- Claim2Date
- Claim2DescriptionIeServicesClaimed
- Claim2Status
- Claim2Amount
- DeductibleAmount2
- Claim3Date
- Claim3DescriptionIeServicesClaimed
- Claim3Status
- Claim3Amount
- DeductibleAmount3
properties:
TotalNumberOfClaims:
type: string
description: Only numeric answers allowed
TotalNumberOfApprovedClaims:
type: string
description: Only numeric answers allowed
TotalValueOfApprovedClaims:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
Claim2Date:
type: string
description: dd/mm/yyyy
Claim2DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim2Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim2Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount2:
type: string
description: Only numeric answers allowed (in AED)
Claim3Date:
type: string
description: dd/mm/yyyy
Claim3DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim3Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim3Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount3:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AETravelInsuranceCompanions:
type: object
required:
- NumberOfTravelCompanions
- CompanionsFullNamesIfCoverageExtendsToThem
- CompanionsDateOfBirth
- RelationshipToTheApplicant
properties:
NumberOfTravelCompanions:
type: string
description: Only numeric answers allowed
CompanionsFullNamesIfCoverageExtendsToThem:
type: string
description: Free-form
CompanionsDateOfBirth:
type: string
description: dd/mm/yyyy
RelationshipToTheApplicant:
type: string
description: Free-form
additionalProperties: false
AETravelInsuranceCoverage:
type: object
required:
- PolicyNumber
- CoverageType
- CoverageLevel
- PolicyLimits
- PolicyExclusions
- CoverageAmount
- CoverageStartDate
- CoverageEndDate
- AdditionalCoverageOptions
- PolicyRenewalDate1
- PolicyRenewalDate2
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- PolicyAdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
CoverageType:
type: string
description: Select from drop-down list (e.g., Single Trip, Multi-Trip)
CoverageLevel:
type: string
description: >-
Select from drop-down list (e.g., Basic, Comrehensive, Premium) -
may vary by insurance company
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
CoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
AdditionalCoverageOptions:
type: string
description: >-
Select from drop-down list (e.g., Adventure Sports, Rental Car
Coverage, Trip Cancellation, Trip Interruption) - may vary by
insurance company
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
PolicyAdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
additionalProperties: false
AETravelInsuranceCustomerData:
type: object
required:
- CustomerId
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
ResidentialAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer residential address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceEmploymentDetails'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
additionalProperties: false
AETravelInsuranceEmergencyContacts:
type: object
required:
- EmergencyContact1Name
- EmergencyContact1Relationship
- EmergencyContact1PhoneNumber
- EmergencyContact1EmailAddress
properties:
EmergencyContact1Name:
type: string
description: Free-form
EmergencyContact1Relationship:
type: string
description: Free-form
EmergencyContact1PhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
EmergencyContact1EmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
additionalProperties: false
AETravelInsuranceOtherAdditionalInformation:
type: object
required:
- PassportUploadForInsuredAndDependents
- DependentsNationality
properties:
PassportUploadForInsuredAndDependents:
type: string
description: Document upload field
DependentsNationality:
type: string
description: Select from drop-down list
additionalProperties: false
AETravelInsuranceOtherData:
type: object
properties:
EmergencyContacts:
$ref: '#/components/schemas/AETravelInsuranceEmergencyContacts'
OtherAdditionalInformation:
$ref: '#/components/schemas/AETravelInsuranceOtherAdditionalInformation'
additionalProperties: false
AETravelInsurancePolicyProperties1:
type: object
required:
- InsurancePolicyId
properties:
InsurancePolicyId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given insurance policy
Customer:
$ref: '#/components/schemas/AETravelInsuranceCustomerData'
Product:
$ref: '#/components/schemas/AETravelInsuranceProductData'
Transactions:
$ref: '#/components/schemas/AETravelInsuranceTransactionData'
Other:
$ref: '#/components/schemas/AETravelInsuranceOtherData'
additionalProperties: false
AETravelInsurancePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: >-
Select from drop-down list (e.g., One-Time Payment, Monthly
Installments)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AETravelInsurancePreviousCoverage:
type: object
required:
- HaveYouEverHadTravelInsuranceBefore
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
HaveYouEverHadTravelInsuranceBefore:
type: string
description: Yes/No
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AETravelInsurancePreviousPolicies:
type: object
required:
- PreviousInsuranceCompany1
- PreviousPolicyId1
- PurchaseDate
- RenewalDate1
- RenewalDate2
- PremiumAmount
- DeductibleAmountIfAny
- CoverageType
- AdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- AdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- ReasonForAdjustment2IfAny
- LoanDateIfApplicable
- LoanAmountIfApplicable
- InterestRateIfApplicable
- RepaymentScheduleIfApplicable
- OutstandingLoanBalanceIfApplicable
- BenefitPayoutDate1
- BenefitPayoutAmount1
- BenefitPayoutDate2
- BenefitPayoutAmount2
- TerminationDate
- ReasonForCancellation
- RefundAmountIfAny
- SurrenderDateIfApplicable
- SurrenderAmountIfApplicable
- ReasonForSurrender
- CashValueOfPolicyPaidToPolicyholder
- TerminationDate_0
- ReasonForCancellation_0
- RefundAmountIfAny_0
properties:
PreviousInsuranceCompany1:
type: string
description: Free-form
PreviousPolicyId1:
type: string
description: Depends on insurance company
PurchaseDate:
type: string
description: dd/mm/yyyy
RenewalDate1:
type: string
description: dd/mm/yyyy
RenewalDate2:
type: string
description: dd/mm/yyyy
PremiumAmount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
AdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
AdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
ReasonForAdjustment2IfAny:
type: string
description: Free-form
LoanDateIfApplicable:
type: string
description: dd/mm/yyyy
LoanAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
InterestRateIfApplicable:
type: string
description: Only numeric answers allowed (%)
RepaymentScheduleIfApplicable:
type: string
description: Only numeric answers allowed (in years)
OutstandingLoanBalanceIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate1:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2:
type: string
description: Only numeric answers allowed (in AED)
TerminationDate:
type: string
description: dd/mm/yyyy
ReasonForCancellation:
type: string
description: Free-form
RefundAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
SurrenderDateIfApplicable:
type: string
description: dd/mm/yyyy
SurrenderAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
ReasonForSurrender:
type: string
description: Free-form
CashValueOfPolicyPaidToPolicyholder:
type: string
description: Only numeric answers allowed (in AED)
TerminationDate_0:
type: string
description: dd/mm/yyyy
ReasonForCancellation_0:
type: string
description: Free-form
RefundAmountIfAny_0:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AETravelInsuranceProductData:
type: object
properties:
TravelDetails:
$ref: '#/components/schemas/AETravelInsuranceTravelDetails'
Coverage:
$ref: '#/components/schemas/AETravelInsuranceCoverage'
PreviousCoverage:
$ref: '#/components/schemas/AETravelInsurancePreviousCoverage'
Companions:
$ref: '#/components/schemas/AETravelInsuranceCompanions'
additionalProperties: false
AETravelInsuranceQuote:
type: object
required:
- QuoteId
- QuoteReference
- status
- Customer
- Product
- Transactions
- Other
properties:
QuoteId:
allOf:
- $ref: '#/components/schemas/uuid'
description: Unique identifier for a given quote
QuoteReference:
allOf:
- $ref: '#/components/schemas/uuid'
description: >-
A unique reference provided by the TPP that allows correlation of
quote responses
across LFIs
status:
$ref: '#/components/schemas/AEInsuranceQuoteStatusCodes'
Customer:
$ref: '#/components/schemas/AETravelInsuranceQuoteCustomerData'
Product:
$ref: '#/components/schemas/AETravelInsuranceQuoteProductData'
Transactions:
$ref: '#/components/schemas/AETravelInsuranceQuoteTransactionData'
Other:
$ref: '#/components/schemas/AETravelInsuranceQuoteOtherData'
additionalProperties: false
AETravelInsuranceQuoteBenefitPayouts:
type: object
required:
- BenefitPayoutDate1
- BenefitPayoutAmount1
- BenefitPayoutDate2
- BenefitPayoutAmount2
properties:
BenefitPayoutDate1:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AETravelInsuranceQuoteClaims:
type: object
required:
- TotalNumberOfClaims
- TotalNumberOfApprovedClaims
- TotalValueOfApprovedClaims
- Claim1Date
- Claim1DescriptionIeServicesClaimed
- Claim1Status
- Claim1Amount
- DeductibleAmount1
- Claim2Date
- Claim2DescriptionIeServicesClaimed
- Claim2Status
- Claim2Amount
- DeductibleAmount2
- Claim3Date
- Claim3DescriptionIeServicesClaimed
- Claim3Status
- Claim3Amount
- DeductibleAmount3
properties:
TotalNumberOfClaims:
type: string
description: Only numeric answers allowed
TotalNumberOfApprovedClaims:
type: string
description: Only numeric answers allowed
TotalValueOfApprovedClaims:
type: string
description: Only numeric answers allowed (in AED)
Claim1Date:
type: string
description: dd/mm/yyyy
Claim1DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim1Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim1Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount1:
type: string
description: Only numeric answers allowed (in AED)
Claim2Date:
type: string
description: dd/mm/yyyy
Claim2DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim2Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim2Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount2:
type: string
description: Only numeric answers allowed (in AED)
Claim3Date:
type: string
description: dd/mm/yyyy
Claim3DescriptionIeServicesClaimed:
type: string
description: Free-form
Claim3Status:
type: string
description: Select from drop-down list (e.g., Submitted, Pending, Complete)
Claim3Amount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmount3:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AETravelInsuranceQuoteCompanions:
type: object
required:
- NumberOfTravelCompanions
- CompanionsFullNamesIfCoverageExtendsToThem
- CompanionsDateOfBirth
- RelationshipToTheApplicant
properties:
NumberOfTravelCompanions:
type: string
description: Only numeric answers allowed
CompanionsFullNamesIfCoverageExtendsToThem:
type: string
description: Free-form
CompanionsDateOfBirth:
type: string
description: dd/mm/yyyy
RelationshipToTheApplicant:
type: string
description: Free-form
additionalProperties: false
AETravelInsuranceQuoteCoverage:
type: object
required:
- PolicyNumber
- CoverageType
- CoverageLevel
- PolicyLimits
- PolicyExclusions
- CoverageAmount
- CoverageStartDate
- CoverageEndDate
- AdditionalCoverageOptions
- PolicyRenewalDate1
- PolicyRenewalDate2
- PolicyAdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
properties:
PolicyNumber:
type: string
description: Only numeric answers allowed
CoverageType:
type: string
description: Select from drop-down list (e.g., Single Trip, Multi-Trip)
CoverageLevel:
type: string
description: >-
Select from drop-down list (e.g., Basic, Comrehensive, Premium) -
may vary by insurance company
PolicyLimits:
type: string
description: Free-form
PolicyExclusions:
type: string
description: Free-form
CoverageAmount:
type: string
description: Only numeric answers allowed (in AED)
CoverageStartDate:
type: string
description: dd/mm/yyyy
CoverageEndDate:
type: string
description: dd/mm/yyyy
AdditionalCoverageOptions:
type: string
description: >-
Select from drop-down list (e.g., Adventure Sports, Rental Car
Coverage, Trip Cancellation, Trip Interruption) - may vary by
insurance company
PolicyRenewalDate1:
type: string
description: dd/mm/yyyy
PolicyRenewalDate2:
type: string
description: dd/mm/yyyy
PolicyAdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
additionalProperties: false
AETravelInsuranceQuoteCustomerData:
type: object
required:
- CustomerId
- FullName
- PrimaryLanguage
- CommunicationPreferences
properties:
CustomerId:
type: string
description: >-
Identifier that uniquely and consistently identifies the insurance
policy customer
FullName:
type: string
description: Full name of the insurance policy customer
ShortName:
type: string
description: Short name of the insurance policy customer
CategorySegment:
type: string
description: Customer category or segment, as defined by the insurance company
LocalBranch:
type: string
description: Local branch, as defined by the insurance company
PrimaryLanguage:
$ref: '#/components/schemas/AECustomerPrimaryLanguage'
BillingAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer billing address
PermanentAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer permanent address
ResidentialAddress:
allOf:
- $ref: '#/components/schemas/AEInsuranceAddress'
description: Customer residential address
CommunicationPreferences:
allOf:
- $ref: '#/components/schemas/AEInsuranceCommunicationPreferences'
description: Customer phone and email communication preferences
BackgroundInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceCustomerBackgroundInformation'
description: Customer background information
EmploymentInformation:
allOf:
- $ref: '#/components/schemas/AETravelInsuranceQuoteEmployment'
description: Customer employment details
IdentityInformation:
allOf:
- $ref: '#/components/schemas/AEInsuranceIdentificationDetails'
description: Customer identification information
additionalProperties: false
AETravelInsuranceQuoteEmergencyContacts:
type: object
required:
- EmergencyContact1Name
- EmergencyContact1Relationship
- EmergencyContact1PhoneNumber
- EmergencyContact1EmailAddress
properties:
EmergencyContact1Name:
type: string
description: Free-form
EmergencyContact1Relationship:
type: string
description: Free-form
EmergencyContact1PhoneNumber:
type: string
description: Area code selection option and 9-10 additional digits permissible
EmergencyContact1EmailAddress:
type: string
description: Must be a valid email address (i.e., include @ followed by domain)
additionalProperties: false
AETravelInsuranceQuoteEmployment:
type: object
required:
- Profession
- ProfessionDescription
- NatureOfBusiness
- Designation
properties:
Profession:
type: string
description: Free-form
ProfessionDescription:
type: string
description: Free-form
NatureOfBusiness:
type: string
description: Select from list of categories (e.g., Law, Finance, Medicine)
Designation:
type: string
description: Free-form
additionalProperties: false
AETravelInsuranceQuoteOtherData:
type: object
properties:
EmergencyContacts:
$ref: '#/components/schemas/AETravelInsuranceQuoteEmergencyContacts'
additionalProperties: false
AETravelInsuranceQuotePremium:
type: object
required:
- PolicyPremiumValue
- PolicyPremiumPaymentPeriod
- PremiumPaymentRecords
- OutstandingBalances
properties:
PolicyPremiumValue:
type: string
description: Only numeric answers allowed (in AED)
PolicyPremiumPaymentPeriod:
type: string
description: >-
Select from drop-down list (e.g., One-Time Payment, Monthly
Installments)
PremiumPaymentRecords:
type: string
description: pdf attachment (incl., payment dates, amount and method)
OutstandingBalances:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AETravelInsuranceQuotePreviousCoverage:
type: object
required:
- HaveYouEverHadTravelInsuranceBefore
- AnyPreviousClaims
- IfYesProvideAmountAndDetails
properties:
HaveYouEverHadTravelInsuranceBefore:
type: string
description: Yes/No
AnyPreviousClaims:
type: string
description: Yes/No
IfYesProvideAmountAndDetails:
type: string
description: >-
Only numeric answers allowed (in AED) for amount and free-form for
details
additionalProperties: false
AETravelInsuranceQuotePreviousPolicies:
type: object
required:
- PreviousInsuranceCompany1
- PreviousPolicyId1
- PurchaseDate
- RenewalDate1
- RenewalDate2
- PremiumAmount
- DeductibleAmountIfAny
- CoverageType
- AdjustmentDate1IfAny
- PremiumAdjustment1IfAny
- CoverageAdjustment1IfAny
- ReasonForAdjustment1IfAny
- AdjustmentDate2IfAny
- PremiumAdjustment2IfAny
- CoverageAdjustment2IfAny
- BenefitPayoutDate1
- BenefitPayoutAmount1
- BenefitPayoutDate2
- BenefitPayoutAmount2
- TerminationDate
- ReasonForCancellation
- RefundAmountIfAny
- SurrenderDateIfApplicable
- SurrenderAmountIfApplicable
- ReasonForSurrender
- CashValueOfPolicyPaidToPolicyholder
properties:
PreviousInsuranceCompany1:
type: string
description: Free-form
PreviousPolicyId1:
type: string
description: Depends on insurance company
PurchaseDate:
type: string
description: dd/mm/yyyy
RenewalDate1:
type: string
description: dd/mm/yyyy
RenewalDate2:
type: string
description: dd/mm/yyyy
PremiumAmount:
type: string
description: Only numeric answers allowed (in AED)
DeductibleAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageType:
type: string
description: >-
Select from drop-down list (e.g., Full, Partial, Other) - may vary
by insurance company
AdjustmentDate1IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment1IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment1IfAny:
type: string
description: Free-form
ReasonForAdjustment1IfAny:
type: string
description: Free-form
AdjustmentDate2IfAny:
type: string
description: dd/mm/yyyy
PremiumAdjustment2IfAny:
type: string
description: Only numeric answers allowed (in AED)
CoverageAdjustment2IfAny:
type: string
description: Free-form
BenefitPayoutDate1:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount1:
type: string
description: Only numeric answers allowed (in AED)
BenefitPayoutDate2:
type: string
description: dd/mm/yyyy
BenefitPayoutAmount2:
type: string
description: Only numeric answers allowed (in AED)
TerminationDate:
type: string
description: dd/mm/yyyy
ReasonForCancellation:
type: string
description: Free-form
RefundAmountIfAny:
type: string
description: Only numeric answers allowed (in AED)
SurrenderDateIfApplicable:
type: string
description: dd/mm/yyyy
SurrenderAmountIfApplicable:
type: string
description: Only numeric answers allowed (in AED)
ReasonForSurrender:
type: string
description: Free-form
CashValueOfPolicyPaidToPolicyholder:
type: string
description: Only numeric answers allowed (in AED)
additionalProperties: false
AETravelInsuranceQuoteProductData:
type: object
properties:
TravelDetails:
$ref: '#/components/schemas/AETravelInsuranceQuoteTravelDetails'
Coverage:
$ref: '#/components/schemas/AETravelInsuranceQuoteCoverage'
PreviousCoverage:
$ref: '#/components/schemas/AETravelInsuranceQuotePreviousCoverage'
Companions:
$ref: '#/components/schemas/AETravelInsuranceQuoteCompanions'
additionalProperties: false
AETravelInsuranceQuoteTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AETravelInsuranceQuotePremium'
BenefitPayouts:
$ref: '#/components/schemas/AETravelInsuranceQuoteBenefitPayouts'
Claims:
$ref: '#/components/schemas/AETravelInsuranceQuoteClaims'
PreviousPolicies:
$ref: '#/components/schemas/AETravelInsuranceQuotePreviousPolicies'
additionalProperties: false
AETravelInsuranceQuoteTravelDetails:
type: object
required:
- DepartureDate
- ReturnDate
- DestinationCountryCountries
- DestinationCityCities
- PurposeOfTravel
- WillYouBeParticipatingInHighriskActivities
- IfYesPleaseSelectAllThatApply
properties:
DepartureDate:
type: string
description: dd/mm/yyyy
ReturnDate:
type: string
description: dd/mm/yyyy
DestinationCountryCountries:
type: string
description: Select from list
DestinationCityCities:
type: string
description: Select from list generated based on previous selection
PurposeOfTravel:
type: string
description: Select from drop-down list (e.g., Leisure, Business, Study)
WillYouBeParticipatingInHighriskActivities:
type: string
description: Yes/No
IfYesPleaseSelectAllThatApply:
type: string
description: Select from drop-down list (e.g., Skydiving, Diving, Skiing)
additionalProperties: false
AETravelInsuranceTransactionData:
type: object
properties:
Premium:
$ref: '#/components/schemas/AETravelInsurancePremium'
BenefitPayouts:
$ref: '#/components/schemas/AETravelInsuranceBenefitPayouts'
Claims:
$ref: '#/components/schemas/AETravelInsuranceClaims'
PreviousPolicies:
$ref: '#/components/schemas/AETravelInsurancePreviousPolicies'
additionalProperties: false
AETravelInsuranceTravelDetails:
type: object
required:
- DepartureDate
- ReturnDate
- DestinationCountryCountries
- DestinationCityCities
- PurposeOfTravel
- Flight1AirlineName
- Flight1Number
- Flight2AirlineName
- Flight2Number
- PlannedActivities
- WillYouBeParticipatingInHighriskActivities
- IfYesPleaseSelectAllThatApply
properties:
DepartureDate:
type: string
description: dd/mm/yyyy
ReturnDate:
type: string
description: dd/mm/yyyy
DestinationCountryCountries:
type: string
description: Select from list
DestinationCityCities:
type: string
description: Select from list generated based on previous selection
PurposeOfTravel:
type: string
description: Select from drop-down list (e.g., Leisure, Business, Study)
Flight1AirlineName:
type: string
description: Free-form
Flight1Number:
type: string
description: Only numeric answers allowed
Flight2AirlineName:
type: string
description: Free-form
Flight2Number:
type: string
description: Only numeric answers allowed
PlannedActivities:
type: string
description: Free-form
WillYouBeParticipatingInHighriskActivities:
type: string
description: Yes/No
IfYesPleaseSelectAllThatApply:
type: string
description: Select from drop-down list (e.g., Skydiving, Diving, Skiing)
additionalProperties: false
AEUpdateAcceptedQuoteStatus:
type: object
properties:
status:
type: string
enum:
- Accepted
additionalProperties: false
AEUpdateConsent1SignedUpdate:
type: object
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/AEUpdateConsent1Update'
additionalProperties: false
AEUpdateConsent1Update:
type: object
properties:
Data:
$ref: '#/components/schemas/AEPatchConsentUpdate'
Subscription:
$ref: '#/components/schemas/EventNotificationUpdate'
description: Patch Account Access Consent
additionalProperties: false
AEUpdateQuoteStatus1:
type: object
properties:
Data:
$ref: '#/components/schemas/AEUpdateAcceptedQuoteStatus'
Links:
$ref: '#/components/schemas/LinksSelfUpdate'
Meta:
$ref: '#/components/schemas/Meta'
additionalProperties: false
AEUpdateQuoteStatus1Signed:
type: object
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/AEUpdateQuoteStatus1'
additionalProperties: false
AEWebhook:
type: object
required:
- Url
- IsActive
properties:
Url:
type: string
description: The TPP Callback URL being registered with the LFI
IsActive:
type: boolean
description: >-
The TPP specifying whether the LFI should send (IsActive true) or
not send (IsActive false) Webhook Notifications to the TPP's Webhook
URL
description: A Webhook Subscription Schema
additionalProperties: false
AEWebhookUpdate:
type: object
properties:
Url:
type: string
description: The TPP Callback URL being registered with the LFI
IsActive:
type: boolean
description: >-
The TPP specifying whether the LFI should send (IsActive true) or
not send (IsActive false) Webhook Notifications to the TPP's Webhook
URL
description: A Webhook Subscription Schema
additionalProperties: false
Amount:
type: number
CurrencyCode:
type: string
pattern: ^[A-Z]{3}$
EventNotification:
type: object
required:
- Webhook
properties:
Webhook:
$ref: '#/components/schemas/AEWebhook'
additionalProperties: false
EventNotificationUpdate:
type: object
properties:
Webhook:
$ref: '#/components/schemas/AEWebhookUpdate'
additionalProperties: false
First:
type: string
format: uri
description: A link to the first page in a paginated result set
Last:
type: string
format: uri
description: A link to the last page in a paginated result set
LinksResource:
type: object
required:
- Self
properties:
Self:
$ref: '#/components/schemas/Self'
First:
$ref: '#/components/schemas/First'
Prev:
$ref: '#/components/schemas/Prev'
Next:
$ref: '#/components/schemas/Next'
Last:
$ref: '#/components/schemas/Last'
description: Links relevant to the resource
additionalProperties: false
LinksSelf:
type: object
required:
- Self
properties:
Self:
$ref: '#/components/schemas/Self'
description: Links relevant to the resource
additionalProperties: false
LinksSelfUpdate:
type: object
properties:
Self:
$ref: '#/components/schemas/Self'
description: Links relevant to the resource
additionalProperties: false
Meta:
type: object
description: Metadata relevant to the resource
additionalProperties: false
Next:
type: string
format: uri
description: A link to the next page in a paginated result set
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
PreviousClaims:
type: object
required:
- ClaimDescription
properties:
ClaimAmount:
allOf:
- $ref: '#/components/schemas/AEAmountAndCurrency'
description: Claim amount and currency
ClaimDescription:
type: string
minLength: 1
maxLength: 140
description: Description of claim using free form text
additionalProperties: false
Self:
type: string
format: uri
description: A link to the current resource
VehicleHistory:
type: string
enum:
- Imported
- Modified
- DeclaredTotalLoss
- Other
uuid:
type: string
minLength: 1
maxLength: 128
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
confirmation-of-payee: Right to invoke a Confirmation of Payee operation
accounts: Ability to read Accounts Information
insurance: Right to read insurance policies
tpp-reports: Right to read Open Finance Platform reports for a given TPP
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
servers:
- url: /open-finance/insurance/v2.0-draft1
|