---
title: "Parse Address"
method: POST
path: "/v1/address/parse"
tags: ["Address Parser"]
---

# Parse Address

`POST /v1/address/parse`

## Request

- Base URL: `https://api.cloud.precisely.com`
- URL: `https://api.cloud.precisely.com/v1/address/parse`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

Parses a single-line address into its components.

## Headers

- `X-Request-Id` string

## Request body

- AddressInfo: Schema for parsing a single address input into structured components, such as house number, street, and city.
  - `id` string, nullable: An optional ID to map the request payload to the response payload, helpful for batch processing.
  - `address` string, required: A single-line address string to parse into structured components.

## Response `200`

Address successfully parsed.

- ParsedAddressResponse: Schema for a response containing parsed address details, including parsing status and structured address components.
  - `response` ParsedAddress: Schema representing a parsed address, including structured components and error details, if any.
    - `id` string, nullable: Optional ID for mapping parsed addresses to their corresponding requests.
    - `status` string, nullable: The parsing status (e.g., "OK" for success).
    - `code` string, nullable: Error code for failed parsing, providing context for the error.
    - `detail` string, nullable: A detailed error message for failed parsing.
    - `address` object: Schema representing a single address input with structured components for house or building details, geographic areas, and other optional details.
      - `addressNumber` string, nullable: The house or building number.
      - `street` string, nullable: The street name where the address is located.
      - `admin1` string, nullable: The primary geographic area, such as a state.
      - `city` string, nullable: The city or town of the address.
      - `suburb` string, nullable: The suburb or secondary geographic area, if applicable.
      - `postalCode` string, nullable: The main postal code for the address.
      - `placeName` string, nullable: The name of a candidate's place or building, if applicable.
      - `floor` string, nullable: The level or floor within a building.
      - `unit` string, nullable: The unit or suite number within a building.

## Other responses

- `400`: Invalid Request for address parser API
- `401`: Unauthorized: Invalid token for address parser API
- `403`: Forbidden for address parser API
- `429`: Too many requests for address parser API
- `500`: Internal server error for address parser API

---

[API](https://skmtc.dev/precisely/apis/address-parser-api.md) · [All operations](https://skmtc.dev/precisely/apis/address-parser-api/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/address-parser-api/revisions/17940e2dc4fc?raw)