> For the complete documentation index, see [llms.txt](https://partner-docs.covergenius.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://partner-docs.covergenius.com/xclaim/first-notice-of-loss-fnol/get-fnol.md).
# Get Fnol
Each FNOL includes 1 to n sections which contain 1 to m sectionFields.
Each sectionField has a type, which you can use to build a form element and validate the data input by cutomers. Check the Appendix for the data types currently supported.
When submitting the claim, the data should match the field type, and any of the validations it contains. Check the Appendix for a list of possible validations.
## Get Fnol
`GET` `https://api.xclaim.xcover-staging.com/partners/{partnerCode}/fnol/{claimTypeUuid}`
Returns data required to build a form to collect data needed to submit a claim.
Each FNOL includes 1 to n sections which contain 1 to m sectionFields.
Each sectionField has a type, which you can use to build a form element and validate the data input by cutomers. Check the Appendix for the data types currently supported.
When submitting the claim, the data should match the field type, and any of the validations it contains. Check the Appendix for a list of possible validations.
#### Path Parameters
| Name | Type | Description |
| ----------------------------------------------- | ------ | ---------------------- |
| partnerCode\* | String | eg. XYZ999 |
| claimTypeUuid\* | String | Claim type uuid string |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | -------------------- |
| Authorization\* | String | Bearer {{JWT token}} |
| Content-Type\* | String | application/json |
{% tabs %}
{% tab title="200: OK " %}
{% tabs %}
{% tab title="Request" %}
{% endtab %}
{% tab title="Response" %}
```json
{
"data": {
"claimType": {
"id": "2b106dce-984e-483a-9b59-87f050643e95",
"name": "parcel_damaged",
"label": "Parcel damaged",
"description": "Parcel damaged",
"createdAt": "2023-07-13T02:58:53+00:00",
"updatedAt": "2023-07-13T02:58:53+00:00",
"claimTypeCategoryId": null,
"translationsCompletedAt": null,
"multipleClaims": "UNLIMITED_CLAIMS_ALLOWED",
"replacerSchemaId": null,
"riskLimitAmount": "2500.000000000000000000",
"riskLimitCurrency": "EUR",
"observingPeriod": 0,
"multipleClaimsPerClaimType": "UNLIMITED_CLAIMS_ALLOWED",
"isExcessCollectionRequired": false,
"isInspectionRequired": false,
"reserveAmount": "1380.000000000000000000",
"reserveCurrency": "GEL",
"isContentInXcms": false
},
"sections": [
{
"id": "715231d4-bf06-4425-8fb7-59d66ea3f068",
"name": "claimant_section",
"label": "Claimant information section",
"description": "Claimant information section, default but optional section field for every claim type",
"ordering": 1,
"sectionFields": [
{
"id": "cd425299-e2f8-43fd-82bc-79c1a79b1dec",
"name": "first_name",
"required": true,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "First Name",
"description": "Claimant first name"
},
"ordering": 1,
"conditions": null,
"conditionAndOr": null,
"type": "string"
},
{
"id": "7217c453-9af7-480d-b050-b4a872b383e0",
"name": "middle_name",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "Middle Name",
"description": "Claimant Middle name"
},
"ordering": 2,
"conditions": null,
"conditionAndOr": null,
"type": "string"
},
{
"id": "a247b8a6-b6ef-48f0-95d8-4a9b6aad2848",
"name": "last_name",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "Last Name",
"description": "Claimant last name"
},
"ordering": 3,
"conditions": null,
"conditionAndOr": null,
"type": "string"
},
{
"id": "a367e685-989a-44a5-af9f-ba13d8666212",
"name": "email",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "Email",
"description": "Claimant email"
},
"ordering": 4,
"conditions": null,
"conditionAndOr": null,
"type": "string"
},
{
"id": "d1276c39-1959-4f52-98b3-88f949ab9b7a",
"name": "phone",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "Phone",
"description": "Claimant phone"
},
"ordering": 5,
"conditions": null,
"conditionAndOr": null,
"type": "string"
},
{
"id": "d1059230-989d-42e2-ab07-e75a3dae1909",
"name": "date_of_birth",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "Date Of Birth",
"description": "Claimant date of birth"
},
"ordering": 6,
"conditions": null,
"conditionAndOr": null,
"type": "date"
},
{
"id": "6bb46f06-85ad-41bc-b413-8068ff05953f",
"name": "address1",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "Address Line 1",
"description": "Claimant address line 1"
},
"ordering": 7,
"conditions": null,
"conditionAndOr": null,
"type": "string"
},
{
"id": "2c7132f0-446f-4e28-88ad-01966e16aa15",
"name": "address2",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "Address Line 2",
"description": "Claimant address line 2"
},
"ordering": 8,
"conditions": null,
"conditionAndOr": null,
"type": "string"
},
{
"id": "8fc3f730-0cae-4401-902a-263764a9ff44",
"name": "city",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "City",
"description": "Claimant city"
},
"ordering": 9,
"conditions": null,
"conditionAndOr": null,
"type": "string"
},
{
"id": "2513eec9-093c-4bb2-b672-d0f9c58944ad",
"name": "state_province",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "State/ Province",
"description": "State or province"
},
"ordering": 10,
"conditions": null,
"conditionAndOr": null,
"type": "string"
},
{
"id": "268f7820-6361-4bef-af1a-4cd93fe970e6",
"name": "postal_code",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "Postal Code",
"description": "Postal code"
},
"ordering": 11,
"conditions": null,
"conditionAndOr": null,
"type": "string"
},
{
"id": "c3b58e06-b161-49d0-87e2-f5870d29a7ff",
"name": "country",
"required": false,
"readOnly": false,
"validation": null,
"options": null,
"meta": {
"label": "Country",
"description": "Country"
},
"ordering": 12,
"conditions": null,
"conditionAndOr": null,
"type": "string"
}
]
},
{
"id": "b0c6d3bb-dec6-48a2-ad61-20fbe0a33d6b",
"name": "claim_information",
"label": "Claim Information",
"description": "Claim Information Section",
"ordering": 2,
"sectionFields": [
{
"id": "43951b66-d378-499e-b90b-b42f48c901f0",
"name": "description",
"required": true,
"readOnly": true,
"validation": null,
"options": null,
"meta": {
"label": "Which items are you claiming for?",
"description": "Your claim will be assessed faster if you provide.",
"placeholder": "description",
"display": null
},
"ordering": 1,
"conditions": null,
"conditionAndOr": null,
"type": "string"
}
]
}
]
}
}
```
{% endtab %}
{% endtabs %}
{% endtab %}
{% tab title="404: Not Found " %}
{% tabs %}
{% tab title="Request" %}
{% endtab %}
{% tab title="Response" %}
```json
{
"type": "exception",
"message": "No valid claim type could be found."
}
```
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://partner-docs.covergenius.com/xclaim/first-notice-of-loss-fnol/get-fnol.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.