API docs by Redocly

Order Experience API (1.3.1)

Download OpenAPI specification:

An experience API to create and receive order results.

Versions

  • 1.3.1 (2026-04-15)
    • Added Identity Verification Check product.
  • 1.3.0 (2026-02-03)
    • Added Source of Funds Check product.
  • 1.2.4 (2025-07-14)
    • Added drivingLicenceNumber option for AML - Individual.
  • 1.2.3 (2024-06-14)
    • Added title property to the Scottish Title Check (Results).
  • 1.2.2 (2024-05-17)
    • Added useExactNameMatching option to Landmark Ownership Check.
  • 1.2.1 (2024-04-23)
    • Added additional check information to International AML with Facial Recognition product results pepsAndSanctions sections.
  • 1.2.0 (2024-04-05)
    • transactionAddress is no longer required for all products.
    • Added oldestAccount and dataSources to the addressAndMortality section for AML Products.
    • Added additional ID Document details to the results schema for AML with Facial Recognition products.
    • Updated dateOfBirth description to clarify that the date must not be within the last 16 years to Order AML Products.
    • Added personReference to the Clients array in the Ownership Check results.
  • 1.1.1 (2024-03-04)
    • Updated idVerification and supportingDocuments sections within AML results schema to address inconsistencies with the data returned by the service.
  • 1.1.0 (2024-02-16)
    • Added overallStatus to AML - Individual, AML UK with Facial Recognition and International AML with Facial Recognition product results.
    • Added additional check information to AML pepsAndSanctions and addressAndMortality sections.
    • Added filename and createdDate properties to documents on retrieved orders.
  • 1.0.0 (2024-01-29)
    • Added Persons with Significant Control Product for Company Information.
  • 0.9.2 (2024-01-02)
    • Added fullName property to AML - Individual, AML UK with Facial Recognition and International AML with Facial Recognition products' responses.
    • Added dateOfBirth property to person objects.
    • Added Cancelled value to orderStatus enum.
  • 0.9.1 (2023-11-17)
    • Removed enableOngoingMonitoring property from AML - Individual, AML UK with Facial Recognition and International AML with Facial Recognition products. This will now be enabled for all checks automatically.
    • Updated AML UK with Facial Recognition product to require either a telephoneNumber or mobileTelephoneNumber to be supplied for the person.
    • Updated AML UK with Facial Recognition product to no longer require email to be supplied for the person.
  • 0.9.0 (2023-11-09)
    • Added 'Add Override AML Result Section' endpoint.
    • Added companyName and companyRegistrationNumber to the additionalProprietors property in the Ownership Check Results.
  • 0.8.0 (2023-11-01)
    • First issued.

Order Experience API

Operations to create and receive order results.

Create Orders

Creates orders associated with a transaction for the given products.

Authorizations:
bearerAuth
Request Body schema: application/json
required
reference
required
string <= 100 characters

Your reference to identify the transaction.

accountId
required
string <uuid> (accountId) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your Landmark account ID - this will be provided to you during onboarding.

transactionId
string <uuid> (transactionId) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

The unique Landmark ID for the transaction. This ID can be used to associate multiple orders to a single transaction.

object

The property address for the transaction related to the products being ordered.

object

Callback uri that should receive status updates. Each product will receieve a status update.

Array of objects (lgsPersonWithRoles) <= 20 items

The details of the people involved in your transaction - some Products will require these for processing (e.g. AML searches).

You must set a unique reference for each of these people for use in ordering products.

required
Array of objects (product) [ 1 .. 20 ] items

An array of the products that you require. For each of these, an order will be created in the Landmark system and will begin processing. You must provide a reference GUID for each product which we will use in the response and callbacks, if you are using them, to help you identify the Order.

See the Product Request Schemas for details on how to order each one.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "reference": "string",
  • "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "transactionAddress": {
    },
  • "callback": {
    },
  • "persons": [
    ],
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "transactionId": "458f6a73-607b-4a06-bc23-b3553e7233ec",
  • "reference": "25GWT/JS/45.5",
  • "orders": [
    ]
}

Callback payload samples

Callback
POST: Order Status
Content type
application/json
{
  • "orderId": "4df4d4b1-9a07-4d25-9772-764d1fefe527",
  • "reference": "513ba615-1e78-4751-968b-2402a49e5594",
  • "status": "Completed",
  • "statusDescription": "AML order is Completed."
}

Get Order

Retrieves an order with the given orderId.

Authorizations:
bearerAuth
path Parameters
orderId
required
string <uuid> (orderId) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Unique Landmark ID for the order.

Responses

Response samples

Content type
application/json
{
  • "transactionId": "458f6a73-607b-4a06-bc23-b3553e7233ec",
  • "orderId": "4df4d4b1-9a07-4d25-9772-764d1fefe527",
  • "reference": "513ba615-1e78-4751-968b-2402a49e5594",
  • "status": "Completed",
  • "statusDescription": "AML order is Completed.",
  • "product": {
    },
  • "results": null,
  • "documents": [
    ]
}

Get Order Status

Retrieves the order status.

Authorizations:
bearerAuth
path Parameters
orderId
required
string <uuid> (orderId) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Unique Landmark ID for the order.

Responses

Response samples

Content type
application/json
{
  • "orderId": "4df4d4b1-9a07-4d25-9772-764d1fefe527",
  • "reference": "513ba615-1e78-4751-968b-2402a49e5594",
  • "status": "Completed",
  • "statusDescription": "AML order is Completed."
}

Download Document

Downloads a results document for an order.

Authorizations:
bearerAuth
path Parameters
orderId
required
string <uuid> (orderId) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Unique Landmark ID for the order.

documentId
required
string <uuid> (documentId) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Unique Landmark ID for the document.

Responses

Response samples

Content type
application/problem+json
{
  • "status": "401",
  • "code": "40100",
  • "title": "Invalid identity"
}

Override AML Result Section

Overrides a result section of an AML order from a 'Refer' to a 'Pass'.

Authorizations:
bearerAuth
path Parameters
orderId
required
string <uuid> (orderId) = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Unique Landmark ID for the order.

Request Body schema: application/json
section
required
string
Enum: "LivenessVerification" "IdVerification" "AddressAndMortality" "PepsAndSanctions"

The AML result section to override. The result section must be valid for the product associated to the order.

Valid result section names per AML product:

AML - Individual: "AddressAndMortality" or "PepsAndSanctions"

AML UK with Facial Recognition: "LivenessVerification", "IdVerification", "AddressAndMortality" or "PepsAndSanctions"

International AML with Facial Recognition: "LivenessVerification", "IdVerification" or "PepsAndSanctions"

status
required
string
Value: "Pass"

The new status for the AML result section.

comment
required
string [ 1 .. 300 ] characters ^(?=.*\S).+$

A comment to explain why the AML result section is being overridden.

actionedBy
required
string [ 2 .. 150 ] characters ^(?=.*[A-Za-zÀ-ÖØ-öø-ž])[0-9A-Za-zÀ-ÖØ-öø-ž\u...

The name or email address of the individual who is overriding the AML result section.

Responses

Request samples

Content type
application/json
{
  • "section": "AddressAndMortality",
  • "status": "Pass",
  • "comment": "Approving manually as customer has provided me with a utility bill, confirming their address.",
  • "actionedBy": "john.doe@company.co.uk"
}

Response samples

Content type
application/problem+json
{
  • "status": "str",
  • "code": "strin",
  • "title": "string",
  • "messages": [
    ]
}

Product Request Schemas

Request schemas and product options for each product.

AML UK with Facial Recognition (Request)

productId
required
string
Value: "43f8ce3b-1120-458d-b25b-51671c937bb0"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

{
  • "productId": "43f8ce3b-1120-458d-b25b-51671c937bb0",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
  • "productOptions": {
    }
}

AML - Individual (Request)

productId
required
string
Value: "7e3e5840-41c5-419c-9e85-6a47b443fa56"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

{
  • "productId": "7e3e5840-41c5-419c-9e85-6a47b443fa56",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6",
  • "productOptions": {
    }
}

International AML with Facial Recognition (Request)

productId
required
string
Value: "e78fa31d-fb19-4872-a5ac-8f0e0889939d"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

{
  • "productId": "e78fa31d-fb19-4872-a5ac-8f0e0889939d",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
  • "productOptions": {
    }
}

Persons with Significant Control (Request)

productId
required
string
Value: "9bbd8070-2683-4329-b2bf-e536b7875fc0"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

{
  • "productId": "9bbd8070-2683-4329-b2bf-e536b7875fc0",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6",
  • "productOptions": {
    }
}

Landmark Ownership Check (Request)

productId
required
string
Value: "1bf15e1f-d43a-45c0-b1a8-21e5dfbfdc02"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

A transactionAddress needs to be supplied in your request for use with this product.

{
  • "productId": "1bf15e1f-d43a-45c0-b1a8-21e5dfbfdc02",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6",
  • "productOptions": {
    }
}

OC1 Register (Request)

productId
required
string
Value: "0c03bdc5-167c-47d8-afb8-ffcb82d44242"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

{
  • "productId": "0c03bdc5-167c-47d8-afb8-ffcb82d44242",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6",
  • "productOptions": {
    }
}

OC1 Title Plan (Request)

productId
required
string
Value: "88bfb993-3bc0-45c7-8529-c5fc78d1dd68"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

{
  • "productId": "88bfb993-3bc0-45c7-8529-c5fc78d1dd68",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6",
  • "productOptions": {
    }
}

Owner Verification Check (Request)

productId
required
string
Value: "c61c761a-baff-4b5a-a437-7c1247019436"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

{
  • "productId": "c61c761a-baff-4b5a-a437-7c1247019436",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6",
  • "productOptions": {
    }
}

Scottish Title Check (Request)

productId
required
string
Value: "b8ed274f-7b4f-4339-b7fd-cabcafafd9a7"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

A transactionAddress needs to be supplied in your request for use with this product.

{
  • "productId": "b8ed274f-7b4f-4339-b7fd-cabcafafd9a7",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6",
  • "productOptions": {
    }
}

Source of Funds Check (Request)

productId
required
string
Value: "03700688-97d2-42af-94be-c84dd730806d"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

{
  • "productId": "03700688-97d2-42af-94be-c84dd730806d",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
  • "productOptions": {
    }
}

Identity Verification Check (Request)

productId
required
string
Value: "77f60734-0f02-4acf-8d56-d1b0733e82ad"

Unique Landmark ID for the product.

reference
required
string <uuid> = 36 characters ^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[4][0-9A-Fa-f]...

Your reference that uniquely identifies the product order.

required
object

An object to provide data and options specific to the product.

{
  • "productId": "77f60734-0f02-4acf-8d56-d1b0733e82ad",
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
  • "productOptions": {
    }
}

Product Results Schemas

Results schemas for each product.

AML UK with Facial Recognition (Results)

overallStatus
string (overallStatus)
Enum: "Pass" "Refer" "PassWarning" "PassOverridden"
fullName
string [ 1 .. 200 ] characters
object
object
object
object
Array of objects
rawResults
object

The full results data from our suppliers.

{
  • "overallStatus": "Refer",
  • "fullName": "John Doe",
  • "livenessVerification": {
    },
  • "idVerification": {
    },
  • "pepsAndSanctions": {
    },
  • "addressAndMortality": {
    },
  • "supportingDocuments": [
    ]
}

AML - Individual (Results)

overallStatus
string (overallStatus)
Enum: "Pass" "Refer" "PassWarning" "PassOverridden"
fullName
string [ 1 .. 200 ] characters
object
object
rawResults
object

The full results data from our suppliers.

{
  • "overallStatus": "Refer",
  • "fullName": "John Doe",
  • "pepsAndSanctions": {
    },
  • "addressAndMortality": {
    }
}

International AML with Facial Recognition (Results)

overallStatus
string (overallStatus)
Enum: "Pass" "Refer" "PassWarning" "PassOverridden"
fullName
string [ 1 .. 200 ] characters
object
object
object
Array of objects
rawResults
object

The full results data from our suppliers.

{
  • "overallStatus": "PassWarning",
  • "fullName": "John Doe",
  • "livenessVerification": {
    },
  • "idVerification": {
    },
  • "pepsAndSanctions": {
    },
  • "supportingDocuments": [
    ]
}

Persons with Significant Control (Results)

Array of objects [ 1 .. 100 ] items
{
  • "items": [
    ]
}

Landmark Ownership Check (Results)

titleNumber
string <= 10 characters
Array of objects [ 1 .. 10 ] items
Array of Person (object) or Company (object) [ 1 .. 10 ] items
OVC (object) or OC1 (object) or Scottish Title Check (object)

The full results data from our suppliers.

{
  • "clients": [
    ],
  • "additionalProprietors": [
    ],
  • "titleNumber": "ABC12345",
  • "rawResults": [
    ]
}

OC1 Register (Results)

object
object
object
rawResults
object

The full results data from our suppliers.

{
  • "propertyAddress": {
    },
  • "title": {
    },
  • "proprietorship": {
    }
}

OC1 Title Plan (Results)

any (OC1 Title Plan (Results))

Only a PDF is returned for this product. Results will be null.

null

Owner Verification Check (Results)

result
string
Enum: "Match" "NoMatch" "PartialMatch"
object
object
object
object
object
ownership
string
Enum: "Sole" "Joint"
rawResults
object

The full results data from our suppliers.

{
  • "result": "Match",
  • "subjectProperty": {
    },
  • "subjectName": {
    },
  • "firstNameMatch": {
    },
  • "middleNameMatch": {
    },
  • "lastNameMatch": {
    },
  • "ownership": "Sole"
}

Scottish Title Check (Results)

destination
string
titleNo
string <= 10 characters
Array of objects [ 1 .. 10 ] items
rawResults
object

The full results data from our suppliers.

{
  • "destination": "None",
  • "titleNo": "MID12345",
  • "proprietors": [
    ]
}

Source of Funds Check (Results)

any (Source of Funds Check (Results))

Only a PDF is returned for this product. Results will be null.

null

Identity Verification Check (Results)

overallStatus
string (overallStatus)
Enum: "Pass" "Refer" "PassWarning" "PassOverridden"
object
object
Array of objects
rawResults
object

The full results data from our suppliers.

{
  • "overallStatus": "Pass",
  • "livenessVerification": {
    },
  • "idVerification": {
    },
  • "supportingDocuments": [
    ]
}