Page Comparison

...

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

...

19 Oct 2022 New fields added to Client Model

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"

...

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

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

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

Any

...

08 Dec 2021 New Client and Document Delete Endpoints are available

Two new endpoints are available:

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

...

07 Oct 2021 New Sandbox Environment available

The previous

The only visible change is the API URL to https://api.sandbox.arken.legal, however, the existing

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

All the data from the

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

...

07 Oct 2020 New Client Search by Application Endpoint available

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.

...

27 May 2020 Production Public API live

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

...

19 May 2020 Added application type to Client Model

The application type is now mandatory to pass in when creating

...

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

...

• 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

  Code Block
  "extensionData" : { "CRMModel" : "string", "CRMClientId" : "string", "CRMMatterId" : ["string", "string"...] }

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

...

01 May 2020 Removed Occupation from Client Model

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

...

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

...

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.

...