---
title: "Creates an address layout."
method: POST
path: "/address/layouts/v2"
tags: ["Address Validation"]
---

# Creates an address layout.

`POST /address/layouts/v2`

## Headers

- `Reference-Id` string

## Request body

- AddressLayoutsV2CreateRequest — Address Layouts V2 Create Request.
  - `layout` AddressLayoutV2, required — Address Layout V2.
    - `name` string, required — The layout name.
    - `comment` string, nullable — The layout comment.
    - `applies_to` AddressLayoutV2AppliesTo[], required — The layout applies to.
      - `country_iso` string, required — The country ISO3 code.
      - `datasets` string[], required — The datasets.
      - `language` string, nullable — The language.
      - `script` string, nullable — The script.
    - `options` AddressLayoutV2Options — Address Layout V2 Options
      - `variation` integer — Variation
      - `flatten_diacritics` boolean — Flatten Diacritics
      - `use_secondary_postcode` string, nullable — Use Secondary Postcode
      - `enable_enhanced_layout` boolean — Enable Enhanced Layout
      - `display_enhanced_info_on_picklist` boolean — Display Enhanced Info On Picklist
      - `enable_intelligent_layout` boolean — Enable Intelligent Layout
      - `capitalise_unused` boolean — Capitalise Unused
      - `separate_elements` boolean — Separate Elements
      - `element_separator` AddressLayoutV2ElementConfigurationWithDefault — Address Layout V2 Element Configuration.
        - `default` string, nullable — The default configuration.
        - `configuration_by_element` object, nullable — The configuration of each element.
      - `retention_element_separator` AddressLayoutV2ElementConfigurationWithDefault — Address Layout V2 Element Configuration.
        - `default` string, nullable — The default configuration.
        - `configuration_by_element` object, nullable — The configuration of each element.
      - `prepend_element_separator` AddressLayoutV2ElementConfigurationWithDefault — Address Layout V2 Element Configuration.
        - `default` string, nullable — The default configuration.
        - `configuration_by_element` object, nullable — The configuration of each element.
      - `separate_element_separator` AddressLayoutV2ElementConfigurationWithDefault — Address Layout V2 Element Configuration.
        - `default` string, nullable — The default configuration.
        - `configuration_by_element` object, nullable — The configuration of each element.
      - `terminate_lines` boolean — Terminate Lines
      - `line_terminator` AddressLayoutV2ElementConfigurationWithDefault — Address Layout V2 Element Configuration.
        - `default` string, nullable — The default configuration.
        - `configuration_by_element` object, nullable — The configuration of each element.
      - `conditional_format` string, nullable — Conditional Format
      - `pad_lines` boolean — Pad Lines
      - `padding_character` string, nullable — Padding Character
      - `multiple_dataplus_delimiter` string, nullable — Multiple DataPlus Delimiter
      - `abbreviate_item` string[], nullable — Indicating the elements that are abbreviated.
      - `capitalise_item` string[], nullable — Indicating the elements that are capitalised.
      - `exclude_item` string[], nullable — Indicating the elements that are excluded.
      - `element_extras` object, nullable — Indicating the elements with extra characters.
    - `lines` AddressLayoutV2Line[], required — The layout lines.
      - `line_name` string, nullable — The line name.
      - `max_width` integer, nullable — Max width.
      - `elements` AddressLayoutV2LineElement[], nullable — Elements.
        - `element_name` string, nullable — The element name.

## Response `200`

OK

- AddressLayoutsV2CreateResponse — Response model for Address Layouts V2 create endpoint.
  - `error` ResponseError — Error model containing the error details.
    - `type` string, nullable — A link to documentation that provides more details about the error you’ve encountered.
    - `title` string, nullable — The title of the error.
    - `detail` string, nullable — A description of the error.
    - `instance` string, nullable — The endpoint that returned the error.
  - `result` AddressLayoutsV2CreateResult — Address Layouts V2 Create Result
    - `id` string, nullable — Layout ID

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `406` — Not Acceptable
- `415` — Unsupported Media Type
- `429` — Too Many Requests
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.dev/experianaperture/apis/aperture-rest-api.md) · [All operations](https://skmtc.dev/experianaperture/apis/aperture-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/experianaperture/aperture-rest-api/revisions/f17d329b4892/schema)