Skip to main content
POST
Verifica indirizzo

Authorizations

x-api-key
string
header
required

Body

application/json
carrierCompanyId
number
required

ID connessione corriere-company (da GET /integrations/carriers)

Example:

12

provincia
string
required

Sigla provincia (es. TO, MI, RM)

Example:

"TO"

city
string
required

Comune

Example:

"Torino"

address
string
required

Indirizzo (via e numero civico)

Example:

"Via Roma 1"

zip
string
required

CAP

Example:

"10121"

country
string

Codice paese ISO alpha-2 (default: IT)

Example:

"IT"

Response

200 - application/json
status
enum<string>
required

Esito sintetico della verifica. success = indirizzo ok; warning = correzione suggerita o non trovato; error = indirizzo non valido o errore; skipped = verifica saltata (estero o corriere offline); unsupported = corriere senza API di verifica.

Available options:
success,
warning,
error,
skipped,
unsupported
Example:

"success"

code
enum<string>
required

Codice esito verifica indirizzo. Vedi la tabella dei codici.

Available options:
ADDRESS_VALID,
ADDRESS_NORMALIZED,
ADDRESS_NOT_FOUND,
ADDRESS_INVALID,
VERIFICATION_SKIPPED_FOREIGN,
VERIFICATION_SKIPPED_UNSUPPORTED,
VERIFICATION_ERROR,
CARRIER_UNAVAILABLE
Example:

"ADDRESS_VALID"

message
string
required

Messaggio leggibile in italiano, derivato da code e dal corriere utilizzato.

Example:

"Indirizzo verificato con BRT."

carrierCode
string
required

Codice corriere E-Manager (es. GLS, BRT, FEDEX, MYDHL, POSTEDB).

Example:

"BRT"

carrierName
string
required

Nome commerciale del corriere.

Example:

"BRT"

verificationType
enum<string>
required

Tipo di verifica applicato dal corriere. Vedi la tabella verificationType.

Available options:
street_registry,
routing,
postal_validation,
transit_time,
none
Example:

"street_registry"

countryScope
enum<string>
required

Ambito geografico della verifica: domestic_it (solo Italia), international (validazione postale globale), any (corriere senza verifica o non supportato).

Available options:
domestic_it,
international,
any
Example:

"domestic_it"

suggestions
object[]
required

Indirizzi suggeriti dal corriere (normalizzazione o alternative). Vuoto se non trovato, skip o errore.