Claimant lookup
This endpoint is used to return all the fields from the Claimant screen and their current values for a given claimant id.
get
https://api.claimsmanagertest.crawco.co.uk/incidents/{incidentId}/claimants/{claimantId}
Path parameters
| Parameter Name | Description | Type | Example Data |
|---|---|---|---|
incidentId
|
The incident id of the incident | Integer | 6597925 |
claimantId
|
The claimant id of the claimant | Integer | 736716 |
Example request
curl --location --request GET 'https://api.claimsmanagertest.crawco.co.uk/incidents/6597925/claimants/736716' \
--header 'Authorization: Bearer {access token}'Response body parameters
| Parameter Name | Description | Type | Example Data |
|---|---|---|---|
firstName
|
The first name of the claimant. | string | John |
lastName
|
The last name of the claimant. | string | Smith |
organisationName
|
The organisation name where the claimant is not an individual. | string | |
isOrganisation
|
Flag specifying whether the claimant is an individual or an organisation. | Boolean | False |
dateOfBirth
|
The date of birth of the claimant. | string ($date) | 1967-07-12 |
gender
|
The gender of the claimant. | string | Male |
claimantType
|
The type of claimant to add. | string | |
contactPerson
|
The name of the contact person for the claimant. | string | Mr. John Smith |
contactAddress
|
The contact address of the claimant. | string | 15 Knights Park Kingston Upon Thames Surrey |
contactPostalCode
|
The post code of the claimant. | string | KT1 2AA |
contactTelephoneNumber
|
The telephone number of the claimant. | string | 0208 541 1111 |
contactMobileNumber
|
The mobile telephone number of the claimant | string | 07940012345 |
contactEmailAddress
|
The email address of the claimant. | string($email) | john.smith@email.com |
extendedFields
|
An array containing any extended fields | array |
Example response
{
"firstName": "John",
"lastName": "Smith",
"organisationName": null,
"isOrganisation": false,
"dateOfBirth": "1976-07-10",
"gender": "Male",
"claimantType": null,
"contactPerson": "Mr. John Smith",
"contactAddress": "15 Knights Park\r\nKingston Upon Thames\r\nSurrey",
"contactPostalCode": "KT1 2AA",
"contactTelephoneNumber": "0208 541 1111",
"contactMobileNumber": "07940012345",
"contactEmailAddress": "john.smith@email.com",
"extendedFields": [
{
"identifier": "Global_Claimant_Form:Title",
"value": "Mr"
},
{
"identifier": "Global_Claimant_Form:SSN",
"value": null
},
{
"identifier": "Global_Claimant_Form:Reference",
"value": null
},
{
"identifier": "Global_Claimant_Form:Vehicle_Registration",
"value": null
},
{
"identifier": "Global_Claimant_Form:Fatality",
"value": null
},
{
"identifier": "Global_Claimant_Form:Death_Date",
"value": null
},
{
"identifier": "Global_Claimant_Form:Number_Dependants",
"value": null
},
{
"identifier": "Global_Claimant_Form:Occupation",
"value": null
},
{
"identifier": "Global_Claimant_Form:Date_First_Employed",
"value": null
},
{
"identifier": "Global_Claimant_Form:Country",
"value": null
},
{
"identifier": "Global_Claimant_Form:Fax_Number",
"value": null
},
{
"identifier": "Global_Claimant_Form:Email_Preference",
"value": null
},
{
"identifier": "Global_Claimant_Form:Letter_Preference",
"value": null
},
{
"identifier": "Global_Claimant_Form:Mobile_Telephone_Preference",
"value": null
},
{
"identifier": "Global_Claimant_Form:SMS_Preference",
"value": null
},
{
"identifier": "Global_Claimant_Form:Telephone_Preference",
"value": null
},
{
"identifier": "Global_Claimant_Form:Policy_Reference",
"value": "POL1234567Z"
},
{
"identifier": "Global_Claimant_Form:Policy_StartDate",
"value": "2020-10-01"
},
{
"identifier": "Global_Claimant_Form:Policy_EndDate",
"value": "2021-09-30"
},
{
"identifier": "Global_Claimant_Form:Gefion (Poland):Claimant_Claim_Type",
"value": null
},
{
"identifier": "Global_Claimant_Form:Salvage_Applicable",
"value": null
},
{
"identifier": "Global_Claimant_Form:Salvage_Comments",
"value": null
},
{
"identifier": "Global_Claimant_Form:Salvage_Resolution",
"value": null
},
{
"identifier": "Global_Claimant_Form:Salvage_Value_PolicyCurrency",
"value": null
},
{
"identifier": "Global_Claimant_Form:Subrogation_Applicable",
"value": null
},
{
"identifier": "Global_Claimant_Form:Subrogation_Status",
"value": null
},
{
"identifier": "Global_Claimant_Form:Recovery_Circumstance",
"value": null
},
{
"identifier": "Global_Claimant_Form:Amount_Not_Recovered",
"value": null
},
{
"identifier": "Global_Claimant_Form:Case_In_Litigation",
"value": null
},
{
"identifier": "Global_Claimant_Form:Litigation_Reason",
"value": null
},
{
"identifier": "Global_Claimant_Form:Date_Proceedings_Issued",
"value": null
},
{
"identifier": "Global_Claimant_Form:Date_Proceedings_Served",
"value": null
},
{
"identifier": "Global_Claimant_Form:Claimant_Lawyer",
"value": null
},
{
"identifier": "Global_Claimant_Form:Defence_Lawyer",
"value": null
},
{
"identifier": "Global_Claimant_Form:Court",
"value": null
},
{
"identifier": "Global_Claimant_Form:Date_Acknowledgement_Required",
"value": null
},
{
"identifier": "Global_Claimant_Form:Date_Defence_Due",
"value": null
},
{
"identifier": "Global_Claimant_Form:Mediation_Considered",
"value": null
},
{
"identifier": "Global_Claimant_Form:Trial_Date",
"value": null
},
{
"identifier": "Global_Claimant_Form:Litigation_Strategy",
"value": null
},
{
"identifier": "Global_Claimant_Form:Litigation_Status",
"value": null
},
{
"identifier": "Global_Claimant_Form:Litigation_Result",
"value": null
},
{
"identifier": "Global_Claimant_Form:Date_Litigation_Concluded",
"value": null
},
{
"identifier": "Global_Claimant_Form:Claimant_Status",
"value": "Incident Only"
},
{
"identifier": "Global_Claimant_Form:DateTime_Claimant_Updated",
"value": "2022-05-01T20:47:52.000Z"
},
{
"identifier": "Global_Claimant_Form:Who_Updated_Claimant",
"value": "API CallScripter"
}
]
}