- Requête HTTP
- Corps de la requête
- Corps de la réponse
- PostalAddress
- LanguageOptions
- ValidationResult
- Verdict
- Précision
- Adresse
- AddressComponent
- ComponentName
- ConfirmationLevel
- Géocode
- LatLng
- PlusCode
- Fenêtre d'affichage
- AddressMetadata
- UspsData
- UspsAddress
Valide une adresse.
Requête HTTP
POST https://addressvalidation.googleapis.com/v1:validateAddress
L'URL utilise la syntaxe de transcodage gRPC.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
---|
{ "address": { object ( |
Champs | |
---|---|
address |
Obligatoire. Adresse en cours de validation. Les adresses sans mise en forme doivent être envoyées via La longueur totale des champs de cette entrée ne doit pas dépasser 280 caractères. Pour connaître les régions acceptées, cliquez ici. La valeur L'API Address Validation ignore les valeurs de |
previousResponseId |
Ce champ doit être vide pour la première demande de validation d'adresse. Si davantage de demandes sont nécessaires pour valider entièrement une seule adresse (par exemple, si les modifications apportées par l'utilisateur après la validation initiale doivent être revalidées), chaque demande de suivi doit renseigner ce champ avec la valeur |
enableUspsCass |
Active le mode compatible USPS CASS. Cela ne concerne que le champ Nous vous recommandons d'utiliser un |
languageOptions |
Facultatif. Aperçu: cette fonctionnalité est en phase de preview (pré-DG). La compatibilité des fonctionnalités et produits pré-DG peut être limitée, et il se peut que les modifications apportées à ces fonctionnalités ou produits ne soient pas compatibles avec d'autres versions pré-DG. Les offres en pré-DG sont couvertes par les Conditions spécifiques du service Google Maps Platform. Pour en savoir plus, consultez les descriptions des étapes de lancement. Permet à l'API Address Validation d'inclure des informations supplémentaires dans la réponse. |
sessionToken |
Facultatif. Chaîne qui identifie une session de saisie semi-automatique à des fins de facturation. Il doit s'agir d'une chaîne en base64 avec nom de fichier et URL ne dépassant pas 36 caractères ASCII. Sinon, une erreur INVALID_ARGUMENT est renvoyée. La session commence lorsque l'utilisateur effectue une requête Autocomplete, et se termine lorsqu'il sélectionne un lieu et qu'un appel à Place Details ou Address Validation est effectué. Chaque session peut comporter plusieurs requêtes Autocomplete, suivies d'une requête Place Details ou Address Validation. Les identifiants utilisés pour chaque requête au cours d'une session doivent appartenir au même projet de la console Google Cloud. Une fois la session terminée, le jeton n'est plus valide. Votre application doit générer un nouveau jeton pour chaque session. Si le paramètre Remarque: Address Validation ne peut être utilisée que dans les sessions avec l'API Autocomplete (New) et non avec l'API Autocomplete. Pour en savoir plus, consultez la page https://developers.google.com/maps/documentation/places/web-service/session-pricing. |
Corps de la réponse
Réponse à une requête de validation d'adresse.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{
"result": {
object ( |
Champs | |
---|---|
result |
Résultat de la validation de l'adresse. |
responseId |
UUID qui identifie cette réponse. Si l'adresse doit être validée à nouveau, cet UUID doit accompagner la nouvelle demande. |
PostalAddress
Représente une adresse postale, telles que des adresses de livraison ou de paiement. Les services postaux peuvent effectuer une livraison à cette adresse, boîte postale ou autre. Ce champ n'a pas vocation à modéliser des emplacements géographiques (routes, villes ou montagnes).
Généralement, une adresse est créée via une saisie utilisateur ou lors de l'importation de données existantes, en fonction du type de processus.
Conseils pour la saisie / modification des adresses : utilisez un widget d'adresse adapté à l'internationalisation, tel que https://github.com/google/libaddressinput. Les utilisateurs ne doivent pas voir les éléments d'interface utilisateur permettant de saisir ou de modifier des champs en dehors des pays où ce champ est utilisé.
Pour en savoir plus sur l'utilisation de ce schéma, consultez la page https://support.google.com/business/answer/6397478.
Représentation JSON |
---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
Champs | |
---|---|
revision |
Révision du schéma de |
regionCode |
Facultatif. Code pays/région CLDR de l'adresse. Pour en savoir plus, consultez les pages https://cldr.unicode.org/ et https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemple : "CH" pour la Suisse. Si le code régional n'est pas fourni, il sera déduit de l'adresse. Pour optimiser les performances, nous vous recommandons d'inclure le code de région si vous le connaissez. Des régions incohérentes ou répétées peuvent nuire aux performances. Par exemple, si |
languageCode |
Le code de langue de l'adresse d'entrée est réservé pour une utilisation future et est ignoré aujourd'hui. L'API renvoie l'adresse dans la langue correspondant à son emplacement. |
postalCode |
Facultatif. Code postal de l'adresse. Tous les pays n'utilisent pas ou n'exigent pas de codes postaux, mais lorsqu'ils s'en servent, ils peuvent déclencher une validation supplémentaire avec d'autres parties de l'adresse (par exemple, validation par État/code postal aux États-Unis). |
sortingCode |
Facultatif. Code de tri supplémentaire, spécifique à chaque pays. La plupart des régions ne s'en servent pas. Lorsqu'il est utilisé, sa valeur comprend une chaîne de type CEDEX, éventuellement suivie d'un numéro (par exemple CEDEX 7), ou tout simplement un nombre représentant un "code de secteur" (Jamaïque), un "indicateur de zone de livraison" (Malawi) ou un "indicateur postal" (Côte d'Ivoire, par exemple). |
administrativeArea |
Facultatif. Plus haute subdivision administrative utilisée pour les adresses postales d'un pays ou d'une région. Par exemple, il peut s'agir d'un État, d'une province, d'un oblast ou d'une préfecture. Plus précisément, pour l'Espagne, il s'agit de la province et non de la communauté autonome (par exemple, "Barcelone" et non "Catalogne"). De nombreux pays n'utilisent pas de région administrative dans leurs adresses postales. Par exemple, ce champ doit rester vide en Suisse. |
locality |
Facultatif. Fait généralement référence à la ville de l'adresse. Exemples : une "city" aux États-Unis, une "comune" en Italie, une "post town" au Royaume-Uni. Dans les régions du monde où les localités ne sont pas bien définies ou ne s'intègrent pas bien dans cette structure, laissez le champ de localité vide et utilisez addressLines. |
sublocality |
Facultatif. Sous-localité de l'adresse. Il peut s'agir, par exemple, de quartiers, d'arrondissements ou de districts. |
addressLines[] |
Obligatoire. Lignes d'adresse non structurées décrivant les niveaux inférieurs d'une adresse. |
recipients[] |
Veuillez ne pas définir ce champ. L'API Address Validation ne l'utilise pas actuellement. Bien que, pour le moment, l'API ne rejette pas les requêtes comportant ce champ, les informations qu'elle contient seront ignorées et ne seront pas renvoyées dans la réponse. |
organization |
Veuillez ne pas définir ce champ. L'API Address Validation ne l'utilise pas actuellement. Bien que, pour le moment, l'API ne rejette pas les requêtes comportant ce champ, les informations qu'elle contient seront ignorées et ne seront pas renvoyées dans la réponse. |
LanguageOptions
Aperçu: cette fonctionnalité est en phase de preview (pré-DG). La compatibilité des fonctionnalités et produits pré-DG peut être limitée, et il se peut que les modifications apportées à ces fonctionnalités ou produits ne soient pas compatibles avec d'autres versions pré-DG. Les offres en pré-DG sont couvertes par les Conditions spécifiques du service Google Maps Platform. Pour en savoir plus, consultez les descriptions des étapes de lancement.
Permet à l'API Address Validation d'inclure des informations supplémentaires dans la réponse.
Représentation JSON |
---|
{ "returnEnglishLatinAddress": boolean } |
Champs | |
---|---|
returnEnglishLatinAddress |
Aperçu: renvoyez un |
ValidationResult
Résultat de la validation d'une adresse.
Représentation JSON |
---|
{ "verdict": { object ( |
Champs | |
---|---|
verdict |
Options d'évaluation globale |
address |
Informations sur l'adresse elle-même, par opposition au géocode. |
geocode |
Informations sur le lieu et le lieu avec lesquels l'adresse a été géocodée. |
metadata |
Autres informations pertinentes pour la livraison. Il n'est pas garanti que le champ |
uspsData |
Indicateurs de livraison supplémentaires fournis par USPS. Uniquement disponible dans les régions |
englishLatinAddress |
Aperçu: cette fonctionnalité est en phase de preview (pré-DG). La compatibilité des fonctionnalités et produits pré-DG peut être limitée, et il se peut que les modifications apportées à ces fonctionnalités ou produits ne soient pas compatibles avec d'autres versions pré-DG. Les offres en pré-DG sont couvertes par les Conditions spécifiques du service Google Maps Platform. Pour en savoir plus, consultez les descriptions des étapes de lancement. Adresse traduite en anglais. Les adresses traduites ne sont pas réutilisables en tant qu'entrées d'API. Grâce à ce service, l'utilisateur peut confirmer ou refuser la validation de l'adresse initialement fournie dans sa langue maternelle. Si une partie de l'adresse n'est pas traduite en anglais, le service la renvoie dans une autre langue utilisant des caractères latins. Pour savoir comment l'autre langue est sélectionnée, cliquez ici. Si une partie de l'adresse ne comporte pas de traduction ni de translittération dans une langue utilisant l'alphabet latin, le service renvoie cette partie dans la langue locale associée à l'adresse. Activez cette sortie à l'aide de l'option Remarque: Le champ |
Verdict
Présentation générale du résultat de validation de l'adresse et du géocode.
Représentation JSON |
---|
{ "inputGranularity": enum ( |
Champs | |
---|---|
inputGranularity |
Précision de l'adresse d'entrée. Il s'agit du résultat de l'analyse de l'adresse d'entrée et ne fournit aucun signal de validation. Pour les signaux de validation, reportez-vous à Par exemple, si l'adresse saisie inclut un numéro d'appartement spécifique, |
validationGranularity |
Niveau de précision auquel l'API peut entièrement validate l'adresse. Par exemple, un Le résultat de la validation par composant d'adresse est disponible dans |
geocodeGranularity |
Informations sur la précision de Cette valeur peut parfois être différente des |
addressComplete |
L'adresse est considérée comme complète s'il n'y a pas de jetons non résolus ni de composants d'adresse inattendus ou manquants. Si cette règle n'est pas configurée, la valeur est |
hasUnconfirmedComponents |
Au moins un composant d'adresse ne peut pas être catégorisé ni validé. Consultez |
hasInferredComponents |
Nous avons déduit au moins un composant d'adresse qui ne figurait pas dans l'entrée. Pour en savoir plus, consultez |
hasReplacedComponents |
Au moins un composant d'adresse a été remplacé. Pour en savoir plus, consultez |
Précision
Il s'agit des différents niveaux de précision d'une adresse ou d'un géocode. Lorsqu'elles sont utilisées pour indiquer le niveau de précision d'une adresse, ces valeurs indiquent le degré de précision avec lequel l'adresse peut identifier une destination postale. Par exemple, une adresse telle que "123 Main Street, Redwood City, CA 94061" identifie un PREMISE
, tandis qu'une adresse du type "Redwood City, CA, 94061" identifie un LOCALITY
. Toutefois, si nous ne trouvons pas de géocode pour le "123 Main Street" à Redwood City, le géocode renvoyé peut être de précision LOCALITY
, même si l'adresse est plus précise.
Enums | |
---|---|
GRANULARITY_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
SUB_PREMISE |
Résultat d'un niveau inférieur au bâtiment, tel qu'un appartement. |
PREMISE |
Résultat au niveau du bâtiment. |
PREMISE_PROXIMITY |
Géocode indiquant approximativement l'emplacement au niveau du bâtiment de l'adresse. |
BLOCK |
L'adresse ou le géocode indique un bloc. Utilisé uniquement dans les régions qui disposent d'un adressage au niveau du bloc, comme le Japon. |
ROUTE |
Le géocode ou l'adresse sont granulaires pour l'itinéraire, comme une rue, une route ou une autoroute. |
OTHER |
Toutes les autres niveaux de précision, qui sont regroupés, car ils ne peuvent pas être diffusés. |
Adresse
Détails de l'adresse post-traitée. Le post-traitement consiste à corriger les parties mal orthographiées de l'adresse, à remplacer les éléments incorrects et à déduire les parties manquantes.
Représentation JSON |
---|
{ "formattedAddress": string, "postalAddress": { object ( |
Champs | |
---|---|
formattedAddress |
Adresse post-traitée, qui prend la forme d'une adresse sur une seule ligne, conformément aux règles de mise en forme applicables à la région où se trouve l'adresse. |
postalAddress |
Adresse post-traitée représentée sous forme d'adresse postale. |
addressComponents[] |
Liste à puces. Les composants d'adresse individuels de l'adresse mise en forme et corrigée, ainsi que les informations de validation. Vous obtenez ainsi des informations sur l'état de validation de chaque composant. Les composants d'adresse ne sont pas ordonnés d'une manière particulière. Ne faites aucune hypothèse concernant l'ordre des composants d'adresse dans la liste. |
missingComponentTypes[] |
Types de composants qui étaient censés être présents dans une adresse postale valide, mais qui étaient introuvables dans l'entrée ET n'ont pas pu être déduits. Les composants de ce type ne sont pas présents dans |
unconfirmedComponentTypes[] |
Types de composants présents dans le |
unresolvedTokens[] |
Tous les jetons de l'entrée qui n'ont pas pu être résolus. Il peut s'agir d'une entrée qui n'a pas été reconnue comme partie valide d'une adresse (par exemple, dans une entrée telle que "123235253253 Main St, San Francisco, CA, 94105"), les jetons non résolus peuvent ressembler à |
AddressComponent
Représente un composant d'adresse, tel qu'une rue, une ville ou un État.
Représentation JSON |
---|
{ "componentName": { object ( |
Champs | |
---|---|
componentName |
Nom de ce composant. |
componentType |
Type du composant d'adresse. Pour obtenir la liste des types possibles, consultez le Tableau 2: Autres types renvoyés par le service Places. |
confirmationLevel |
Indique le degré de certitude quant à l'exactitude du composant. |
inferred |
Indique que l'élément ne faisait pas partie de l'entrée, mais que nous l'avons déduit pour l'emplacement de l'adresse et que nous pensons qu'il doit être fourni pour une adresse complète. |
spellCorrected |
Indique la correction d'une faute d'orthographe dans le nom du composant. L'API ne signale pas toujours les changements d'orthographe d'une variante orthographique à une autre, comme lors du passage de "centre" à "centre". Par ailleurs, il ne signale pas toujours les fautes d'orthographe courantes, telles que le remplacement de "Amphitheatre Pkwy" par "Amphitheatre Pkwy". |
replaced |
Indique que le nom de l'élément a été remplacé par un nom complètement différent (par exemple, le remplacement d'un code postal incorrect par un code correspondant à l'adresse). Il ne s'agit pas d'une modification esthétique. Le composant d'entrée a été remplacé par un autre. |
unexpected |
Indique un composant d'adresse qui ne devrait pas être présent dans une adresse postale de la région donnée. Nous ne l'avons conservé que parce qu'il faisait partie de l'entrée. |
ComponentName
Wrapper pour le nom du composant.
Représentation JSON |
---|
{ "text": string, "languageCode": string } |
Champs | |
---|---|
text |
Texte du nom. Par exemple, "5e Avenue" pour un nom de rue ou "1253" pour un numéro de rue. |
languageCode |
Code de langue BCP-47. Cet attribut n'est pas indiqué si le nom du composant n'est pas associé à une langue, comme un numéro de rue. |
ConfirmationLevel
Les différentes valeurs possibles pour les niveaux de confirmation.
Enums | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
CONFIRMED |
Nous avons pu vérifier que cet élément existe et qu'il est logique dans le contexte du reste de l'adresse. |
UNCONFIRMED_BUT_PLAUSIBLE |
Ce composant n'a pas pu être confirmé, mais il est possible qu'il existe. Par exemple, un numéro de rue compris dans une plage de numéros valide dans une rue où des numéros de rue spécifiques ne sont pas connus. |
UNCONFIRMED_AND_SUSPICIOUS |
Ce composant n'a pas été confirmé et est probablement incorrect. (un quartier qui ne correspond pas au reste de l'adresse, par exemple). |
Géocoder
Contient des informations sur le lieu dans lequel l'entrée a été géocodée.
Représentation JSON |
---|
{ "location": { object ( |
Champs | |
---|---|
location |
Position géocodée de l'entrée. Il est préférable d'utiliser des ID de lieu plutôt que des adresses, des coordonnées de latitude/longitude ou des codes plus code. Si vous utilisez des coordonnées pour calculer ou calculer un itinéraire, le point sera toujours ancré à la route la plus proche de ces coordonnées. Il ne s'agit peut-être pas d'une route qui conduira rapidement ou de manière sûre à la destination, et peut ne pas se trouver à proximité d'un point d'accès à la propriété. En outre, lorsqu'un établissement fait l'objet d'un geocoding inversé, il n'y a aucune garantie que l'adresse renvoyée corresponde à l'adresse d'origine. |
plusCode |
Plus code correspondant au |
bounds |
Les limites du lieu géocodé. |
featureSizeMeters |
Taille du lieu géocodé, en mètres. Il s'agit d'une autre mesure du caractère grossier du lieu géocodé, mais en taille physique et non sémantique. |
placeId |
PlaceID du lieu vers lequel est géocodé cette entrée. Pour en savoir plus sur les ID de lieu, cliquez ici. |
placeTypes[] |
Type(s) de lieu sur lequel l'entrée a été géocodée. Par exemple, |
LatLng
Objet représentant une paire latitude/longitude. Cette valeur est exprimée par une paire de doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.
Représentation JSON |
---|
{ "latitude": number, "longitude": number } |
Champs | |
---|---|
latitude |
Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0]. |
longitude |
Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0]. |
PlusCode
Les plus codes (http://plus.codes) sont des références de lieu disponibles en deux formats: un code global définissant un rectangle de 14 x 14 m (1/8 000 degrés) ou un rectangle plus petit, et un code composé, qui remplace le préfixe par un emplacement de référence.
Représentation JSON |
---|
{ "globalCode": string, "compoundCode": string } |
Champs | |
---|---|
globalCode |
Code global (complet) du lieu, tel que "9FWM33GV+HQ", représentant une zone de 1/8 000 x 1/8 000 degrés (environ 14 x 14 mètres) |
compoundCode |
Code composé du lieu, tel que "33GV+HQ, Ramberg, Norvège ", contenant le suffixe du code global et remplacé par le nom formaté d'une entité de référence. |
Fenêtre d'affichage
Une fenêtre d'affichage de latitude-longitude, représentée par deux points low
et high
opposés en diagonale. Une fenêtre d'affichage est considérée comme une zone fermée, c'est-à-dire qu'elle inclut ses limites. Les limites de latitude doivent être comprises entre -90 et 90 degrés inclus, et les limites de longitude doivent être comprises entre -180 et 180 degrés inclus. Différents cas sont possibles:
Si
low
=high
, la fenêtre d'affichage se compose de ce point unique.Si
low.longitude
>high.longitude
, la plage de longitudes est inversée (la fenêtre d'affichage traverse la ligne de longitude à 180 degrés).Si
low.longitude
= -180 degrés ethigh.longitude
= 180 degrés, la fenêtre d'affichage inclut toutes les longitudes.Si
low.longitude
= 180 degrés ethigh.longitude
= -180 degrés, la plage de longitude est vide.Si
low.latitude
>high.latitude
, la plage de latitudes est vide.
Les champs low
et high
doivent tous les deux être renseignés, et la zone représentée ne peut pas être vide (comme indiqué dans les définitions ci-dessus). Une fenêtre d'affichage vide génère une erreur.
Par exemple, la fenêtre d'affichage suivante inclut entièrement New York:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
Représentation JSON |
---|
{ "low": { object ( |
Champs | |
---|---|
low |
Obligatoire. Point bas de la fenêtre d'affichage. |
high |
Obligatoire. Point haut de la fenêtre d'affichage. |
AddressMetadata
Métadonnées de l'adresse. Il n'est pas garanti que le champ metadata
soit entièrement renseigné pour chaque adresse envoyée à l'API Address Validation.
Représentation JSON |
---|
{ "business": boolean, "poBox": boolean, "residential": boolean } |
Champs | |
---|---|
business |
Indique qu'il s'agit de l'adresse d'une entreprise. Si cette règle n'est pas configurée, la valeur est inconnue. |
poBox |
Indique l'adresse d'une boîte postale. Si cette règle n'est pas configurée, la valeur est inconnue. |
residential |
Indique qu'il s'agit de l'adresse d'une résidence. Si cette règle n'est pas configurée, la valeur est inconnue. |
UspsData
Données USPS pour l'adresse. Il n'est pas garanti que le champ uspsData
soit entièrement renseigné pour toutes les adresses américaines ou publiques envoyées à l'API Address Validation. Il est recommandé d'intégrer les champs d'adresse de secours dans la réponse si vous utilisez uspsData comme partie principale de la réponse.
Représentation JSON |
---|
{
"standardizedAddress": {
object ( |
Champs | |
---|---|
standardizedAddress |
Adresse standardisée USPS. |
deliveryPointCode |
Code de point de livraison à deux chiffres |
deliveryPointCheckDigit |
Chiffre de contrôle du point de livraison. Ce numéro est ajouté à la fin de "delivery_point_barcode" pour les courriers scannés mécaniquement. En additionnant tous les chiffres de l'élément delivery_point_barcode, deliveryPointCheckDigit, du code postal et du ZIP+4, vous devriez obtenir un nombre divisible par 10. |
dpvConfirmation |
Valeurs possibles pour la confirmation de la DPV. Renvoie un seul caractère ou ne renvoie aucune valeur.
|
dpvFootnote |
Notes de bas de page de la validation du point de livraison. Plusieurs notes de bas de page peuvent être regroupées au sein d'une même chaîne.
|
dpvCmra |
Indique si l'adresse est une agence de réception de courrier commercial (CMRA), c'est-à-dire une entreprise privée recevant du courrier pour des clients. Renvoie un seul caractère.
|
dpvVacant |
Ce lieu est-il vacant ? Renvoie un seul caractère.
|
dpvNoStat |
S'agit-il d'une adresse inactive ou active ? Aucune adresse statistique n'est occupée en continu ou n'est pas desservie par l'USPS. Renvoie un seul caractère.
|
dpvNoStatReasonCode |
Indique le type NoStat. Renvoie un code de motif sous la forme d'un entier.
|
dpvDrop |
L'indicateur indique que le message est distribué à un seul destinataire sur un site. Renvoie un seul caractère.
|
dpvThrowback |
Indique que le courrier n'est pas distribué à l'adresse postale. Renvoie un seul caractère.
|
dpvNonDeliveryDays |
L'indicateur indique que la distribution des e-mails n'est pas effectuée tous les jours de la semaine. Renvoie un seul caractère.
|
dpvNonDeliveryDaysValues |
Entier identifiant les jours de non-diffusion. Il peut être interrogé à l'aide d'indicateurs de bits: 0x40 – Le dimanche est un jour de non-livraison 0x20 – Lundi est un jour de non-livraison 0x10 – Mardi est un jour de non-livraison 0x08 – Mercredi est un jour de non-livraison 0x04 – Le jeudi est un jour de non-livraison 0x02 – Samedi est un jour de non-livraison 0x02 – Samedi est un jour de non-livraison 0x02 |
dpvNoSecureLocation |
Le drapeau indique que la porte est accessible, mais qu'aucun colis ne sera déposé pour des raisons de sécurité. Renvoie un seul caractère.
|
dpvPbsa |
Indique que l'adresse a été mise en correspondance avec l'enregistrement PBSA. Renvoie un seul caractère.
|
dpvDoorNotAccessible |
Un drapeau indique une adresse où USPS ne peut pas frapper à la porte pour livrer du courrier. Renvoie un seul caractère.
|
dpvEnhancedDeliveryCode |
Indique que plusieurs codes de retour de la DPV sont valides pour l'adresse. Renvoie un seul caractère.
|
carrierRoute |
Code d'acheminement du transporteur. Un code à quatre caractères composé d'un préfixe d'une lettre et d'un indicateur d'itinéraire à trois chiffres. Préfixes:
|
carrierRouteIndicator |
Indicateur de tri des tarifs d'itinéraire du transporteur. |
ewsNoMatch |
L'adresse de livraison peut être mise en correspondance, mais le fichier EWS indique qu'une correspondance exacte sera bientôt disponible. |
postOfficeCity |
Ville du bureau de poste principal. |
postOfficeState |
État du bureau de poste principal. |
abbreviatedCity |
Ville abrégée. |
fipsCountyCode |
Code de comté FIPS. |
county |
Nom du comté. |
elotNumber |
Numéro de ligne de transport amélioré (eLOT). |
elotFlag |
Indicateur eLOT croissant/décroissant (A/D). |
lacsLinkReturnCode |
Code de retour LACSLink. |
lacsLinkIndicator |
Indicateur LACSLink. |
poBoxOnlyPostalCode |
Code postal de la boîte postale uniquement. |
suitelinkFootnote |
Notes de bas de page correspondant aux informations sur une rue ou un gratte-ciel Si une correspondance est trouvée pour le nom de l'entreprise, le numéro secondaire est renvoyé.
|
pmbDesignator |
Indicateur de boîte aux lettres privée. |
pmbNumber |
Numéro de boîte aux lettres privée (PMB, Private Mail Box) |
addressRecordType |
Type d'enregistrement d'adresse correspondant à l'adresse d'entrée.
|
defaultAddress |
Indicateur indiquant qu'une adresse par défaut a été trouvée, mais qu'il existe des adresses plus spécifiques. |
errorMessage |
Message d'erreur pour la récupération des données USPS. Ce champ est renseigné lorsque le traitement USPS est suspendu en raison de la détection d'adresses créées artificiellement. Il est possible que les champs de données USPS ne soient pas renseignés lorsque cette erreur se produit. |
cassProcessed |
Indicateur confirmant que la demande a été traitée par CASS. |
UspsAddress
Représentation USPS d'une adresse aux États-Unis
Représentation JSON |
---|
{ "firstAddressLine": string, "firm": string, "secondAddressLine": string, "urbanization": string, "cityStateZipAddressLine": string, "city": string, "state": string, "zipCode": string, "zipCodeExtension": string } |
Champs | |
---|---|
firstAddressLine |
Première ligne d'adresse. |
firm |
Nom de l'entreprise. |
secondAddressLine |
Deuxième ligne d'adresse. |
urbanization |
Nom de l'urbanisation portoricaine. |
cityStateZipAddressLine |
Ville + État + code postal. |
city |
Nom de la ville. |
state |
Code d'état à deux lettres. |
zipCode |
Code postal, par exemple 10009. |
zipCodeExtension |
Extension de code postal à quatre chiffres, par exemple 5023 |