{ "components": { "schemas": {}, "securitySchemes": { "bearerAuth": { "bearerFormat": "Bearer token", "description": "Send a valid bearer token in the `Authorization` header.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "A REST HTTP API to search and purchase property documents", "title": "Fynd API", "version": "0.0.1" }, "openapi": "3.1.0", "paths": { "/api/v0/addresses": { "get": { "description": "Address autocomplete search across Australia using a partial address term (e.g., street number, street name, suburb). This endpoint is optimized for address lookup and does not perform lot/plan query matching. Provide a 'term' query parameter with at least 2 characters. Returns matching addresses with an 'id'. Use that 'id' as the 'addressId' query parameter in GET /api/v0/titles to retrieve associated titles.", "operationId": "searchAddresses", "parameters": [ { "example": "678 macquarie", "examples": { "14 Flemming Avenue, Burnside": { "value": "14 Flemming Avenue, Burnside" }, "678 macquarie": { "value": "678 macquarie" } }, "in": "query", "name": "term", "required": true, "schema": { "minLength": 2, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "nswTitleSearchFlow": { "summary": "NSW address lookup used in the title-search flow", "value": { "data": [ { "address": "678 MACQUARIE DRIVE, ELEEBANA, NSW, 2282", "id": "W2duYWZfdjFdR0FOU1c3MDQ2Nzc0MzU=" }, { "address": "678 KINGSWAY, MIRANDA, NSW, 2228", "id": "W2duYWZfdjFdR0FOU1c3MTc3NDYwNzc=" } ], "success": true } }, "vicTitleSearchFlow": { "summary": "VIC address lookup used in the title-search flow", "value": { "data": [ { "address": "14 FLEMMING AVENUE, BURNSIDE, VIC, 3023", "id": "W2duYWZfdjFdR0FWSUM0MTk3NDM2NTk=" } ], "success": true } } }, "schema": { "additionalProperties": false, "description": "Address autocomplete for addresses in Australia. \n\nSend the returned \"id\" to the GET /api/v0/titles?addressId={id} endpoint to find associated titles for that address.", "properties": { "data": { "items": { "additionalProperties": false, "properties": { "address": { "type": "string" }, "id": { "type": "string" } }, "required": [ "address", "id" ], "type": "object" }, "type": "array" }, "success": { "enum": [ true ], "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" } } }, "description": "Address autocomplete for addresses in Australia. \n\nSend the returned \"id\" to the GET /api/v0/titles?addressId={id} endpoint to find associated titles for that address." }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search addresses", "tags": [ "Addresses" ] } }, "/api/v0/identity": { "get": { "description": "Return the API client id associated with the authenticated credentials. Returns null when no client id is available.", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "apiClientId": { "anyOf": [ { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "type": "string" }, { "type": "null" } ] } }, "required": [ "apiClientId" ], "type": "object" }, "success": { "enum": [ true ], "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" } } }, "description": "Default Response" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "tags": [ "Identity" ] } }, "/api/v0/orders": { "get": { "description": "Return a paginated list of orders for the authenticated organisation. Supports optional filtering by `clientReference`, `status`, and date range.", "operationId": "getOrders", "parameters": [ { "description": "Zero-based page number (default: 0)", "example": 0, "in": "query", "name": "pageIndex", "required": false, "schema": { "default": 0, "minimum": 0, "type": "number" } }, { "description": "Number of orders per page, max 100 (default: 10)", "example": 10, "in": "query", "name": "pageSize", "required": false, "schema": { "default": 10, "maximum": 100, "minimum": 1, "type": "number" } }, { "description": "Filter by exact client-defined reference", "example": "acme-vic-title-569", "in": "query", "name": "clientReference", "required": false, "schema": { "minLength": 1, "type": "string" } }, { "description": "Filter by order status", "example": "COMPLETE", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "processing", "complete", "cancelled", "failed" ], "type": "string" } }, { "description": "Filter orders with orderDate >= dateFrom (ISO 8601)", "example": "2026-07-01T00:00:00.000Z", "in": "query", "name": "dateFrom", "required": false, "schema": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "type": "string" } }, { "description": "Filter orders with orderDate <= dateTo (ISO 8601)", "example": "2026-07-31T23:59:59.000Z", "in": "query", "name": "dateTo", "required": false, "schema": { "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "type": "string" } }, { "description": "Whether to include resource details in the response", "example": "true", "in": "query", "name": "includeResources", "required": false, "schema": { "enum": [ "true" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "summary": "Mixed order statuses with resources", "value": { "data": [ { "clientReference": "my-ref-001", "createdAt": "2026-07-16T07:00:00.000Z", "fulfilledAt": "2026-07-16T07:20:00.000Z", "id": "707e776b-0ee7-4ff7-b90d-8c84070bf12e", "resource": { "downloadUrl": "https://storage.example.com/documents/ORD-260300043/VIC%20Title%20Search.pdf?sv=...", "downloadUrlExpiresAt": "2026-07-16T08:20:00.000Z", "editionDate": "16/07/2026", "expiresAt": "2026-07-23T07:20:00.000Z", "fileName": "JoshCorp_14 FLEMMING AVENUE BURNSIDE 3023_VIC Title Search.pdf", "ownerDetails": "REGISTERED PROPRIETOR JOHN SMITH", "owners": [ "JOHN SMITH" ], "status": "complete", "titleReference": "LP123456" }, "status": "complete", "totalGst": 2, "totalPrice": 22 }, { "clientReference": "my-ref-002", "createdAt": "2026-07-16T08:00:00.000Z", "fulfilledAt": null, "id": "a1b2c3d4-0000-4000-8000-111111111111", "resource": { "message": "Order is still being processed", "status": "processing" }, "status": "processing", "totalGst": 2, "totalPrice": 22 }, { "clientReference": "my-ref-003", "createdAt": "2026-07-16T08:30:00.000Z", "fulfilledAt": null, "id": "b2c3d4e5-0000-4000-8000-222222222222", "resource": { "editionDate": "16/07/2026", "expiresAt": null, "message": "Order data received, document is being generated", "ownerDetails": "REGISTERED PROPRIETOR JANE DOE", "owners": [ "JANE DOE" ], "status": "partial", "titleReference": "LP789012" }, "status": "processing", "totalGst": 2, "totalPrice": 22 }, { "clientReference": "my-ref-004", "createdAt": "2026-06-01T07:00:00.000Z", "fulfilledAt": "2026-06-01T07:15:00.000Z", "id": "c3d4e5f6-0000-4000-8000-333333333333", "resource": { "expiresAt": "2026-06-08T07:15:00.000Z", "message": "This resource has expired", "status": "expired" }, "status": "complete", "totalGst": 2, "totalPrice": 22 }, { "clientReference": "my-ref-005", "createdAt": "2026-07-14T09:00:00.000Z", "fulfilledAt": null, "id": "d4e5f6a7-0000-4000-8000-444444444444", "resource": { "message": "Order has been cancelled", "status": "cancelled" }, "status": "cancelled", "totalGst": 2, "totalPrice": 22 }, { "clientReference": "my-ref-006", "createdAt": "2026-07-15T10:00:00.000Z", "fulfilledAt": null, "id": "e5f6a7b8-0000-4000-8000-555555555555", "resource": { "message": "Order could not be fulfilled. Our support team has been notified", "status": "failed" }, "status": "failed", "totalGst": 2, "totalPrice": 22 } ], "pageIndex": 0, "pageSize": 10, "success": true, "total": 6 } }, "examples": { "paginatedOrders": { "summary": "Paginated order list without resource details", "value": { "data": [ { "clientReference": "acme-vic-title-569", "createdAt": "2026-07-16T07:00:00.000Z", "fulfilledAt": "2026-07-16T07:20:00.000Z", "id": "707e776b-0ee7-4ff7-b90d-8c84070bf12e", "status": "complete" }, { "clientReference": "acme-nsw-title-150", "createdAt": "2026-07-16T08:00:00.000Z", "fulfilledAt": null, "id": "a1b2c3d4-0000-4000-8000-111111111111", "status": "processing" } ], "pageIndex": 0, "pageSize": 10, "success": true, "total": 2 } }, "paginatedOrdersWithResources": { "summary": "Paginated order list with resource details when includeResources=true", "value": { "data": [ { "clientReference": "acme-vic-title-569", "createdAt": "2026-07-16T07:00:00.000Z", "fulfilledAt": "2026-07-16T07:20:00.000Z", "id": "707e776b-0ee7-4ff7-b90d-8c84070bf12e", "resource": { "downloadUrl": "http://127.0.0.1:10000/devstoreaccount1/documents/ORD-260300043/VIC%20Title%20Search%20-%2014%20FLEMMING%20AVENUE%20BURNSIDE%203023.pdf?...", "downloadUrlExpiresAt": "2026-07-16T08:20:00.000Z", "editionDate": "16/07/2026", "expiresAt": "2026-07-23T07:20:00.000Z", "fileName": "JoshCorp_14 FLEMMING AVENUE BURNSIDE 3023_VIC Title Search.pdf", "ownerDetails": "REGISTERED PROPRIETOR JOHN SMITH", "owners": [ "JOHN SMITH" ], "status": "complete", "titleReference": "LP123456" }, "status": "complete" }, { "clientReference": "acme-nsw-title-151", "createdAt": "2026-07-16T08:30:00.000Z", "fulfilledAt": null, "id": "b2c3d4e5-0000-4000-8000-222222222222", "resource": { "editionDate": "16/07/2026", "expiresAt": null, "message": "Order data received, document is being generated", "ownerDetails": "REGISTERED PROPRIETOR JANE DOE", "owners": [ "JANE DOE" ], "status": "partial", "titleReference": "LP789012" }, "status": "processing" } ], "pageIndex": 0, "pageSize": 10, "success": true, "total": 2 } } }, "schema": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "clientReference": { "description": "Client-defined identifier for the order, if supplied at creation time.", "type": "string" }, "createdAt": { "type": "string" }, "fulfilledAt": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the order.", "type": "string" }, "resource": { "oneOf": [ { "additionalProperties": false, "properties": { "message": { "description": "Indicates the document is not yet ready for download.", "enum": [ "Order is still being processed" ], "type": "string" }, "status": { "enum": [ "processing" ], "type": "string" } }, "required": [ "status", "message" ], "title": "Processing", "type": "object" }, { "additionalProperties": false, "properties": { "editionDate": { "description": "Edition date of the title document in dd/mm/yyyy format, when available.", "type": "string" }, "expiresAt": { "description": "The date and time when the order data is no longer available.", "type": [ "string", "null" ] }, "message": { "description": "Data has been received but the document is not yet ready for download.", "enum": [ "Order data received, document is being generated" ], "type": "string" }, "ownerDetails": { "description": "Registered proprietorship text returned by the authority or derived from it.", "type": [ "string", "null" ] }, "owners": { "description": "Owner or legal-entity names parsed from the registered proprietorship details.", "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "partial" ], "type": "string" }, "titleReference": { "description": "Title reference / volume/folio for the searched title, when available.", "type": [ "string", "null" ] } }, "required": [ "status", "expiresAt", "message" ], "title": "Partially Complete", "type": "object" }, { "additionalProperties": false, "properties": { "downloadUrl": { "description": "Signed URL for downloading the document.", "type": "string" }, "downloadUrlExpiresAt": { "description": "The date and time when this download URL expires. Refresh by recalling this endpoint while data is still available.", "type": "string" }, "editionDate": { "description": "Edition date of the title document in dd/mm/yyyy format, when available.", "type": "string" }, "expiresAt": { "description": "The date and time when the order data is no longer available.", "type": [ "string", "null" ] }, "fileName": { "description": "Suggested file name for the downloaded document.", "type": "string" }, "ownerDetails": { "description": "Registered proprietorship text returned by the authority or derived from it.", "type": [ "string", "null" ] }, "owners": { "description": "Owner or legal-entity names parsed from the registered proprietorship details.", "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "complete" ], "type": "string" }, "titleReference": { "description": "Title reference / volume/folio for the searched title, when available.", "type": [ "string", "null" ] } }, "required": [ "status", "expiresAt", "downloadUrl", "downloadUrlExpiresAt", "fileName" ], "title": "Complete", "type": "object" }, { "additionalProperties": false, "properties": { "expiresAt": { "description": "The date and time when the order data is no longer available.", "type": [ "string", "null" ] }, "message": { "enum": [ "This resource has expired" ], "type": "string" }, "status": { "enum": [ "expired" ], "type": "string" } }, "required": [ "status", "expiresAt", "message" ], "title": "Expired", "type": "object" }, { "additionalProperties": false, "properties": { "message": { "anyOf": [ { "enum": [ "Order has been cancelled" ], "title": "Cancelled", "type": "string" }, { "enum": [ "Order has been cancelled and refunded" ], "title": "Refunded", "type": "string" } ] }, "status": { "enum": [ "cancelled" ], "type": "string" } }, "required": [ "status", "message" ], "title": "Cancelled", "type": "object" }, { "additionalProperties": false, "properties": { "message": { "enum": [ "Order could not be fulfilled. Our support team has been notified" ], "type": "string" }, "status": { "enum": [ "failed" ], "type": "string" } }, "required": [ "status", "message" ], "title": "Failed", "type": "object" } ], "title": "Resource" }, "status": { "description": "Current order status: `processing` — in progress; `complete` — fulfilled; `cancelled` — deliberately cancelled or refunded; `failed` — could not be fulfilled.", "enum": [ "processing", "complete", "cancelled", "failed" ], "type": "string" }, "totalGst": { "description": "GST component of totalPrice (AUD). Null if the order has no items.", "type": [ "number", "null" ] }, "totalPrice": { "description": "Total order price including GST (AUD). Null if the order has no items.", "type": [ "number", "null" ] } }, "required": [ "id", "status", "createdAt", "fulfilledAt", "totalPrice", "totalGst" ], "type": "object" }, "type": "array" }, "pageIndex": { "type": "number" }, "pageSize": { "type": "number" }, "success": { "enum": [ true ], "type": "boolean" }, "total": { "type": "number" } }, "required": [ "success", "data", "total", "pageIndex", "pageSize" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "List orders", "tags": [ "Orders" ] }, "post": { "description": "Create an order for a property document. If the order completes within the specified timeout, the response will include the order data. Otherwise, the response will indicate that the order is being processed asynchronously. You can then wait for a webhook notification (if configured) or poll the order status using `GET /api/v0/orders/:orderId`.", "operationId": "createOrder", "parameters": [ { "description": "Optional key used to safely retry order creation without creating duplicates. Reuse the same value for retries of the same request. UUIDs are recommended but not required.", "example": "d6e7fda1-8d37-45a9-82c6-5f6aa8597d88", "in": "header", "name": "idempotency-key", "required": false, "schema": { "default": "d6e7fda1-8d37-45a9-82c6-5f6aa8597d88", "maxLength": 512, "minLength": 1, "type": "string" } }, { "description": "Optional maximum milliseconds to wait for order data synchronously. If data is ready before the timeout concludes, measured from request processing start, a 200 response with data is returned instead. Otherwise a 202 response is returned, and the client can poll for completion or wait for a webhook notification if configured.", "example": 5000, "in": "header", "name": "x-order-timeout-ms", "required": false, "schema": { "default": 5000, "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, { "in": "header", "name": "Content-Type", "required": true, "schema": { "default": "application/json", "enum": [ "application/json" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "createOrderVicRequest": { "summary": "Create a title order (VIC)", "value": { "clientReference": "acme-vic-title-569", "product": "title", "titleId": "W3ZpY19zZXJ2XVUwanRsQ2d0dFZuY2hMRHIzTFBjcFVreTZtMEV5UTFkdWc9PQ==" } }, "createOrderWaDigitalTitleRequest": { "summary": "Create a title order (WA)", "value": { "clientReference": "acme-wa-title-lr3001-10a", "product": "title", "titleId": "W3dhX2xhbmRnYXRlXUxSMDMwMDEwMDAxMEE=" } } }, "schema": { "oneOf": [ { "properties": { "clientReference": { "description": "Optional client-defined identifier for this order. Must be unique per organisation. Use it when you want a client-owned reference that helps reduce accidental duplicate orders and lets you later find the order via `GET /api/v0/orders` without persisting Fynd's generated `orderId`.", "maxLength": 255, "minLength": 1, "type": "string" }, "product": { "enum": [ "title" ], "type": "string" }, "titleId": { "description": "Obtained from `GET /api/v0/titles`.", "type": "string" } }, "required": [ "product", "titleId" ], "type": "object" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "completedNswOrder": { "summary": "NSW title order completed within the requested timeout", "value": { "data": { "clientReference": "acme-nsw-title-149", "editionDate": "9/2/1999", "orderId": "1ca060c8-0cc9-4d7e-8a95-4bf2934bc660", "ownerDetails": "PADXLAPS SIDJ, PEILI CHEQYZG SIZC AS TENANTS IN COMMON IN EQUAL SHARES", "owners": [ "PADXLAPS SIDJ", "PEILI CHEQYZG SIZC" ] }, "success": true } } }, "schema": { "additionalProperties": false, "description": "Order completed synchronously within the timeout requested by the `x-order-timeout-ms` header. Contains the extracted title data.", "properties": { "data": { "additionalProperties": false, "properties": { "clientReference": { "description": "Client-defined identifier for the order, if supplied at creation time.", "type": "string" }, "orderId": { "description": "Unique identifier for the created order.", "type": "string" }, "resource": { "anyOf": [ { "additionalProperties": false, "description": "The ordered resource data, e.g. extracted title data for title orders.", "properties": { "editionDate": { "description": "Edition date of the title document in dd/mm/yyyy format, when available.", "type": "string" }, "ownerDetails": { "description": "Registered proprietorship text returned by the authority or derived from it.", "type": [ "string", "null" ] }, "owners": { "description": "Owner or legal-entity names parsed from the registered proprietorship details.", "items": { "type": "string" }, "type": "array" }, "titleReference": { "description": "Title reference / volume/folio for the searched title, when available.", "type": [ "string", "null" ] } }, "required": [ "owners" ], "type": "object" }, { "additionalProperties": false, "description": "The order could not be fulfilled.", "properties": { "message": { "enum": [ "Order could not be fulfilled. Our support team has been notified" ], "type": "string" }, "status": { "enum": [ "failed" ], "type": "string" } }, "required": [ "status", "message" ], "title": "Failed", "type": "object" } ], "description": "The ordered resource data, or a terminal failure payload." }, "totalGst": { "description": "GST component of totalPrice (AUD).", "type": "number" }, "totalPrice": { "description": "Total order price including GST (AUD).", "type": "number" } }, "required": [ "orderId", "totalPrice", "totalGst", "resource" ], "type": "object" }, "success": { "enum": [ true ], "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" } } }, "description": "Order completed synchronously within the timeout requested by the `x-order-timeout-ms` header. Contains the extracted title data." }, "202": { "content": { "application/json": { "examples": { "processingVicOrder": { "summary": "VIC title order accepted for asynchronous processing", "value": { "data": { "clientReference": "acme-vic-title-569", "orderId": "707e776b-0ee7-4ff7-b90d-8c84070bf12e" }, "message": "Order is being processed asynchronously. Wait for webhook notification (if configured), or poll GET /api/v0/orders/:orderId for completion.", "success": true } } }, "schema": { "additionalProperties": false, "description": "Order accepted but not yet complete. Poll `GET /api/v0/orders/:orderId` for completion.", "properties": { "data": { "additionalProperties": false, "properties": { "clientReference": { "description": "Client-defined identifier for the order, if supplied at creation time.", "type": "string" }, "orderId": { "description": "Unique identifier for the created order.", "type": "string" }, "totalGst": { "description": "GST component of totalPrice (AUD).", "type": "number" }, "totalPrice": { "description": "Total order price including GST (AUD).", "type": "number" } }, "required": [ "orderId", "totalPrice", "totalGst" ], "type": "object" }, "message": { "description": "Informational message, e.g. that the order is being processed.", "enum": [ "Order is being processed asynchronously. Wait for webhook notification (if configured), or poll GET /api/v0/orders/:orderId for completion." ], "type": "string" }, "success": { "enum": [ true ], "type": "boolean" } }, "required": [ "success", "data", "message" ], "type": "object" } } }, "description": "Order accepted but not yet complete. Poll `GET /api/v0/orders/:orderId` for completion." }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Order a property document", "tags": [ "Orders" ] } }, "/api/v0/orders/{orderId}": { "get": { "description": "Get order information including the __download link__ once the order is complete.", "operationId": "getOrderDownload", "parameters": [ { "example": "707e776b-0ee7-4ff7-b90d-8c84070bf12e", "in": "path", "name": "orderId", "required": true, "schema": { "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "completedVicTitleSearch": { "summary": "Completed order with a downloadable resource", "value": { "data": { "clientReference": "acme-vic-title-569", "createdAt": "2026-07-16T07:00:00.000Z", "fulfilledAt": "2026-07-16T07:20:00.000Z", "id": "707e776b-0ee7-4ff7-b90d-8c84070bf12e", "resource": { "downloadUrl": "http://127.0.0.1:10000/devstoreaccount1/documents/ORD-260300043/VIC%20Title%20Search%20-%2014%20FLEMMING%20AVENUE%20BURNSIDE%203023.pdf?...", "downloadUrlExpiresAt": "2026-07-16T08:20:00.000Z", "editionDate": "16/07/2026", "expiresAt": "2026-07-23T07:20:00.000Z", "fileName": "JoshCorp_14 FLEMMING AVENUE BURNSIDE 3023_VIC Title Search.pdf", "ownerDetails": "REGISTERED PROPRIETOR JOHN SMITH", "owners": [ "JOHN SMITH" ], "status": "complete", "titleReference": "LP123456" }, "status": "complete" }, "success": true } }, "processingTitleSearch": { "summary": "Processing order with no downloadable resource yet", "value": { "data": { "clientReference": "acme-nsw-title-150", "createdAt": "2026-07-16T08:00:00.000Z", "fulfilledAt": null, "id": "a1b2c3d4-0000-4000-8000-111111111111", "resource": { "message": "Order is still being processed", "status": "processing" }, "status": "processing" }, "success": true } } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "clientReference": { "description": "Client-defined identifier for the order, if supplied at creation time.", "type": "string" }, "createdAt": { "type": "string" }, "fulfilledAt": { "type": [ "string", "null" ] }, "id": { "description": "Unique identifier for the order.", "type": "string" }, "resource": { "oneOf": [ { "additionalProperties": false, "properties": { "message": { "description": "Indicates the document is not yet ready for download.", "enum": [ "Order is still being processed" ], "type": "string" }, "status": { "enum": [ "processing" ], "type": "string" } }, "required": [ "status", "message" ], "title": "Processing", "type": "object" }, { "additionalProperties": false, "properties": { "editionDate": { "description": "Edition date of the title document in dd/mm/yyyy format, when available.", "type": "string" }, "expiresAt": { "description": "The date and time when the order data is no longer available.", "type": [ "string", "null" ] }, "message": { "description": "Data has been received but the document is not yet ready for download.", "enum": [ "Order data received, document is being generated" ], "type": "string" }, "ownerDetails": { "description": "Registered proprietorship text returned by the authority or derived from it.", "type": [ "string", "null" ] }, "owners": { "description": "Owner or legal-entity names parsed from the registered proprietorship details.", "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "partial" ], "type": "string" }, "titleReference": { "description": "Title reference / volume/folio for the searched title, when available.", "type": [ "string", "null" ] } }, "required": [ "status", "expiresAt", "message" ], "title": "Partially Complete", "type": "object" }, { "additionalProperties": false, "properties": { "downloadUrl": { "description": "Signed URL for downloading the document.", "type": "string" }, "downloadUrlExpiresAt": { "description": "The date and time when this download URL expires. Refresh by recalling this endpoint while data is still available.", "type": "string" }, "editionDate": { "description": "Edition date of the title document in dd/mm/yyyy format, when available.", "type": "string" }, "expiresAt": { "description": "The date and time when the order data is no longer available.", "type": [ "string", "null" ] }, "fileName": { "description": "Suggested file name for the downloaded document.", "type": "string" }, "ownerDetails": { "description": "Registered proprietorship text returned by the authority or derived from it.", "type": [ "string", "null" ] }, "owners": { "description": "Owner or legal-entity names parsed from the registered proprietorship details.", "items": { "type": "string" }, "type": "array" }, "status": { "enum": [ "complete" ], "type": "string" }, "titleReference": { "description": "Title reference / volume/folio for the searched title, when available.", "type": [ "string", "null" ] } }, "required": [ "status", "expiresAt", "downloadUrl", "downloadUrlExpiresAt", "fileName" ], "title": "Complete", "type": "object" }, { "additionalProperties": false, "properties": { "expiresAt": { "description": "The date and time when the order data is no longer available.", "type": [ "string", "null" ] }, "message": { "enum": [ "This resource has expired" ], "type": "string" }, "status": { "enum": [ "expired" ], "type": "string" } }, "required": [ "status", "expiresAt", "message" ], "title": "Expired", "type": "object" }, { "additionalProperties": false, "properties": { "message": { "anyOf": [ { "enum": [ "Order has been cancelled" ], "title": "Cancelled", "type": "string" }, { "enum": [ "Order has been cancelled and refunded" ], "title": "Refunded", "type": "string" } ] }, "status": { "enum": [ "cancelled" ], "type": "string" } }, "required": [ "status", "message" ], "title": "Cancelled", "type": "object" }, { "additionalProperties": false, "properties": { "message": { "enum": [ "Order could not be fulfilled. Our support team has been notified" ], "type": "string" }, "status": { "enum": [ "failed" ], "type": "string" } }, "required": [ "status", "message" ], "title": "Failed", "type": "object" } ], "title": "Resource" }, "status": { "description": "Current order status: `processing` — in progress; `complete` — fulfilled; `cancelled` — deliberately cancelled or refunded; `failed` — could not be fulfilled.", "enum": [ "processing", "complete", "cancelled", "failed" ], "type": "string" }, "totalGst": { "description": "GST component of totalPrice (AUD). Null if the order has no items.", "type": [ "number", "null" ] }, "totalPrice": { "description": "Total order price including GST (AUD). Null if the order has no items.", "type": [ "number", "null" ] } }, "required": [ "id", "status", "createdAt", "fulfilledAt", "totalPrice", "totalGst", "resource" ], "type": "object" }, "success": { "enum": [ true ], "type": "boolean" } }, "required": [ "success", "data" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "410": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Get order details", "tags": [ "Orders" ] } }, "/api/v0/titles": { "get": { "description": "Search for orderable titles

Query modes are mutually exclusive:

ModeParametersDescription
Address IDaddressIdResolve titles for an address id returned by GET /api/v0/addresses.
G-NAF IDgnafAddressIdLookup by encoded G-NAF address identifier, e.g. GAQLD163156816.
Parcelparcel[state], parcel[lot], parcel[division], parcel[block], parcel[section], parcel[plan], parcel[location], parcel[part], parcel[unit]Parcel lookup is mutually exclusive with all other title-search modes. Use the fields and formats listed for the selected state:
  • ACT Required: parcel[state]=ACT, parcel[division], parcel[section], parcel[block]. Optional: parcel[unit].
  • NSW Required: parcel[state]=NSW, parcel[lot], parcel[plan]. Optional: parcel[section]. Values supply parcel metadata directly as lot/section/plan. Examples: 149/221864 maps to lot 149, no section, and plan 221864; 12/55/700123 maps to lot 12, section 55, and plan 700123.
  • NT Required: parcel[state]=NT, parcel[location], parcel[lot]. Optional: parcel[plan] (LTO plan), parcel[part], parcel[unit].
  • QLD Required: parcel[state]=QLD, parcel[lot], parcel[plan]. parcel[plan] is the combined plan type & number, such as RP12345 or DW803415.
  • SA Required: parcel[state]=SA, parcel[lot], parcel[plan]. Both fields use TYPE/NUMBER: for example, lot A/14 and plan D/10001 represent the parcel D/10001/A/14.
  • TAS Required: parcel[state]=TAS, parcel[lot], parcel[plan]. Sections are not accepted; for title 150228/1, use plan 150228 and lot 1.
  • VIC Required: parcel[state]=VIC, parcel[lot], parcel[plan]. Optional: parcel[section]. Values are the components of a VIC SPI: 569\\PS434021 maps to lot 569, no section, and plan PS434021; 12-A\\PS434021 maps to lot 12, section A, and plan PS434021.
  • WA Required: parcel[state]=WA, parcel[lot], parcel[plan]. SP3244/1 maps to plan SP3244 and lot 1.
Titletitle[state], title[id]Direct title lookup is mutually exclusive with all other title-search modes. Supply both fields using the format listed for the selected state:
  • ACT Use VOLUME/FOLIO; the edition is returned with the result and is not part of the input.
  • NSW Accepted title reference formats:
    • Lot/plan or lot/section/plan, including alphanumeric components: 149/221864, 149/DP221864, 12/55/700123, 1A/C/96
    • Strata and lease folios: CP/SP5500, 1/SP5500, 15/SP22978A, 1/LF105
    • Auto consolidation or volume/folio: AC2106-67A, 1000-99
    • Water Access Licence: WAL14880
  • NT Use REGISTER_BOOK/VOLUME/FOLIO, for example CUFT/886/405.
  • QLD Use an eight-digit Queensland title reference, for example 15023001.
  • SA Use a LSSA resource name or a register format such as CT 7001/231 or CT:7001/231.
  • TAS Use VOLUME/FOLIO, for example 150228/1.
  • VIC Use VOLUME/FOLIO, for example 9674/149.
  • WA Use a Landgate title reference such as 2535/174, 191/197A, or LR3001/10.

See Titles Reference.

", "operationId": "searchTitles", "parameters": [ { "description": "Address ID returned by GET /api/v0/addresses.", "example": "W2duYWZfdjFdR0FOU1c3MDQ2Nzc0MzU=", "in": "query", "name": "addressId", "required": false, "schema": { "example": "W2duYWZfdjFdR0FOU1c3MDQ2Nzc0MzU=", "minLength": 1, "type": "string" } }, { "description": "G-NAF address ID.", "example": "GANSW704677435", "in": "query", "name": "gnafAddressId", "required": false, "schema": { "example": "GANSW704677435", "minLength": 1, "type": "string" } }, { "description": "Parcel state.", "example": "QLD", "in": "query", "name": "parcel[state]", "required": false, "schema": { "enum": [ "ACT", "NT", "NSW", "QLD", "VIC", "SA", "TAS", "WA" ], "type": "string" } }, { "description": "Parcel lot.", "example": "7", "in": "query", "name": "parcel[lot]", "required": false, "schema": { "minLength": 1, "type": "string" } }, { "description": "Parcel division. ACT only", "in": "query", "name": "parcel[division]", "required": false, "schema": { "maxLength": 4, "minLength": 1, "type": "string" } }, { "description": "Parcel block. ACT only", "in": "query", "name": "parcel[block]", "required": false, "schema": { "minLength": 1, "type": "string" } }, { "description": "Parcel section.", "in": "query", "name": "parcel[section]", "required": false, "schema": { "type": "string" } }, { "description": "Parcel plan.", "example": "RP1441", "in": "query", "name": "parcel[plan]", "required": false, "schema": { "minLength": 1, "type": "string" } }, { "description": "Parcel location. NT only", "in": "query", "name": "parcel[location]", "required": false, "schema": { "minLength": 1, "type": "string" } }, { "description": "Parcel part. NT only", "in": "query", "name": "parcel[part]", "required": false, "schema": { "minLength": 1, "type": "string" } }, { "description": "Parcel unit. ACT or NT", "in": "query", "name": "parcel[unit]", "required": false, "schema": { "minLength": 1, "type": "string" } }, { "description": "Direct title lookup state.", "example": "VIC", "in": "query", "name": "title[state]", "required": false, "schema": { "enum": [ "ACT", "NT", "NSW", "QLD", "VIC", "SA", "TAS", "WA" ], "type": "string" } }, { "description": "Direct title identifier. Format is state dependant", "example": "9674/149", "in": "query", "name": "title[id]", "required": false, "schema": { "example": "9674/149", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "nswGnafAddressLookup": { "summary": "NSW G-NAF address lookup", "value": { "data": { "titles": [ { "address": "678 MACQUARIE DR, ELEEBANA 2282", "county": "NORTHUMBERLAND", "description": "Lot 149 in 221864 (Parish of KAHIBAH, County of NORTHUMBERLAND, LAKE MACQUARIE)", "id": "W25zd19scnNdMTQ5LzIyMTg2NA==", "kind": "STANDARD_LOT", "lga": "LAKE MACQUARIE", "lot": "149", "parish": "KAHIBAH", "plan": "221864", "preview": [ " LOCAL GOVERNMENT AREA LAKE MACQUARIE", " PARISH OF KAHIBAH COUNTY OF NORTHUMBERLAND", "", " FIRST SCHEDULE", " --------------", " PADXLAPS SIDJ", "", " *** END OF SEARCH ***" ], "raw": { "address": "678 MACQUARIE DR, ELEEBANA 2282", "county": "NORTHUMBERLAND", "lga": "LAKE MACQUARIE", "lot": "149", "parish": "KAHIBAH", "plan": "221864", "state": "NSW", "titlePreview": [ " LOCAL GOVERNMENT AREA LAKE MACQUARIE", " PARISH OF KAHIBAH COUNTY OF NORTHUMBERLAND", "", " FIRST SCHEDULE", " --------------", " PADXLAPS SIDJ", "", " *** END OF SEARCH ***" ], "titleReference": "149/221864" }, "section": null, "state": "NSW", "status": null, "titleReference": "149/221864", "type": null } ] }, "query": { "mode": "gnaf", "properties": [ { "address": "678 MACQUARIE DRIVE ELEEBANA NSW 2282", "aliasAddresses": [], "id": "GANSW704677435" } ], "search": "GANSW704677435" }, "success": true } }, "qldDirectTitleLookup": { "summary": "QLD current-title lookup with registered proprietor preview", "value": { "data": { "titles": [ { "address": "QLD title 15023001", "county": null, "description": "Freehold - 15023001", "id": "W3FsZF90aXRsZXNdMTUwMjMwMDE=", "kind": "UNKNOWN", "lga": null, "lot": null, "parish": null, "plan": null, "preview": [ "JOHN SMITH" ], "raw": { "familyName": "SMITH", "givenName": "JOHN", "imagedFlag": "Y", "state": "QLD", "titleNameRows": [ { "familyName": "SMITH", "givenName": "JOHN", "imagedFlag": "Y", "state": "QLD", "titleReference": "15023001", "titleTypeCode": "FH", "titleTypeDescription": "Freehold" } ], "titleReference": "15023001", "titleTypeCode": "FH", "titleTypeDescription": "Freehold" }, "section": null, "state": "QLD", "status": "CURRENT", "titleReference": "15023001", "type": "Freehold" } ] }, "query": { "mode": "title", "search": "15023001" }, "success": true } }, "qldParcelLookup": { "summary": "QLD parcel lookup with Property Location Service address context", "value": { "data": { "titles": [ { "address": "45 EDMONDSTONE ST, SOUTH BRISBANE QLD 4101", "county": null, "description": "Title - 49017208 - Lot 7 on RP1441", "id": "W3FsZF90aXRsZXNdNDkwMTcyMDg=", "kind": "UNKNOWN", "lga": null, "lot": "7", "parish": null, "plan": "RP1441", "preview": [ "JOHN SMITH" ], "raw": { "familyName": "SMITH", "givenName": "JOHN", "imagedFlag": "Y", "lot": "7", "planNumber": "1441", "planType": "RP", "propertyLocationService": { "address": "45 EDMONDSTONE ST, SOUTH BRISBANE QLD 4101", "aliases": [], "confidence": 100, "geocodes": [ { "latitude": -27.48098426, "longitude": 153.0162792, "type": "PC" } ], "parcels": [ { "lot": "7", "plan": "RP1441" } ] }, "state": "QLD", "titleNameRows": [ { "familyName": "SMITH", "givenName": "JOHN", "imagedFlag": "Y", "state": "QLD", "titleReference": "49017208", "titleTypeCode": "FH", "titleTypeDescription": "Freehold" } ], "titleReference": "49017208", "titleTypeCode": "FH", "titleTypeDescription": "Freehold" }, "section": null, "state": "QLD", "status": "CURRENT", "titleReference": "49017208", "type": "Freehold" } ] }, "query": { "mode": "parcel", "properties": [ { "address": "45 EDMONDSTONE ST, SOUTH BRISBANE QLD 4101", "aliasAddresses": [], "geocodes": [ { "latitude": -27.48098426, "longitude": 153.0162792, "type": "PC" } ], "id": "qld-pls:7/RP1441", "parcels": [ { "lot": "7", "plan": "RP1441" } ] } ], "search": "7/RP1441" }, "success": true } }, "qldUnavailableDirectTitleLookup": { "summary": "QLD missing or non-current title reported as unavailable to order", "value": { "data": { "titles": [] }, "query": { "mode": "title", "search": "15023000", "warnings": [ { "code": "titles_not_available_to_order", "message": "We could not validate a title for the provided information. It may be missing, invalid, or otherwise unverifiable.", "unmatchedTitleCount": 1, "unmatchedTitleReferences": [ "15023000" ] } ] }, "success": true } }, "vicGnafComplexProperty": { "summary": "G-NAF address lookup with multiple addresses", "value": { "data": { "titles": [ { "address": "180 GILLIES STREET N LAKE WENDOUREE 3350", "county": null, "description": "FREEHOLD LOT 1 TP960916B (BALLARAT)", "id": "W3ZpY19zZXJ2XUdMVHdzVWwwd0JwUlBwc3UyRDJLa1U3VWdER0Fxd0FmT3c9PQ==", "kind": "LOT", "lga": "BALLARAT", "lot": "1", "parish": null, "plan": "TP960916B", "preview": null, "raw": { "isPartParcel": false, "lot": "1", "parcelStatus": "ACTIVE", "parcelType": "LOT", "planNumber": "TP960916B", "spi": "1\\TP960916", "state": "VIC", "titleId": "GLTwsUl0wBpRPpsu2D2KkU7UgDGAqwAfOw==", "titleStatus": "ACTIVE", "titleType": "FREEHOLD" }, "section": null, "state": "VIC", "status": "ACTIVE", "titleReference": null, "type": "FREEHOLD" }, { "address": "180 GILLIES STREET N LAKE WENDOUREE 3350", "county": null, "description": "CROWN_GRANT 2023 PP5030 (BALLARAT)", "id": "W3ZpY19zZXJ2XWYrUjRYTjZyWXJyVjdlTytnOTlFdTNEbEFzYjJBZnlj", "kind": "UNKNOWN", "lga": "BALLARAT", "lot": "2023", "parish": "Ballarat", "plan": "PP5030", "preview": null, "raw": { "allotment": "2023", "isPartParcel": false, "lot": "2023", "parcelStatus": "ACTIVE", "parish": "Ballarat", "planNumber": "PP5030", "spi": "2023\\PP5030", "state": "VIC", "titleId": "f+R4XN6rYrrV7eO+g99Eu3DlAsb2Afyc", "titleStatus": "ACTIVE", "titleType": "CROWN_GRANT", "township": "Ballarat" }, "section": null, "state": "VIC", "status": "ACTIVE", "titleReference": null, "type": "CROWN_GRANT" } ] }, "query": { "mode": "gnaf", "properties": [ { "address": "180 GILLIES STREET N LAKE WENDOUREE 3350", "aliasAddresses": [ "11 NURSERY DRIVE LAKE WENDOUREE 3350", "170 GILLIES STREET N LAKE WENDOUREE 3350" ], "id": "131100892" } ], "search": "GAVIC721296730", "warnings": [ { "code": "titles_not_available_to_order", "message": "We could not validate a title for the provided information. It may be missing, invalid, or otherwise unverifiable.", "unmatchedTitleCount": 1, "unmatchedTitleTypes": [ { "count": 1, "type": "CROWN_LAND" } ] } ] }, "success": true } }, "vicParcelLookup": { "summary": "VIC parcel lookup", "value": { "data": { "titles": [ { "address": "14 FLEMMING AVENUE BURNSIDE 3023", "county": null, "description": "FREEHOLD LOT 569 PS434021W (MELTON)", "id": "W3ZpY19zZXJ2XVUwanRsQ2d0dFZuY2hMRHIzTFBjcFVreTZtMEV5UTFkdWc9PQ==", "kind": "LOT", "lga": "MELTON", "lot": "569", "parish": null, "plan": "PS434021W", "preview": null, "raw": { "isPartParcel": false, "lot": "569", "parcelStatus": "ACTIVE", "parcelType": "LOT", "planNumber": "PS434021W", "spi": "569\\PS434021", "state": "VIC", "titleId": "U0jtlCgttVnchLDr3LPcpUky6m0EyQ1dug==", "titleStatus": "ACTIVE", "titleType": "FREEHOLD" }, "section": null, "state": "VIC", "status": "ACTIVE", "titleReference": null, "type": "FREEHOLD" } ] }, "query": { "mode": "parcel", "properties": [ { "address": "14 FLEMMING AVENUE BURNSIDE VIC 3023", "aliasAddresses": [], "id": "52709687" } ], "search": "569\\PS434021" }, "success": true } }, "waDirectTitleLookup": { "summary": "WA direct title lookup with title type derived from register-id prefix", "value": { "data": { "titles": [ { "address": "LR3001/10A", "county": null, "description": "LR3001/10A", "id": "W3dhX2xhbmRnYXRlXUxSMDMwMDEwMDAxMEE=", "kind": "UNKNOWN", "lga": null, "lot": null, "parish": null, "plan": null, "preview": null, "raw": { "registerId": "LR0300100010A", "state": "WA", "titleReference": "LR3001/10A" }, "section": null, "state": "WA", "status": null, "titleReference": "LR3001/10A", "type": "Crown Land Record" } ] }, "query": { "mode": "title", "search": "LR3001/10A" }, "success": true } } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "titles": { "description": "List of discovered titles matching the query.", "items": { "additionalProperties": false, "properties": { "address": { "description": "Human-readable address label for the discovered title row.", "type": "string" }, "county": { "description": "Cadastre county when known.", "type": [ "string", "null" ] }, "description": { "description": "Human-readable summary built from available cadastral and local government context.", "type": "string" }, "id": { "description": "Opaque title id used by downstream purchase flows.", "type": "string" }, "kind": { "description": "Parcel or title kind when available.", "enum": [ "Closed Road Marked", "Allotment (Reserve)", "Allotment", "Allotment (Road)", "Allotment (Throughfare)", "Block", "Common Property (Community Plan)", "Lot", "Development Lot", "Piece", "Section", "Town Acre", "Common Property (Strata Plan)", "Unit", "LOT", "UNIT", "COMMON_PROPERTY", "ROAD", "RESERVE", "STANDARD_LOT", "SECTIONED_LOT", "STRATA_UNIT", "STRATA_COMMON_PROPERTY", "COMMUNITY_ASSOCIATION", "PRECINCT_ASSOCIATION", "NEIGHBOURHOOD_ASSOCIATION", "AUTO_CONSOL", "WATER_ACCESS_LICENSE", "UNKNOWN", "Agricultural Farm", "Selection Files", "Agricultural Homestead", "Auction Purchase Freehold", "Auction Perpetual Lease", "Auction Perpetual Lease Sugar Works", "Agricultural Reserve", "Perpetual Country Lease", "Commonwealth Acquisition", "Crown Development", "Dead Farm", "Exchange", "Farm", "Forestry Grazing Lease", "Grazing Farm", "Grazing Homestead", "Grazing Homestead Freehold Lease", "Grazing Homestead Perpetual Lease", "Informal Lease", "Land Acquisition Batch", "Land Open for Selection", "Miners Homestead Lease", "Miners Homestead Perpetual Lease", "Mining Titles Freeholding Leases", "Non-Competitive Lease", "Occupation License", "Pastoral Holding", "Perpetual Lease", "Perpetual Lease Prickly Pear Development Lease", "Perpetual Lease Prickly Pear Selection", "Perpetual Lease Selection", "Permit to Occupy", "Prickly Pear Development Grazing Farm", "Prickly Pear Development Grazing Homestead", "Prickly Pear Development Selection", "Prickly Pear Frontage Selection", "Prickly Pear Lease", "Prickly Pear Selection", "Perpetual Suburban Lease", "Perpetual Town Lease", "Public Works Land Resumption", "Reserve", "Run", "Road Case", "Rifle Range", "Settlement Farm Lease", "Perpetual Town and Suburban Lease", "Special Lease", "Special Lease Purchase Freehold", "Special Non-Competitive Lease", "Special Purchase", "Special Purpose Mining Perpetual Lease", "Sugar Selection", "Soldier Settlement Land Opening", "Soldier Settlement Occupation Board", "Sugar Works", "Unconditional Selection" ], "type": "string" }, "lga": { "description": "Local government area. VIC values typically mirror municipality.", "type": [ "string", "null" ] }, "lot": { "description": "Parcel lot metadata when known.", "type": [ "string", "null" ] }, "parish": { "description": "Cadastre parish when known.", "type": [ "string", "null" ] }, "plan": { "description": "Parcel plan metadata when known.", "type": [ "string", "null" ] }, "preview": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Best-effort title preview lines when available." }, "raw": { "description": "Additional state-specific discovery data. This field may duplicate top-level fields and is not a stable cross-state contract." }, "section": { "description": "Parcel section metadata when known.", "type": [ "string", "null" ] }, "state": { "enum": [ "ACT", "NSW", "NT", "QLD", "SA", "TAS", "VIC", "WA" ], "type": "string" }, "status": { "anyOf": [ { "enum": [ "CURRENT", "Active", "Cancelled", "Subject to dealing", "ACTIVE", "CANCELLED", "PARTIALLY_CANCELLED" ], "type": "string" }, { "type": "null" } ], "description": "Current title status when available." }, "titleReference": { "description": "Provider title reference when the source system exposes one. ACT includes the provider edition as VOLUME/FOLIO/EDITION; NSW and TAS use their references as the title identity." }, "type": { "anyOf": [ { "enum": [ "0000", "CACL", "CAFT", "CRCL", "CUCL", "CUFT", "DTAL", "NACL", "NAFT", "NRCL", "NTCL", "NTFT", "NTT0", "XXXX", "Certificate of Title", "Crown Record", "Crown Lease", "Freehold", "Crown Land Record", "Country Grant", "Town Grant", "Lands Copy Grant", "Surface Right", "Permit", "Country Enrollment", "Town Enrollment", "Railway Grant", "FREEHOLD", "ALPINE_LEASE", "CITY_LINK_LEASE", "CROWN_GRANT", "CROWN_LAND", "CROWN_LEASE", "IDENTIFIED", "MINERAL_EXCLUDES", "MINERAL_INCLUDES", "TREASURERS_RECEIPT" ], "type": "string" }, { "type": "null" } ], "description": "Title type when available." } }, "required": [ "id", "titleReference", "address", "description", "kind", "preview", "type", "status", "state", "lga", "county", "parish", "lot", "section", "plan", "raw" ], "type": "object" }, "type": "array" } }, "required": [ "titles" ], "type": "object" }, "query": { "additionalProperties": false, "properties": { "mode": { "description": "The lookup mode used.", "enum": [ "gnaf", "address", "parcel", "title" ], "type": "string" }, "properties": { "description": "Property summaries resolved during the lookup. For VIC, these are DDP property records with alias addresses. For ACT/NSW/TAS GNAF lookups, contains the formatted GNAF address as a single entry.", "items": { "additionalProperties": false, "properties": { "address": { "description": "Primary address string (eziAddress for VIC, formatted GNAF address for ACT/NSW/TAS).", "type": "string" }, "aliasAddresses": { "description": "Additional addresses associated with this property. Present for VIC DDP lookups; empty for ACT/NSW/TAS GNAF lookups.", "items": { "type": "string" }, "type": "array" }, "geocodes": { "description": "Property location coordinates when available.", "items": { "additionalProperties": false, "properties": { "latitude": { "type": "number" }, "longitude": { "type": "number" }, "type": { "type": "string" } }, "required": [ "type", "latitude", "longitude" ], "type": "object" }, "type": "array" }, "id": { "description": "Property identifier — gnafAddressId for ACT/NSW/TAS GNAF lookups, propertyPfi for VIC DDP lookups.", "type": "string" }, "parcels": { "description": "QLD lot/plan parcels resolved for this property.", "items": { "additionalProperties": false, "properties": { "lot": { "type": "string" }, "plan": { "type": "string" } }, "required": [ "lot", "plan" ], "type": "object" }, "type": "array" } }, "required": [ "id", "address", "aliasAddresses" ], "type": "object" }, "type": "array" }, "search": { "description": "The raw search input.", "type": "string" }, "warnings": { "description": "Summary warnings for titles discovered during the query but excluded from the main result set because they are not available to order for the requested product.", "items": { "additionalProperties": false, "properties": { "code": { "description": "Warning code.", "type": "string" }, "message": { "description": "Warning summary for the query response.", "type": "string" }, "unmatchedTitleCount": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "unmatchedTitleReferences": { "description": "Title references for unmatched titles excluded from the main result set.", "items": { "description": "Title reference for an unmatched title.", "type": "string" }, "type": "array" }, "unmatchedTitleTypes": { "description": "Summary counts for unmatched titles grouped by title type.", "items": { "additionalProperties": false, "properties": { "count": { "exclusiveMinimum": 0, "maximum": 9007199254740991, "type": "integer" }, "type": { "description": "Title type for the unmatched titles.", "type": "string" } }, "required": [ "type", "count" ], "type": "object" }, "type": "array" } }, "required": [ "code", "message", "unmatchedTitleCount" ], "type": "object" }, "type": "array" } }, "type": "object" }, "success": { "enum": [ true ], "type": "boolean" } }, "required": [ "success", "data", "query" ], "type": "object" } } }, "description": "Default Response" }, "400": { "content": { "application/json": { "examples": { "malformedTitleId": { "summary": "VIC title[id] must use the VOLUME/FOLIO format", "value": { "error": "Expected format 'VOLUME/FOLIO'", "success": false } }, "mutuallyExclusiveModes": { "summary": "Parameters from multiple query modes were supplied together", "value": { "error": "Query modes are mutually exclusive. Provide exactly one of addressId, gnafAddressId, parcel, or title.", "success": false } }, "noModeProvided": { "summary": "No supported query mode was supplied", "value": { "error": "No recognised query mode was provided. Use exactly one of addressId, gnafAddressId, parcel, or title.", "success": false } } }, "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" }, "501": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "type": "string" }, "success": { "enum": [ false ], "type": "boolean" } }, "required": [ "success", "error" ], "type": "object" } } }, "description": "Default Response" } }, "security": [ { "bearerAuth": [] } ], "summary": "Search for titles", "tags": [ "Titles" ] } } }, "servers": [ { "url": "https://api.fynd.info" } ], "tags": [ { "name": "Identity" }, { "name": "Addresses" }, { "name": "Titles" }, { "name": "Orders" } ] }