v1
latestOpenAPI 3.0.12026-08-066103.9 MBCreate a travel claim.
Cf. summary
post/insurance/travel/v2/claims
Headers
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.
x-tenant-idstring
Example:42bbd332fa8f48e7bb382165f257a579
The unique identifier of the tenant, the value should be provided by AXA.
Request body
Example request
{
"policy": {
"policy_id": "2e1c73fa-5e84-49e0-8167-a7c61b364289",
"is_verified": true,
"policy_external_reference": {
"contract_id": "3d1cf19b-bb20-48a1-bbf9-b1110f758548",
"product_id": "c8e90634-c3aa-43d7-a055-0936a8e652d2",
"issued_date": "2018-07-11"
},
"issuer_name": "AXA Partners",
"country": "FR",
"beneficiary_ids": [
"4c854f8d-a569-41c9-8028-36530b9ead4d",
"68e785f7-0aaa-4f31-a7bf-e87aff1968fd"
],
"policy_holder_id": "4c854f8d-a569-41c9-8028-36530b9ead4d"
},
"planned_trips": [
{
"planned_trip_id": "1db7a370-3cf3-4427-8526-fac2af885c9c",
"booking_date": "2019-06-18",
"start_date": "2019-06-02",
"end_date": "2019-06-08",
"country": "FR"
}
],
"involved_person": [
{
"involved_person_id": "bb2df1d1-85b2-472f-b391-cce0062ea5bb",
"external_person_id": "0ee85475-e7e8-438c-86f5-92d7a910e0dc",
"person": {
"title": "MR",
"first_name": "Jonathan",
"middle_name": "Junior",
"last_name": "Doe",
"birth_date": "1990-10-25",
"birth_country": "FR",
"birth_locality": "PARIS",
"gender": "ML",
"nationalities": [
"FR"
]
},
"preferred_language": "en",
"registrations": [
{
"value": "UQ2FRANYG",
"expiring_date": "2020-05-11",
"issue_date": "2012-08-03",
"issued_country": "FR"
}
],
"phones": [
{
"international_prefix": "+33",
"number": "0123456789",
"is_preferred": true
}
],
"emails": [
{
"email": "jonathan.doe@mail.com",
"is_preferred": true
}
],
"address": {
"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"
},
"bank_account": {
"bank": {
"name": "Santander UK",
"address": {
"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"
}
},
"holder_name": "Joe Doe",
"account_type": "1|2|3 Current Account",
"preferred_transfer_type": "IBAN",
"account_number": "FR7630006000011234567890189",
"currency": "EUR",
"routing_number": "12-34-56",
"bank_identification_number": "AGRIFRPP"
}
}
],
"involved_companies": [
{
"company_id": "bb2df1d1-85b2-472f-b391-cce0062ea5bb",
"external_company_id": "0ee85475-e7e8-438c-86f5-92d7a910e0dc",
"name": "Santander UK",
"address": {
"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"
},
"phone": {
"international_prefix": "+33",
"number": "0123456789"
},
"email": "jonathan.doe@mail.com",
"bank_account": {
"bank": {
"name": "Santander UK",
"address": {
"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"
}
},
"holder_name": "Joe Doe",
"account_type": "1|2|3 Current Account",
"preferred_transfer_type": "IBAN",
"account_number": "FR7630006000011234567890189",
"currency": "EUR",
"routing_number": "12-34-56",
"bank_identification_number": "AGRIFRPP"
}
}
],
"related_claim_ids": [
"e941c951-6101-41b8-b227-28c0495227f3"
],
"circumstance": {
"loss_date": "2019-06-05T21:55:30.0000000+00:00",
"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"
},
"reporter_id": "747b1129-a6fb-468e-87c7-df7a8ae5a5a7",
"main_contact_id": "747b1129-a6fb-468e-87c7-df7a8ae5a5a7"
}
}Response
Claim created.
Example response
{
"claim_id": "e941c951-6101-41b8-b227-28c0495227f3",
"status": {
"created_at": "2019-07-25T18:35:30.0000000+00:00"
},
"policy": {
"policy_id": "2e1c73fa-5e84-49e0-8167-a7c61b364289",
"policy_type": "SINGLE",
"policy_external_reference": {
"contract_id": "3d1cf19b-bb20-48a1-bbf9-b1110f758548",
"product_id": "c8e90634-c3aa-43d7-a055-0936a8e652d2",
"issued_date": "2018-07-11"
},
"country": "FR",
"beneficiary_ids": [
"4c854f8d-a569-41c9-8028-36530b9ead4d",
"68e785f7-0aaa-4f31-a7bf-e87aff1968fd"
],
"policy_holder_id": "4c854f8d-a569-41c9-8028-36530b9ead4d"
},
"planned_trips": [
{
"planned_trip_id": "1db7a370-3cf3-4427-8526-fac2af885c9c",
"booking_date": "2019-06-18",
"start_date": "2019-06-02",
"end_date": "2019-06-08",
"country": "FR"
}
],
"involved_person": [
{
"involved_person_id": "bb2df1d1-85b2-472f-b391-cce0062ea5bb",
"external_person_id": "0ee85475-e7e8-438c-86f5-92d7a910e0dc",
"person": {
"title": "MR",
"first_name": "Jonathan",
"middle_name": "Junior",
"last_name": "Doe",
"birth_date": "1990-10-25",
"birth_country": "FR",
"birth_locality": "PARIS",
"gender": "ML",
"nationalities": [
"FR"
]
},
"preferred_language": "en",
"registrations": [
{
"value": "UQ2FRANYG",
"expiring_date": "2020-05-11",
"issue_date": "2012-08-03",
"issued_country": "FR"
}
],
"phones": [
{
"international_prefix": "+33",
"number": "0123456789",
"is_preferred": true
}
],
"emails": [
{
"email": "jonathan.doe@mail.com",
"is_preferred": true
}
],
"address": {
"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"
},
"bank_account": {
"bank": {
"name": "Santander UK",
"address": {
"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"
}
},
"holder_name": "Joe Doe",
"account_type": "1|2|3 Current Account",
"preferred_transfer_type": "IBAN",
"account_number": "FR7630006000011234567890189",
"currency": "EUR",
"routing_number": "12-34-56",
"bank_identification_number": "AGRIFRPP"
}
}
],
"involved_companies": [
{
"company_id": "bb2df1d1-85b2-472f-b391-cce0062ea5bb",
"external_company_id": "0ee85475-e7e8-438c-86f5-92d7a910e0dc",
"name": "Santander UK",
"address": {
"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"
},
"phone": {
"international_prefix": "+33",
"number": "0123456789"
},
"email": "jonathan.doe@mail.com",
"bank_account": {
"bank": {
"name": "Santander UK",
"address": {
"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"
}
},
"holder_name": "Joe Doe",
"account_type": "1|2|3 Current Account",
"preferred_transfer_type": "IBAN",
"account_number": "FR7630006000011234567890189",
"currency": "EUR",
"routing_number": "12-34-56",
"bank_identification_number": "AGRIFRPP"
}
}
],
"attachments": [
{
"attachment_id": "4c854f8d-a569-41c9-8028-36530b9ead4d",
"name": "car_rental_invoice.jpg",
"attachment_category": "PERSONAL_IDENTIFICATION"
}
],
"total_amount_claim": {
"value": 199.99,
"currency": "EUR"
},
"total_amount_reimbursed": {
"value": 199.99,
"currency": "EUR"
},
"circumstance": {
"loss_date": "2019-06-05T21:55:30.0000000+00:00",
"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"
},
"reporter_id": "747b1129-a6fb-468e-87c7-df7a8ae5a5a7",
"main_contact_id": "747b1129-a6fb-468e-87c7-df7a8ae5a5a7"
}
}