# Not Yet Built

The Not Yet Built address format is identical to the [Postcode Address File](/docs/data/paf.md) format. Only the dataset label differs.

* `dataset` string

  Dataset

  Indicates the provenance of an address.

  Example: `nyb`

  Enum: "nyb"

## Native Record

* `native` object

  Native Record

  The raw dataset record backing an address, exactly as the dataset supplies it. One schema per dataset; `dataset` on the record says which.

Raw Royal Mail Not Yet Built record backing an `nyb` address.

Delivery points Royal Mail has allocated for addresses under construction, ahead of them appearing in PAF. Same shape as a PAF record.

Fields shared by every Royal Mail PAF family native record (`paf`, `mr`, `nyb`, `pafa`, `pafw`).

The Royal Mail record as held in Postgres, before any derived fields are added. Formatted lines, `premise`, postcode parts, geocodes, UPRN and county fields belong to the address, not to the native record. `dataset` is the one field not taken from Royal Mail.

Two values differ from the raw PAF file: `post_town` is title cased (Royal Mail supplies it upper cased), and a `building_number` of `0`, PAF's sentinel for "none", is returned as an empty string.

### Example Record

| Field                                                            | Example               | Type     |
| ---------------------------------------------------------------- | --------------------- | -------- |
| [`dataset`](#native-dataset)                                     | nyb                   | `string` |
| [`postcode`](#native-postcode)                                   | L1 8JQ                | `string` |
| [`post_town`](#native-post_town)                                 | Liverpool             | `string` |
| [`dependant_locality`](#native-dependant_locality)               | Empty in this example | `string` |
| [`double_dependant_locality`](#native-double_dependant_locality) | Empty in this example | `string` |
| [`thoroughfare`](#native-thoroughfare)                           | Wall Street           | `string` |
| [`dependant_thoroughfare`](#native-dependant_thoroughfare)       | Empty in this example | `string` |
| [`building_number`](#native-building_number)                     | Empty in this example | `string` |
| [`building_name`](#native-building_name)                         | 2b                    | `string` |
| [`sub_building_name`](#native-sub_building_name)                 | Empty in this example | `string` |
| [`po_box`](#native-po_box)                                       | Empty in this example | `string` |
| [`department_name`](#native-department_name)                     | Empty in this example | `string` |
| [`organisation_name`](#native-organisation_name)                 | Empty in this example | `string` |
| [`udprn`](#native-udprn)                                         | `53656380`            | `number` |
| [`postcode_type`](#native-postcode_type)                         | S                     | `string` |
| [`su_organisation_indicator`](#native-su_organisation_indicator) | Empty in this example | `string` |
| [`delivery_point_suffix`](#native-delivery_point_suffix)         | 1R                    | `string` |

```json
{
  "dataset": "nyb",
  "postcode": "L1 8JQ",
  "post_town": "Liverpool",
  "dependant_locality": "",
  "double_dependant_locality": "",
  "thoroughfare": "Wall Street",
  "dependant_thoroughfare": "",
  "building_number": "",
  "building_name": "2b",
  "sub_building_name": "",
  "po_box": "",
  "department_name": "",
  "organisation_name": "",
  "udprn": 53656380,
  "postcode_type": "S",
  "su_organisation_indicator": "",
  "delivery_point_suffix": "1R"
}
```

Every field is documented below.

* `dataset` string

  Example: `nyb`

  Enum: "nyb"

* `postcode` string

  Postcode, space separated

  Example: `L1 8JQ`

* `post_town` string

  Royal Mail post town, title cased

  Example: `Liverpool`

* `dependant_locality` string

  Dependant locality. Empty string when not present

  Example: Empty in this example

* `double_dependant_locality` string

  Double dependant locality. Empty string when not present

  Example: Empty in this example

* `thoroughfare` string

  Street name

  Example: `Wall Street`

* `dependant_thoroughfare` string

  Dependant street name. Empty string when not present

  Example: Empty in this example

* `building_number` string

  Building number. Empty string when not present, or when PAF merges it into the building name

  Example: Empty in this example

* `building_name` string

  Building name. Empty string when not present

  Example: `2b`

* `sub_building_name` string

  Sub building name. Empty string when not present

  Example: Empty in this example

* `department_name` string

  Department name within an organisation. Empty string when not present

  Example: Empty in this example

* `organisation_name` string

  Organisation name. Empty string when not present

  Example: Empty in this example

* `udprn` integer

  Unique Delivery Point Reference Number

  Example: `53656380`

* `postcode_type` string

  Postcode type.

  * `S` Small user
  * `L` Large user
  * `""` where Royal Mail supplies none

  Example: `S`

  Enum: "S", "L", ""

* `su_organisation_indicator` string

  Small user organisation indicator. `Y` where the small user postcode is held by an organisation

  Example: Empty in this example

* `delivery_point_suffix` string

  Royal Mail delivery point suffix

  Example: `1R`

* `po_box` string

  PO Box number. Empty string when not present

  Example: Empty in this example