Skip to content

Validate Address

Overview

Address validation is a critical component for logistics. The API seamlessly integrates into existing systems, providing real-time validation for addresses entered by users. This ensures that the information captured is accurate, complete, and adheres to postal standards.

Basic Information

  • Schemas     : HTTPS
  • Host             : api.ils.live
  • Consumes   : application/json
  • Produces     : application/json

Operations

Paths

validateAddress

  • POST /api/address/validate

Description

Returns the validated address and validation status.

Parameters

TypeNameDescriptionSchema
Bodybody
required		The request schema for the validate address operation. Validate Address Request Schema 

{
 "address_line1": "219 s poplar ave",
 "address_line2": "",
 "address_line3": "",
 "city": "Brea",
 "state_province": "CA",
 "country_code": "US",
 "postal_code": "92821",
 "is_residential": true
}

Responses

HTTP Code Description Schema
200 Success.

Headers:
  • X-Rate-Limit-Limit (number): The maximum number of API calls.
  • X-Rate-Limit-Remaining (number): The remaining number of API calls.
  • X-Rate-Limit-Reset (number): The time internal to reset the API call count.
 Validate Address Response Schema 

{
 "results": [
  {
   "is_valid": true,
   "score": 100,
   "verifiedBy": "FedEx",
   "matchedAddress": {
    "address_line1": "219 s poplar ave",
    "address_line2": "",
    "address_line3": "",
    "city": "Brea",
    "state_province": "CA",
    "country_code": "US",
    "postal_code": "92821",
    "is_residential": true
   },
   "message": "Resolved 1 address(es)",
   "success": true
  }
 ],
 "statusCode": "Ok",
 "statusInfoSet": {
  "ils_codeMajor": "success",
  "ils_codeMinor": "full success",
  "ils_codeSeverity": "status",
  "ils_description": "The request completed successfully."
 }
}
400 Bad Request.

Headers:
  • X-Rate-Limit-Limit (number): The maximum number of API calls.
  • X-Rate-Limit-Remaining (number): The remaining number of API calls.
  • X-Rate-Limit-Reset (number): The time internal to reset the API call count.
 Error Status Info Schema 

{
 "errors": [
  {
   "location": "address_line1",
   "reason": "required",
   "message": "The address_line1 cannot be blank or empty"
  }
 ],
 "statusCode": "Bad Request",
 "statusInfoSet": {
  "ils_codeMajor": "failure",
  "ils_codeMinor": "invalid data",
  "ils_codeSeverity": "error",
  "ils_description": "Invalid data posted in the request payload."
 }
}
401 Unauthorized.

Headers:
  • X-Rate-Limit-Limit (number): The maximum number of API calls.
  • X-Rate-Limit-Remaining (number): The remaining number of API calls.
  • X-Rate-Limit-Reset (number): The time internal to reset the API call count.
 Error Status Info Schema 

{
 "statusCode": "Unauthorized",
 "statusInfoSet": {
  "ils_codeMajor": "failure",
  "ils_codeMinor": "unauthorized",
  "ils_codeSeverity": "error",
  "ils_description": "Invalid client credentials provided."
 }
}
429 Too Many Requests.

Headers:
  • X-Rate-Limit-Limit (number): The maximum number of API calls.
  • X-Rate-Limit-Remaining (number): The remaining number of API calls.
  • X-Rate-Limit-Reset (number): The time internal to reset the API call count.
 Error Status Info Schema 

{
 "statusCode": "Too Many Requests",
 "statusInfoSet": {
  "ils_codeMajor": "failure",
  "ils_codeMinor": "too many requests",
  "ils_codeSeverity": "error",
  "ils_description": "Quota exceeded. Maximum allowed: 120 per minute. Please try again in 38 second(s)."
 }
}
500 Internal Server Error.

Headers:
  • X-Rate-Limit-Limit (number): The maximum number of API calls.
  • X-Rate-Limit-Remaining (number): The remaining number of API calls.
  • X-Rate-Limit-Reset (number): The time internal to reset the API call count.
 Error Status Info Schema 

{
 "statusCode": "Internal Server Error",
 "statusInfoSet": {
  "ils_codeMajor": "failure",
  "ils_codeMinor": "system failure",
  "ils_codeSeverity": "error",
  "ils_description": "Exception Occurred."
 }
}

Schemas

Validate Address Request

Field Required Type Description
address_line1 string Indicate the combination of number, street name. etc. Recommended limit per line is 35 characters.
address_line2 string Indicate the combination of number, street name. etc. Recommended limit per line is 35 characters.
address_line3 string Indicate the combination of number, street name. etc. Recommended limit per line is 35 characters.
city string Indicate the name of city, town, etc.
state_province string Indicate the State or Province codes. The Format and presence of this field may vary depending on the country.
country_code string Specify the ISO Alpha2 code of the country.
postal_code string Indicate the Postal Code which is an identification code of a region (usually small) for easier and accurate mail/package delivery. The format and presence of this field may vary depending on the country.
is_residential boolean Indicate whether the address is residential.

Validate Address Response

Field Type Description
results list List of address result objects.
results\is_valid boolean Indicates whether it is valid address.
results\score number Indicates the address validation score value.
results\verifiedBy string The possible values are: FedEx, Stamps.
results\matchedAddress object The potentially matached address object.
results\matchedAddress\address_line1 string Indicates the combination of number, street name. etc.
results\matchedAddress\address_line2 string Indicates the combination of number, street name. etc.
results\matchedAddress\address_line3 string Indicates the combination of number, street name. etc.
results\matchedAddress\city string Indicates the name of city, town, etc.
results\matchedAddress\state_province string Indicates the State or Province codes. The Format and presence of this field may vary depending on the country.
results\matchedAddress\country_code string Specifies the ISO Alpha2 code of the country.
results\matchedAddress\postal_code string Indicates the Postal Code which is an identification code of a region (usually small) for easier and accurate mail/package delivery. The format and presence of this field may vary depending on the country.
results\matchedAddress\is_residential boolean Indicates whether the address is residential.
statusCode string The HTTP Status Code for the response.
statusInfoSet\ils_codeMajor string The possible values are: success, failure.
statusInfoSet\ils_codeMinor string The possible values are: full success, partial success, unknown object, invalid data, unauthorized, forbidden, server_busy.
statusInfoSet\ils_codeSeverity string The possible values are: status, error, warning.
statusInfoSet\ils_description string A text string providing a human readable description of the error that happened.

Error Status Info

Field Type Description
errors list List of error message objects.
errors\location string Location of the error message. Ideally this is a field where the error occurred.
errors\reason string The reason for the error.
errors\message string Detailed error description.
statusCode string The HTTP Status Code for the response.
statusInfoSet\ils_codeMajor string The possible values are: success, failure.
statusInfoSet\ils_codeMinor string The possible values are: full success, partial success, unknown object, invalid data, unauthorized, forbidden, server_busy.
statusInfoSet\ils_codeSeverity string The possible values are: status, error, warning.
statusInfoSet\ils_description string A text string providing a human readable description of the error that happened.
Copyright © 2024 - 2025 jeztech.com