Incident metadata
This endpoint is used to return all the available fields and their relevant metadata for the claimant screen.
get
https://api.claimsmanagertest.crawco.co.uk/metadata/claimants
Path parameters
| Parameter Name | Description | Type | Example Data |
|---|---|---|---|
programmeCode
|
Programme code | string | 8ffd4f55 |
policyTypeCode
|
Policy type code | string | 17ed9895 |
countryCode
|
Policy country code. ISO 2-character code | string | GB |
incidentDate
|
The date of the incident. When omitted this defaults to the current date | string($date) | 2022-04-30 |
Example request
curl --location --request GET 'https://api.claimsmanagertest.crawco.co.uk/metadata/Claimants?programmeCode=8ffd4f55&policyTypeCode=17ed9895&countryCode=GB' \
--header 'Authorization: Bearer {access token}'Response body parameters
| Parameter Name | Description | Type | Example Data |
|---|---|---|---|
identifier
|
Unique identifier for the field. When the mapsTo property is ‘extendedFields’, this should be populated in the identifier field of the extendedField. | string | Global_Incident_Form:File_Handler |
mapsTo
|
Determines which property in the relevant model the field should be populated in. When this is ‘extendedFields’, the field should be added to the extendedFields array with the given identifier. | string | extendedFields |
name
|
The name of the field as it appears in Claims Manager | string | File Handler |
section
|
The tab in which this field can be found in Claims Manager | string | Status |
dataType
|
The expected data type for the field. When the mapsTo property is extendedFields, the given string value of the extendedField should be convertible to this data type. | string | string |
maxLength
|
When the dataType property is string, this field is the maximum length string that will be accepted. | numeric | 100 |
isRequired
|
Flag showing whether the field is marked as required in Claims Manager. | boolean | True |
listSource
|
When present, indicates that the value of this field should be one of the given options in the array. | array (string) | [“Option 1”, “Option 2”] |
Example response
[
{
"identifier": "Global_Claimant_Form:Title",
"mapsTo": "extendedFields",
"name": "Title",
"section": "Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Mr",
"Ms",
"Mrs",
"Miss",
"Dr",
"Prof"
]
},
{
"identifier": "Global_Claimant_Form:First_Name",
"mapsTo": "firstName",
"name": "First Name",
"section": "Details",
"dataType": "string",
"maxLength": 50,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Last_Name",
"mapsTo": "lastName",
"name": "Last Name",
"section": "Details",
"dataType": "string",
"maxLength": 50,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Organisation",
"mapsTo": "organisationName",
"name": "Organisation",
"section": "Details",
"dataType": "string",
"maxLength": 100,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Organisation_Is_Claimant",
"mapsTo": "isOrganisation",
"name": "Organisation is Claimant?",
"section": "Details",
"dataType": "boolean",
"maxLength": null,
"isRequired": true,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Gender",
"mapsTo": "gender",
"name": "Gender",
"section": "Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Male",
"Female"
]
},
{
"identifier": "Global_Claimant_Form:Claimant_Type",
"mapsTo": "claimantType",
"name": "Claimant Type",
"section": "Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Own Driver",
"Own Passenger",
"Pedestrian/Cyclist",
"TP Driver",
"TP Passenger",
"TP Property Owner"
]
},
{
"identifier": "Global_Claimant_Form:DOB",
"mapsTo": "dateOfBirth",
"name": "Date of Birth",
"section": "Details",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:SSN",
"mapsTo": "extendedFields",
"name": "Social Security Number",
"section": "Details",
"dataType": "string",
"maxLength": 35,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Reference",
"mapsTo": "extendedFields",
"name": "Reference",
"section": "Details",
"dataType": "string",
"maxLength": 35,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Vehicle_Registration",
"mapsTo": "extendedFields",
"name": "Vehicle Registration",
"section": "Details",
"dataType": "string",
"maxLength": 50,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Fatality",
"mapsTo": "extendedFields",
"name": "Fatality?",
"section": "Details",
"dataType": "boolean",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Death_Date",
"mapsTo": "extendedFields",
"name": "Date of Death",
"section": "Details",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Number_Dependants",
"mapsTo": "extendedFields",
"name": "Number of Dependants",
"section": "Details",
"dataType": "integer",
"maxLength": 3,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Occupation",
"mapsTo": "extendedFields",
"name": "Occupation",
"section": "Details",
"dataType": "string",
"maxLength": 50,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Date_First_Employed",
"mapsTo": "extendedFields",
"name": "Date First Employed",
"section": "Details",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Contact_Person",
"mapsTo": "contactPerson",
"name": "Contact Person",
"section": "Contact Details",
"dataType": "string",
"maxLength": 100,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Address",
"mapsTo": "contactAddress",
"name": "Address",
"section": "Contact Details",
"dataType": "string",
"maxLength": 300,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Postal_Code",
"mapsTo": "contactPostalCode",
"name": "Postal Code",
"section": "Contact Details",
"dataType": "string",
"maxLength": 35,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Country",
"mapsTo": "extendedFields",
"name": "Country",
"section": "Contact Details",
"dataType": "string",
"maxLength": 5,
"isRequired": false,
"listSource": [
"Afghanistan",
"Åland Islands",
"Albania",
"Algeria",
"American Samoa",
"Andorra",
"Angola",
"Anguilla",
"Antarctica",
"Antigua and Barbuda",
"Argentina",
"Armenia",
"Aruba",
"Australia",
"Austria",
"Azerbaijan",
"Bahamas",
"Bahrain",
"Bangladesh",
"Barbados",
"Belarus",
"Belgium",
"Belize",
"Benin",
"Bermuda",
"Bhutan",
"Bolivia, Plurinational State of",
"Bonaire, Sint Eustatius and Saba",
"Bosnia and Herzegovina",
"Botswana",
"Bouvet Island",
"Brazil",
"British Indian Ocean Territory",
"Brunei Darussalam",
"Bulgaria",
"Burkina Faso",
"Burundi",
"Cabo Verde",
"Cambodia",
"Cameroon",
"Canada",
"Cayman Islands",
"Central African Republic",
"Chad",
"Chile",
"China",
"Christmas Island",
"Cocos (Keeling) Islands",
"Colombia",
"Comoros",
"Congo",
"Cook Islands",
"Costa Rica",
"Côte d'Ivoire",
"Croatia",
"Cuba",
"Curaçao",
"Cyprus",
"Czech Republic",
"Democratic Republic of the Congo",
"Denmark",
"Djibouti",
"Dominica",
"Dominican Republic",
"Ecuador",
"Egypt",
"El Salvador",
"Equatorial Guinea",
"Eritrea",
"Estonia",
"Ethiopia",
"Falkland Islands",
"Faroe Islands",
"Fiji",
"Finland",
"France",
"French Guiana",
"French Polynesia",
"French Southern Territories",
"Gabon",
"Gambia",
"Georgia",
"Germany",
"Ghana",
"Gibraltar",
"Greece",
"Greenland",
"Grenada",
"Guadeloupe",
"Guam",
"Guatemala",
"Guernsey",
"Guinea",
"Guinea-Bissau",
"Guyana",
"Haiti",
"Heard Island and McDonald Islands",
"Holy See",
"Honduras",
"Hong Kong",
"Hungary",
"Iceland",
"India",
"Indonesia",
"Iran",
"Iraq",
"Ireland",
"Isle of Man",
"Israel",
"Italy",
"Jamaica",
"Japan",
"Jersey",
"Jordan",
"Kazakhstan",
"Kenya",
"Kiribati",
"Korea (the Democratic People's Republic of)",
"Korea (the Republic of)",
"Kosovo",
"Kuwait",
"Kyrgyzstan",
"Lao People's Democratic Republic",
"Latvia",
"Lebanon",
"Lesotho",
"Liberia",
"Libya",
"Liechtenstein",
"Lithuania",
"Luxembourg",
"Macao",
"Macedonia",
"Madagascar",
"Malawi",
"Malaysia",
"Maldives",
"Mali",
"Malta",
"Marshall Islands",
"Martinique",
"Mauritania",
"Mauritius",
"Mayotte",
"Mexico",
"Micronesia",
"Moldova",
"Monaco",
"Mongolia",
"Montenegro",
"Montserrat",
"Morocco",
"Mozambique",
"Myanmar",
"Namibia",
"Nauru",
"Nepal",
"Netherlands",
"New Caledonia",
"New Zealand",
"Nicaragua",
"Niger",
"Nigeria",
"Niue",
"Norfolk Island",
"Northern Mariana Islands",
"Norway",
"Oman",
"Pakistan",
"Palau",
"Palestine, State of",
"Panama",
"Papua New Guinea",
"Paraguay",
"Peru",
"Philippines",
"Pitcairn",
"Poland",
"Portugal",
"Puerto Rico",
"Qatar",
"Réunion",
"Romania",
"Russian Federation",
"Rwanda",
"Saint Barthélemy",
"Saint Helena, Ascension and Tristan da Cunha",
"Saint Kitts and Nevis",
"Saint Lucia",
"Saint Martin (French part)",
"Saint Pierre and Miquelon",
"Saint Vincent and the Grenadines",
"Samoa",
"San Marino",
"Sao Tome and Principe",
"Saudi Arabia",
"Senegal",
"Serbia",
"Seychelles",
"Sierra Leone",
"Singapore",
"Sint Maarten (Dutch part)",
"Slovakia",
"Slovenia",
"Solomon Islands",
"Somalia",
"South Africa",
"South Georgia and the South Sandwich Islands",
"South Sudan",
"Spain",
"Sri Lanka",
"Sudan",
"Suriname",
"Svalbard and Jan Mayen",
"Swaziland",
"Sweden",
"Switzerland",
"Syrian Arab Republic",
"Taiwan",
"Tajikistan",
"Tanzania, United Republic of",
"Thailand",
"Timor-Leste",
"Togo",
"Tokelau",
"Tonga",
"Trinidad and Tobago",
"Tunisia",
"Turkey",
"Turkmenistan",
"Turks and Caicos Islands",
"Tuvalu",
"Uganda",
"Ukraine",
"United Arab Emirates",
"United Kingdom",
"United States",
"United States Minor Outlying Islands",
"Uruguay",
"Uzbekistan",
"Vanuatu",
"Venezuela, Bolivarian Republic of ",
"Viet Nam",
"Virgin Islands (British)",
"Virgin Islands (U.S.)",
"Wallis and Futuna",
"Western Sahara",
"Yemen",
"Zambia",
"Zimbabwe"
]
},
{
"identifier": "Global_Claimant_Form:Telephone_Number",
"mapsTo": "contactTelephoneNumber",
"name": "Telephone Number",
"section": "Contact Details",
"dataType": "string",
"maxLength": 50,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Mobile_Number",
"mapsTo": "contactMobileNumber",
"name": "Mobile Number",
"section": "Contact Details",
"dataType": "string",
"maxLength": 50,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Fax_Number",
"mapsTo": "extendedFields",
"name": "Fax Number",
"section": "Contact Details",
"dataType": "string",
"maxLength": 50,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Email_Address",
"mapsTo": "contactEmailAddress",
"name": "Email Address",
"section": "Contact Details",
"dataType": "string($email)",
"maxLength": 254,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Email_Preference",
"mapsTo": "extendedFields",
"name": "Communication preference: Email",
"section": "Contact Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Allowed",
"Preferred",
"Prohibited"
]
},
{
"identifier": "Global_Claimant_Form:Letter_Preference",
"mapsTo": "extendedFields",
"name": "Communication preference: Letter",
"section": "Contact Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Allowed",
"Preferred",
"Prohibited"
]
},
{
"identifier": "Global_Claimant_Form:Mobile_Telephone_Preference",
"mapsTo": "extendedFields",
"name": "Communication preference: Mobile Telephone",
"section": "Contact Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Allowed",
"Preferred",
"Prohibited"
]
},
{
"identifier": "Global_Claimant_Form:SMS_Preference",
"mapsTo": "extendedFields",
"name": "Communication preference: SMS",
"section": "Contact Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Allowed",
"Preferred",
"Prohibited"
]
},
{
"identifier": "Global_Claimant_Form:Telephone_Preference",
"mapsTo": "extendedFields",
"name": "Communication preference: Telephone",
"section": "Contact Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Allowed",
"Preferred",
"Prohibited"
]
},
{
"identifier": "Global_Claimant_Form:Policy_Reference",
"mapsTo": "extendedFields",
"name": "Policy Reference",
"section": "Policy Info",
"dataType": "string",
"maxLength": 35,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Policy_StartDate",
"mapsTo": "extendedFields",
"name": "Policy Start Date",
"section": "Policy Info",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Policy_EndDate",
"mapsTo": "extendedFields",
"name": "Policy End Date",
"section": "Policy Info",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Salvage_Applicable",
"mapsTo": "extendedFields",
"name": "Salvage is Applicable?",
"section": "Salvage",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Yes",
"No",
"To be Decided"
]
},
{
"identifier": "Global_Claimant_Form:Salvage_Comments",
"mapsTo": "extendedFields",
"name": "Salvage Comments",
"section": "Salvage",
"dataType": "string",
"maxLength": 1000,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Salvage_Resolution",
"mapsTo": "extendedFields",
"name": "Salvage Resolution",
"section": "Salvage",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Salvage Sold",
"Insured Retained",
"No Salvage",
"Destroyed - No Value",
"Destroyed - Brand Issues",
"Repaired or Refurbished"
]
},
{
"identifier": "Global_Claimant_Form:Salvage_Value_PolicyCurrency",
"mapsTo": "extendedFields",
"name": "Salvage Value (Policy Currency)",
"section": "Salvage",
"dataType": "number($double)",
"maxLength": 19,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Subrogation_Applicable",
"mapsTo": "extendedFields",
"name": "Subrogation is Applicable?",
"section": "Subrogation",
"dataType": "boolean",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Subrogation_Status",
"mapsTo": "extendedFields",
"name": "Subrogation Status",
"section": "Subrogation",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Closed No Further Recovery",
"Closed No Recovery",
"Closed With Recovery",
"No Recovery Potential",
"Open Recovery",
"Partial Recovery"
]
},
{
"identifier": "Global_Claimant_Form:Recovery_Circumstance",
"mapsTo": "extendedFields",
"name": "Reason for any Amount Not Recovered",
"section": "Subrogation",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Contract Limit",
"Current/Market Value",
"Deductible",
"Insufficient Evidence",
"Time Barred",
"TP Not Liable",
"TP Quantum Offer",
"TP Unknown"
]
},
{
"identifier": "Global_Claimant_Form:Amount_Not_Recovered",
"mapsTo": "extendedFields",
"name": "Amount Not Recovered (Policy Currency)",
"section": "Subrogation",
"dataType": "number($double)",
"maxLength": 19,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Case_In_Litigation",
"mapsTo": "extendedFields",
"name": "Case In Litigation?",
"section": "Litigation Details",
"dataType": "boolean",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Litigation_Reason",
"mapsTo": "extendedFields",
"name": "Reason for Litigation",
"section": "Litigation Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Application for Pre-Action Disclosure",
"Costs",
"Infant Approval",
"Liability Dispute",
"Limitation",
"Quantum and Liability Dispute",
"Quantum only"
]
},
{
"identifier": "Global_Claimant_Form:Date_Proceedings_Issued",
"mapsTo": "extendedFields",
"name": "Date Proceedings Issued",
"section": "Litigation Details",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Date_Proceedings_Served",
"mapsTo": "extendedFields",
"name": "Date Proceedings Served",
"section": "Litigation Details",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Claimant_Lawyer",
"mapsTo": "extendedFields",
"name": "Name of Claimant's Lawyer",
"section": "Litigation Details",
"dataType": "string",
"maxLength": 150,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Defence_Lawyer",
"mapsTo": "extendedFields",
"name": "Name of Defence Lawyer",
"section": "Litigation Details",
"dataType": "string",
"maxLength": 150,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Court",
"mapsTo": "extendedFields",
"name": "Court",
"section": "Litigation Details",
"dataType": "string",
"maxLength": 150,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Date_Acknowledgement_Required",
"mapsTo": "extendedFields",
"name": "Date Acknowledgement Required",
"section": "Litigation Details",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Date_Defence_Due",
"mapsTo": "extendedFields",
"name": "Date Defence Due",
"section": "Litigation Details",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Mediation_Considered",
"mapsTo": "extendedFields",
"name": "Mediation Considered?",
"section": "Litigation Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Yes",
"No",
"To Be Considered"
]
},
{
"identifier": "Global_Claimant_Form:Trial_Date",
"mapsTo": "extendedFields",
"name": "Trial Date",
"section": "Litigation Details",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Litigation_Strategy",
"mapsTo": "extendedFields",
"name": "Litigation Strategy",
"section": "Litigation Details",
"dataType": "string",
"maxLength": 1500,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Litigation_Status",
"mapsTo": "extendedFields",
"name": "Litigation Status",
"section": "Litigation Details",
"dataType": "string",
"maxLength": 1500,
"isRequired": false,
"listSource": null
},
{
"identifier": "Global_Claimant_Form:Litigation_Result",
"mapsTo": "extendedFields",
"name": "Litigation Result",
"section": "Litigation Details",
"dataType": "string",
"maxLength": 10,
"isRequired": false,
"listSource": [
"Settled before Trial",
"Settled between parties at Trial",
"Judgement at Trial in favour of Claimant",
"Judgement at Trial in favour of Defendant",
"Pre-Action Disclosure Completed",
"Withdrawn / Repudiated Pre-trial"
]
},
{
"identifier": "Global_Claimant_Form:Date_Litigation_Concluded",
"mapsTo": "extendedFields",
"name": "Date Litigation Concluded",
"section": "Litigation Details",
"dataType": "string($date)",
"maxLength": null,
"isRequired": false,
"listSource": null
}
]