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 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

...

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

...

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

...