Verify shipping addresses in real-time around the world.
This API end point is for validating US addresses only.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from SnapCX |
requestId | String | Mandatory Client provided unique request id. Same request_id is returned as part of response header. |
street | String | Mandatory Address line 1. It’s needed for any address validation |
secondaryStreet | String | Optional Address line2, if it’s there. Examples are apt# or suite# etc. |
city | String | Optional City & State OR zipcode should be present at least. If city & state are present then zipcode is ignored. |
state | String | Optional 2 char valid USA state code. Example: NY / NJ / CA etc. |
zipcode | String | Optional 5 digit US zipcode |
This API end point is for validating global addresses.
Field | Type | Description |
---|---|---|
apiKey | credentials | Api key obtained from SnapCX |
requestId | String | Mandatory Client provided unique request id. Same request_id is returned as part of response header. |
street | String | Mandatory Address line 1. It’s needed for any address validation |
country | String | Country name or ISO 3-char or ISO 2-char country code. Examples USA, CAN, AU etc. |
secondaryStreet | String | Optional Address line2, if it’s there. Examples are apt# or suite# etc. |
city | String | Optional City & State OR zipcode should be present at least. If city & state are present then zipcode is ignored. |
state | String | Dependending upon country. |
zipcode | String | Optional 5 digit US zipcode |