Please refer to the Arken Public API Endpoint Inventory page for endpoint usage and required parameters.
Account Data Model
A company or other organisation having license to the system.
GET Account Endpoint output - /account
| Column Property | Description |
|---|---|
| hashId | Arken Account Hash Identifier |
| name | Arken Account Name |
| businessType | Nature of business |
| companyType | Company Type |
| country | Country of Origin where the Arken Account Holder is based |
| address | Physical Address of the Account holder, broken down into address parts below |
| street | Street Address |
| suburb | Suburb |
| city | City |
| region | Region |
| postcode | Postcode or Zip code |
| country | Country |
| Arken Account Email | |
| telephone | Arken Account Telephone |
| operatesAs | Business Alias or Trading name |
| practiceAppointment | Practice Appointment details |
| practiceName | Practice Name |
| practiceAddress | Practice Physical Address broken down into address parts below |
| street | Street Address |
| suburb | Suburb |
| city | City |
| region | Region |
| postcode | Postcode or Zip Code |
| country | Country |
| practiceTelephone | Practice phone number |
| practiceEmail | Practice Email |
| trustAppointment | Trust Appointment details |
| trustName | Trust name |
| trustAddress | Trust Physical Address broken down into address parts below |
| street | Street Address |
| suburb | Suburb |
| city | City |
| region | Region |
| postcode | Postcode or Zip Code |
| country | Country |
| trustTelephone | Trust Phone number |
| trustEmail | Trust Email |
| createdOn | Date created on in UTC format |
| updatedOn | Date updated on UTC format |
Example:
Client Data Model
A person who needs legal service, i.e. the person who's will is created.
POST PUT GET Get Endpoint output - /client, /client/account, /client/account/externalreference
| Column Property | Description | Mandatory |
|---|---|---|
| hashId | Client Hash Identifier |  |
| accountHashId | Arken Account Hash Identifier | |
| title | Client's Salutation Title | |
| name | Client name, broken down in parts below | |
| first | First Name | |
| middle | Middle Name |
|
| surname | Surname or Last name | |
| fullName | Concatenated name based on the values provided on the first, middle and surnames. | |
| gender | Accepts the following values:
| |
| maritalStatus | Accepts the following values:
| |
| Client Email | | |
| address | Client Physical Address , broken down into address parts below | |
| street | Street Address | |
| suburb | Suburb | |
| city | City | |
| region | Region | |
| postcode | Postcode or Zip code | |
| country | Country | |
| dateOfBirth | Date of Birth in UTC format | |
| mobile | Mobile number | |
| telephone | Phone Number | |
| occupation | Occupation | |
| partnerName | Client partner's name, broken down in parts below | |
| first | First name | |
| middle | Middle Name | |
| surname | Last or surname | |
| partnerGender | Client partner's gender. Accepts the following values:
| |
| partnerTitle | Client partner's salutation title | |
| partnerDateOfBirth | Client partner's date of birth | |
| partnerHashId | Arken Account Hash identifier for the primary client's partner. | |
| createdOn | Record created date in UTC format | |
| updatedOn | Record updated date in UTC format | |
| externalReference | String field that allows API Consumers to map their unique client numbers or any logical identifier value used on their application end |
Example:
Document Data Model
Collected client information, answers to questions given by a certain client during the interview process
GET DocumentData Endpoint output - /documentdata, /documentdata/account, /documentdata/client
| Column Property | Description |
|---|---|
| accountHashId | Arken Account Hash Identifier |
| clientHashId | Client Hash Idetifier |
| hashId | Document Data Hash Identifier |
| clientMatterReference | Document Reference number |
| documentType | (See Document Types table below) |
| version | Document Version |
| jurisdiction | Document Jurisdiction |
| content | Document Content consisting of:
|
| createdOn | Document created date in UTC format |
| updatedOn | Document updated date in UTC format |
Document Types
| Name | Document Type | Country | State |
|---|---|---|---|
| Will | WILL-1 | UK | |
| Lasting Power of Attorney - Property and Affairs | LPAPA-1 | ||
| Lasting Power of Attorney - Health and Welfare | LPAHW-1 | ||
| Enduring Power of Attorney | EPA-1 | ||
| General Power of Attorney | GPA-1 | ||
| Severance of Joint Tenancy | SOJT-1 | ||
| Severance of Joint Tenancy (Isle of Man) | SOJT-2 | ||
| Expression of Wishes | EXOW-1 | ||
| Will | WILL-1 | NZ | |
| EPA - Personal Care and Welfare | EPA-PCW-1 | ||
| EPA - Property | EPA-PRP-1 | ||
| Will | WILL-1 | AU | All |
| Enduring Power of Attorney | ACT-EPA-1 | Australian Capital Territory | |
| Enduring Power of Attorney | NSW-EPA-1 | New South Wales | |
| Appointment of Enduring Guardian | NSW-EPG-1 | New South Wales | |
| Enduring Power of Attorney | NT-EPA-1 | Nothern Territory | |
| EPA Short Form (Form 2) | Qls-EPA-2 | Queensland | |
| EPA Long Form (Form 3) | Qls-EPA-3 | Queensland | |
| Enduring Power of Attorney | SA-EPA-1 | South Australia | |
| Particular Enduring Power of Attorney | Tas-EPA-1 | Tasmania | |
| General Power of Attorney | Tas-EPA-2 | Tasmania | |
| Instrument Appointing Enduring Guardian(s) | Tas-Med-2 | Tasmania | |
| Enduring Power of Attorney | Vic-EPA-1 | Victoria | |
| Appointment of Medical Treatment Decision Maker | Vic-Med-1 | Victoria | |
| Enduring Power of Attorney | WA-EPA-1 | Western Australia | |
| Appointment of Enduring Guardian | WA-EPG-1 | Western Australia |
Example:
File Data Model
Information about a printable document file
GET File Download Endpoint output - /file
| Column Property | Description |
|---|---|
| accountHashId | Arken Account Hash Identifier |
| clientHashId | Client Hash Idetifier |
| fileKey | The file name |
| downloadUrl | The URL document download link with an expiry date. If the file needs to be downloaded way past the expiry date, then the same call would be needed to be executed again to get a valid link. |
Example:
Event Feed Info Data Model
Event listing that contains when actions in Arken were raised against an Arken account
GET Arken Events Endpoint output - /event, /event/info
The list of Events being monitored are as follows:
- POST Client (Create)
- PUT Client (Update)
- GET Client listing by Account Hash Id
- GET Client by Hash Id
- GET File
- POST DocumentData (Create)
- PUT DocumentData (Update)
| Column Property | Description |
|---|---|
| feedLink | The Event feed link to fetch items from |
| lastEventNumber | The last event sequence entry |
| lastEntryFeed | Please see Event Entries Model |
Example:
Event Entries Data Model
Contains the Event triggered by a watched action
| Column Property | Description |
|---|---|
| eventId | Event Identifier in GUID value |
| eventType | The action event that was triggered |
| eventNumber | The event sequence value |
| eventDateTimeUtc | The Date when the event happened in UTC format |
| link | URL link that points to the changed data item |
| properties | Additional information describing the event. For Properties > FileStore.GetFileDetail; Returns a Key-value pair array describing the file downloaded via Arken application |
| key | Applicable for Properties > FileStore.GetFileDetail events only Name of the Field |
| value | Applicable for Properties > FileStore.GetFileDetail events only Contains key value |
Example:
Webhook Provision Authentication Data Model
Authentication used for executing Webhook Posts; This is driven by the 3rd party (non-Arken) events subscriber
| Column Property | Description |
|---|---|
| accessKey | 3rd Party Client Key or Access Key used for Machine-to-Machine Authentication (based on Open ID protocol, if available) |
| secretKey | 3rd Party Secret Key (based on Open ID protocol, if available) |
| authUrl | 3rd Party Authentication URL (based on Open ID protocol, if available) |
| scope | 3rd Party Security Scope (based on Open ID protocol, if available) |
| grantType | 3rd Party Security Grant Type (based on Open ID protocol, if available) |
| headerName | Unused. 3rd Party Custom Header name |
| headerKeyValue | Unused. 3rd Party Custom Header value |
Webhook Provision Data Model Subscription
Contains the necessary Webhook subscription detail needed for sending Webhook events
GET POST - /event/subscription
| Column Property | Description |
|---|---|
| accountHashId | Arken Account Hash Identifier |
| postUrl | 3rd Party Post URL where the webhook event will be sent to |
| version | 3rd Party Post URL API version, if available |
| postAuth | 3rd Party Post Authentication, see Webhook Provision Authentication Data Model for details |
| createdOn | Date when the subscription entry was created on |
| active | Boolean flag where it indicates if webhooks are turned on or off. |
{
"accountHashId": "ssserwerwer",
"postUrl": "http://watsonlaw.com/myendpoint",
"version": "1",
"postAuth": {
"accessKey": "aaaaaaaa",
"secretKey": "b1234rrrewerwe",
"authUrl": "https://auth.watsonlaw.com/oauth/token",
"scope": "all:access",
"grantType": "client_credentials",
"headerName": null,
"headerKeyValue": null
},
"createdOn": "2019-07-04T04:38:07.639Z",
"active": "true"
}
In this document: