| Open api |
|---|
{ "swagger": "2.0", "info": { "version": "2020-05-19T1101T11:26:57Z", "title": "Public Arken API" }, "host": "api.uksandbox.pre.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": { "getdelete": { "tags": [ "Client" ], "summary": "Get allDelete client records based on an accountits hash identifier", "produces": [ "application/json" ], "parameters": [{ "name": "accountHashIdhashId", "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 all client by External Reference records based on an account hash identifier", "produces": [ "application/json" ], "parameters": [{ "name": "accountHashId", "in": "query", "required": true, "type": "string" }, { "name": "externalReferenceAuthorization", "in": "queryheader", "required": true, "type": "string" } ], "responses": { "name200": "Authorization",{ "indescription": "header200 response", "requiredschema": true,{ "type$ref": "string#/definitions/ArrayOfClients" } ], "responses": { }, "200204": { "description": "200204 response", "schema": { "$ref": "#/definitions/Empty" } }, "204400": { "description": "204400 response" }, "400401": { "description": "400401 response" }, "401404": { "description": "401404 response", }, "404schema": { "description$ref": "404 response"#/definitions/Empty" } }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/documentdataclient/search/account/application": { "get": { "tags": [ "DocumentDataClient" ], "summary": "Get by Document DataSearch client based on a query parameter, account hash identifier and application", "produces": [ "application/json" ], ], "parameters": [ { "name": "hashIdapplication", "in": "query", "required": true, "type": "string" }, { }, { "name": "AuthorizationaccountHashId", "in": "headerquery", "required": false, true, "type": "string" } ], "responses": { "200 }, { "name": "query", "in": "query", "required": true, "type": "string" }, { "name": "pageRowsCount", "in": "query", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "required": false, "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": [] } ] } }, "/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": [] }] }, "delete": { "tags": [ "DocumentData" ], "summary": "Delete Document 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": { "204": { "description": "204 response", "schema": { "$ref": "#/definitions/Empty" } }, "400": { "description": "400 response" }, "401": { "description": "401 response" }, "404": { "description": "200404 response", "schema": { "$ref": "#/definitions/DocumentData" /Empty" } }, "500": { "description": "500 response" } }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/documentdata/account": { "204get": { "descriptiontags": "204 response",[ "schemaDocumentData": { ], "$refsummary": "#/definitions/Empty"Get all documents based on an account hash identifier", "produces": [ } "application/json" }], "400parameters": [{ "descriptionname": "400 responseaccountHashId", }"in": "query", "401required": {true, "descriptiontype": "401 responsestring" }, { "404name": {"Authorization", "descriptionin": "404 responseheader", "schemarequired": {true, "$reftype": "#/definitions/Emptystring" } },], "responses": { "500200": { "description": "500200 response" } , }, "securityschema": [{ "jwt-rsa-custom-authorizer$ref": []"#/definitions/ArrayOfDocumentData" }] } }, "/documentdata/account": { "get204": { "tags": [ "DocumentData" ], "summary": "Get all documents based on an account hash identifierdescription": "204 response", "producesschema": [{ "application/json"$ref": "#/definitions/Empty" ] } }, "parameters400": [{ "namedescription": "accountHashId400 response", "in": "query"}, "required401": true,{ "typedescription": "string401 response" }, { "name"404": "Authorization",{ "indescription": "header404 response", "requiredschema": true,{ "type$ref": "string#/definitions/Empty" } ] }, "responses500": { "200description": "500 {response" "description": "200 response", } }, "schemasecurity": [{ "$ref"jwt-rsa-custom-authorizer": "#/definitions/ArrayOfDocumentData" [] }] } }, "/documentdata/account/client": { "204delete": { "descriptiontags": [ "204 response", "DocumentData" ], "schemasummary": { "Delete All Documents based on an account hash identifier and client hash identifier", "$refproduces": [ "#application/definitions/Emptyjson" }], }, "parameters": [{ "400name": "accountHashId", { "descriptionin": "400 responsequery", }, "401required": {true, "descriptiontype": "401 responsestring" }, { "404name": {"clientHashId", "descriptionin": "404 responsequery", "schemarequired": {true, "$reftype": "#/definitions/Emptystring" }, },{ "500name": {"Authorization", "descriptionin": "500 response" }header", }, "securityrequired": [{true, "jwt-rsa-custom-authorizer "type": []"string" }] } }, "/documentdata/client": { "get": { ], "tagsresponses": [{ "DocumentData204": { ], "summarydescription": "Get all documents based on an account hash identifier and client hash identifier204 response", "producesschema": [{ "application/json "$ref": "#/definitions/Empty" ] } }, "parameters400": [{ "namedescription": "accountHashId400 response", "in": "query"}, "required401": true,{ "typedescription": "string401 response" }, { "name404": "clientHashId",{ "indescription": "query404 response", "requiredschema": true,{ "type$ref": "string#/definitions/Empty" }, {}, "name500": "Authorization",{ "indescription": "header500 response", } "required }, "security": true,[{ "type"jwt-rsa-custom-authorizer": "string"[] }] } ] }, "/documentdata/client": { "responsesget": { "200tags": {[ "DocumentData" "description], "summary": "200 responseGet all documents based on an account hash identifier and client hash identifier", "schemaproduces": {[ "$ref": "#/definitions/ArrayOfDocumentDataapplication/json" }], }, "parameters": [{ "204name": {"accountHashId", "descriptionin": "204 responsequery", "schemarequired": {true, "$reftype": "#/definitions/Emptystring" }, },{ "400name": {"clientHashId", "descriptionin": "400 responsequery", }, "401required": {true, "descriptiontype": "401 responsestring" }, "404{ "name": {"Authorization", "descriptionin": "404 responseheader", "schemarequired": {true, "$reftype": "#/definitions/Emptystring" } },], "responses": { "500200": { "description": "500200 response", } }, "security"schema": [{ "jwt-rsa-custom-authorizer "$ref": []"#/definitions/ArrayOfDocumentData" }] } }, "/event": { "get204": { "tagsdescription": [ "204 response", "Eventschema": { ], "summary$ref": "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", #/definitions/Empty" } }, "400": { "description": "400 response" }, "produces401": [{ "application/json "description": "401 response" ] }, "parameters404": [{ "namedescription": "direction404 response", "schema": { "in$ref": "query"#/definitions/Empty" } }, "required500": true,{ "typedescription": "string500 response" } }, "security": [{ "namejwt-rsa-custom-authorizer": "accountHashId", "in": "query", [] }] } }, "/event": { "requiredget": true,{ "typetags": "string"[ },"Event" {], "namesummary": "eventPositionFrom", "in": "query", 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", "requiredproduces": true,[ "type": "string"application/json" }], "parameters": [{ "name": "Authorizationdirection", "in": "headerquery", "required": true, "type": "string" }, { "name": "rowsReturnedaccountHashId", "in": "query", "required": true, "type": "string" }, ], "responses": { "200name": {"eventPositionFrom", "descriptionin": "200 responsequery", "schemarequired": {true, "$reftype": "#/definitions/ArrayOfEventEntriesstring" }, },{ "204name": {"Authorization", "descriptionin": "204 responseheader", "schemarequired": {true, "$reftype": "#/definitions/Emptystring" }, },{ "400name": {"rowsReturned", "descriptionin": "400 responsequery", }, "401required": {true, "descriptiontype": "401 responsestring" } ], "responses": { "404200": { "description": "404200 response", "schema": { "$ref": "#/definitions/EmptyArrayOfEventEntries" } }, "500204": { "description": "500204 response", } }, "security"schema": [{ "jwt-rsa-custom-authorizer$ref": []"#/definitions/Empty" }] } }, "/event/info": { "get400": { "tagsdescription": [ "Event"400 response" ], "summary": "Get the last event entry and the feed link to subscribe to" }, "produces401": [{ "application/json "description": "401 response" ] }, "parameters404": [{ "namedescription": "accountHashId404 response", "inschema": "query",{ "required$ref": true,"#/definitions/Empty" "type": "string" } }, "500": { "namedescription": "Authorization", 500 response" } }, "insecurity": "header",[{ "required"jwt-rsa-custom-authorizer": true, [] }] } }, "type/event/info": "string"{ } ],"get": { "responsestags": {[ "200Event": { ], "descriptionsummary": "200 responseGet the last event entry and the feed link to subscribe to", "schemaproduces": {[ "$ref": "#/definitions/EventFeedInfo"application/json" }], }, "parameters": [{ "204name": {"accountHashId", "descriptionin": "204 responsequery", "schemarequired": {true, "$reftype": "#/definitions/Emptystring" }, },{ "400name": {"Authorization", "descriptionin": "400 response" }header", "401required": {true, "descriptiontype": "401 responsestring" } ], "responses": { "404200": { "description": "404200 response", "schema": { "$ref": "#/definitions/EmptyEventFeedInfo" } }, "500204": { "description": "500204 response", } }, "securityschema": [{ "jwt-rsa-custom-authorizer "$ref": [] "#/definitions/Empty" }] } }, "/event/subscription": { "get400": { "tagsdescription": [ "Webhooks""400 response" ], "description": "Get webhook subscription details based on account hash id" }, "produces401": [{ "application/jsondescription": "401 response" ] }, "parameters404": [{ "namedescription": "hashId404 response", "inschema": "query",{ "required$ref": true,"#/definitions/Empty" "type": "string" } }, "500": { "namedescription": "Authorization", 500 response" } }, "insecurity": "header"[{ "jwt-rsa-custom-authorizer": [] }] } }, "/event/subscription": { "requiredget": false,{ "typetags": "string"[ }"Webhooks" ], "responsesdescription": { "Get webhook subscription details based on account hash id", "200produces": {[ "descriptionapplication/json": "200 response" ], "schemaparameters": [{ "$refname": "#/definitions/WebhookProvisionhashId", } }"in": "query", "400required": {true, "descriptiontype": "400 responsestring" }, "401": { "descriptionname": "401 responseAuthorization", }"in": "header", "500required": {false, "descriptiontype": "500 responsestring" } }], "securityresponses": [{ "jwt-rsa-custom-authorizer200": []{ }]"description": "200 response", }, "postschema": { "tags$ref": [ "#/definitions/WebhookProvision" "Webhooks"} ] }, "description400": "Create or update webhook subscription", { "consumesdescription": [ "application/json""400 response" ] }, "produces401": [{ "application/json"description": "401 response" ]}, "parameters500": [{ "namedescription": "hashId500 response", } "in": "query"}, "requiredsecurity": false,[{ "typejwt-rsa-custom-authorizer": "string"[] }] }, "post": { "nametags": "Authorization",[ "inWebhooks": "header" ], "requireddescription": false "Create or update webhook subscription", "typeconsumes": "string"[ }"application/json" ], "responsesproduces": {[ "200application/json" ], "parameters": [{ "descriptionname": "200 responsehashId", "schemain": {"query", "$refrequired": "#/definitions/WebhookProvision"false, }"type": "string" }, "400": { "descriptionname": "400 responseAuthorization", } "in": "header", "401required": {false, "descriptiontype": "401 responsestring" } ], "responses": { "500200": { "description": "500200 response", } }, "security"schema": [{ "jwt-rsa-custom-authorizer$ref": [] "#/definitions/WebhookProvision" }] } }, "/file/detail "400": { "get": { "tags": [ "File"description": "400 response" ] }, "summary401": "Get file details", { "producesdescription": "401 [response" "application/json" }, ], "parameters"500": [ { "name{ "description": "accountHashId500 response", } "in": "query", "required": true, }, "security": [{ "jwt-rsa-custom-authorizer": [] }] } }, "/file/detail": { "schema"get": { "tags": [ "File" ], "summary": "Get file "typedetails", "produces": "string" [ "application/json" ], "parameters": [ } }, { "name": "clientHashIdaccountHashId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "keyclientHashId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Authorizationkey", "in": "headerquery", "required": true, "schema": { "type": "string" } }, ], { "responsesname": "Authorization", { "200in": {"header", "descriptionrequired": "200 response"true, "schema": { "$reftype": "#/definitions/FileDetail"string" } } ], }, "responses": { "204200": { "description": "204200 response", "schema": { "$ref": "#/definitions/EmptyFileDetail" } }, "400204": { "description": "400204 response", "contentschema": {} }, "401$ref": { "description": "401 response","#/definitions/Empty" "content": {} }, "404400": { "description": "404400 response", "content": {} }, "500401": { "description": "500401 response", "content": {} }, }, "404": { "security": [ "description": "404 {response", "jwt-rsa-custom-authorizercontent": []{} }, ] "500": { } }, "/file/download"description": {"500 response", "get": { "tags": [ "File" ], "summarycontent": "Get{} the file downloadUrl", "produces": [ "application/json" ], } "parameters": [ }, { "security": [ "name": "accountHashId", { "injwt-rsa-custom-authorizer": "query", [] } "required": true, ] } }, "schema/file/download": { "get": { "tags": [ "File" ], "typesummary": "string"Get the file downloadUrl", "produces": [ "application/json" ], } },"parameters": [ { "name": "clientHashIdaccountHashId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "keyclientHashId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Authorizationkey", "in": "headerquery", "required": true, "schema": { "type": "string" } }, { ], "responsesname": {"Authorization", "200in": {"header", "descriptionrequired": "200 response", true, "schema": { "$reftype": "#/definitions/FileDownloadstring" } } ], "responses": { "204200": { "description": "204200 response", "schema": { "$ref": "#/definitions/EmptyFileDownload" } }, "400204": { "description": "400204 response", "contentschema": {} }, "401": { "description$ref": "401 response",#/definitions/Empty" "content": {} }, "404400": { "description": "404400 response", "content": {} }, "500401": { "description": "500401 response", "content": {} } , }, "security404": [ { "jwt-rsa-custom-authorizerdescription": [] "404 response", } ] } }, "/ping"content": { "get": { "tags": [ "Healthcheck" ], "summary": "Site Healthcheck", "produces": [ "application/json" ], "responses": { "200": { } }, "500": { "description": "200500 response", "schema "content": { "$ref": "#/definitions/Ping" } }, "500": { "description": "500 response" } } } } }, "securityDefinitions": { } } }, "security": [ { "jwt-rsa-custom-authorizer": { "type": "apiKey", "name": "Authorization", "in": "header", "x-amazon-apigateway-authtype": "custom" } }, "definitions": { "Account": { "type": "object", "properties [] } ] } }, "/ping": { "hashIdget": { "typetags": "string",[ "descriptionHealthcheck": "Account Hash Identifier" }], "namesummary": { "type": "string" }"Site Healthcheck", "businessTypeproduces": {[ "typeapplication/json": "string" }], "companyTyperesponses": { "type200": "string"{ }, "countrydescription": { "type": "string""200 response", }, "addressschema": { "$ref": "#/definitions/PhysicalAddress"Ping" } }, "email500": { "typedescription": "string"500 response" } }, } "telephone} }, "securityDefinitions": { "jwt-rsa-custom-authorizer": { "type": "stringapiKey", }"name": "Authorization", "operatesAsin": { "header", "typex-amazon-apigateway-authtype": "stringcustom" } }, "definitions": { "practiceAppointmentAccount": { "type": "string" }object", "practiceNameproperties": { "typehashId": "string" }, { "practiceAddresstype": {"string", "$refdescription": "#/definitions/PhysicalAddressAccount Hash Identifier" }, "practiceTelephonename": { "type": "string" }, "practiceEmailbusinessType": { "type": "string" }, "trustAppointmentcompanyType": { "type": "string" }, "trustNamecountry": { "type": "string" }, "trustAddressaddress": { "$ref": "#/definitions/PhysicalAddress" }, "trustTelephoneemail": { "type": "string" }, "trustEmailtelephone": { "type": "string" }, "createdOnoperatesAs": { "type": "string", "format": "date-time" }, "updatedOnpracticeAppointment": { "type": "string", "format": "date-time" } }, "title": "Arken Account Model", "description": "Arken Account Details" }, "WebhookProvision": { "type": "object", "propertiespracticeName": { "accountHashIdtype": { "string" }, "typepracticeAddress": "string",{ "description$ref": "Account Hash Identifier#/definitions/PhysicalAddress" }, "postUrlpracticeTelephone": { "type": "string" }, "versionpracticeEmail": { "type": "string" }, "postAuthtrustAppointment": { "$reftype": "#/definitions/WebhookProvisionAuthstring" }, "activetrustName": { "type": "string" }, }, "titletrustAddress": "Arken Webhook Provision Model", { "description$ref": "Arken Webhook Provision Details#/definitions/PhysicalAddress" }, "ArrayOfClientstrustTelephone": { "title": "Arken Client Array Model", "type": "arraystring", "description": "Arken Client Array Details"}, "itemstrustEmail": { "$reftype": "#/definitions/Clientstring" }, }, "EventFeedInfocreatedOn": { "type": "objectstring", "propertiesformat": {"date-time" }, "feedLinkupdatedOn": { "type": "string", "format": "date-time" } }, "lastEventNumbertitle": { "Arken Account Model", "typedescription": "stringArken Account Details" }, "lastEventFeedWebhookProvision": { "$reftype": "#/definitions/EventEntryobject", } "properties": { }, "accountHashId": { "titletype": "Arken Event Feed Info Modelstring", "description": "Arken Event Feed Info DataAccount Hash Identifier" }, "ArrayOfDocumentDatapostUrl": { "titletype": "string"Arken DocumentData Array Model" }, "typeversion": "array",{ "descriptiontype": "string"Arken DocumentData Array Details" }, "itemspostAuth": { "$ref": "#/definitions/DocumentDataWebhookProvisionAuth" }, }, "ArrayOfEventEntriesactive": { "titletype": "Arken Event Entries Array Model", string" "type": "array"} }, "descriptiontitle": "Arken EventWebhook EntriesProvision Array DetailsModel", "itemsdescription": "Arken { "$ref": "#/definitions/EventEntry" }Webhook Provision Details" }, "PhysicalAddressArrayOfClients": { "typetitle": "objectArken Client Array Model", "propertiestype": { "streetarray": {, "typedescription": "string" }Arken Client Array Details", "suburbitems": { "type$ref": "string#/definitions/Client" } }, "cityEventFeedInfo": { "type": "stringobject", },"properties": { "regionfeedLink": { "type": "string" }, "postcodelastEventNumber": { "type": "string" }, "countrylastEventFeed": { "type$ref": "string#/definitions/EventEntry" } }, "title": "Arken CommonEvent Feed AddressInfo Model", "description": "Physical address format for Arken" }, "Name": { "type": "object", "properties": { "firstEvent Feed Info Data" }, "ArrayOfDocumentData": { "typetitle": "string" }Arken DocumentData Array Model", "middletype": {"array", "typedescription": "string" }Arken DocumentData Array Details", "surnameitems": { "type$ref": "string#/definitions/DocumentData" } }, "fullNameArrayOfEventEntries": { "typetitle": "string"Arken Event Entries Array Model", } }"type": "array", "titledescription": "Arken CommonEvent Entries NameArray ModelDetails", "descriptionitems": { "Person's structured name model" "$ref": "#/definitions/EventEntry" } }, "DocumentDataPhysicalAddress": { "type": "object", "properties": { "accountHashIdstreet": { "type": "string" }, "clientHashIdsuburb": { "type": "string" }, "hashIdcity": { "type": "string" }, "clientMatterReferenceregion": { "type": "string" }, "documentTypepostcode": { "type": "string" }, "versioncountry": { "type": "string" } }, "title": "Arken Common Address Model", "jurisdictiondescription": { "Physical address format for Arken" }, "Name": { "type": "stringobject", },"properties": { "contentfirst": { "type": "object"string" }, "middle": { "propertiestype": {}"string" }, "createdOnsurname": { "type": "string" }, "fullName": { "formattype": "date-timestring" }, "updatedOn": { }, "typetitle": "stringArken Common Name Model", "formatdescription": "date-timePerson's structured name model" }, "settingsDocumentData" : { "type" : "object", "properties" : { "currentDocumentKeyaccountHashId": { "type": "string"} }, } "clientHashId": { }, "titletype": "Arken Document Data Model",string" "description": "Arken Document Data" }, "EmptyhashId": { "type": "object"string" }, "titleclientMatterReference": { "Empty Schema "type": "string" }, "EventEntrydocumentType": { "type": "objectstring", "properties": { }, "eventIdversion": { "type": "string" }, "eventTypejurisdiction": { "type": "string" }, "eventNumbercontent": { "type": "object", "numberproperties": {} }, "eventDateTimeUtccreatedOn": { "type": "string", "format": "date-time" }, "linkupdatedOn": { "type": "string", }, "format": "date-time" }, "propertiessettings" : { "type" : "object", "properties" : { "properties "currentDocumentKey": { "type":"string"} } } }, "title": "Arken EventDocument EntryData Model", "description": "Arken Event EntryDocument Data" }, "PingEmpty": { "type": "object", "title": "Arken Healthcheck", "description": "Arken Healthcheck PingEmpty Schema" }, "CRMDataEventEntry": { "type" : "object", "properties" : { "CRMModeleventId" : { "type" : "string" }, "CRMClientIdeventType" : { "type" : "string" }, "CRMMatterIdeventNumber" : { "type" : "array", "properties" : { : "number" }, "eventDateTimeUtc": { "type": "string" }, "link": { "type": "string" }, "properties": { "type": "object", "properties": {} } }, "title": "Arken Event } } }Entry Model", "description": "Arken Event Entry Data" }, "Ping": { "type": "object", "title" : "Arken CRM Data ModelHealthcheck", "description" : "Arken CRMHealthcheck Extension DataPing" }, "Client": { "type": "object", "properties": { "hashId": { "type": "string", "description": "Client Hash Identifier" }, "accountHashId": { "type": "string", "description": "Account Hash Identifier" }, "title": { "type": "string" }, "name": { "$ref": "#/definitions/Name" }, "gender": { "type": "string" }, "maritalStatus": { "type": "string" }, "email": { "type": "string" }, "address": { "$ref": "#/definitions/PhysicalAddress" }, "dateOfBirth": { "type": "string", "format": "date-time" }, "mobile": { "type": "string" }, "telephone": { "type": "string" }, "partnerName": { "$ref": "#/definitions/Name" }, "partnerGender": { "type": "string" }, "partnerTitle": { "type": "string" }, "partnerDateOfBirth": { "type": "string", "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time" }, "updatedOn": { "type": "string", "format": "date-time" }, "externalReference": { "type": "string" }, "partnerHashId": { "type": "string" }, "application": { "type": "string" }, "extensionData "extensiondata": { "$reftype": "#/definitions/CRMDataobject" } }, "title": "Arken Client Model", "description": "Arken Client Details" }, "FileDetail": { "type" : "object", "properties" : { "accountHashId" : { "type" : "string" }, "clientHashId" : { "type" : "string" }, "fileKey" : { "type" : "string" }, "properties" : { "type" : "object", "properties" : { } } }, "title" : "Arken File Detail Data Model", "description" : "Arken File DetailData" }, "FileDownload": { "type" : "object", "properties" : { "accountHashId" : { "type" : "string" }, "clientHashId" : { "type" : "string" }, "fileKey" : { "type" : "string" }, "downloadUrl" : { "type" : "object", "properties" : { } } }, "title" : "Arken File Download Model", "description" : "Arken File Download URL" }, "WebhookProvisionAuth": { "type": "object", "properties": { "accessKey": { "type": "string" }, "secretKey": { "type": "string" }, "scope": { "type": "string" }, "authurl": { "type": "string" }, "granttype": { "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": [] } } }] } } |
...