v1

latestOpenAPI 3.0.1raw.githubusercontent.com2023-04-194127.4 KB
claim

POST call to create a claim record, or return existing one if already created

  • Mandatory fields for Update claim - Claimant Id, Benefit type. e.g.
    {
      "claimant_id": "5efbb7aebb703c618c3d4fe5",
      "benefit_type": "PIP"
    }
    
post/v1/claim

Request body

claimant_idstring required
benefit_type'PIP' required

the type of benefit PIP, ESA etc..

Example request

{
  "claimant_id": "6ed1d430716609122be7a4d6",
  "benefit_type": "PIP"
}

Response

FOUND - an existing claim returned

claim_idstring
submission_idstring
form_datastring

the session data blob

claim_status'CLAIM_STARTED' | 'APPLICATION_SUBMITTED'

the status of the claim record

Example response

{
  "claim_id": "5ed0d430716609122be7a4d6",
  "submission_id": "5ed0d430716609122be7a4d6",
  "form_data": "{\"data\", \"claim data\"}",
  "claim_status": "CLAIM_STARTED"
}
All 4 operations