...
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.
| Info |
|---|
Note -
|
...
New fields added to Client Model
| Status | ||||
|---|---|---|---|---|
|
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 | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
A new endpoint is available to delete ALL the documents for a specific client:
| Status | ||||
|---|---|---|---|---|
|
/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 | ||||
|---|---|---|---|---|
|
...
New Client and Document Delete Endpoints are available
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
Two new endpoints are available:
| Status | ||||
|---|---|---|---|---|
|
/client and | Status | ||||
|---|---|---|---|---|
|
/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 | ||||
|---|---|---|---|---|
|
| Info |
|---|
Breaking changes |
The previous
| Status | ||||
|---|---|---|---|---|
|
The only visible change is the API URL to https://api.sandbox.arken.legal, however, the existing
| Status | ||||
|---|---|---|---|---|
|
Furthermore, the Arken Professional application was also moved to a new location.
All the data from the
| Status | ||||
|---|---|---|---|---|
|
See UK Sandbox API Endpoints (api.sandbox.arken.legal) for further details.
...
New Client Search by Application Endpoint available
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
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.
...
Production Public API live
| Status | ||||
|---|---|---|---|---|
|
The Public API is now live for Production. See the UK Prod API Endpoints (api.uk.pro.arken.legal) documentation on available endpoints.
...
Added application type to Client Model
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
| Info |
|---|
Breaking changes |
The application type is now mandatory to pass in when creating
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
If the client is from a CRM system set the application to ‘CRM’
| Code Block |
|---|
"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
| Code Block |
|---|
"application" : "ARKEN", |
...
Added CRM Integration functionality to Client
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
A client created in a CRM system should be created with the application set to ‘CRM’ as part of the Client Model
| Code Block |
|---|
"application" : "CRM", |
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
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.
...
Removed Occupation from Client Model
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
The occupation Client field is deprecated and removed from the Client Model. All Client API calls correctly reflect this Model change.
| Code Block |
|---|
...
"occupation": "string", |
...
Updated DocumentData to correct content response
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
All /documentdata calls now correctly return the content field value as an empty JSON object.
| Code Block |
|---|
"content": {}, |
...
Added Current Document Key to DocumentData
...
GET /documentdata calls have been updated to also return the File Key as CurrentDocumentKey. This value is the most recent downloaded pack name.
| Code Block |
|---|
... "createdOn": "2020-02-21T15:16:21Z", "updatedOn": "2020-02-21T15:42:47Z", "settings": { "currentDocumentKey": "Checking Pack-Test Api-21-02-2020 15-42-44.ZIP" } |
You can then use this File Key as a parameter in /file/download and /file/detail in order to retrieve the downloaded document.
...
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.
...