Versions Compared

Version Old Version 6 New Version 7
Changes made by

Chris Wood

Chris Wood

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
HTTP/1.1 200 OK
Content-Type: application/json
x-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602
{
  "Data": {
    "AccountData": [
      {
        "AccountIdPolicyType": "f91d07d0-6d8f-4e0e-9fb4-0ac61f84d115Motor",
        "AccountHolderNamePolicyDetails": {
"Hamad Ali",         "AccountHolderShortNameInsurancePolicyId": "176794ea-ee8c-4621-b824-b8cfa95db0ff",
          "StatusCustomerId": "Activedcaaef9c-63cb-4c57-9f2a-a4986c4a958e",
          "CurrencyPolicyHolderName": "AEDHamad Ali",
          "AccountTypeCustomerCommunicationDetails": "UAEOF.Retail", {
            "AccountSubTypeCorrespondenceAddress": "CurrentAccount",{
        "Nickname": "CurrentAC",     "AddressLine": [
      "OpeningDate": "2021-01-28T15:27:13+0300",         "AccountIdentifiers": [PO Box 12345"
              ],
 {             "IdentificationTypePostalCode": "UAEOF.IBAN12345",
              "IdentificationCity": "SA4420000001234567891234Al Qouz",
              "NameStateEmirate": "Hamad AliDubai",
          }    "Country": "UAE"
    ],        },
"Servicer": {           "IdentificationTypePermanentAddress": "UAEOF.BICFI", {
           "Identification":   "SASAMAAddressLine":    [
    }       },     "PO Box {12345"
        "AccountId": "g91d07d0-6d8f-4e0e-9fb4-0ac61f84e444",     ],
   "AccountHolderName": "Hamad Ali",         "AccountHolderShortNamePostalCode": "12345",
              "StatusCity": "ActiveAl Qouz",
              "CurrencyStateEmirate": "USDDubai",
        "AccountType": "UAEOF.Retail",         "AccountSubTypeCountry": "SavingsUAE",
          "Nickname": "SavingsAC",  },
            "OpeningDateResidentialAddress": "2021-01-28T15:27:13+0300", {
         "AccountIdentifiers": [    "AddressLine": [
     {           "PO Box "IdentificationType12345":
"UAEOF.IBAN",             "Identification": "SA4420000001234567890001", ],
              "NamePostalCode": "12345"Hamad,
  Ali"           } "City": "Al Qouz",
     ],         "ServicerStateEmirate": {"Dubai",
           "IdentificationType   "Country": "UAEOF.BICFI",UAE"
            },
            "IdentificationCommunicationPreferences": "SASAMA"
[
       }       }{
    ]   },   "Links": {     "SelfType": "https://rs1.openfinanceplatform.ae/open-finance/account-information/v1.0-draft3/accounts"
  },Home",
                "MetaPhoneNumber": {}
}

3.8 Get an Insurance Policy

3.8.1 Request: Insurance Policy Resource

...

3.8.2 Response: Insurance Policy Resource

...

4. Further Examples

4.1 The TPP Queries the Account Access Consent Resource for the Status after a User has Authorized the Consent

4.1.1 Request: account-access-consents/{ConsentId} resource

Code Block
GET /open-finance/account-information/v1.0-draft3/account-access-consents/aac-1a672e83-d1e5-42bc-b8e1-60a490ec52fd HTTP/1.1
Host: rs1.openfinanceplatform.ae
Content-Type: application/json
x-fapi-interaction-id: 2e974f01-d111-4078-9a19-7a9b385e637c
Authorization: Bearer e6156449-6f27-4c42-aa5b-36602f73eac9

4.1.2 Response: account-access-consents/{ConsentId} resource

Code Block
HTTP/1.1 200 OK
Content-Type:application/json
x-fapi-interaction-id: 2e974f01-d111-4078-9a19-7a9b385e637c
{
  "Data": {
    "ConsentId": "aac-69255d98-ab0e-4758-92a7-cacbf3073efa",
    "CreationDateTime": "2024-06-27T15:27:13+0300",
    "ConsentStatus": "Authorized",
    "ConsentFlags": {
      "PartlyAuthorized": "2024-06-27T16:27:13+0300"
    },
    "ConsentStatusUpdateDateTime": "2024-06-27T16:27:13+0300",
    "Permissions": [
      "ReadAccountsBasic",
      "ReadAccountsDetail",
      "ReadBalances",
      "ReadBeneficiariesBasic",
      "ReadBeneficiariesDetail",
      "ReadTransactionsBasic",
      "ReadTransactionsDetail",
      "ReadTransactionsCredits",
      "ReadTransactionsDebits",
      "ReadScheduledPaymentsBasic",
      "ReadScheduledPaymentsDetail",
      "ReadDirectDebits",
      "ReadStandingOrdersBasic",
      "ReadStandingOrdersDetail"
    ],
    "AuthorizationExpirationTimeWindow": "720:00:00",
    "ExpirationDateTime": "2024-06-28T15:27:13+0300",
    "TransactionFromDateTime": "2024-06-25T12:19:24+0300",
    "TransactionToDateTime": "2024-06-27T12:19:24"971000000000"
              }
            ],
            "Email": "hamad.ali@email.ae"
          },
          "IndividualCustomerDetails": {
            "Gender": "Male",
            "DateofBirth": "2003-09-12",
            "MaritalStatus": "Married",
            "Nationality": "UAE",
            "NumberofChildren": 1
          },
          "VehicleInformation": {
            "CarMake": "Toyota",
            "CarModel": "Land Cruiser",
            "CarModelYear": "2023",
            "CarPurchaseDateTime": "2023-01-31T00:00:00.000Z",
            "EstimatedValueAmount": {
              "Currency": "AED",
              "Amount": 180000
            },
            "RegistrationDateTime": "2023-01-31T00:00:00.000Z",
            "CountryofOrigin": "ARE",
            "VehicleColor": "White",
            "PlateNumber": "12345",
            "PlateCode": "1",
            "VehicleMileage": 50000,
            "VehicleWeight": 2000,
            "VehicleHistory": "Imported"
          },
          "InsurancePolicyInformation": {
            "IssueDateTime": "2024-05-01T00:00:00.000Z",
            "ExpiryDateTime": "2025-04-31T23:59:59.999Z",
            "PolicyType": "Comprehensive",
            "CoverageAmount": {
              "Currency": "AED",
              "Amount": 180000
            },
            "CoverageStartDateTime": "2024-05-01T00:00:00.000Z",
            "PolicyPremium": {
              "Currency": "AED",
              "Amount": 4600
            },
            "PolicyHolderEmirates": true,
            "PreviousPolicy": {
              "PolicyReference": "8a43bab5-43d8-4525-b92d-840eff449ba5",
              "Insurer": "AXA",
              "PolicyStartDateTime": "2023-05-01T00:00:00.000Z",
              "PolicyExpiryDateTime": "2024-04-31T23:59:59.999Z"
            }
          },
          "AddOns": {
            "DriversPersonalAccident": true,
            "PassengersPersonalAccident": true
          },
          "AdditionalInformation": {
            "FirstTimeRegistration": "true",
            "VehicleMortgageAmount": {
              "Currency": "AED",
              "Amount": 180000
            }
          }
        }
      }
    ],
    "Links": {
      "Self": "https://rs1.openfinanceplatform.ae/open-finance/insurance/v1.0-draft3/insurance-policies"
    },
    "Meta": {
      "TotalPages": "1"
    }
  }

3.8 Get an Insurance Policy

3.8.1 Request: Insurance Policy Resource

Code Block
GET /open-finance/insurance/v1.0-draft3/insurance-policies/176794ea-ee8c-4621-b824-b8cfa95db0ff HTTP/1.1
Host: rs1.openfinanceplatform.ae
Accept: application/json
x-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602
Authorization: Bearer caa1b60d-61ff-4cd8-a4e1-2d18c8696de0

3.8.2 Response: Insurance Policy Resource

Code Block
HTTP/1.1 200 OK
Content-Type: application/json
x-fapi-interaction-id: 942a7ee7-d29a-45aa-93b7-c5f292d86602
{
    "Data": {
      "PolicyType": "Motor",
      "PolicyDetails": {
        "InsurancePolicyId": "176794ea-ee8c-4621-b824-b8cfa95db0ff",
        "CustomerId": "dcaaef9c-63cb-4c57-9f2a-a4986c4a958e",
        "PolicyHolderName": "Hamad Ali",
        "CustomerCommunicationDetails": {
          "CorrespondenceAddress": {
            "AddressLine": [
              "PO Box 12345"
            ],
            "PostalCode": "12345",
            "City": "Al Qouz",
            "StateEmirate": "Dubai",
            "Country": "UAE"
          },
          "PermanentAddress": {
            "AddressLine": [
              "PO Box 12345"
            ],
            "PostalCode": "12345",
            "City": "Al Qouz",
            "StateEmirate": "Dubai",
            "Country": "UAE"
          },
          "ResidentialAddress": {
            "AddressLine": [
              "PO Box 12345"
            ],
            "PostalCode": "12345",
            "City": "Al Qouz",
            "StateEmirate": "Dubai",
            "Country": "UAE"
          },
          "CommunicationPreferences": [
            {
              "Type": "Home",
              "PhoneNumber": "971000000000"
            }
          ],
          "Email": "hamad.ali@email.ae"
        },
        "IndividualCustomerDetails": {
          "Gender": "Male",
          "DateofBirth": "2003-09-12",
          "MaritalStatus": "Married",
          "Nationality": "UAE",
          "NumberofChildren": 1
        },
        "VehicleInformation": {
          "CarMake": "Toyota",
          "CarModel": "Land Cruiser",
          "CarModelYear": "2023",
          "CarPurchaseDateTime": "2023-01-31T00:00:00.000Z",
          "EstimatedValueAmount": {
            "Currency": "AED",
            "Amount": 180000
          },
          "RegistrationDateTime": "2023-01-31T00:00:00.000Z",
          "CountryofOrigin": "ARE",
          "VehicleColor": "White",
          "PlateNumber": "12345",
          "PlateCode": "1",
          "VehicleMileage": 50000,
          "VehicleWeight": 2000,
          "VehicleHistory": "Imported"
        },
        "InsurancePolicyInformation": {
          "IssueDateTime": "2024-05-01T00:00:00.000Z",
          "ExpiryDateTime": "2025-04-31T23:59:59.999Z",
          "PolicyType": "Comprehensive",
          "CoverageAmount": {
            "Currency": "AED",
            "Amount": 180000
          },
          "CoverageStartDateTime": "2024-05-01T00:00:00.000Z",
          "PolicyPremium": {
            "Currency": "AED",
            "Amount": 4600
          },
          "PolicyHolderEmirates": true,
          "PreviousPolicy": {
            "PolicyReference": "8a43bab5-43d8-4525-b92d-840eff449ba5",
            "Insurer": "AXA",
            "PolicyStartDateTime": "2023-05-01T00:00:00.000Z",
            "PolicyExpiryDateTime": "2024-04-31T23:59:59.999Z"
          }
        },
        "AddOns": {
          "DriversPersonalAccident": true,
          "PassengersPersonalAccident": true
        },
        "AdditionalInformation": {
          "FirstTimeRegistration": "true",
          "VehicleMortgageAmount": {
            "Currency": "AED",
            "Amount": 180000
          }
        }
      }
    },
    "Links": {
      "Self": "https://rs1.openfinanceplatform.ae/open-finance/insurance/v1.0-draft3/insurance-policies/176794ea-ee8c-4621-b824-b8cfa95db0ff"
    }
  }

4. Further Examples

4.1 The TPP Queries the Insurance Resource for the Status after a User has Authorized the Consent

4.1.1 Request: insurance-consents/{ConsentId} resource

Code Block
GET /open-finance/insurance/v1.0-draft3/insurance-consents/aac-1a672e83-d1e5-42bc-b8e1-60a490ec52fd HTTP/1.1
Host: rs1.openfinanceplatform.ae
Content-Type: application/json
x-fapi-interaction-id: 2e974f01-d111-4078-9a19-7a9b385e637c
Authorization: Bearer e6156449-6f27-4c42-aa5b-36602f73eac9

4.1.2 Response: insurance-consents/{ConsentId} resource

Code Block
HTTP/1.1 200 OK
Content-Type:application/json
x-fapi-interaction-id: 2e974f01-d111-4078-9a19-7a9b385e637c
{
  "Data": {
    "ConsentId": "6a6a826f-0930-4eb0-b365-a8eac3032828",
    "CreationDateTime": "2024-06-27T15:27:13+0300",
    "ConsentStatus": "Authorized",
    "ConsentFlags": {
      "PartlyAuthorized": "2024-06-27T16:27:13+0300"
    },
    "ConsentStatusUpdateDateTime": "2024-06-27T16:27:13+0300",
    "AccountTypePermissions": [
        "UAEOF.RetailReadInsurancePoliciesMotor"
    ],
    "AccountSubTypeExpirationDateTime": [
      "CurrentAccount"
    ]"2024-03-28T15:27:13+030",
    "ConsentPurposePurpose": [
  
   "Account Aggregation",       "E-Statement"MotorInsuranceQuote"
    ]
  },
  "Subscription": {
    "Webhook": {
      "Url": "https://api.tpp1.com/webhook/callbackUrl",
      "IsActive": false
    }
  },
  "Links": {
    "Self": "https://rs1.openfinanceplatform.ae/open-finance/account-information/v1.0-draft3/account-accessinsurance-consents/aac6a6a826f-69255d980930-ab0e4eb0-4758b365-92a7-cacbf3073efaa8eac3032828"
  },
  "Meta": {}
}

4.2 The TPP Requests the List of Insurance Policies Using an Expired Access Token

...