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

Status

colour	Blue
title	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
email	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:

Code Block

language	js
title	Account Data Model Example
linenumbers	true
collapse	true

{
    "hashId": "qzlVU5FB7Y7NNlHr7UOzr3",
    "name": "Arken Test Account - Preproduction",
    "businessType": "O",
    "companyType": "Startup company - limited company",
    "country": "NZL",
    "address": {
        "street": "Level 1, Generator, 12 Madden Street,,,",
        "suburb": "",
        "city": "Auckland",
        "region": "",
        "postcode": "1010",
        "country": ""
    },
    "email": "ann.marinas@arken.legal",
    "telephone": "099764742",
    "operatesAs": "L",
    "practiceAppointment": "N",
    "practiceName": "",
    "practiceAddress": {
        "street": ",,,",
        "suburb": "",
        "city": "",
        "region": "",
        "postcode": "",
        "country": ""
    },
    "practiceTelephone": "",
    "practiceEmail": "",
    "trustAppointment": "N",
    "trustName": "",
    "trustAddress": {
        "street": ",,,",
        "suburb": "",
        "city": "",
        "region": "",
        "postcode": "",
        "country": ""
    },
    "trustTelephone": "",
    "trustEmail": "",
    "createdOn": "0001-01-01T00:00:00Z",
    "updatedOn": "2019-02-05T05:13:54.7739046Z",
    "externalReference": "222222"
}

Client Data Model

A person who needs legal service, i.e. the person who's will is created.

Status


colour	Green
title	POST

Status


colour	Yellow
title	put

Status


colour	Blue
title	get

Get Endpoint output - /client, /client/account, /client/account/externalreference

String field that allows API Consumers to map their unique client numbers or any logical identifier value used on their application end

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: Male Female Unspecified (default)
maritalStatus	Accepts the following values: Single Married Widow StableUnion InPartnership Separated Unspecified (default)
email	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
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: Male Female Unspecified (default)
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
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
application	Arken Application type Accepts the following values: ARKEN CRM
extensionData	Extra data stored unique to the specific client. Fields are down below Only used when application is set to CRM
CRMModel	The name of the CRM system as specified by CRM Integration documentation
CRMClientId	The Client ID in the CRM system
CRMMatterId	An array of Matter Id's used in the CRM and which act as the Matter Reference in Arken document creation

Example:

Code Block

language	js
title	Client Data Model Example
linenumbers	true
collapse	true

{
        "hashId": "TBosHjx9kKA2SsEQ3Hoa51",
        "accountHashId": "qzlVU5FB7Y7NNlHr7UOzr3",
        "title": "Miss",
        "name": {
            "first": "Daisy",
            "middle": "",
            "surname": "Duck",
            "fullName": "Daisy Duck"
        },
        "gender": "Female",
        "maritalStatus": "Single",
        "email": "daisyduck@disney.com",
        "address": {
            "street": "string",
            "suburb": "string",
            "city": "string",
            "region": "string",
            "postcode": "string",
            "country": "string"
        },
        "dateOfBirth": "1970-02-05T08:44:51.074Z",
        "mobile": "string",
        "telephone": "string",
        "partnerName": {
            "first": "string",
            "middle": "string",
            "surname": "string",
            "fullName": "string string string"
        },
        "partnerGender": "Unspecified",
        "partnerTitle": "Unspecified",
        "partnerDateOfBirth": "1980-02-05T08:44:51.074Z",
        "partnerHashId": "Sdfsrew98434e",
        "createdOn": "2019-02-05T08:44:51.074Z",
        "updatedOn": "2019-02-05T08:44:51.074Z"
        "externalReference": "2222222",
		"application": "ARKEN",
		"extensionData": ""
    }

Document Data Model

Collected client information, answers to questions given by a certain client during the interview process

Status

colour	Blue
title	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: documentExpirationDate totalAssets totalLiabilites netAssets executor dependentChildren
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:

Code Block

language	js
title	Document Data Model Example
linenumbers	true
collapse	true

[{
		"accountHashId": "qzlVU5FB7Y7NNlHr7UOzr3",
		"clientHashId": "fV98CpoX5aMVxFXwW8zAS6",
		"hashId": "B9eDGhzIeI16mRDLEtpnF5",
		"clientMatterReference": "WILL-001",
		"documentType": " WILL-1",
		"version": "V0001",
		"jurisdiction": "",
		"content": [{
				"Key": "date_expire",
				"Value": "2019/04/06"
			}, {
				"Key": "total-assets-joint-1",
				"Value": ""
			}, {
				"Key": "total-assets-sole-1",
				"Value": ""
			}, {
				"Key": "total-liabilities-joint-1",
				"Value": ""
			}, {
				"Key": "total-liabilities-sole-1",
				"Value": ""
			}, {
				"Key": "net-asset-1",
				"Value": ""
			}, {
				"Key": "executor",
				"Value": "string string string"
			}
		],
		"createdOn": "2019-02-05T22:41:38Z",
		"updatedOn": "2019-02-05T22:44:07Z"
	}
]

File Data Model

Information about a printable document file

Status

colour	Blue
title	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:

Code Block

language	js
title	File Data Model Example
linenumbers	true
collapse	true

{
  "accountHashId" : "qzlVU5FB7Y7NNlHr7UOzr3",
  "clientHashId" : "v1wLxsmtn4MmLdAAwl8Z30",
  "fileKey" : "checking pack-07-02-2019 10-05-49.zip",
  "downloadUrl" : "http://pre-arkenlegal-nz-arken-file.s3.ap-southeast-2.amazonaws.com/nzl/qzlVU5FB7Y7NNlHr7UOzr3/v1wLxsmtn4MmLdAAwl8Z30/checking%20pack-07-02-2019%2010-05-49.zip?X-Amz-Expires=3600&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJXNAECSXD5NXPNYQ/20190206/ap-southeast-2/s3/aws4_request&X-Amz-Date=20190206T222255Z&X-Amz-SignedHeaders=host&X-Amz-Signature=f2b309a3119a387c782c574b15ff822c63546c7027cdc2c87fe3a6b4ea3d6ec4",
  "properties": [{"Key":"Description","Value":"Checking Pack"},{"Key":"DownloadType","Value":"ZIP"},{"Key":"DocumentFileCreatedDate","Value":"2019/02/07 10:05:53"},{"Key":"DownloadDate","Value":"07-02-2019 10-05-49"},{"Key":"DocumentType","Value":"WILL-1"}]
}

Event Feed Info Data Model

Event listing that contains when actions in Arken were raised against an Arken account

Status

colour	Blue
title	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:

Code Block

language	js
title	Event Feed Info Data Model Example
linenumbers	true
collapse	true

{
    "feedLink": "https://api.nz.pre.arken.legal/pre/event?accountHashId=qzlVU5FB7Y7NNlHr7UOzr3&eventPositionFrom=88&rowsReturned=50&direction=backward",
    "lastEventNumber": 88,
    "lastEntryFeed": {
        "eventId": "d6491737-9800-409c-9764-b4ebb1f57272",
        "eventType": "FileStore.GetFileDetail",
        "eventNumber": 88,
        "eventDateTimeUtc": "2019-02-06T21:05:54.51426Z",
        "link": "https://api.nz.pre.arken.legal/pre/accountHashId=qzlVU5FB7Y7NNlHr7UOzr3&clientHashId=v1wLxsmtn4MmLdAAwl8Z30&key=checking pack-07-02-2019 10-05-49.zip",
        "properties": [
            {
                "Key": "Description",
                "Value": "Checking Pack"
            },
            {
                "Key": "DownloadType",
                "Value": "ZIP"
            },
            {
                "Key": "DocumentFileCreatedDate",
                "Value": "2019/02/07 10:05:53"
            },
            {
                "Key": "DownloadDate",
                "Value": "07-02-2019 10-05-49"
            },
            {
                "Key": "DocumentType",
                "Value": "WILL-1"
            }
        ]
    }
}

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:

Code Block

language	js
title	Event Entries Data Model Example
linenumbers	true
collapse	true

{
        "eventId": "d6491737-9800-409c-9764-b4ebb1f57272",
        "eventType": "FileStore.GetFileDetail",
        "eventNumber": 88,
        "eventDateTimeUtc": "2019-02-06T21:05:54.51426Z",
        "link": "https://api.nz.pre.arken.legal/pre/accountHashId=qzlVU5FB7Y7NNlHr7UOzr3&clientHashId=v1wLxsmtn4MmLdAAwl8Z30&key=checking pack-07-02-2019 10-05-49.zip",
        "properties": [
            {
                "Key": "Description",
                "Value": "Checking Pack"
            },
            {
                "Key": "DownloadType",
                "Value": "ZIP"
            },
            {
                "Key": "DocumentFileCreatedDate",
                "Value": "2019/02/07 10:05:53"
            },
            {
                "Key": "DownloadDate",
                "Value": "07-02-2019 10-05-49"
            },
            {
                "Key": "DocumentType",
                "Value": "WILL-1"
            }
        ]
    }

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

Status

colour	Blue
title	GET

Status


colour	Green
title	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.

Code Block

{
  "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:

Table of Contents

Version	Old Version 4	New Version 5
Changes made by	Manus Muller	Manus Muller
Saved on	May 01, 2020	May 19, 2020

Page Comparison

Versions Compared

Key

Account Data Model

Client Data Model

Document Data Model

Document Types

File Data Model

Event Feed Info Data Model

Event Entries Data Model

Webhook Provision Authentication Data Model

Webhook Provision Data Model Subscription