Skip to content

FedEx - Validate Address

This module validates a shipping address using the FedEx Address Validation service. It receives the address lines (separated by line breaks), city, state/province, zip code, and country. It makes a POST request to the /address/v1/addresses/resolve endpoint and returns the resolved address, classification (RESIDENTIAL or BUSINESS), residential indicator, and additional attributes.

ParameterTypeRequiredDescription
credentials_idcredentialsYesFedEx credential (provider: fedex)
street_linestextareaYesAddress lines separated by line breaks
citytextYesCity
state_or_provincetextYesState or province
postal_codetextYesZip code
country_codetextYesISO country code (default: US)

A fedex type credential is required with the following fields:

  • client_id: FedEx API Client ID
  • client_secret: FedEx API Client Secret
{
"success": true,
"resolved_address": {
"streetLinesToken": ["123 MAIN ST"],
"city": "MEMPHIS",
"stateOrProvinceCode": "TN",
"postalCode": "38118",
"countryCode": "US"
},
"classification": "RESIDENTIAL",
"is_residential": true,
"attributes": {},
"message": "Direccion validada: RESIDENTIAL"
}
{
"credentials_id": "mi_credencial_fedex",
"street_lines": "123 Main Street\nApt 4B",
"city": "Memphis",
"state_or_province": "TN",
"postal_code": "38118",
"country_code": "US"
}
  • Address lines are separated by line breaks and empty lines are filtered out
  • The classification indicates whether the address is RESIDENTIAL or BUSINESS
  • The is_residential field is a boolean derived from the classification
  • Useful for determining residential surcharges before creating a shipment