Get a single claim

GET 
/v1/claims/:claim_id

This endpoint allows you retrieve a single claim

Request

Path Parameters

claim_id stringrequired

A unique identifier for the claim

Responses

200

OK

application/json

Schema

Schema

data 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)

{
  "data": {
    "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"
  }
}

400

Bad request(400).

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "400 Bad Request (Client Error)"
}

Loading...