> For the complete documentation index, see [llms.txt](https://docs.api.insyncdigital.co.uk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.api.insyncdigital.co.uk/insync-digital-api-documentation.md).

# Insync Digital API Documentation

## Introduction

The Insync Digital API is a multi-endpoint API that provides property intelligence services. This API allows developers to access property risk data including flood risk, crime statistics, natural hazards, and emergency service proximity information.

## Environments

The API is available in two environments:

* **Sandbox**: <https://api-sandbox.insyncdigital.co.uk>
* **Production**: <https://api.insyncdigital.co.uk>

The sandbox environment should be used for testing and development purposes, while the production environment should only be used for live applications.

## Authentication

All API endpoints are secured using API key authentication. You must include the appropriate headers with every request.

### Required Headers

| Header             | Description                                         | Required    |
| ------------------ | --------------------------------------------------- | ----------- |
| `x-api-key`        | Your unique API key provided by Insync Digital      | Yes         |
| `x-client-id`      | Your client identifier                              | Yes         |
| `x-correlation-id` | A unique identifier for the request (UUIDv4 format) | Recommended |

### Required Parameters

| Parameter | Description                            | Required |
| --------- | -------------------------------------- | -------- |
| `code`    | Access code provided by Insync Digital | Yes      |

This parameter must be included in every API request as a query parameter.

Example correlation ID: `123e4567-e89b-12d3-a456-426614174000`

### Authorization Scopes

Different API endpoints require different authorization scopes. Your API key will be provisioned with the appropriate scopes for your use case. The main scopes used are:

* `address:read` - Required for single address lookup
* `address:bulk-read` - Required for bulk address operations


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.api.insyncdigital.co.uk/insync-digital-api-documentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.