v1

latestOpenAPI 3.0.12026-08-066103.9 MB

Gets policy details.

Cf. summary

get/sales/v2/individual/travel/policies/{policy_id}

Path parameters

policy_idstring required

Example:ea45ec62-0d21-4f44-a577-b8624da2bf5b

Unique policy identifier.

Headers

accept-languagestring

Example:en

Accepted language, IANA language codification. If language not managed, "en" will be used by default.

x-axa-contextstring JSON Web Token RFC 7519

The token is formatted as a JWT and provided by the partner.

x-tenant-idstring

Example:42bbd332fa8f48e7bb382165f257a579

The unique identifier of the tenant, the value should be provided by AXA.

Response

Policy details.

policy_numberstring

Final policy number.

external_policy_numberstring

External policy identifier that can be provided by the partner.

subscription_countrystring

Country where the customer subscribes the policy, ISO-3166-1 alpha-2 format (2 letter codes).

policy_idstring

Unique final policy identifier.

draft_policy_numberstring

Draft policy number, provided in case if the policy is not confirmed.

cancellation_datestring date

Cancellation date of the policy - ISO 8601 format (YYYY-MM-DD).

purchase_datestring date

The date of the subscription (purchase) of the policy - ISO 8601 format (YYYY-MM-DD).

contracting_actor_namestring

The legal entity relied to the customer.

editable_version'SOLD_AS' | 'LATEST'

Version of the catalog to use in case of policy edit.

SOLD_AS: use the version of the catalog the policy was sold under.
LATEST: use the latest version of the catalog.

legal_withdrawal_periodstring

The legal withdrawal period ISO 8601 format (P5Y8M4D).

legal_withdrawal_datestring date

The last date when the user still has a legal right to cancel the policy without penalty - ISO 8601 format (YYYY-MM-DD).

renewal_datestring date

The renewal date of the policy

is_renewableboolean

Indicates if the policy is renewal.

Example response

{
  "subscription_country": "FR",
  "transactions": [
    {
      "transaction_id": "ABC123456",
      "type": "PAYMENT",
      "status": "PROCESSED",
      "amount": {
        "value": 199.99,
        "currency": "EUR"
      },
      "processed_at": "2018-11-20"
    }
  ],
  "policy_id": "ea45ec62-0d21-4f44-a577-b8624da2bf5b",
  "cancellation_date": "2019-01-30",
  "purchase_date": "2019-01-23",
  "coverage_period": {
    "start_date": "2019-01-25",
    "end_date": "2020-01-24"
  },
  "effective_period": {
    "start_date": "2019-01-25",
    "end_date": "2020-01-24"
  },
  "contracting_actor_name": "EXPEDIA UK",
  "legal_withdrawal_period": "P14D",
  "legal_withdrawal_date": "2019-01-23",
  "catalog": {
    "code": "Opodo FR",
    "version": "v12",
    "country": "FR",
    "currency": "EUR"
  },
  "guarantees": [
    {
      "code": "accidental_damage",
      "label": "Medical repatriation.",
      "is_sub_guarantee": true
    }
  ],
  "product": {
    "code": "PRTNCATALOG",
    "name": "Short Stay Travel - Formula 1",
    "headline": "Short Stay Travel - Simple",
    "description": "The coverage includes this but not that.",
    "price_after_discount_inc_tax": 150.25,
    "price_before_discount_excl_tax": 200.25,
    "total_discount": 10,
    "premium_after_discount_excl_tax": 180,
    "total_taxes": 5,
    "sub_category": "VoyageSimple",
    "promo_code": "ETE2018",
    "guarantee_class_prices": [
      {
        "code": "GUARANTEE_CLASS_02",
        "label": "Accident",
        "premium_after_discount_excl_tax": 180,
        "total_taxes": 5
      }
    ],
    "coverage_repartition": [
      {
        "category": "missed_connection_cruise_and_tour_departures",
        "gross_premium": 180,
        "tax_amount": 5,
        "tax_type": "INSURANCE",
        "label": "Missed Connection (Cruise and tour Departures)",
        "name": "CR-180628"
      }
    ],
    "payment_modes": [
      {
        "type": "PAYPAL",
        "Provider": {
          "id": "52664e48-a35f-4f68-b3f3-1e45d0f7dbb9",
          "label": "WorldPay"
        }
      }
    ],
    "yearly_price_details": {
      "price_after_discount_inc_tax": 150.25,
      "price_before_discount_excl_tax": 200.25,
      "price_after_discount_excl_tax": 180,
      "total_taxes": 5
    }
  },
  "addons": [
    {
      "code": "PRTNCATALOG",
      "name": "Short Stay Travel - Formula 1",
      "headline": "Short Stay Travel - Simple",
      "description": "This addon must be requested within the 7 days since the booking date.",
      "price_after_discount_inc_tax": 150.25,
      "price_before_discount_excl_tax": 200.25,
      "total_discount": 10,
      "total_taxes": 5,
      "premium_after_discount_excl_tax": 180,
      "guarantee_class_prices": [
        {
          "code": "GUARANTEE_CLASS_02",
          "label": "Accident",
          "premium_after_discount_excl_tax": 180,
          "total_taxes": 5
        }
      ],
      "coverage_repartition": [
        {
          "category": "missed_connection_cruise_and_tour_departures",
          "gross_premium": 180,
          "tax_amount": 5,
          "tax_type": "INSURANCE",
          "label": "Missed Connection (Cruise and tour Departures)",
          "name": "CR-180628"
        }
      ],
      "cancellation_date": "2019-01-30",
      "purchase_date": "2019-01-23",
      "coverage_period": {
        "start_date": "2019-01-25",
        "end_date": "2020-01-24"
      },
      "effective_period": {
        "start_date": "2019-01-25",
        "end_date": "2020-01-24"
      },
      "yearly_price_details": {
        "price_after_discount_inc_tax": 150.25,
        "price_before_discount_excl_tax": 200.25,
        "price_after_discount_excl_tax": 180,
        "total_taxes": 5
      }
    }
  ],
  "temporary_addons": [
    {
      "code": "PRTNCATALOG",
      "name": "Short Stay Travel - Formula 1",
      "headline": "Short Stay Travel - Simple",
      "description": "This addon must be requested within the 7 days since the booking date.",
      "price_after_discount_inc_tax": 150.25,
      "price_before_discount_excl_tax": 200.25,
      "total_discount": 10,
      "total_taxes": 5,
      "premium_after_discount_excl_tax": 180,
      "guarantee_class_prices": [
        {
          "code": "GUARANTEE_CLASS_02",
          "label": "Accident",
          "premium_after_discount_excl_tax": 180,
          "total_taxes": 5
        }
      ],
      "coverage_repartition": [
        {
          "category": "missed_connection_cruise_and_tour_departures",
          "gross_premium": 180,
          "tax_amount": 5,
          "tax_type": "INSURANCE",
          "label": "Missed Connection (Cruise and tour Departures)",
          "name": "CR-180628"
        }
      ],
      "cancellation_date": "2019-01-30",
      "purchase_date": "2019-01-23",
      "coverage_period": {
        "start_date": "2019-01-25",
        "end_date": "2020-01-24"
      },
      "effective_period": {
        "start_date": "2019-01-25",
        "end_date": "2020-01-24"
      },
      "yearly_price_details": {
        "price_after_discount_inc_tax": 150.25,
        "price_before_discount_excl_tax": 200.25,
        "price_after_discount_excl_tax": 180,
        "total_taxes": 5
      }
    }
  ],
  "payment": {
    "id": "a19AU00000AIdJhYAL",
    "type": "CREDIT_CARD",
    "is_managed_by_axa": true,
    "payment_reference": "bank cheque number - 27006",
    "payment_periodicity": {
      "value": "R12/P1M",
      "amount": 23,
      "amount_first_payment": 23.02,
      "amount_per_period_before_discount": 24
    },
    "total_amount_incl_tax": 61,
    "has_missing_payment": true,
    "has_bad_debt": true,
    "balance_amount": {
      "value": 199.99,
      "currency": "EUR"
    },
    "iban": "FR7630006000011234567890189",
    "taxes_breakdown": [
      {
        "code": "IPS",
        "amount": {
          "value": 0.24,
          "currency": "EUR"
        }
      }
    ]
  },
  "policy_holder": {
    "title": "MR",
    "first_name": "John",
    "middle_name": "Junior",
    "last_name": "Doe",
    "birth_date": "1990-04-25",
    "email": "jonathan.doe@mail.com",
    "spoken_language": "en-US",
    "phone": {
      "international_prefix": "+33",
      "number": "12345678"
    },
    "address": {
      "street_address": "150 Avenue de Paris",
      "postal_code": "75001",
      "city": "Paris",
      "country": "FR"
    },
    "external_holder_id": "ab8b7d8b-cdc4-46fd-bc4d-4abb3743a6d8"
  },
  "beneficiaries": [
    {
      "title": "MR",
      "first_name": "John",
      "middle_name": "Junior",
      "last_name": "Doe",
      "birth_date": "1990-04-25",
      "email": "jonathan.doe@mail.com"
    }
  ],
  "motor_coverages": {
    "insured_items": {
      "vehicles": [
        {
          "registration_number": "4234BMW",
          "brand": "Volkswagen",
          "model": "Passat SW",
          "colour": "Spatial grey"
        }
      ]
    }
  },
  "attachments": [
    {
      "name": "Proof of purchase",
      "content_url": "https://axa.com/deeplink/route",
      "type": "CONTRACT",
      "technical_reference": "3c13937d-9f60-4fff-bf03-06d9aee56abe"
    }
  ],
  "additional_information": [
    {
      "code": "EXISTING_INSURANCE_REFERENCE",
      "value": "A1455CDH"
    }
  ],
  "renewal_date": "2021-11-20",
  "wallet_informations": {
    "pass_url": "https://myp.as/G77VRY75negVJKRL28jjpf"
  }
}