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": "AuthorizationaccountHashId",
						
            "in": "headerquery",
						            "required": false,
						true,
            "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,
						
          },
          {
            "name": "query",
            "in": "query",
            "required": true,
            "type": "string"
          },
          {
            "name": "pageRowsCount",
            "in": "query",
            "required": false,
            "type": "string"
          },
          {
            "name": "Authorization",
            "in": "header",
            "required": false,
            "type": "string"
					},
					{
						"name": "Authorization",
						"in": "header",
						"required": true,
						"type": "string"
					}
				],
				"responses": {
					"200": {
						
          }
        ],
        "responses": {
          "200": {
            "description": "200 response",
						
            "schema": {
							
              "$ref": "#/definitions/ArrayOfDocumentDataArrayOfClients"
						}
					},
					"204": {
						            }
          },
          "204": {
            "description": "204 response",
						            "schema": {
							
              "$ref": "#/definitions/Empty"
						}
					},
					"400": {
						"description": "400 response"
					},
					"401": {
						            }
          },
          "400": {
            "description": "401400 response"
					},
					"404          },
          "401": {
						            "description": "404401 response",
						"schema": {
							"$ref": "#/definitions/Empty"
						}
					},
					"500": {
						
          },
          "404": {
            "description": "500404 response"
					}
				},
				"security": [{
					"jwt-rsa-custom-authorizer": []
				}]
			}
		},
		"/documentdata/client,
            "schema": {
			"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"
					},
					
              "$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": "clientHashIdhashId",
						"in": "query",
						"required": true,
						"type": "string"
					},
					{
						"name": "Authorization",
						"in": "header",
						"required": truefalse,
						"type": "string"
					}
				],
				"responses": {
					"200": {
						"description": "200 response",
						"schema": {
							"$ref": "#/definitions/ArrayOfDocumentDataDocumentData"
						}
					},
					"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": {
			"getdelete": {
				"tags": [
					"EventDocumentData"
				],
				"summary": "GetDelete a list of events Document based on theits account identifier, when the last event number and return items based on the number of rows requestedhash identifier",
				"produces": [
					"application/json"
				],
				"parameters": [{
						"name": "directionhashId",
						"in": "query",
						"required": true,
						"type": "string"
					},
					{
						"name": "accountHashIdAuthorization",
						"in": "queryheader",
						"required": true,
						"type": "string"
					}
				],
					"responses": {
						"name204": "eventPositionFrom",{
						"indescription": "query204 response",
						"requiredschema": true,{
							"type$ref": "string#/definitions/Empty"
						},
					{},
						"name400": "Authorization",{
						"indescription": "header"400 response"
					},
						"required401": true,{
						"typedescription": "string401 response"
					},
					{
						"name404": "rowsReturned",{
						"indescription": "query404 response",
						"requiredschema": true,{
							"type$ref": "string#/definitions/Empty"
						}
				]	},
					"responses500": {
						"200description": "500 {response"
						"description": "200 response",
		}
				},
				"schemasecurity": [{
							"$ref"jwt-rsa-custom-authorizer": "#/definitions/ArrayOfEventEntries"[]
						}]
			}
		},
		"/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"
					},
					"404{
						"name": {"Authorization",
						"descriptionin": "404 responseheader",
						"schemarequired": {true,
							"$reftype": "#/definitions/Emptystring"
						}
					},],
				"responses": {
					"500200": {
						"description": "500200 response"
					}
	,
			},
				"securityschema": [{
						"jwt-rsa-custom-authorizer	"$ref": []"#/definitions/ArrayOfDocumentData"
						}]
			}
		},
		"/event/info": {
			"get204": {
						"tagsdescription": [
"204 response",
						"Eventschema": 	{
			],
				"summary$ref": "Get the last event entry and the feed link to subscribe to",
				"produces": [
#/definitions/Empty"
						"application/json"}
					]},
					"parameters400": [{
						"namedescription": "accountHashId400 response",
						"in": "query"},
						"required401": true,{
						"typedescription": "string401 response"
					},
					{
						"name404": "Authorization",{
						"indescription": "header404 response",
						"requiredschema": true,{
							"type$ref": "string#/definitions/Empty"
						}
					]},
				"responses": {
					"200500": {
						"description": "200500 response",
					}
				},
				"schemasecurity": [{
							"$refjwt-rsa-custom-authorizer": "#/definitions/EventFeedInfo"
	[]
					}]
			}
		},
		"/documentdata/account/client": {
			"204delete": {
						"descriptiontags": "204 response",
	[
					"schemaDocumentData": {
				],
				"$refsummary": "#/definitions/Empty"Delete All Documents based on an account hash identifier and client hash identifier",
						}"produces": [
					}"application/json"
				],
					"400parameters": [{
						"descriptionname": "400 responseaccountHashId",
					}	"in": "query",
						"401required": {true,
						"descriptiontype": "401 responsestring"
					},
					{
						"404name": {"clientHashId",
						"descriptionin": "404 responsequery",
						"schemarequired": {true,
							"$reftype": "#/definitions/Emptystring"
						},
					},{
						"500name": {"Authorization",
						"descriptionin": "500 responseheader",
						}"required": true,
				},
				"securitytype": [{"string"
					"jwt-rsa-custom-authorizer": []}
				}],
			}
		},
		"/event/subscription"responses": {
					"get204": {
						"tagsdescription": [
"204 response",
						"Webhooksschema": {
				],
				"description$ref": "Get webhook subscription details based on account hash id",#/definitions/Empty"
				"produces": [
		}
			"application/json"
				]},
					"parameters400": [{
						"namedescription": "hashId400 response",
						"in": "query"},
						"required401": true,{
						"typedescription": "string401 response"
					},
					"404": {
						"namedescription": "Authorization404 response",
						"inschema": "header",{
							"required$ref": false,"#/definitions/Empty"
						"type": "string"}
					}
				],
				"responses": {
					"200500": {
						"description": "200500 response",

					}
				},
				"schemasecurity": [{
							"$ref"jwt-rsa-custom-authorizer": "#/definitions/WebhookProvision"
	[]
					}]
			}
		},
					"400/documentdata/client": {
						"descriptionget": "400 response"{
					},
					"401"tags": {[
						"description": DocumentData"401
response"
					}],
					"500summary": "Get {
		all documents based on an account hash identifier and client hash identifier",
				"descriptionproduces": "500 response"[
					}"application/json"
				}],
				"securityparameters": [{
					"jwt-rsa-custom-authorizer	"name": []
"accountHashId",
						}]"in": "query",
			},
			"postrequired": {true,
						"tagstype": ["string"
					"Webhooks"},
					],{
						"descriptionname": "Create or update webhook subscriptionclientHashId",
						"consumesin": ["query",
						"application/json"
				],
required": true,
						"producestype": [
					"application/json"string"
					]},
					"parameters": [{
						"name": "hashIdAuthorization",
						"in": "queryheader",
						"required": falsetrue,
						"type": "string"
					}
				],
					"responses": {
						"name200": "Authorization",{
						"indescription": "header200 response",
						"requiredschema": false,{
							"type$ref": "string#/definitions/ArrayOfDocumentData"
						}
				]	},
				"responses": {
					"200204": {
						"description": "200204 response",
						"schema": {
							"$ref": "#/definitions/WebhookProvisionEmpty"
						}
					},
					"400": {
						"description": "400 response"
					},
					"401": {
						"description": "401 response"
					},
					"500404": {
						"description": "500404 response",
					}
				},
				"security"schema": [{
					"jwt-rsa-custom-authorizer		"$ref": []
"#/definitions/Empty"
						}]
			}
		},
					"/file/detail500": {
      "get						"description": {"500 response"
					}
				},
				"tagssecurity": [{
					"File"
jwt-rsa-custom-authorizer": []
				}],
			}
		},
		"summary/event": "Get file details",{
			"get": {
				"producestags": [
					"application/jsonEvent"
				],
        "parameters				"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"name": "accountHashId",
            ,
				"produces": [
					"application/json"
				],
				"parameters": [{
						"name": "direction",
						"in": "query",
            						"required": true,
            "schema						"type": {
              "type"string"
					},
					{
						"name": "stringaccountHashId",
						"in": "query",
						"required": true,
						"type":        }
          },
          {
            "string"
					},
					{
						"name": "clientHashIdeventPositionFrom",
            						"in": "query",
						"required":            true,
						"type": "string"
					},
					{
						"name": "Authorization",
						"in": "header",
						"required": true,
						"type": "string"
					},
         "schema": {
              "type					{
						"name": "rowsReturned",
						"in": "stringquery"
            }
          },
          {
            "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": {
            ,
						"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",
            "content
					},
					"401": {}
          },
          "401": {
            
						"description": "401 response"
					},
					"404": {
						"description": "401404 response",
            "content						"schema": {}
          },
          "404
							"$ref": "#/definitions/Empty"
						}
					},
					"500": {
						"description": "500 response"
					}
				},
				"security": [{
					"jwt-rsa-custom-authorizer": []
				}]
			}
		},
"description		"/event/subscription": "404 response",
            "content": {}
          },
          "500": {
            "description": "500 response",
            "content": {}
          {
			"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": {}
          },
          "500404": {
            "description": "500404 response",
            "content": {}
          },
        },      "500": {
  "security": [         "description": "500 {response",
            "jwt-rsa-custom-authorizercontent": []{}
          }
        ]},
        "security": [
 }     }, 		"/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
            "jwt-rsa-custom-authorizer": []
          }
        ]
      }
    },
		"/ping": {
			"get": {
				"tags": [
					"Healthcheck"
				],
				"summary": "Site Healthcheck",
				"produces": [
					"application/json"
				],
				"responses": {
					"hashId200": {
						"typedescription": "string200 response",
						"descriptionschema": "Account Hash Identifier"
{
				},
				"name$ref": {
"#/definitions/Ping"
						"type": "string"
}
					},
					"businessType500": {
						"typedescription": "string"500 response"
					}
				},
			}
	"companyType	}
	},
	"securityDefinitions": {
		"jwt-rsa-custom-authorizer": {
			"type": "stringapiKey",
				}"name": "Authorization",
				"countryin": {
		"header",
			"typex-amazon-apigateway-authtype": "stringcustom"
			}
	},
	"definitions": {
			"addressAccount": {
					"$reftype": "#/definitions/PhysicalAddressobject",
				},"properties": {
				"emailhashId": {
					"type": "string",
					"description": "Account Hash Identifier"
				},
				"telephonename": {
					"type": "string"
				},
				"operatesAsbusinessType": {
					"type": "string"
				},
				"practiceAppointmentcompanyType": {
					"type": "string"
				},
				"practiceNamecountry": {
					"type": "string"
				},
				"practiceAddressaddress": {
					"$ref": "#/definitions/PhysicalAddress"
				},
				"practiceTelephoneemail": {
					"type": "string"
				},
				"practiceEmailtelephone": {
					"type": "string"
				},
				"trustAppointmentoperatesAs": {
					"type": "string"
				},
				"trustNamepracticeAppointment": {
					"type": "string"
				},
				"trustAddresspracticeName": {
					"$reftype": "#/definitions/PhysicalAddressstring"
				},
				"trustTelephonepracticeAddress": {
					"type$ref": "string#/definitions/PhysicalAddress"
				},
				"trustEmailpracticeTelephone": {
					"type": "string"
				},
				"createdOnpracticeEmail": {
					"type": "string",
					"format": "date-time"
				},
				"updatedOntrustAppointment": {
					"type": "string",
					"format": "date-time"
				}
			},
			"title": "Arken Account Model",
			"descriptiontrustName": "Arken Account Details"
{
		},
		"WebhookProvision": {
			"type": "objectstring",
			"properties": {
				"accountHashId": {	},
					"typetrustAddress": "string",{
					"description$ref": "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 Webhook ProvisionAccount Model",
			"description": "Arken Webhook ProvisionAccount 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", Details",
			"items": {
				"$ref": "#/definitions/Client"
			}
		},
		"EventFeedInfo": {
			"type": "object",
			"properties": {
				"itemsfeedLink": {
					"$reftype": "#/definitions/DocumentDatastring"
				},
		},
		"ArrayOfEventEntrieslastEventNumber": {
			"title": "Arken Event Entries Array Model",
			"type": "arraystring",
				"description": "Arken Event Entries Array Details"},
				"itemslastEventFeed": {
					"$ref": "#/definitions/EventEntry"
				}
			},
			"PhysicalAddresstitle": {"Arken Event Feed Info Model",
			"typedescription": "object"Arken Event Feed Info Data"
		},
			"propertiesArrayOfDocumentData": {
				"streettitle": {
	"Arken DocumentData Array Model",
				"type": "stringarray",
					}"description": "Arken DocumentData Array Details",
				"suburbitems": {
					"type$ref": "string#/definitions/DocumentData"
			}
		},
				"cityArrayOfEventEntries": {
					"typetitle": "string"
				},
	Arken Event Entries Array Model",
			"regiontype": {"array",
					"typedescription": "string"
				}Arken Event Entries Array Details",
				"postcodeitems": {
					"type$ref": "string#/definitions/EventEntry"
			}
		},
				"countryPhysicalAddress": {
					"type": "stringobject",
				}"properties": {
			},
			"titlestreet": "Arken Common Address Model",
{
					"description": "Physical address format for Arkentype": "string"
				},
				"Namesuburb": {
					"type": "objectstring",
				"properties": {},
				"firstcity": {
					"type": "string"
				},
				"middleregion": {
					"type": "string"
				},
				"surnamepostcode": {
					"type": "string"
				},
				"fullNamecountry": {
					"type": "string"
				}
			},
			"title": "Arken Common NameAddress Model",
			"description": "Person's structured name modelPhysical address format for Arken"
		},
		"DocumentDataName": {
			"type": "object",
			"properties": {
				"accountHashIdfirst": {
					"type": "string"
				},
				"clientHashIdmiddle": {
					"type": "string"
				},
				"hashIdsurname": {
					"type": "string"
				},
				"clientMatterReferencefullName": {
					"type": "string"
				}
			},
				"documentTypetitle": { "Arken Common Name Model",
					"typedescription": "stringPerson's structured name model"
				},
				"versionDocumentData": {
					"type": "stringobject",
				},"properties": {
				"jurisdictionaccountHashId": {
					"type": "string"
				},
				"contentclientHashId": {
					"type": "object",string"
				},
				"hashId": {
					"propertiestype": {}"string"
				},
				"createdOnclientMatterReference": {
					"type": "string"
				},
				"documentType": {
					"formattype": "date-timestring"
				},
				"updatedOnversion": {
					"type": "string",
					"format": "date-time"
},
				},
"settingsjurisdiction" : {
				  	"type" : "object"string"
				},
				  "propertiescontent" : {

					  "currentDocumentKeytype": { "type":"string"}
object",
					"properties":  {}
				},
				},"createdOn": {
					"titletype": "Arken Document Data Modelstring",
					"descriptionformat": "Arken Document Datadate-time"
				},
				"EmptyupdatedOn": {
					"type": "objectstring",
					"titleformat": "Empty Schemadate-time"
				},
		"EventEntrysettings" : {
				  "type" : "object",
				  "properties" : { 
					  "eventIdcurrentDocumentKey": { 					"type": "string"}
				}, 				"eventType": { }
					"type": "string"
}
				},
				"eventNumbertitle": {
	 "Arken Document Data Model",
				"typedescription": "numberArken Document Data"
				},
				"eventDateTimeUtcEmpty": {
					"type": "string"
				}object",
				"linktitle": {
					"type": "string"Empty Schema"
				},
				"propertiesEventEntry": {
					"type": "object",
			"properties": {
				"propertieseventId": {}
				}
	"type": "string"
				},
				"titleeventType": "Arken Event Entry Model",
{
					"descriptiontype": "Arken Event Entry Datastring"
				},
				"PingeventNumber": {
					"type": "object"number"
				},
				"titleeventDateTimeUtc": "Arken Healthcheck",
{
					"descriptiontype": "Arken Healthcheck Pingstring"
				},
				"CRMDatalink": {
					"type" : "object"string"
				},
				"properties" : {
					"CRMModeltype" : {"object",
					"typeproperties" : "string"{}
				}
			},
					"CRMClientId" : {
		"title": "Arken Event Entry Model",
			"typedescription" : "stringArken Event Entry Data"
					},
					"CRMMatterIdPing" : {
					"type" : "array"
					}
				}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": []
				}
			}
		}]
	}
}

...