API docs by Redocly

V0.2 'Submit an application to change the Land Register API' Schema

Download OpenAPI specification:Download

V0.2 of the set of APIs for the new 'Submit an application to change the Land Register API' Schema

Submit an application API

Submit an application API

Submit an application API - Submit application creation requests for processing

Authorizations:
basicAuth
header Parameters
Idempotency-Key
required
string
Request Body schema: application/json
required
required
object (SubstantiveApplicationData)

The data required to capture an application

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "application_request_id": "string"
}

Send a document API

Create an upload URL

Create an upload URL - Retrieve a generated document upload URL

Authorizations:
basicAuth
Request Body schema: application/json
required
required
object (DocumentUploadUrlData)

The data needed to generate a URL to upload a document

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "upload_url": "string",
  • "document_id": "string"
}

Upload a document

Upload a document - Upload the document contents. Note: This URL, including hostname and path parameters is returned from the create URL endpoint and should be used unmodified. The path and hostname given in the API specification here are examples only.

header Parameters
X-Amz-Checksum-Sha256
string

The base64 encoded SHA-256 hash of the file contents. Must match both the document being uploaded and the value provided to the create URL endpoint.

Content-Length
integer <int32>

The length of the file in bytes. Must match both the document being uploaded and the value provided to the create URL endpoint.

Request Body schema: application/octet-stream
string <binary>

Responses

Application information API

Application information API

Application information API - Get the information about an application

Authorizations:
basicAuth
path Parameters
application_request_id
required
string

The ID returned by Application Creation to track submission requests

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "hmlr_reference": "string",
  • "priority_timestamp": "2019-08-24T14:15:22Z",
  • "application_request_id": "string",
  • "status": "VALIDATING",
  • "calculated_fees": {
    },
  • "warnings": [
    ]
}

Notifications API

Receive notifications API

Receive notifications API - Get any unacknowledged notifications

Authorizations:
basicAuth
query Parameters
created_before
string <date-time>
created_after
string <date-time>
status
string
Enum: "NEW" "ACKNOWLEDGED"
occured_before
string <date-time>
occured_after
string <date-time>
notification_type
string
subject
string
additional_provider_filter
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    }
}

Acknowledge notifications API

Acknowledge notifications API - Acknowledge notifications that have been processed, so they are no longer returned when fetching

Authorizations:
basicAuth
Request Body schema: application/json
data
Array of strings

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}