Service partners files integration

Authorization

To submit file to case or damage notification service partner must provide valid authorization header. For more information, please see authentication.

The file submission endpoints require "platform-service-provider:write" scope.

Endpoints and their details described on this page are only applicable for use in Scalepoint ECB system.

Integration point URLs

Below 2 available integration points are described with samples provided.

Submitting files to open cases

With this endpoint files can be submitted to open cases in ECB system.

URL: /file/submitForCase

HTTP METHOD: POST

URL Example: https://sandbox.scalepoint.com/ecx/host/api/integration/v1/file/submitForCase

Requirements:

• Case must not be closed
• User with provided e-mail must exist and be active under service partner employees in Scalepoint ECB system
• Valid service partner security token must be provided

Submitting files to damage notifications

URL: /file/submitForDamageNotification

HTTP METHOD: POST

URL Example: https://sandbox.scalepoint.com/ecx/host/api/integration/v1/file/submitForDamageNotification

Requirements:

• Damage notification must not be merged to a case
• User with provided e-mail must exist and be active under service partner employees in Scalepoint ECB system
• Valid service partner security token must be provided

Request structure

File submit request must be in form of json which means that it must include Content-Type header equal to: “application/json”. For more details of available content types 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.

Request parameters description

Example request

{
  "securityToken": "00000000-0000-0000-0000-000000000000",
  "payload": {
      "files": [
        {
          "content": "base64encoded file content",
          "contentType": "text/plain",
          "fileName": "filename.txt",
          "description": "test description",
          "isRestricted": false,
          "isDamageImage": false
        },
        {
          "content": "base64encoded file2 content",
          "contentType": "text/csv",
          "description": "test csv file2",
          "fileName": "test.csv",
          "isDamageImage": false,
          "isRestricted": false
        }
      ],
      "id": "11111111-1111-1111-1111-111111111111",
      "insuranceCompanyAlias": "company",
      "userEmail": "company_ds@example.com"
  }
}

NOTE: In order to retrieve proper insuranceCompanyAlias and securityToken reach out to your contact at Scalepoint.

Response parameters description

Available response status codes description

Example response

Success

{
    "success": true,
    "payload": {
        "files": [
            {
                "id": "ce502efb-6128-4c89-8850-79ac648bef84",
                "fileName": "filename.txt"
            },
            {
                "id": "d37b2e13-c2da-44f8-acd7-066b7a1396f9",
                "fileName": "test.csv"
            }
        ]
    }
}

Failure

{
    "success": false,
    "errorDescription": "payload.id with value '11111111-1111-1111-1111-111111111111' is not ok. Reason: Damage notification with id 11111111-1111-1111-1111-111111111111 is already merged to claim with id 22222222-2222-2222-2222-222222222222",
    "errorType": "DamageNotificationMergedToClaim"
}

Allowed file extensions

Below table lists all allowed file extensions to be used during endpoints invocation