Public API Changelog

These logs document changes to the Arken Public API. The document lists the change and the environment where it is rolled out.

Active Environments The environments where the changes are live are listed on the side.

Breaking changes are listed where relevant. Breaking changes are any changes in resource paths, changing payload structures, or fixing HTTP verbs and response codes. This may require development.

Events are sent sequentially and in real-time but upon receiving an event, a sequential order cannot be guaranteed.
ALL API endpoints have a 10MB hard restriction on the payload

Oct 19, 2022 New fields added to Client Model

UK SANDBOX

Three new fields have been exposed in the Client Model

This extensionData is only available under the ARKEN application value.

"extensionData": {
  "preferred": "string",
  "referred": "string"
}

The preferred value switches to display the below methods of the preferred contact

The referred value stores how the client’s partner should be referred to.

"preferredContactMethod": "string"

Jan 24, 2022 Delete All Documents per Client Endpoint - Hard Delete functionality

UK SANDBOX UK PROD

A new endpoint is available to delete ALL the documents for a specific client:

DELETE /documentdata/account/client

The AccountHashId and ClientHashId are mandatory fields. This endpoint will remove all the documents for the client but not the client itself.

Any DELETE function will now immediately delete the request object.

Dec 8, 2021 New Client and Document Delete Endpoints are available

UK SANDBOX UK PROD

Two new endpoints are available:

DELETE/client and DELETE /documentdata

Deleting a Client will not remove all the documents linked with the Client. This will be changed in a future update.

Oct 7, 2021 New Sandbox Environment available

UK SAndbox

Breaking changes

The previous UK preprod environment has been removed and a new Sandbox environment has been created.

The only visible change is the API URL to https://api.sandbox.arken.legal, however, the existing UK PREPROD environment is deprecated and the URL will be inaccessible.

Furthermore, the Arken Professional application was also moved to a new location.

All the data from the UK PREPROD is still intact and relevant.

See UK Sandbox API Endpoints (api.sandbox.arken.legal) for further details.

Oct 7, 2020 New Client Search by Application Endpoint available

UK PREPRODUK PROD

A new endpoint is available: /client/search/account/application

The endpoint will return an array of clients filtered by application type and the search query.

For large result sets, the pageRowsCount parameter can be set to an integer which will return that amount of Clients. Omitting this parameter will return ALL clients however, this can add process time to the result. We recommend setting this to 10 or less.

May 27, 2020 Production Public API live

UK PROD

The Public API is now live for Production. See the UK Prod API Endpoints (api.uk.pro.arken.legal) documentation on available endpoints.

May 19, 2020 Added application type to Client Model

UK PREPRODUK PROD

Breaking changes

The application type is now mandatory to pass in when creating POST or updating PUT a client. The application will be in the response body.

If the client is from a CRM system set the application to ‘CRM’

"application" : "CRM",

By setting the application to CRM, additional information can now be saved in the extensionData field. See the CRM Integration functionality to Client changelog

To create or update a normal Arken client set the application to ‘ARKEN’ as part of the Client Model

May 19, 2020 Added CRM Integration functionality to Client

UK PREPRODUK PROD

A client created in a CRM system should be created with the application set to ‘CRM’ as part of the Client Model

This allows to pass in further CRM related fields:

The CRM Model. This is the name of the CRM Integration and is a constant value
The CRM Client ID can be used to save the client ID used in the CRM system
The CRM Matter ID is to add Matter references used when adding a document in Arken Professional

All field names are case-sensitive. CRMMatterId is an array and requires the block brackets in the request body.

May 1, 2020 Removed Occupation from Client Model

UK PREPRODUK PROD

The occupation Client field is deprecated and removed from the Client Model. All Client API calls correctly reflect this Model change.

Apr 16, 2020 Updated DocumentData to correct content response

UK PREPRODUK PROD

All /documentdata calls now correctly return the content field value as an empty JSON object.

Feb 20, 2020 Added Current Document Key to DocumentData

UK PREPRODUK PROD

GET /documentdata calls have been updated to also return the File Key as CurrentDocumentKey. This value is the most recent downloaded pack name.

You can then use this File Key as a parameter in /file/download and /file/detail in order to retrieve the downloaded document.

Nov 8, 2019 New endpoint for File Download

NZ TESTNZ PREPRODNZ PRODUK PREPRODUK PROD

The /file endpoint has been split into two different calls. /file/download and /file/detail.

GET /file/download will only return the download URL of the document. This will create an event and it is broadcasted via the webhook service.

GET /file/detail will return all the details about the file similar to the old /file call. This will not create an event.

The purpose of this change was to stop the /file GET method from creating an event, which in turn stops any polling from constantly creating repeating events.

See Public API documentation for more details on calls and webhook events.

Dec 3, 2019 Bearer Authentication added for Webhook subscription

NZ TESTNZ PREPRODNZ PRODUK PREPROD

A webhook POST will now need to authenticate with the listener. In order for the listener to authenticate the incoming message, the authenticate URL and optionally the grantType and scope should be added when subscribing for a webhook.

This allows the listener to verify the receiving message is from the correct source.

Dec 9, 2019 Event created with correct EventNumber

NZ TESTNZ PREPRODNZ PRODUK PREPROD

The response received from a Webhook POST or a GET /event always returned the corresponding eventNumber as 0.

It now shows the correct sequential number linked to the event.