Help center

Document Servicing API ​

Run integration(s) for a Portfolio

POST https://www.clarinetlive.com/api/v3/documentservicing/run/portfolio/<portfolioPublicId>?mode=<mode>

Request

No body.

Query parameters:

  • portfolioPublicId required - the public id of the Portfolio for which you want to run integrations for. You can look this up using the Portfolios API.
  • mode optional - query string parameter that accepts Normal or DryRun. The latter means that no documents will be uploaded, it will just be a test run that outputs potential actions that can be used to verify a particular integration configuration.

Response

The correlation id you can use for subsequent status requests, and a success or failure message.

json
{
    "correlationId": "4a7c0c72-4d6a-4c6e-8a9f-25326212a982",
    "message": "The request has been queued successfully. See location header for status query"
}

Run a specific integration

POST https://www.clarinetlive.com/api/v3/documentservicing/run/integration/<integrationPublicId>?mode=<mode>

Request

No body.

Query parameters:

  • integrationPublicId required - the public id of the Integration that you want to run
  • mode optional - query string parameter that accepts Normal or DryRun. The latter means that no documents will be uploaded, it will just be a test run that outputs potential actions that can be used to verify a particular integration configuration.

Response

The correlation id you can use for subsequent status requests, and a success or failure message.

json
{
    "correlationId": "4a7c0c72-4d6a-4c6e-8a9f-25326212a982",
    "message": "The request has been queued successfully. See location header for status query"
}

Run a specific integration

GET https://www.clarinetlive.com/api/v3/documentservicing/run/status/<correlationId>?detailed=<true|false>

Request

No body.

Query parameters:

  • correlationIdrequired - the correlation id of the run to get the status for, provided by the response from the /documentservicing/run endpoints detailed above.
  • detailed optional - if true (default false), the actions taken will be detailed in the response. This may make the output large depending on the size of the portfolio and the number of actions taken.

Response

An array of integration runs with basic information about their current status and actions taken. The actions array is not included unless detailed is set to true.

json
[
    {
        "publicId": "42dfe356-5d69-44ac-8393-c626b55634e5",
        "integration": "Test",
        "correlationId": "92bf148e-9e09-4159-9d97-13d680e94ed3",
        "createdTime": "2025-10-08T14:54:41Z",
        "startedTime": "2025-10-08T14:54:47Z",
        "finishedTime": "2025-10-08T14:54:58Z",
        "dryRun": false,
        "documentsAdded": 4,
        "matchErrors": 0,
        "status": "Completed",
        "actions": [
            {
                "publicId": "76fc6f87-d685-4c1b-ba1e-a4599c11cdeb",
                "actionTime": "2025-10-08T14:54:54Z",
                "sourceFile": "TestDocumentLibrary/root/Case 6689/hipaa01.pdf",
                "folder": "https://testing.sharepoint.com/sites/Testing/TestDocumentLibrary/Case 6689",
                "matchedValue": "Case 6689",
                "matchedFieldType": "CaseReference",
                "matchedEntityType": "Case",
                "matchedPublicId": "4e5882e3-4f6a-4367-9f38-9d3551ad7684",
                "documentPublicId": "aa363988-bbd8-498e-a350-a767332071b8",
                "matchedEntityName": "Case 6689"
            },
            {
                "publicId": "65599544-a3bb-4a9e-9dae-f4727415a865",
                "actionTime": "2025-10-08T14:54:57Z",
                "sourceFile": "TestDocumentLibrary/root/Case 6689/policyform01.pdf",
                "folder": "https://testing.sharepoint.com/sites/Testing/TestDocumentLibrary/Case 6689",
                "matchedValue": "Case 6689",
                "matchedFieldType": "CaseReference",
                "matchedEntityType": "Case",
                "matchedPublicId": "4e5882e3-4f6a-4367-9f38-9d3551ad7684",
                "documentPublicId": "8a8e5264-4f88-43bb-8a25-5cab78826afd",
                "matchedEntityName": "Case 6689"
            },
            {
                "publicId": "42eafc3e-1b4f-4ba1-a561-aebbb54cef32",
                "actionTime": "2025-10-08T14:54:57Z",
                "sourceFile": "TestDocumentLibrary/root/Case 6700/Illustration01.pdf",
                "folder": "https://testing.sharepoint.com/sites/Testing/TestDocumentLibrary/Case 6700",
                "matchedValue": "Case 6700",
                "matchedFieldType": "CaseReference",
                "matchedEntityType": "Case",
                "matchedPublicId": "255e1dbd-d19a-48d1-942e-588a884cf764",
                "documentPublicId": "66d22a45-ad15-4031-8038-c9ca052e019c",
                "matchedEntityName": "Case 6700"
            },
            {
                "publicId": "8898498b-4bc0-4fd5-866b-ea5eb8dc01b5",
                "actionTime": "2025-10-08T14:54:58Z",
                "sourceFile": "TestDocumentLibrary/root/Case 6700/policyform02.pdf",
                "folder": "https://testing.sharepoint.com/sites/Testing/TestDocumentLibrary/Case 6700",
                "matchedValue": "Case 6700",
                "matchedFieldType": "CaseReference",
                "matchedEntityType": "Case",
                "matchedPublicId": "255e1dbd-d19a-48d1-942e-588a884cf764",
                "documentPublicId": "14a67cdb-f535-457f-ad9f-1aec95f2b3d5",
                "matchedEntityName": "Case 6700"
            }
        ]
    }
]

Get available integrations for a Portfolio

GET https://www.clarinetlive.com/api/v3/documentservicing/integrations/<portfolioPublicId>

Request

No body.

Query parameters

No query parameters.

Response

An array of integrations available on the requested portfolio.

json
[
    {
        "publicId": "60ab3a54-7c21-425c-b7b5-152120d97180",
        "portfolioPublicId": "ddb11165-785f-4dbf-8450-d6591b633365",
        "documentServiceConnectionName": "My SharePoint Connection",
        "documentServiceConnectionType": "SharePoint",
        "searchFields": [
            "CaseReference"
        ],
        "directory": "SharePoint SubFolder",
        "mappingsCount": 1,
        "name": "Testing",
        "disabled": false,
        "portfolioName": "Test Portfolio"
    }
]

Get runs for a Portfolio

GET https://www.clarinetlive.com/api/v3/documentservicing/runs/portfolio/<portfolioPublicId>

Request

No body.

Query parameters

  • portfolioPublicId - the portfolio public identifier to retrieve runs for
  • pageoptional - the page of results to query for
  • pageSize optional - the number of results per page

Response

An array of runs available for the portfolio, ordered by creation time descending, and pagination details.

json
{
    "pagination": {
        "currentPage": 1,
        "pageSize": 50,
        "totalResults": 2
    },
    "runs": [
        {
            "publicId": "dddbbe3b-985a-40e2-8efa-3114f622aa27",
            "integration": "Testing",
            "correlationId": "9f164c30-e89b-4d98-b3df-f40972e61631",
            "createdTime": "2025-10-15T09:34:04Z",
            "startedTime": "2025-10-15T09:34:07Z",
            "finishedTime": null,
            "dryRun": false,
            "documentsAdded": 33,
            "matchErrors": 0,
            "status": "InProgress"
        }
    ]
}

Get a specific run

GET https://www.clarinetlive.com/api/v3/documentservicing/run/<runPublicId>

Request

No body.

Query parameters

  • detailed - includes action detail in the response body

Response

Information on the requested run such as start, end time and current status.

json
{
    "publicId": "dddbbe3b-985a-40e2-8efa-3114f622aa27",
    "integration": "Testing",
    "correlationId": "9f164c30-e89b-4d98-b3df-f40972e61631",
    "createdTime": "2025-10-15T09:34:04Z",
    "startedTime": "2025-10-15T09:34:07Z",
    "finishedTime": null,
    "dryRun": false,
    "documentsAdded": 33,
    "matchErrors": 0,
    "status": "InProgress"
}

© 2025 ClearLife Limited. All Rights Reserved.