Skip to main content

Verify Address

The API for address verification is used to verify the accuracy of a given address. This can include verifying the existence of a specific address, checking its postal code, verifying its format, and verifying that it is a deliverable address.

info

You need to verify the address of a shipper just after adding a shipper

URL Config
Endpoint: https://api-stage.dps.io/api
APIVersion: v1
route: addresses/verify-address
path:
Method
POST
URL
https://api-stage.dps.io/api/v1/addresses/verify-address
Request Headers
{
  "x-api-key": "<YOUR_API_KEY>",
  "Content-Type": "application/json"
}
Request Body
{
    "Address1": "12575 Placida RD",
    "Address2": "Plaicda",
    "City": "Placida",
    "CompanyName": "My Test Company 1",
    "PersonName": "John Doe",
    "Phone": "9729729720",
    "State": "FL",
    "Zip": "33946"
}
Curl request
curl --location --request POST 'https://api-stage.dps.io/api/v1/addresses/verify-address' \
--header 'x-api-key: xxxxxxdfjbdjdfjdhfxxxxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Address1": "12575 Placida RD",
    "Address2": "Plaicda",
    "City": "Placida",
    "CompanyName": "My Test Company 1",
    "PersonName": "John Doe",
    "Phone": "9729729720",
    "State": "FL",
    "Zip": "33946",
    "Provider": "usps"
}'
Response
{
    "addressCorrection": {
        "status": "0",
        "description": "Success",
        "addresses": {
            "address": {
                "name": "John Doe",
                "organization": "My Test Company 1",
                "address1": "Plaicda",
                "address2": "12575 Placida Rd",
                "city": "Placida",
                "state": "FL",
                "zip": "33946-2135",
                "country": "UNITED STATES",
                "fineCorrectionMessage": "No significant changes",
                "coarseCorrectionMessage": "No Changes",
                "standard": "true",
                "international": "false",
                "nonMailable": "false"
            }
        }
    }
}
Error

In case of multiple addresses you will get an error with error code 400