---
agentTools:
  projectIndex: https://finch-app.readme.io/llms.txt
---

# Get title analysis

Gets a title analysis previously performed using [Create a title analysis](/reference/f0339f6a-f20b-4ba2-870d-6f75f7180a84).
            
## Permissions
The following permissions are required to call this API. [Learn more](/reference/jwt-bearer-api-key).
            
| Permission type | Permissions |
|---|---|
| API key action permission | Title |
| Folder access control list permission | Viewer |

# OpenAPI definition

```json
{
  "x-generator": "https://www.finch-app.com",
  "openapi": "3.0.0",
  "info": {
    "title": "Finch API v1",
    "version": "1.7"
  },
  "servers": [
    {
      "url": "https://secure.finch-app.com"
    },
    {
      "url": "https://secure.agreement.to"
    }
  ],
  "paths": {
    "/api/public/v1/title/{titleNumber}/analysis/{analysisId}": {
      "get": {
        "tags": [
          "Title analysis"
        ],
        "summary": "Get title analysis",
        "description": "Gets a title analysis previously performed using [Create a title analysis](/reference/f0339f6a-f20b-4ba2-870d-6f75f7180a84).\n            \n## Permissions\nThe following permissions are required to call this API. [Learn more](/reference/jwt-bearer-api-key).\n            \n| Permission type | Permissions |\n|---|---|\n| API key action permission | Title |\n| Folder access control list permission | Viewer |\n            ",
        "operationId": "{B73FF33B-701B-439F-A422-203A5B2242B2}",
        "parameters": [
          {
            "name": "titleNumber",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "maxLength": 9,
              "minLength": 1,
              "nullable": true
            },
            "x-position": 1
          },
          {
            "name": "analysisId",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "nullable": true
            },
            "x-position": 2
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TitleAnalysisResponse"
                }
              }
            }
          },
          "400": {
            "description": "HTTP 400 Bad Request - Badly formed request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "403": {
            "description": "HTTP 403 Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "HTTP 404 Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "422": {
            "description": "HTTP 422 Unprocessable Entity - Well formed request but unprocessable",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "HTTP 500 Internal Server Error - Unexpected server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "PublicApiPolicy": [
              "title"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "description": "Finch standard error response",
        "example": {
          "errors": []
        },
        "additionalProperties": false,
        "properties": {
          "errors": {
            "type": "array",
            "description": "A collection of errors preventing your request from being processed which may be supplied during error response codes.",
            "nullable": true,
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          }
        }
      },
      "Error": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "description": "A code which can be used to identify the kind of error which occured.",
            "oneOf": [
              {
                "$ref": "#/components/schemas/ErrorCode"
              }
            ]
          },
          "message": {
            "type": "string",
            "description": "A message describing the error by our server which could be presented to an end user or logged.",
            "minLength": 1
          },
          "jsonPath": {
            "type": "string",
            "description": "If this error relates to an element in the request, provides the JSON path to the problem property.",
            "nullable": true
          }
        }
      },
      "ErrorCode": {
        "type": "string",
        "description": "| Code | Description |\n|---|---|\n| UserMessage | An error was raised which should be presented to the user to help them resolve it. |\n| DuplicateRequestError | A request with the given ID has already been processed. |\n| ClientError | An error was caused by the client request. Check your request and try again. |\n| Error | We have encountered an unexpected error. This will be raised with our support team automatically. |",
        "x-enumNames": [
          "UserMessage",
          "DuplicateRequestError",
          "ClientError",
          "Error"
        ],
        "enum": [
          "UserMessage",
          "DuplicateRequestError",
          "ClientError",
          "Error"
        ]
      },
      "TitleAnalysisResponse": {
        "type": "object",
        "description": "Title analysis status and data",
        "example": {
          "status": "Success",
          "analysisId": "1eYgrUlFHJtpJwnqcBn5LL",
          "analysisUrl": "https://secure.agreement.to/api/public/v1/title/GR506405/analysis/1eYgrUlFHJtpJwnqcBn5LL",
          "analysis": {
            "version": "bt_title_analysis_v1",
            "outcome": "Green",
            "rules": {
              "classification": {
                "outcome": "Green",
                "ruleSatisfied": true,
                "comment": "The title is absolute."
              },
              "commonhold": {
                "outcome": "Green",
                "ruleSatisfied": true,
                "comment": "The title is not commonhold."
              },
              "proprietors": {
                "outcome": "Green",
                "ruleSatisfied": true,
                "comment": "No claimed proprietor names were provided to check against the title."
              }
            },
            "title": {
              "titleNumber": "GR506405",
              "officialCopyDate": "2012-02-06T10:07:49+00:00",
              "titleEditionDate": "2012-01-17T00:00:00+00:00",
              "landRegistryFeePaid": 7,
              "address": "2 William Prance Road",
              "tenure": "leasehold_absolute",
              "salePrice": {
                "date": "2011-12-19T00:00:00+00:00",
                "amount": 149000
              },
              "proprietors": [
                {
                  "name": "Robert Jones",
                  "type": "private_individual"
                },
                {
                  "name": "John Davies",
                  "type": "private_individual"
                }
              ],
              "lease": {
                "date": "2011-12-01T00:00:00+00:00",
                "start": "2011-12-01T00:00:00+00:00",
                "years": 99,
                "expires": "2110-12-01T00:00:00+00:00"
              }
            }
          },
          "officialCopyUrl": "https://secure.agreement.to/api/public/v1/title/GR506405/analysis/1eYgrUlFHJtpJwnqcBn5LL/download/official-copy",
          "titlePlanUrl": "https://secure.agreement.to/api/public/v1/title/GR506405/analysis/1eYgrUlFHJtpJwnqcBn5LL/download/title-plan"
        },
        "additionalProperties": false,
        "properties": {
          "status": {
            "description": "Provides the response code of the request. Check the response code descriptions",
            "oneOf": [
              {
                "$ref": "#/components/schemas/API_E_TitleAnalysisResponseCode"
              }
            ]
          },
          "analysisId": {
            "type": "string",
            "description": "If the analysis is available or queued, the unique ID of the analysis",
            "nullable": true
          },
          "analysisUrl": {
            "type": "string",
            "description": "Provides the URL to the title analysis",
            "nullable": true
          },
          "analysis": {
            "description": "If the analysis is available, contains the title analysis report",
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/TitleAnalysis"
              }
            ]
          },
          "officialCopyUrl": {
            "type": "string",
            "description": "If the official copy is available, contains the absolute URL to the official copy PDF. This URL requires authentication and shouldn't be provided directly to end users.",
            "nullable": true
          },
          "titlePlanUrl": {
            "type": "string",
            "description": "If the title plan is available, contains the absolute URL to the title plan PDF. This URL requires authentication and shouldn't be provided directly to end users.",
            "nullable": true
          }
        }
      },
      "API_E_TitleAnalysisResponseCode": {
        "type": "string",
        "description": "| Code | Description |\n|---|---|\n| success | The title analysis was performed and is available immediately |\n| queued | A copy of the title is required from HM Land Registry and their service is currently unavailable. The analysis will be performed when the title arrives. |\n| unavailable | A copy of the title is required from HM Land Registry, but no digital copy of that title currently exists |\n| titleNotHeld | A copy of the title is required from HM Land Registry and the request specifies to not make orders. The order was aborted. Specify OrderTitleIfNotHeld = true on your request to proceed with the order. |\n| pendingApplication | A copy of the title is required from HM Land Registry and the property has a pending application. The order was aborted. Specify OrderTitleWithPendingApplication = true on your request to ignore the pending application and proceed with the order. |",
        "x-enumNames": [
          "Success",
          "Queued",
          "Unavailable",
          "TitleNotHeld",
          "PendingApplication"
        ],
        "enum": [
          "Success",
          "Queued",
          "Unavailable",
          "TitleNotHeld",
          "PendingApplication"
        ]
      },
      "TitleAnalysis": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "version": {
            "description": "Provides the version of the analysis process used to analyse the title",
            "oneOf": [
              {
                "$ref": "#/components/schemas/AnalysisVersion"
              }
            ]
          },
          "outcome": {
            "description": "Indicates the overall outcome of this report",
            "oneOf": [
              {
                "$ref": "#/components/schemas/AnalysisReportSeverity"
              }
            ]
          },
          "rules": {
            "type": "object",
            "description": "Provides the list of rule checks performed during the title analysis, their outcome and commentary",
            "nullable": true,
            "additionalProperties": {
              "$ref": "#/components/schemas/RuleResult"
            }
          },
          "title": {
            "description": "Key digital data from the title, extracted and normalised from HM Land Registry data",
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/Title"
              }
            ]
          }
        }
      },
      "AnalysisVersion": {
        "type": "string",
        "description": "",
        "x-enumNames": [
          "bt_title_analysis_v1"
        ],
        "enum": [
          "bt_title_analysis_v1"
        ]
      },
      "AnalysisReportSeverity": {
        "type": "string",
        "description": "| Code | Description |\n|---|---|\n| green | This result should cause no further concerns |\n| amber | This result should be checked for concerns |\n| red | This result is known to cause problems with transactions in your business |",
        "x-enumNames": [
          "Green",
          "Amber",
          "Red"
        ],
        "enum": [
          "Green",
          "Amber",
          "Red"
        ]
      },
      "RuleResult": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "outcome": {
            "description": "Indicates the graded outcome of the analysis rule check",
            "oneOf": [
              {
                "$ref": "#/components/schemas/AnalysisReportSeverity"
              }
            ]
          },
          "ruleSatisfied": {
            "type": "boolean",
            "description": "Indicates if the rule check was satisfied. Use the \"Outcome\" property to determine the impact of any rule check failure."
          },
          "comment": {
            "type": "string",
            "description": "Further commentary around the outcome of the rule check suitable for presentation to a user.",
            "nullable": true
          }
        }
      },
      "Title": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "titleNumber": {
            "type": "string",
            "description": "The HM Land Registry title number",
            "nullable": true
          },
          "officialCopyDate": {
            "type": "string",
            "description": "The date this official copy was produced",
            "format": "date-time",
            "nullable": true
          },
          "titleEditionDate": {
            "type": "string",
            "description": "The edition date of of the title in the register",
            "format": "date-time",
            "nullable": true
          },
          "landRegistryFeePaid": {
            "type": "number",
            "description": "The HM land registry fee paid in GBP for the delivery of the official copy (and title plan if ordered), at the time of the official copy date",
            "format": "decimal",
            "nullable": true
          },
          "address": {
            "type": "string",
            "description": "The address of the property related to the title, presented on a single line with address lines comma seperated",
            "nullable": true
          },
          "tenure": {
            "description": "The tenure of the property",
            "oneOf": [
              {
                "$ref": "#/components/schemas/ClassOfTitle"
              }
            ]
          },
          "salePrice": {
            "description": "Price that was paid for the property",
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/PricePaid"
              }
            ]
          },
          "proprietors": {
            "type": "array",
            "description": "Proprietors on the title",
            "nullable": true,
            "items": {
              "$ref": "#/components/schemas/Proprietor"
            }
          },
          "lease": {
            "description": "Optional lease information",
            "nullable": true,
            "oneOf": [
              {
                "$ref": "#/components/schemas/Lease"
              }
            ]
          }
        }
      },
      "ClassOfTitle": {
        "type": "string",
        "description": "",
        "x-enumNames": [
          "unknown",
          "freehold_absolute",
          "freehold_possessory",
          "freehold_qualified",
          "freehold_scheme_title",
          "leasehold_scheme_title",
          "leasehold_absolute",
          "leasehold_good",
          "leasehold_qualified",
          "leasehold_possessory",
          "rentcharge_absolute",
          "rentcharge_possessory",
          "rentcharge_qualified",
          "rentcharge_caution_against_first_registration"
        ],
        "enum": [
          "unknown",
          "freehold_absolute",
          "freehold_possessory",
          "freehold_qualified",
          "freehold_scheme_title",
          "leasehold_scheme_title",
          "leasehold_absolute",
          "leasehold_good",
          "leasehold_qualified",
          "leasehold_possessory",
          "rentcharge_absolute",
          "rentcharge_possessory",
          "rentcharge_qualified",
          "rentcharge_caution_against_first_registration"
        ]
      },
      "PricePaid": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "date": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "format": "decimal"
          }
        }
      },
      "Proprietor": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "$ref": "#/components/schemas/ProprietorType"
          }
        }
      },
      "ProprietorType": {
        "type": "string",
        "description": "",
        "x-enumNames": [
          "private_individual",
          "organisation"
        ],
        "enum": [
          "private_individual",
          "organisation"
        ]
      },
      "Lease": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "date": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "term": {
            "type": "string",
            "nullable": true
          },
          "start": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "years": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "expires": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        }
      }
    },
    "securitySchemes": {
      "PublicApiPolicy": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  },
  "x-readme": {
    "proxy-enabled": false,
    "samples-languages": [
      "curl",
      "csharp",
      "node",
      "php",
      "java"
    ],
    "explorer-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 98,
      "1": 166,
      "2": 63,
      "3": 241,
      "4": 0,
      "5": 193,
      "6": 57,
      "7": 0,
      "8": 26,
      "9": 75,
      "10": 202,
      "11": 36
    }
  }
}
```