Validate an Address

Shipping to an incorrect address can be costly and leave a customer feeling less than satisfied. ShipCaddie cross references multiple databases to ensure accurate address validation to eliminate any potential shipping issues that may arise.

Available Countries

ShipCaddie supports address validation from every country on PGA tour plus 240+ countries and territories

Example

POST /api/v2.1/ValidateAddress

This is a full request you can make to the address verification service.

POST /api/v2.1/ValidateAddress

{

    "accessToken": "lKGTGI…",
    "addressToValidate": {
        "address1": "2600 Executive Parkway",
        "address2": "STE 160",
        "city": "Lehi",
        "countryCode": "US",
        "stateOrProvidence": "UT",
        "postalCode": "84043",
        "isResidential": false
    }
}

The Address Validation Response is provided for every address sent to the Address Validator, in the order it was received.

POST /api/v2.1/ValidateAddress

{
    "addressIsValidated": true,
       "validatedAddress": {
        "address1": "2600 W EXECUTIVE PKWY",
        "address2": "STE 160",
        "city": "LEHI",
        "countryCode": "US",
        "stateOrProvidence": "UT",
        "postalCode": "84043-3987",
        "isResidential": false,
	"companyName": null,
       },
    "error": {
        "details": [],
        "hasError": false
    }
}
Validate StatusDescription
trueAddress was successfully verified.
falseThe address could not be validated with any degree of certainty against the database.
Auto CorrectedThe address was validated, but an auto correction took place.

Sample Responses

Validate True

{
    "addressIsValidated": true,
       "validatedAddress": {
        "address1": "2600 W EXECUTIVE PKWY",
        "address2": "STE 160",
        "city": "LEHI",
        "countryCode": "US",
        "stateOrProvidence": "UT",
        "postalCode": "84043-3987",
        "isResidential": false,
	"companyName": null,
       },
    "error": {
        "details": [],
        "hasError": false
    }
}

Validate False

{
    "addressIsValidated": false,
    "validationMessages": [],
    "validatedAddress": {
        "address1": "",
        "address2": "",
        "city": "",
        "countryCode": "",
        "stateOrProvidence": "",
        "postalCode": "",
        "isResidential": false,
        "attentionOf": "",
        "companyName": "",
        "email": "",
        "phoneNumber": ""
    },
    "error": {
        "details": [
            "Address Validation Error"
        ],
        "hasError": true
    }
}

Auto Corrected Status

{
    "addressIsValidated": true,
    "validationMessages": [
        {
            "code": "Auto corrected",
            "message": "Some of the fields are auto corrected based on suggestions"
        }
    ],
    "validatedAddress": {
        "address1": "2600 W EXECUTIVE PKWY",
        "address2": "STE 160",
        "city": "LEHI",
        "countryCode": "US",
        "stateOrProvidence": "UT",
        "postalCode": "84043-3987",
        "isResidential": false,
        "attentionOf": "",
        "companyName": null,
        "email": "",
        "phoneNumber": ""
    },
    "error": {
        "details": [],
        "hasError": false
    }
}

Powered by BetterDocs

Leave A Comment

Go to Top