Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Info
Note -
  • Events are sent sequentially and in

realtime
  • real-time but upon receiving an event, a sequential order cannot be guaranteed.

  • ALL API endpoints have a 10MB hard restriction on the payload

...

New fields added to Client Model

Status
colourYellow
titleUK SANDBOX

Three new fields have been exposed in the Client Model

This extensionData is only available under the ARKEN application value.

Code Block
"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.

Code Block
"preferredContactMethod": "string"

...

Delete All Documents per Client Endpoint - Hard Delete functionality

Status
colourYellow
titleUK SANDBOX
Status
colourGreen
titleUK PROD

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

Status
colourRed
titleDELETE
/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

Status
colourRed
titleDELETE
function will now immediately delete the request object.

...

New Client and Document Delete Endpoints are available

Status
colourYellow
titleUK SANDBOX
Status
colourGreen
titleUK PROD

Two new endpoints are available:

Status
colourRed
titleDELETE
/client and
Status
colourRed
titleDELETE
/documentdata

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

...

New Sandbox Environment available

Status
colourYellow
titleUK SAndbox

Info

Breaking changes

The previous

Status
colourYellow
titleUK 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

Status
colourYellow
titleUK 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

Status
colourYellow
titleUK PREPROD
is still intact and relevant.

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

...

New Client Search by Application Endpoint available

...

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.

...