# 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