> ## Documentation Index
> Fetch the complete documentation index at: https://docs.loqate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HasSubPremise

[← Back to Address Fields](/field-descriptions/addfields)

This page covers the logic and example scenarios for the `HasSubPremise` field, which is available in US PDH data. For the full set of address fields, see [Address Fields](/field-descriptions/addfields).

## Field values

| Value | Meaning                                                                                                                  |
| ----- | ------------------------------------------------------------------------------------------------------------------------ |
| `Yes` | The verified premise contains one or more sub premises (for example, apartments or suites).                              |
| `No`  | The verified record is itself a sub premise, or the verified premise contains no sub premises.                           |
| blank | No sub premise information is available (typically when the address was only verified to thoroughfare or a lower level). |

## How `HasSubPremise` interacts with AVC

The value of `HasSubPremise` should always be interpreted alongside the [AVC code](/field-descriptions/addfields). The table below summarises the common combinations.

| AVC  | Verification level                      | Typical `HasSubPremise` | Interpretation                                                             |
| ---- | --------------------------------------- | ----------------------- | -------------------------------------------------------------------------- |
| `V4` | Verified to premise level               | `Yes`                   | Premise verified and contains sub premises.                                |
| `V4` | Verified to premise level               | `No`                    | Premise verified and contains no sub premises.                             |
| `V5` | Verified to sub premise level           | `No`                    | Record is itself a sub premise, so it cannot contain further sub premises. |
| `A5` | Ambiguous at sub premise level          | `No`                    | Sub premise level record; no further sub premises to flag.                 |
| `V3` | Verified to thoroughfare (street) level | blank                   | No sub premise information available.                                      |

## Scenarios

The following scenarios illustrate how the `HasSubPremise` flag behaves for different verification outcomes.

### Scenario 1: Verified premise level property that contains sub premises

| Field            | Value                                  |
| ---------------- | -------------------------------------- |
| `HasSubPremise`  | `Yes`                                  |
| `AVC`            | `V4`                                   |
| Verified address | `999 Baker Way San Mateo CA 94404 USA` |

The property has been verified to premise level, so the AVC is `V4`. It also contains one or more sub premises, so `HasSubPremise` is set to `Yes`.

### Scenario 2: Verified sub premise level property

| Field            | Value                                        |
| ---------------- | -------------------------------------------- |
| `HasSubPremise`  | `No`                                         |
| `AVC`            | `V5`                                         |
| Verified address | `999 Baker Way Ste 1 San Mateo CA 94404 USA` |

The property has been verified as a sub premise, so the AVC is `V5`. A sub premise cannot itself contain further sub premises, so `HasSubPremise` is set to `No`.

### Scenario 3: Verified premise level property with incorrect sub premise data

| Field            | Value                                         |
| ---------------- | --------------------------------------------- |
| `HasSubPremise`  | `Yes`                                         |
| `AVC`            | `V4`                                          |
| Verified address | `999 Baker Way Ste 21 San Mateo CA 94404 USA` |

The property has been verified to premise level (AVC `V4`) because the supplied sub premise information was incorrect. The premise does contain sub premises, so `HasSubPremise` is set to `Yes`.

### Scenario 4: Verified premise level property with no sub premises

| Field            | Value                                              |
| ---------------- | -------------------------------------------------- |
| `HasSubPremise`  | `No`                                               |
| `AVC`            | `V4`                                               |
| Verified address | `121 Private Road 3697 Paradise TX 76073-4800 USA` |

The property has been verified to premise level (AVC `V4`) and contains no sub premises, so `HasSubPremise` is set to `No`.

### Scenario 5: Ambiguous sub premise level property

| Field            | Value                                           |
| ---------------- | ----------------------------------------------- |
| `HasSubPremise`  | `No`                                            |
| `AVC`            | `A5`                                            |
| Verified address | `1 Chestnut St Ste 3Y Nashua NH 03060-9306 USA` |

The AVC code of `A5` means there is more than one close reference data match at sub premise level. Because this is a sub premise level record, the sub premise does not contain further sub premises, so `HasSubPremise` is set to `No`.

### Scenario 6: No sub premise information

| Field            | Value                                   |
| ---------------- | --------------------------------------- |
| `HasSubPremise`  | blank                                   |
| `AVC`            | `V3`                                    |
| Verified address | `8055 veterans blvd redwoodcity ca usa` |

The property was only verified to the thoroughfare (street) level, so no sub premise information is available and `HasSubPremise` is returned blank.
