Open api |
---|
{ "swagger": "2.0", "info": { "version": "2019-0712-05T0304T16:26:57Z", "title": "Public Arken API" }, "host": "api.nz.pro.arken.legal", "schemes": [ "https" ], "paths": { "/account": { "get": { "tags": [ "Account" ], "summary": "Get account data by account hash identifier", "produces": [ "application/json" ], "parameters": [{ "name": "hashId", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/Account" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "404": { "description": "404 response", "schema": { "$ref": "#/definitions/Empty" } }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/client": { "get": { "tags": [ "Client" ], "summary": "Get client based on its hash identifier", "produces": [ "application/json" ], "parameters": [{ "name": "hashId", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/Client" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "404": { "description": "404 response", "schema": { "$ref": "#/definitions/Empty" } }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] }, "post": { "tags": [ "Client" ], "summary": "Create a new client", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [{ "name": "Content-Type", "in": "header", "required": true, "type": "string" }, { "name": "accountHashId", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "type": "string" }, { "in": "body", "name": "Client", "required": true, "schema": { "$ref": "#/definitions/Client" } } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/Client" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] }, "put": { "tags": [ "Client" ], "summary": "Update an existing client", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [{ "name": "Content-Type", "in": "header", "required": true, "type": "string" }, { "name": "hashId", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "type": "string" }, { "in": "body", "name": "Client", "required": true, "schema": { "$ref": "#/definitions/Client" } } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/Client" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/client/account": { "get": { "tags": [ "Client" ], "summary": "Get all client records based on an account hash identifier", "produces": [ "application/json" ], "parameters": [{ "name": "accountHashId", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/ArrayOfClients" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "404": { "description": "404 response", "schema": { "$ref": "#/definitions/Empty" } }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/client/account/externalreference": { "get": { "tags": [ "Client" ], "summary": "Get client by External Reference", "produces": [ "application/json" ], "parameters": [{ "name": "accountHashId", "in": "query", "required": true, "type": "string" }, { "name": "externalReference", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/Empty" } }, "204": { "description": "204 response" }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "404": { "description": "404 response" }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/documentdata": { "get": { "tags": [ "DocumentData" ], "summary": "Get by Document Data hash identifier", "produces": [ "application/json" ], "parameters": [{ "name": "hashId", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": false, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/DocumentData" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "404": { "description": "404 response", "schema": { "$ref": "#/definitions/Empty" } }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/documentdata/account": { "get": { "tags": [ "DocumentData" ], "summary": "Get all documents based on an account hash identifier", "produces": [ "application/json" ], "parameters": [{ "name": "accountHashId", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/ArrayOfDocumentData" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "404": { "description": "404 response", "schema": { "$ref": "#/definitions/Empty" } }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/documentdata/client": { "get": { "tags": [ "DocumentData" ], "summary": "Get all documents based on an account hash identifier and client hash identifier", "produces": [ "application/json" ], "parameters": [{ "name": "accountHashId", "in": "query", "required": true, "type": "string" }, { "name": "clientHashId", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/ArrayOfDocumentData" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "404": { "description": "404 response", "schema": { "$ref": "#/definitions/Empty" } }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/event": { "get": { "tags": [ "Event" ], "summary": "Get a list of events based on the account identifier, when the last event number and return items based on the number of rows requested", "produces": [ "application/json" ], "parameters": [{ "name": "direction", "in": "query", "required": true, "type": "string" }, { "name": "accountHashId", "in": "query", "required": true, "type": "string" }, { "name": "eventPositionFrom", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "type": "string" }, { "name": "rowsReturned", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/ArrayOfEventEntries" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "404": { "description": "404 response", "schema": { "$ref": "#/definitions/Empty" } }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/event/info": { "get": { "tags": [ "Event" ], "summary": "Get the last event entry and the feed link to subscribe to", "produces": [ "application/json" ], "parameters": [{ "name": "accountHashId", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/EventFeedInfo" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "404": { "description": "404 response", "schema": { "$ref": "#/definitions/Empty" } }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/event/subscription": { "get": { "tags": [ "Webhooks" ], "description": "Get webhook subscription details based on account hash id", "produces": [ "application/json" ], "parameters": [{ "name": "hashId", "in": "query", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "required": false, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/WebhookProvision" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] }, "post": { "tags": [ "Webhooks" ], "description": "Create or update webhook subscription", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [{ "name": "hashId", "in": "query", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "required": false, "type": "string" } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/WebhookProvision" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/file/detail": { "get": { "tags": [ "File" ], "summary": "Get download detail for a filefile details", "produces": [ "application/json" ], "parameters": [ { "name": "accountHashId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "clientHashId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/FileFileDetail" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response", "content": {} }, "401": { "description": "401 response", "content": {} }, "404": { "description": "404 response", "content": {} }, "500": { "description": "500 response", "content": {} } }, "security": [ { "jwt-rsa-custom-authorizer": [] } ] } }, "/file/pingdownload": { "get": { "tags": [ "HealthcheckFile" ], "summary": "Site HealthcheckGet the file downloadUrl", "produces": [ "application/json" ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/Ping" } }, "500": { "description": "500 response" } } } } }, "securityDefinitions": { "jwt-rsa-custom-authorizer": { "parameters": [ { "name": "accountHashId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "clientHashId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "key", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/FileDownload" } }, "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response", "content": {} }, "401": { "description": "401 response", "content": {} }, "404": { "description": "404 response", "content": {} }, "500": { "description": "500 response", "content": {} } }, "security": [ { "jwt-rsa-custom-authorizer": [] } ] } }, "/ping": { "get": { "tags": [ "Healthcheck" ], "summary": "Site Healthcheck", "produces": [ "application/json" ], "responses": { "200": { "description": "200 response", "schema": { "$ref": "#/definitions/Ping" } }, "500": { "description": "500 response" } } } } }, "securityDefinitions": { "jwt-rsa-custom-authorizer": { "type": "apiKey", "name": "Authorization", "in": "header", "x-amazon-apigateway-authtype": "custom" } }, "definitions": { "Account": { "type": "object", "properties": { "hashId": { "type": "string", "description": "Account Hash Identifier" }, "name": { "type": "string" }, "businessType": { "type": "string" }, "companyType": { "type": "string" }, "country": { "type": "apiKeystring", "name": "Authorization"}, "inaddress": "header", { "x-amazon-apigateway-authtype$ref": "custom#/definitions/PhysicalAddress" } }, "definitionsemail": { "Account": { "type": "object"string" }, "propertiestelephone": { "hashIdtype": { "string" }, "typeoperatesAs": "string",{ "descriptiontype": "Account Hash Identifierstring" }, "namepracticeAppointment": { "type": "string" }, "businessTypepracticeName": { "type": "string" }, "companyTypepracticeAddress": { "type$ref": "string#/definitions/PhysicalAddress" }, "countrypracticeTelephone": { "type": "string" }, "addresspracticeEmail": { "$reftype": "#/definitions/PhysicalAddressstring" }, "emailtrustAppointment": { "type": "string" }, "telephonetrustName": { "type": "string" }, "operatesAstrustAddress": { "type$ref": "string#/definitions/PhysicalAddress" }, "practiceAppointmenttrustTelephone": { "type": "string" }, "practiceNametrustEmail": { "type": "string" }, "practiceAddresscreatedOn": { "type": "string", "$refformat": "#/definitions/PhysicalAddressdate-time" }, "practiceTelephoneupdatedOn": { "type": "string", "format": "date-time" } }, "practiceEmailtitle": { "Arken Account Model", "typedescription": "stringArken Account Details" }, "trustAppointmentWebhookProvision": { "type": "stringobject", },"properties": { "trustNameaccountHashId": { "type": "string", }, "trustAddressdescription": { "$ref": "#/definitions/PhysicalAddress"Account Hash Identifier" }, "trustTelephonepostUrl": { "type": "string" }, "trustEmailversion": { "type": "string" }, "createdOnpostAuth": { "type$ref": "string#/definitions/WebhookProvisionAuth", "format": "date-time" }, "updatedOnactive": { "type": "string", "format": "date-time" } }, "title": "Arken AccountWebhook Provision Model", "description": "Arken Webhook AccountProvision Details" }, "WebhookProvisionArrayOfClients": { "typetitle": "object", "properties": { "accountHashId": { Arken Client Array Model", "type": "stringarray", "description": "AccountArken Client HashArray Identifier" }Details", "postUrlitems": { "type$ref": "string#/definitions/Client" } }, "versionEventFeedInfo": { "type": "stringobject", },"properties": { "postAuthfeedLink": { "$reftype": "#/definitions/WebhookProvisionAuthstring" }, "createdOnlastEventNumber": { "type": "string", "format": "date-time" }, "activelastEventFeed": { "type$ref": "string#/definitions/EventEntry" } }, "title": "Arken Event WebhookFeed ProvisionInfo Model", "description": "Arken Event WebhookFeed ProvisionInfo DetailsData" }, "ArrayOfClientsArrayOfDocumentData": { "title": "Arken ClientDocumentData Array Model", "type": "array", "description": "Arken ClientDocumentData Array Details", "items": { "$ref": "#/definitions/ClientDocumentData" } }, "EventFeedInfoArrayOfEventEntries": { "title": "Arken Event Entries Array Model", "type": "object"array", "description": "Arken Event Entries Array Details", "propertiesitems": { "feedLink$ref": { ""#/definitions/EventEntry" } }, "PhysicalAddress": { "type": "stringobject", },"properties": { "lastEventNumberstreet": { "type": "string" }, "lastEventFeedsuburb": { "$reftype": "#/definitions/EventEntry" } string" }, "titlecity": "Arken Event Feed Info Model", { "descriptiontype": "Arken Event Feed Info Datastring" }, "ArrayOfDocumentDataregion": { "titletype": "string"Arken DocumentData Array Model" }, "typepostcode": "array", { "descriptiontype": "string"Arken DocumentData Array Details" }, "itemscountry": { "$reftype": "#/definitions/DocumentDatastring" } }, "ArrayOfEventEntriestitle": { "Arken Common Address Model", "titledescription": "Arken Event Entries Array Model",Physical address format for Arken" }, "Name": { "type": "arrayobject", "descriptionproperties": "Arken Event Entries Array Details", { "itemsfirst": { "$reftype": "#/definitions/EventEntrystring" }, }, "PhysicalAddressmiddle": { "type": "objectstring", "properties": { }, "streetsurname": { "type": "string" }, "suburbfullName": { "type": "string" } }, "citytitle": { "Arken Common Name Model", "typedescription": "stringPerson's structured name model" }, "regionDocumentData": { "type": "stringobject", },"properties": { "postcodeaccountHashId": { "type": "string" }, "countryclientHashId": { "type": "string" } }, "titlehashId": "Arken Common Address Model", { "descriptiontype": "Physical address format for Arkenstring" }, "NameclientMatterReference": { "type": "objectstring", "properties": {}, "firstdocumentType": { "type": "string" }, "middleversion": { "type": "string" }, "surnamejurisdiction": { "type": "string" }, "fullNamecontent": { "type": "stringobject", "properties": {} }, "titlecreatedOn": "Arken Common Name Model", { "descriptiontype": "Person's structured name model" }, string", "DocumentDataformat": {"date-time" "type": "object" }, "propertiesupdatedOn": { "accountHashIdtype": {"string", "typeformat": "stringdate-time" } }, "clientHashIdtitle": { "Arken Document Data Model", "typedescription": "stringArken Document Data" }, "hashIdEmpty": { "type": "stringobject", "title": "Empty Schema" }, "clientMatterReferenceEventEntry": { "type": "stringobject", },"properties": { "documentTypeeventId": { "type": "string" }, "versioneventType": { "type": "string" }, "jurisdictioneventNumber": { "type": "stringnumber" }, "contenteventDateTimeUtc": { "type": "objectstring", "properties": {} }, "createdOnlink": { "type": "string", "format": "date-timestring" }, "updatedOnproperties": { "type": "stringobject", "formatproperties": "date-time"{} } }, "title": "Arken DocumentEvent DataEntry Model", "description": "Arken Event DocumentEntry Data" }, "EmptyPing": { "type": "object", "title": "Arken "Empty SchemaHealthcheck", "description": "Arken Healthcheck Ping" }, "EventEntryClient": { "type": "object", "properties": { "eventIdhashId": { "type": "string", "description": "Client Hash Identifier" }, "eventTypeaccountHashId": { "type": "string", }, "eventNumberdescription": { "type": "number""Account Hash Identifier" }, "eventDateTimeUtctitle": { "type": "string" }, "linkname": { "type$ref": "string#/definitions/Name" }, "propertiesgender": { "type": "object", "properties": {}string" }, }, "titlemaritalStatus": "Arken Event Entry Model", { "descriptiontype": "Arken Event Entry Datastring" }, "Pingemail": { "type": "object"string" }, "titleaddress": "Arken Healthcheck", { "description$ref": "Arken Healthcheck Ping#/definitions/PhysicalAddress" }, "ClientdateOfBirth": { "type": "objectstring", "propertiesformat": { "date-time" }, "hashIdmobile": { "type": "string" }, "telephone": { "descriptiontype": "Client Hash Identifierstring" }, "accountHashIdoccupation": { "type": "string" }, "partnerName": { "description$ref": "Account Hash Identifier#/definitions/Name" }, "titlepartnerGender": { "type": "string" }, "namepartnerTitle": { "$reftype": "#/definitions/Namestring" }, "genderpartnerDateOfBirth": { "type": "string", "format": "date-time" }, "maritalStatuscreatedOn": { "type": "string", "format": "date-time" }, "emailupdatedOn": { "type": "string", "format": "date-time" }, "addressexternalReference": { "$reftype": "#/definitions/PhysicalAddressstring" }, "dateOfBirthpartnerHashId": { "type": "string", "format": "date-time" } }, "mobiletitle": { "Arken Client Model", "typedescription": "stringArken Client Details" }, "telephoneFileDetail": { "type" : "object", "stringproperties" }, "occupation": { "type" : { "accountHashId" : { "type" : "string" }, "partnerName" "clientHashId" : { "$ref" "type" : "#/definitions/Name" }, "partnerGender": { "type"string" }, "fileKey" : { "type" : "string" }, "partnerTitle" "properties" : { "type" : "stringobject" }, "partnerDateOfBirth": { "type": "string", "format": "date-time" , "properties" : { } } }, "title" : "Arken File Detail Data Model", "description" : "Arken File DetailData" }, "createdOnFileDownload": { "type" : "stringobject", "formatproperties" : "date-time" }, "updatedOn": { "type" { "accountHashId" : { "type" : "string", "format": "date-time" }, "externalReference": { "type" }, "clientHashId" : { "type" : "string" }, "partnerHashId": { "fileKey" : { "type" : "string" } }, "title": "Arken Client Model", "descriptiondownloadUrl" : { "Arken Client Details" }, "File": { "type" : "object", "properties" : { "accountHashId": { "type": "string" }, "clientHashId": { "type": "string" }, "fileKey": { "type": "string" }, "properties": { } } }, "title" : "Arken File Download Model", "description" : "Arken File Download URL" }, "WebhookProvisionAuth": { "type": "object", "properties": {} }, "downloadUrl"accessKey": { "type": "object"string" }, "propertiessecretKey": {} } }, "titletype": "Arken File Data Model",string" "description": "Arken File Data" }, "WebhookProvisionAuthscope": { "type": "objectstring", "properties": {}, "accessKeyauthurl": { "type": "string" }, "secretKeygranttype": { "type": "string" }, "headerName": { "type": "string" }, "headerKeyValue": { "type": "string" } }, "title": "Arken Webhook Provisioning Auth", "description": "Arken Webhook Provisioning Auth" } }, "x-amazon-apigateway-policy": { "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Principal": "*", "Action": "execute-api:Invoke", "Resource": "", "Condition": { "IpAddress": { "aws:SourceIp": [] } } }] } } |
Page Comparison
General
Content
Integrations