Create a new claim from a policy

POST 
/v1/claims

Make a request to create a claim for a policy on our platform

Request

application/json

Body

Details of the claim to be created

policy_number stringrequired

The policy number you want to create a claim for

amount numberrequired

The claim value

attachments integer[]required
payment_details objectrequired

To settle the claim, we will deposit the claimed amount to this account

bank_name string

account_number string

sort_code integer

Six digits bank sort code

child_partner_id string

If you are creating this claim for a child partner, add the partner key to the request

Responses

201

Created

application/json

Schema

Schema

claim object

Claim

id integer

The unique ID of the claim

status string

Current status of the claim

policy object

Policy

id integer

The unique ID of the policy

number string

The policy number

description string

The description of the policy

start_date date

The start date of the coverage

end_date date

The end date of the coverage

status string

Current status of the policy

amount_requested string

The amount requested when creating a claim

amount_approved string

The amount approved for the claim

currency string

The currency of the amount

created_at date

The date and time the claim was created

Example (from schema)

{
  "claim": {
    "id": 8,
    "status": "processing",
    "policy": {
      "id": 8,
      "number": "PH-34243TF",
      "description": "Lorem ipsum...",
      "start_date": "2022-03-24",
      "end_date": "2023-03-24",
      "status": "active"
    },
    "amount_requested": "239832.00",
    "amount_approved": "100000.00",
    "currency": "EUR",
    "created_at": "2022-03-12T14:19:50.000000Z"
  }
}

422

Unprocessable Content

application/json

Schema

Schema

message string
errors object
policy_number string[]
amount string[]
payment_details string[]

Example (from schema)

{
  "message": "The given data was invalid",
  "errors": {
    "policy_number": [
      "The policy_number is required"
    ],
    "amount": [
      "The amount field is required"
    ],
    "payment_details": [
      "The payment_details field is required"
    ]
  }
}

Loading...