Passer au contenu principal
POST
curl
L’API Address Validation de Didit confirme qu’une adresse postale existe et la renvoie normalisée, avec ses lignes de livraison, ses composants et ses coordonnées. Utilisez POST /v3/address-validation/ lorsque votre backend dispose d’une adresse et doit savoir si elle existe, et sous quelle forme normalisée. Address Validation confirme uniquement l’adresse. Elle ne relie jamais l’adresse à une personne : un résultat verified signifie que le lieu existe, et non que quelqu’un y habite.

Envoyer l’adresse

Envoyez-la sur une seule ligne dans address, ou sous forme de champs structurés : address_line_1 et, si vous les avez, address_line_2, city, region et postal_code. N’envoyez jamais les deux formats dans une même requête. country est toujours obligatoire, sous forme de code ISO 3166-1 alpha-2 ou alpha-3.

Interpréter la réponse

  • address_validation.status est la réponse sur laquelle vous appuyer :
    • verified : l’adresse a été confirmée jusqu’au bâtiment (ou jusqu’à l’appartement ou à la boîte postale).
    • partially_verified : elle n’a été confirmée que jusqu’à la rue, ou jusqu’au niveau le plus précis que les données de référence postales contiennent pour ce lieu.
    • not_verified : seuls la région ou la ville correspondaient, ou rien ne correspondait.
    • unavailable : la validation n’a pas pu être exécutée. Réessayez plus tard.
  • address_validation.verification_level correspond au niveau le plus précis obtenu : administrative_area, locality, thoroughfare, premise ou delivery_point.
  • address_validation.address et address_validation.formatted_address contiennent l’adresse normalisée, écrite selon la manière dont le pays l’écrit.
  • address_validation.latitude et address_validation.longitude situent l’adresse trouvée.
  • request_id identifie la requête. Aucune session n’est créée et le résultat n’est renvoyé que dans cette réponse : conservez donc ce dont vous avez besoin.
Le code HTTP est 200 pour toute requête terminée, y compris lorsque le résultat est unavailable.

Address Validation dans un workflow

La même vérification est un module complémentaire des étapes de workflow Vérification d’identité et Justificatif de domicile. Activez address_validation_enabled dans les paramètres de l’étape : l’adresse fournie par la personne (imprimée sur le document d’identité ou sur le justificatif de domicile) est validée une fois son envoi lu. Le résultat est l’objet address_validation de l’entrée de cette étape dans la décision de session (id_verifications[] ou poa_verifications[]). Une adresse partially_verified ou not_verified déclenche l’avertissement ADDRESS_NOT_VERIFIED, dont l’action est celle définie dans address_not_verified_action de l’étape (NO_ACTION par défaut, qui se contente d’enregistrer l’avertissement). Une validation unavailable ne déclenche jamais cet avertissement et ne modifie jamais la vérification.

Comportement en sandbox

Les clés sandbox valident la requête et renvoient toujours un résultat verified déterministe qui reprend l’adresse envoyée. Elles ne consomment pas de crédits.

Facturation

Un appel à l’API Address Validation coûte $0.10 par adresse validée. Un résultat `unavailable` n'est pas facturé. Dans un workflow, le module complémentaire coûte $0.10 par adresse validée par une étape.

Autorisations

x-api-key
string
header
requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Corps

application/json

Une adresse : sur une seule ligne (address) ou sous forme de champs structurés avec au moins address_line_1, jamais les deux.

country
string
requis

Code ISO 3166-1 alpha-2 ou alpha-3 du pays de l'adresse.

Maximum string length: 3
Exemple:

"US"

address
string

L'adresse complète sur une seule ligne.

Maximum string length: 500
Exemple:

"Paseo de la Castellana 259, 28046 Madrid"

address_line_1
string

Rue et numéro.

Maximum string length: 255
Exemple:

"1600 Amphitheatre Pkwy"

address_line_2
string

Appartement, suite, étage ou bâtiment.

Maximum string length: 255
city
string

Ville ou localité.

Maximum string length: 128
Exemple:

"Mountain View"

region
string

État, province ou région.

Maximum string length: 128
Exemple:

"CA"

postal_code
string
Maximum string length: 32
Exemple:

"94043"

Réponse

La validation est terminée. Consultez address_validation.status ; le code HTTP est toujours 200 pour une requête terminée.

request_id
string<uuid>
requis

Identifiant de cette requête ; indiquez-le au support. Aucune session n'est créée.

address_validation
object
requis

Le résultat d'une Address Validation : indique si l'adresse existe, ainsi que sa forme normalisée. Cela confirme uniquement l'adresse ; cela ne lie jamais l'adresse à une personne.

created_at
string<date-time>
requis
Dernière modification le 7 novembre 2026