All of our error responses contain an error top-level object. This is what it looks like.

NameTypeDescription
typestringAn computer friendly stable string like invalid_pdf_error
messagestringA human-readable description of the error

PostGrid uses standard HTTP codes to indicate successful or failed API requests. Successful operations will return 2xx codes. Responses with 4xx codes usually indicate input errors and 5xx codes indicate a server error.

Please refer to our API documentation for more details.

Contacts - Address Verification Errors

PostGrid offers free Address Verification for North American addresses to ensure deliverability of mailings. Please note that address verification is available only in LIVE mode. In TEST mode, all contacts are automatically marked as verified.

Primary ErrorDescription
AlternateThe Input value has been changed to an alternate value
Would not fitThe input does not fit within the required address field
Incorrect ValueThe input value is incorrect
Missing ValueThe input value is missing
Typo in ValueTyping error in the input value
VerbosityThe input value is unnecessarily lengthy, redundant, or overly detailed, making it harder for the system to read and understand
Secondary ErrorDescription
Addressee and/or Additional Delivery InformationThe name of the recipient and any extra delivery instructions
Complete Street InformationThe complete street address, including house or building number, street name, and type
Civic numberThe numeric portion of the street address, representing the house or building number
Civic number suffixAny additional characters or letters that accompany the civic number
Street nameThe designated name of the street
Street typeThe classification of the street, such as Avenue, Road, or Boulevard
Street directionThe cardinal direction (N, S, E, W) associated with the street name
Suite keywordThe term used to indicate the presence of a suite, such as "Apt", "Unit", or "Ste"
Suite identifierThe number or letter that specifies a particular suite, unit, or apartment within a building
Delivery InformationGeneral information pertaining to how and where the delivery should be made
Complete Route Service InformationThe full route service details, typically used in rural delivery systems
Route Service KeywordA term indicating the type of route service, such as "RR" for Rural Route
Route Service identifierThe numeric or alphanumeric identifier associated with a specific route service
Complete PO Box/Bag InformationThe entire PO Box or bag address information for mail destined for post office storage
PO Box/Bag keywordThe term indicating PO Box or bag for delivery, e.g., "PO Box"
PO Box/Bag identifierThe number or code assigned to a specific PO Box or mail bag
Complete General Delivery InformationFull details for general delivery; used when a recipient has no fixed address
General Delivery keywordThe term used for mail pickup at a post office by someone without a fixed address; Temporary mailing address
Complete Delivery Installation InformationDetails regarding the post office or delivery facility where mail is processed
Delivery Installation Area NameThe name of a village, town, city or metropolitan area which is served by a postal delivery installation
Delivery Installation TypeThe classification of the postal installation, such as "Post Office", "Mail Depot", "Lock box address" etc.
Delivery Installation QualifierIdentifies the portion of the area served by the installation.
MunicipalityThe city or town where the recipient is located
ProvinceThe provincial designation in the address
Postal CodeThe alphanumeric code assigned to the recipient's specific geographic area

All Secondary Error Details can potentially be paired with each of the Primary Errors, except for the following:

Primary ErrorDescription
Rural validated on postal code onlyThe input address was identified as rural. For such addresses, Canada Post only provides data to verify the postal code's validity, not the specific details of individual houses or streets.
Unable to find a match for this addressAddress Verification failed because the system couldn't find a match for the address in the USPS or Canada Post database.
Not enough informationAddress verification failed because the provided information is insufficient for the system to find a match in the USPS or Canada Post database.

Sample Error Combinations

  1. line1: Incorrect Value: Suite identifier
  2. generic: Missing Value: Complete Street Information; city: Incorrect Value: Municipality
  3. line1: Missing Value: Suite identifier
  4. generic: Unable to find a match for this address
  5. generic: Not enough information.
  6. city: Missing Value: Municipality