v1

latestOpenAPI 3.0.12026-08-066103.9 MB

Create a general incident linked to a travel claim.

Cf. summary

post/insurance/travel/v2/claims/{claim_id}/general_incidents

Path parameters

claim_idstring required

Claim identifier.

Example:e941c951-6101-41b8-b227-28c0495227f3

Claim identifier.

Headers

x-tenant-idstring
Example:42bbd332fa8f48e7bb382165f257a579

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

x-environment'test' | 'preprod' | 'prod'

When calling the API, the client can precise in which environment the information should be sent. The environments are listed below:

  • test --> UAT / User Acceptance Environment.
  • preprod --> Pre-production (real data, real clients to validate the software before release to production).
  • prod --> Production environment.

Request body

incident_idstring

Identifier of the incident.

planned_trip_idstring required

Identifier of the planned trip where the incident occurred.

Example request

{
  "incident_id": "ec2ebd7f-684c-4d52-9a5f-fc49a23bc89c",
  "planned_trip_id": "1db7a370-3cf3-4427-8526-fac2af885c9c",
  "circumstance": {
    "type": "LEGAL_EXPENSES",
    "official_report": {
      "has_a_report_made": true,
      "reported_to": "Police Station",
      "reported_at": "2019-05-06T10:05:22.0000000+00:00",
      "report_id": "43f7ded0-d074-4430-bff0-f490e6bd0609"
    },
    "legal_expenses": {
      "medical_diagnosis": "Broken Ankle",
      "injured_id": "0c1df0f6-73d6-49ab-9856-aa79bba11dfe",
      "has_contacted_attorney": true,
      "attorney_id": "3b56de0d-a734-4fb9-8ead-64e2f13c980a",
      "case_reference": "7d2b9861-feaf-4ba5-bf3e-62580e9529c1"
    },
    "personal_liability": {
      "third_party_id": "1bc90fbe-0a90-44bf-844a-cd646d6fdb46",
      "has_perceived_liability": true,
      "has_promised_to_reimbursed": true
    },
    "involved_person": [
      {
        "involved_person_id": "bb2df1d1-85b2-472f-b391-cce0062ea5bb"
      }
    ]
  },
  "external_claims": [
    {
      "company_type": "INSURER",
      "company_name": "British Airline",
      "status": "CLOSED",
      "has_received_compensation": true,
      "compensation_amount": {
        "value": 199.99,
        "currency": "EUR"
      }
    }
  ],
  "expenses": [
    {
      "expense_id": "4a795d42-251f-4cdc-8b6f-0eff9af5d262",
      "external_expense_id": "eef6e822-a117-4db3-a7d0-bd1c1bcacd45",
      "claimant_id": "9b3820f8-c802-4f44-9665-587936b73218",
      "description": "Hotel Fee",
      "purchased_location": {
        "street_address": "123 Some Street Name",
        "postal_code": "75001",
        "locality": "PARIS",
        "country": "FR",
        "subdivision": "Le marais",
        "state": "Ile-de-France",
        "complete_address": "123 Some Street Name Le marais 75001 PARIS Ile-de-France FRANCE"
      },
      "purchased_at": "2019-05-12T12:55:33.0000000+00:00",
      "price": {
        "value": 199.99,
        "currency": "EUR"
      },
      "ownership_proof_id": "82c27939-c34a-49de-9364-87afd47106a2"
    }
  ],
  "attachments": [
    {
      "attachment_id": "7f88b079-2205-4335-b72e-72d994e47fc8",
      "name": "Hotel fee"
    }
  ],
  "questions_and_answers": [
    {
      "question_id": "6c8bd730-fef8-4ebf-9baf-f2d2883b91f2",
      "question_text": "What is the age of the oldest passenger?",
      "enumeration_answers": [
        {
          "answer_text": "Between 50 and 70",
          "answer_id": "3252e3cc-2862-4772-8176-5b6f2b70e048"
        }
      ],
      "answered_text": "The age of the oldest passager is sixty-nine.",
      "answered_amount": {
        "value": 199.99,
        "currency": "EUR"
      },
      "answered_distance": {
        "value": 30,
        "unit": "km"
      },
      "answered_weight": {
        "value": 1250,
        "unit": "kg"
      }
    }
  ],
  "total_amount_claimed": {
    "value": 199.99,
    "currency": "EUR"
  }
}

Response

General incident information.

incident_idstring

Identifier of the incident.

planned_trip_idstring required

Identifier of the planned trip where the incident occurred.

Example response

{
  "incident_id": "ec2ebd7f-684c-4d52-9a5f-fc49a23bc89c",
  "planned_trip_id": "1db7a370-3cf3-4427-8526-fac2af885c9c",
  "circumstance": {
    "type": "LEGAL_EXPENSES",
    "official_report": {
      "has_a_report_made": true,
      "reported_to": "Police Station",
      "reported_at": "2019-05-06T10:05:22.0000000+00:00",
      "report_id": "43f7ded0-d074-4430-bff0-f490e6bd0609"
    },
    "legal_expenses": {
      "medical_diagnosis": "Broken Ankle",
      "injured_id": "0c1df0f6-73d6-49ab-9856-aa79bba11dfe",
      "has_contacted_attorney": true,
      "attorney_id": "3b56de0d-a734-4fb9-8ead-64e2f13c980a",
      "case_reference": "7d2b9861-feaf-4ba5-bf3e-62580e9529c1"
    },
    "personal_liability": {
      "third_party_id": "1bc90fbe-0a90-44bf-844a-cd646d6fdb46",
      "has_perceived_liability": true,
      "has_promised_to_reimbursed": true
    },
    "involved_person": [
      {
        "involved_person_id": "bb2df1d1-85b2-472f-b391-cce0062ea5bb"
      }
    ]
  },
  "external_claims": [
    {
      "company_type": "INSURER",
      "company_name": "British Airline",
      "status": "CLOSED",
      "has_received_compensation": true,
      "compensation_amount": {
        "value": 199.99,
        "currency": "EUR"
      }
    }
  ],
  "expenses": [
    {
      "expense_id": "4a795d42-251f-4cdc-8b6f-0eff9af5d262",
      "external_expense_id": "eef6e822-a117-4db3-a7d0-bd1c1bcacd45",
      "claimant_id": "9b3820f8-c802-4f44-9665-587936b73218",
      "description": "Hotel Fee",
      "purchased_location": {
        "street_address": "123 Some Street Name",
        "postal_code": "75001",
        "locality": "PARIS",
        "country": "FR",
        "subdivision": "Le marais",
        "state": "Ile-de-France",
        "complete_address": "123 Some Street Name Le marais 75001 PARIS Ile-de-France FRANCE"
      },
      "purchased_at": "2019-05-12T12:55:33.0000000+00:00",
      "price": {
        "value": 199.99,
        "currency": "EUR"
      },
      "ownership_proof_id": "82c27939-c34a-49de-9364-87afd47106a2"
    }
  ],
  "attachments": [
    {
      "attachment_id": "7f88b079-2205-4335-b72e-72d994e47fc8",
      "name": "Hotel fee"
    }
  ],
  "questions_and_answers": [
    {
      "question_id": "6c8bd730-fef8-4ebf-9baf-f2d2883b91f2",
      "question_text": "What is the age of the oldest passenger?",
      "enumeration_answers": [
        {
          "answer_text": "Between 50 and 70",
          "answer_id": "3252e3cc-2862-4772-8176-5b6f2b70e048"
        }
      ],
      "answered_text": "The age of the oldest passager is sixty-nine.",
      "answered_amount": {
        "value": 199.99,
        "currency": "EUR"
      },
      "answered_distance": {
        "value": 30,
        "unit": "km"
      },
      "answered_weight": {
        "value": 1250,
        "unit": "kg"
      }
    }
  ],
  "total_amount_claimed": {
    "value": 199.99,
    "currency": "EUR"
  }
}