Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
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": "accountHashId",
            "in": "query",
            "required": true,
            "type": "string"
          },
          {
            "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": "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": falsetrue,
						"type": "string"
					}
				],
				"responses": {
					"200": {
						"description": "200 response",
						"schema": {
							"$ref": "#/definitions/DocumentDataArrayOfDocumentData"
						}
					},
					"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/client": {
			"getdelete": {
				"tags": [
					"DocumentData"
				],
				"summary": "GetDelete allAll documentsDocuments based on an account hash identifier and client hash identifier",
				"produces": [
					"application/json"
				],
				"parameters": [{
						"name": "accountHashId",
						"in": "query",
						"required": true,
						"type": "string"
					},
					{
						"name": "AuthorizationclientHashId",
						"in": "headerquery",
						"required": true,
						"type": "string"
					},
				],
				"responses": {
						"200name": {"Authorization",
						"descriptionin": "200 responseheader",
						"schemarequired": {true,
							"$reftype": "#/definitions/ArrayOfDocumentDatastring"
					}
					}],
					},"responses": {
					"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 file 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/FileDetail"
                }

          },
          "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/download": {
      "get": {
	  "tags": [
					"File"
				],
				"summary": "Get the file downloadUrl",
				"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/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/ping": {
						"descriptionget": "500{
response"
					}
				}"tags": [
			}
		}
	},
	"securityDefinitions": {"Healthcheck"
		"jwt-rsa-custom-authorizer": {
			"type": "apiKey"		],
				"namesummary": "AuthorizationSite Healthcheck",
				"inproduces": "header",[
				"x-amazon-apigateway-authtype": "custom"
		}
	},
	"definitions	"application/json"
				],
				"responses": {
					"Account200": {
						"typedescription": "object200 response",
			"properties": {
				"hashIdschema": {
							"type$ref": "string#/definitions/Ping",
						"description": "Account Hash Identifier"
}
					},
					"name500": {
						"typedescription": "string500 response"
					},
				"businessType": {}
			}
		}
		},
	"typesecurityDefinitions": "string"
				},
	{
			"companyType"jwt-rsa-custom-authorizer": {
					"type": "stringapiKey",
				}"name": "Authorization",
				"countryin": {
		"header",
			"typex-amazon-apigateway-authtype": "stringcustom"
			}
	},
	"definitions": {
			"addressAccount": {
					"$reftype": "#/definitions/PhysicalAddressobject",
				},"properties": {
				"emailhashId": {
					"type": "string",
				},
				"telephonedescription": {
					"type": "string""Account Hash Identifier"
				},
				"operatesAsname": {
					"type": "string"
				},
				"practiceAppointmentbusinessType": {
					"type": "string"
				},
				"practiceNamecompanyType": {
					"type": "string"
				},
				"practiceAddresscountry": {
					"$reftype": "#/definitions/PhysicalAddressstring"
				},
				"practiceTelephoneaddress": {
					"type$ref": "string#/definitions/PhysicalAddress"
				},
				"practiceEmailemail": {
					"type": "string"
				},
				"trustAppointmenttelephone": {
					"type": "string"
				},
				"trustNameoperatesAs": {
					"type": "string"
				},
				"trustAddresspracticeAppointment": {
					"$reftype": "#/definitions/PhysicalAddressstring"
				},
				"trustTelephonepracticeName": {
					"type": "string"
				},
				"trustEmailpracticeAddress": {
					"type$ref": "string#/definitions/PhysicalAddress"
				},
				"createdOnpracticeTelephone": {
					"type": "string",
					"format":
"date-time"
				},
				"updatedOnpracticeEmail": {
					"type": "string",
					"format":
"date-time"
				},
			},
			"titletrustAppointment": "Arken Account Model",
{
					"descriptiontype": "Arken Account Detailsstring"
				},
				"WebhookProvisiontrustName": {
					"type": "objectstring",
				"properties": {
},
				"accountHashIdtrustAddress": {
					"type$ref": "string",
					"description": "Account Hash Identifier#/definitions/PhysicalAddress"
				},
				"postUrltrustTelephone": {
					"type": "string"
				},
				"versiontrustEmail": {
					"type": "string"
				},
				"postAuthcreatedOn": {
					"type": "string",
					"$refformat": "#/definitions/WebhookProvisionAuthdate-time"
				},
				"activeupdatedOn": {
					"type": "string",
					"format": "date-time"
				}
			},
			"title": "Arken WebhookAccount Provision Model",
			"description": "Arken WebhookAccount Provision Details"
		},
		"ArrayOfClientsWebhookProvision": {
			"titletype": "Arken Client Array Modelobject",
			"typeproperties": "array",{
				"descriptionaccountHashId": "Arken Client Array Details",
{
					"itemstype": {"string",
					"$refdescription": "#/definitions/ClientAccount Hash Identifier"
				},
		},
		"EventFeedInfopostUrl": {
					"type": "objectstring",
				"properties": {},
				"feedLinkversion": {
					"type": "string"
				},
				"lastEventNumberpostAuth": {
					"type$ref": "string#/definitions/WebhookProvisionAuth"
				},
				"lastEventFeedactive": {
					"$reftype": "#/definitions/EventEntrystring"
				}
			},
			"title": "Arken EventWebhook Feed InfoProvision Model",
			"description": "Arken EventWebhook FeedProvision Info DataDetails"
		},
		"ArrayOfDocumentDataArrayOfClients": {
			"title": "Arken DocumentDataClient Array Model",
			"type": "array",
			"description": "Arken DocumentDataClient Array Details",
			"items": {
				"$ref": "#/definitions/DocumentDataClient"
			}
		},
		"ArrayOfEventEntriesEventFeedInfo": {
			"titletype": "Arken Event Entries Array Modelobject",
			"typeproperties": "array",{
			"description": "Arken Event Entries Array Details",
			"itemsfeedLink": {
					"$reftype": "#/definitions/EventEntrystring"
			}
		},
		"PhysicalAddress": {
			"type": "object",
			"properties": {
				"streetlastEventNumber": {
					"type": "string"
				},
				"suburblastEventFeed": {
					"type$ref": "string#/definitions/EventEntry"
				}
			},
				"citytitle": {
		"Arken Event Feed Info Model",
			"typedescription": "stringArken Event Feed Info Data"
				},
				"regionArrayOfDocumentData": {
			"title": "Arken DocumentData Array Model",
			"type": "stringarray",
				}"description": "Arken DocumentData Array Details",
				"postcodeitems": {
					"type$ref": "string#/definitions/DocumentData"
			}
		},
				"countryArrayOfEventEntries": {
					"typetitle": "string"Arken Event Entries Array Model",
				}
			}"type": "array",
			"titledescription": "Arken CommonEvent Entries AddressArray ModelDetails",
			"descriptionitems": {
"Physical address format for Arken"
				"$ref": "#/definitions/EventEntry"
			}
		},
		"NamePhysicalAddress": {
			"type": "object",
			"properties": {
				"firststreet": {
					"type": "string"
				},
				"middlesuburb": {
					"type": "string"
				},
				"surnamecity": {
					"type": "string"
				},
				"fullNameregion": {
					"type": "string"
				},
			},
			"titlepostcode": "Arken Common Name Model",
{
					"descriptiontype": "Person's structured name modelstring"
				},
				"DocumentDatacountry": {
					"type": "objectstring",
			"properties": {	}
			},
				"accountHashIdtitle": { "Arken Common Address Model",
					"typedescription": "stringPhysical address format for Arken"
				},
				"clientHashIdName": {
					"type": "stringobject",
				},"properties": {
				"hashIdfirst": {
					"type": "string"
				},
				"clientMatterReferencemiddle": {
					"type": "string"
				},
				"documentTypesurname": {
					"type": "string"
				},
				"versionfullName": {
					"type": "string"
				}
			},
				"jurisdictiontitle": {
		"Arken Common Name Model",
			"typedescription": "stringPerson's structured name model"
				},
				"contentDocumentData": {
					"type": "object",
					"properties": {}
				},
				"createdOn"accountHashId": {
					"type": "string"
				},
				"clientHashId": {
					"formattype": "date-timestring"
				},
				"updatedOnhashId": {
					"type": "string",
					"format": "date-time"},
				},
"settingsclientMatterReference" : {
					  "type" : "object""string"
				},
				  "propertiesdocumentType" : {

					  "currentDocumentKeytype": { "type":"string"}
				  },
				}
	"version": {
		},
			"titletype": "Arken Document Data Model",
			"description": "Arken Document Data"
string"
				},
				"Emptyjurisdiction": {
					"type": "objectstring",
			"title": "Empty Schema"
		},
				"EventEntrycontent": {
					"type": "object",
					"properties": {}
				"eventId},
				"createdOn": {
					"type": "string",
					"format": "date-time"
				},
				"eventTypeupdatedOn": {
					"type": "string"string",
					"format": "date-time"
				},
				"eventNumbersettings" : {
					  "type" : "numberobject",
				},
				"eventDateTimeUtc"  "properties" : { 
					  "currentDocumentKey": { "type": "string"}
				  }
				}
			},
				"linktitle": {
		"Arken Document Data Model",
			"typedescription": "stringArken Document Data"
				},
				"propertiesEmpty": {
					"type": "object",
					"propertiestitle": {}"Empty Schema"
				},
			},"EventEntry": {
			"titletype": "Arken Event Entry Modelobject",
			"descriptionproperties": "Arken Event Entry Data"{
		},
		"PingeventId": {

					"type": "object"string"
				},
				"titleeventType": "Arken Healthcheck",
{
					"descriptiontype": "Arken Healthcheck Pingstring"
				},
				"CRMDataeventNumber": {
					"type" : "objectnumber",
				"properties" : {
	},
				"CRMModeleventDateTimeUtc" : {
					"type" : "string"
					},
					"CRMClientIdlink" : {
					"type" : "string"
					},
					"CRMMatterIdproperties" : {
					"type" : "arrayobject",
					"properties": {}
				}
			},
			"title": "Arken Event Entry                                  "properties" : []
					}
				}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": []
				}
			}
		}]
	}
}

...