Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Address validate docs update for recordType / propertyType #577

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Address validate docs update for recordType / propertyType #577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/api.mdx → docs/Address validate docs update
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
Loading