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 (YYYY-MM-DDThh:mm:ssZ)

  updatedOn

Date updated on UTC format (YYYY-MM-DDThh:mm:ssZ)

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 (YYYY-MM-DDThh:mm:ssZ)

mobile

Mobile number

telephone

Phone Number

preferredContactMethod

Client's preferred contact method. This can be activated by specifying the "preferred" option (See extensionData)

The single-character values are

• T = Telephone

• M = Mobile

• E = Email

 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 (YYYY-MM-DDThh:mm:ssZ)

updatedOn 

Record updated date in UTC format (YYYY-MM-DDThh:mm:ssZ)

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

This is case sensitive

extensionData

Extra data stored unique to the specific client. Fields are down below

Only used when the 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

    Preferred

The preferred method of contact for the client

• Y = Yes

• N = No

    Contemplating

Is the client contemplating? 

• M = Marriage

• C = Civil Partnership

• E = Either marriage or civil partnership

• X = Not applicable (In this scenario the referred value is not required)

   Referred

How the partner is referred to:

• I = Intended

• P = Partner

• E = Fiance

• F = Friend

• X = Not applicable

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 (YYYY-MM-DDThh:mm:ssZ)

    updatedOn 

Document updated date in UTC format (YYYY-MM-DDThh:mm:ssZ)

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

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.

feedLink

The Event feed link to fetch items from

lastEventNumber

The last event sequence entry

lastEntryFeed

Please see Event Entries Model

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

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

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.