From c25d13b42514e1e004e6af3c1e405c36348fa0a5 Mon Sep 17 00:00:00 2001 From: Gianie <33092372+gianiek@users.noreply.github.com> Date: Wed, 4 Dec 2024 16:26:45 -0500 Subject: [PATCH] Docs update for recordType / propertyType --- docs/{api.mdx => Address validate docs update} | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) rename docs/{api.mdx => Address validate docs update} (99%) diff --git a/docs/api.mdx b/docs/Address validate docs update similarity index 99% rename from docs/api.mdx rename to docs/Address validate docs update index 02775bbd0..405707912 100644 --- a/docs/api.mdx +++ b/docs/Address validate docs update @@ -888,7 +888,7 @@ Returns a `verificationStatus` as part of the `result`, as defined below: - **`ambiguous`**: The input closely matches multiple results. - **`unverified`**: Unable to verify the input address. -Returns a `recordType` value in the `metadata` field as part of the `result`, values are defined below according to USPS standards: +Returns a `recordType` value in the `metadata` field as part of the `result`, if available. Values are defined below according to USPS standards: - **`S`**: Street Address - **`P`**: Post Office Box @@ -897,6 +897,11 @@ Returns a `recordType` value in the `metadata` field as part of the `result`, va - **`F`**: Firm - **`G`**: General Delivery +Returns a `propertyType` value in the `metadata` field as part of the `result`, if available. Values are defined below: + +- **`residential`**: Indicates the address is identified as a residential property. +- **`commercial`**: Indicates the address identified as a commercial property. + On US addresses, an `analysis` field may be returned, which contains the following fields: - **`unit:missing`**: Radar detected units at the address, but no unit was specified.