Errors
All of our error responses contain an error
top-level object. This is what it looks like.
Name | Type | Description |
---|---|---|
type | string | An computer friendly stable string like invalid_pdf_error |
message | string | A 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 Error | Description |
---|---|
Alternate | The Input value has been changed to an alternate value |
Would not fit | The input does not fit within the required address field |
Incorrect Value | The input value is incorrect |
Missing Value | The input value is missing |
Typo in Value | Typing error in the input value |
Verbosity | The input value is unnecessarily lengthy, redundant, or overly detailed, making it harder for the system to read and understand |
Secondary Error | Description |
---|---|
Addressee and/or Additional Delivery Information | The name of the recipient and any extra delivery instructions |
Complete Street Information | The complete street address, including house or building number, street name, and type |
Civic number | The numeric portion of the street address, representing the house or building number |
Civic number suffix | Any additional characters or letters that accompany the civic number |
Street name | The designated name of the street |
Street type | The classification of the street, such as Avenue, Road, or Boulevard |
Street direction | The cardinal direction (N, S, E, W) associated with the street name |
Suite keyword | The term used to indicate the presence of a suite, such as "Apt", "Unit", or "Ste" |
Suite identifier | The number or letter that specifies a particular suite, unit, or apartment within a building |
Delivery Information | General information pertaining to how and where the delivery should be made |
Complete Route Service Information | The full route service details, typically used in rural delivery systems |
Route Service Keyword | A term indicating the type of route service, such as "RR" for Rural Route |
Route Service identifier | The numeric or alphanumeric identifier associated with a specific route service |
Complete PO Box/Bag Information | The entire PO Box or bag address information for mail destined for post office storage |
PO Box/Bag keyword | The term indicating PO Box or bag for delivery, e.g., "PO Box" |
PO Box/Bag identifier | The number or code assigned to a specific PO Box or mail bag |
Complete General Delivery Information | Full details for general delivery; used when a recipient has no fixed address |
General Delivery keyword | The term used for mail pickup at a post office by someone without a fixed address; Temporary mailing address |
Complete Delivery Installation Information | Details regarding the post office or delivery facility where mail is processed |
Delivery Installation Area Name | The name of a village, town, city or metropolitan area which is served by a postal delivery installation |
Delivery Installation Type | The classification of the postal installation, such as "Post Office", "Mail Depot", "Lock box address" etc. |
Delivery Installation Qualifier | Identifies the portion of the area served by the installation. |
Municipality | The city or town where the recipient is located |
Province | The provincial designation in the address |
Postal Code | The 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 Error | Description |
---|---|
Rural validated on postal code only | The 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 address | Address Verification failed because the system couldn't find a match for the address in the USPS or Canada Post database. |
Not enough information | Address 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
- line1: Incorrect Value: Suite identifier
- generic: Missing Value: Complete Street Information; city: Incorrect Value: Municipality
- line1: Missing Value: Suite identifier
- generic: Unable to find a match for this address
- generic: Not enough information.
- city: Missing Value: Municipality
Updated 3 months ago