# Introduction

Fynd API for searching and purchasing Australian property records.
It is designed for backend-to-backend integrations that need a predictable workflow for address lookup, title discovery, title search orders, and a range of other property, construction, and conveyancing documents.

<hr />

## Authentication

Every request is authenticated with an API key using the `Authorization` header:

```bash
Authorization: Bearer <your-api-key>
```

API keys are issued per API client and scoped to an organisation.
If your oraganisation has API Access enabled (contact support@fynd.au for more information), then you can manage your API Keys from [Settings](/api-management).

Requests are rejected if the key is missing, invalid, expired, inactive, or linked to a disabled client or organisation.

Call `GET /api/v0/identity` first if you want to validate connectivity and confirm which API client is associated with the key you are using.

```bash
curl 'https://api.fynd.au/api/v0/identity' \
  -H 'Authorization: Bearer sk_live_...'
```

:::note

From within [API Reference](/spec) the **API Playground** will let you use your logged in session instead of an api key.
The identity request here will return null for your api client id.

:::

## Quickstart Example

A simple end-to-end workflow for finding an address, discovering available titles, and ordering a title search starts with an address lookup:

```bash
curl 'https://api.fynd.au/api/v0/addresses?term=16+Ascot+Vale+Road' \
  -H 'Authorization: Bearer sk_live_...'
```

Use the returned address `id` to resolve available titles:

```bash
curl 'https://api.fynd.au/api/v0/titles?addressId=<address-id>' \
  -H 'Authorization: Bearer sk_live_...'
```

Create a title-search order with the returned title `id` as `titleId`:

```bash
curl 'https://api.fynd.au/api/v0/orders' \
  -X POST \
  -H 'Authorization: Bearer sk_live_...' \
  -H 'x-order-timeout-ms: 5000' \
  -H 'Content-Type: application/json' \
  -d '{"product":"title","titleId":"<title-id>","clientReference":"acme-title-lookup-001"}'
```

Depending on `x-order-timeout-ms`, the create-order request may return the order data immediately or accept the order for asynchronous processing. In either case, poll the order until the document is ready:

```bash
curl 'https://api.fynd.au/api/v0/orders/<order-id>' \
  -H 'Authorization: Bearer sk_live_...'
```

## API Specification

The [API Playground](/spec) is rendered directly from our OpenAPI spec.

Download the spec at [OpenAPI downloads](/openapi).
