Service Partners Integration with Scalepoint's FNoL

Authorization

To submit FNoL service partner must provide valid authorization header. For more information, please see authentication.

The FNoL submit endpoint requires "platform-service-provider:write" scope.

Integration point URL

URL: /fnol/submit?company={companyAlias}

NOTE: In order to retrieve proper companyAlias reach out to your contact at Scalepoint.

HTTP METHOD: POST

URL Example: https://sandbox.scalepoint.com/ecx/host/api/integration/v1/fnol/submit?company=scalepoint

Example: FnolSubmitRequest.example.txt FNoL submit request must be in form of multipart/form-data which means that it must include Content-Type header equal to: “multipart/form-data; boundary=”. For more details of this content type and boundaries please see Content-Type description.

The request must include only one part with Content-Type header equal to “application/vnd.casecreation+json”. This part will be treated as a FNoL payload. Request can consist also of other parts that will be processed and treated as attachments for submitted FNoL. FNoL payload schema is the same as for the unified case creation and it is tenant specific. For more details, please see case integration api.

Example request


------WebKitFormBoundarykuWhvnTpvTvfnASA
Content-Disposition: form-data; name="Case creation"; filename="CaseCreation.json"
Content-Type: application/vnd.casecreation+json

{
  "tenant": "tenant",
  "company": "company",
  "language": "da-DK",
  "country": "dk",
  "caseType": "insuranceClaim",
  "subCaseType": "tenant.product.productAlias",
  "accidentDate": "8/3/2021 12:00:00 AM",
  "firstNotificationDate": "10/4/2021 12:00:00 AM",
  "policy": {
    "number": "123456789"
  },
  "loss": {
    "type": "disability",
    "subType": "workInjury",
    "description": "Description",
    "building": {
      "sector": "Private"
    }
  },
  "customer": {
    "personalTaxId": "123456789",
    "paymentDetails": [
      {
        "type": "bankAccount"
      }
    ],
    "email": "test@example.com",
    "lastName": "Doe",
    "firstName": "John",
    "address": {
      "street1": "Street 1",
      "city": "City",
      "postalCode": "0000"
    }
  },
  "case": {
    "placeOfExaminationFirstTime": "Place",
    "hasSubrogation": "no",
    "wellForWorkTimeOfAccident": "yes",
    "whenPlaceOfExamFirstTime": "9/1/2021 12:00:00 AM",
    "howDidAccidentHappen": "How",
    "sourceOfCreation": "internetAutomatic",
    "accidentHappenedInRelationTo": "asSelfemployed",
    "nameOfHospital": "Hospital",
    "reasonForAccident": "Reason",
    "whenDidAccidentHappen": "8/3/2021 12:00:00 AM"
  },
  "damageAddress": {
    "city": "Other City",
    "postalCode": "0000",
    "street1": "Street 2"
  }
}

------WebKitFormBoundarykuWhvnTpvTvfnASA
Content-Disposition: form-data; name="test"; filename="TestFile1.txt"
Content-Type: text/plain

TestFile1 Content
------WebKitFormBoundarykuWhvnTpvTvfnASA--

Example response


{
    "payload": {
        "itemId": "f9ff5c7b-6c36-40e7-915b-3b8d40558ee3"
    },
    "success": true
}

Request customizations

At the root node of FNoL document few additional sections can be provided that will later be handled when document is processed. Please read description for each of sections below to find out how FNoL processing can be customized by adding some specific information to the submitted payload.

FNoL data node

When you are using service partners events integration api you can extend your submitted payload with an identifier you'd like to receive back in the event that is sent to your end when we automatically request a service on a claim and assign you to it. To achieve this you need to provide externalId value inside of fnolData node. The identifier is of string type and doesn't have any format requirements. If you provide externalId in your payload please also make sure it is excluded from printout

"fnolData": {
  "externalId": "yourExternalId"
}

Printout data

Insured object information

You can use this section to provide information about the object that is considered as insured one (this can be a property, car, person, etc...). Section can contain fields:

policyNumber - number of the policy
policyType - type of the policy
name - whatever text that can be called a display string for the object - e.g. vehicle brand and model, persons first and last name, etc...
address - field dedicated for property/content related entries, should contain display string for the considered address
objectId - unique identifier of object (CPR for person, registration number for car, etc...)

Some samples below:

  "insuredObject": {
    "policyNumber": "222222222",
    "policyType": "Husforsikring",
    "address": "Ingemannsvej 9, 1964 Frederiksberg C"
  }

  "insuredObject": {
    "policyNumber": "333333333",
    "policyType": "Hundeforsikring",
    "name": "Tokyo"
  }

Policy holder information

Section can contain fields as visible in the sample below. Some description of non-obvious fields:

memberNumber - member number from policy system

  "policyHolder": {
    "memberNumber": "984605",
    "firstName": "First",
    "lastName": "Last",
    "email": "test@example.com",
    "phone": "+4512345678",
    "mobile": "+4522222222",
    "personalTaxId": "1111111111",
    "address": {
      "street1": "Ingemannsvej 9",
      "postalCode": "1964",
      "city": "Frederiksberg C",
      "country": "dk"
    }
  }

Fields excluded from printout

This section applies for exclusion rules of fields from case and fnolData nodes. If for some reason there are fields you don't want to be displayed on printout you can specify their aliases in a dedicated string array - fieldsExcludedFromPrintouts

Sample of case node:

  "case": {
    "profession": "Plumber",
    "typeOfPipe": "heatingPipes",
    "typeOfLeakage": "leakage"
  }

Sample of exclusion list:

  "fieldsExcludedFromPrintouts": [
    "profession",
    "typeOfLeakage",
  ]