Saltar al contenido
/Address Validation

Address Validation

Operaciones

Validación de direcciones

Solicitud

La API de Validación de Direcciones verifica la validez de las direcciones nacionales de EE. UU. y devuelve los componentes de la dirección estandarizados de acuerdo con los estándares de direcciones de USPS®. Esto ayuda a mejorar la precisión de entrega, reducir el correo no entregable y favorecer una tarificación consistente para envíos y logística.

Seguridad
BearerAuth
Cuerpoapplication/jsonrequerido
streetstringrequerido

El número del edificio junto con el nombre de la vía o calle en la que se encuentra.

Ejemplo:"xxxx Olive Street"
street2string

El identificador de unidad secundaria, como el número de apartamento (APT) o suite (STE), que define la ubicación exacta de la dirección dentro de un edificio.

Ejemplo:"STE XXX"
citystringrequerido

Nombre de la ciudad de la dirección.

Ejemplo:"Los Angeles"
statestringrequerido
  • Para direcciones de EE. UU., este campo debe ser un código de estado válido de dos letras (por ejemplo, "CA" para California, "NY" para Nueva York).
  • Para direcciones fuera de EE. UU., no existe restricción sobre el valor.
Ejemplo:"CA"
zip_codestringrequerido

Código postal de la dirección.

Ejemplo:"021XX"
countrystringrequerido

Código de país de 2 letras. El valor de este campo será un código de dos dígitos ISO 3166-1.

Ejemplo:"US"
POST
/api/address/validate
curl -i -X POST \
  https://x-api.shipsaving.com/api/address/validate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "street": "xxxx Olive Street",
    "street2": "STE XXX",
    "city": "Los Angeles",
    "state": "CA",
    "zip_code": "021XX",
    "country": "US"
  }'

Respuestas

OK

Cuerpoapplication/json
codestring

Código de resultado.

Ejemplo:"ok"
msgstring

Mensaje legible por humanos.

Ejemplo:"ok"
dataobject(ValidatedAddress)
Response
{
  "code": "ok",
  "msg": "ok",
  "data": {
    "street": "17XXX Tremont ST",
    "street2": null,
    "city": "Los Angeles",
    "state": "CA",
    "zip": "02111-XXXX",
    "country": "US",
    "residential": true,
    "errored": true,
    "corrected": true,
    "standardized": false,
    "errors": [ … ],
    "corrections": [ … ]
  }
}