El endpoint clásico CheckAddress valida una dirección completa
en una sola llamada, corrigiéndola si es necesario y devolviendo
un veredicto de entregabilidad DQECodeDetail (DQECodeDetail)
junto con un desglose opcional de los cambios campo por campo.
Solicitud
Se admiten tanto GET como POST.
l'église
→ l%27%C3%A9glise.
Ejemplos de código
Francia - con Modification=O y Version=1.1
Internacional - Italia
Envía todos los parámetros en el cuerpo de la solicitud
usando
Content-Type: application/x-www-form-urlencoded.
La dirección del servidor permanece en la URL.
Ejemplos de código
Francia - dirección completa con indicador Modification
Parámetros
| Parámetro | Valor | Descripción | Obl. / Opc. |
|---|---|---|---|
| Licence |
{LICENCE_CODE}
|
Tu clave de licencia DQE o token OAuth2. Ponte en contacto con soporte si aún no tienes una. | Obligatorio |
| Adresse |
{INPUT}
|
Cadena de dirección separada por barras verticales.
Las cinco barras
son obligatorias incluso cuando los campos están
vacíos.
Para
Francia, se puede anteponer un sexto segmento
para
el punto de entrega (apartamento, piso, buzón).
dirección adicional|dirección|localidad dependiente o estado|código postal|ciudad
Ejemplo:
|
Obligatorio |
| Pays |
{COUNTRY_CODE}
|
Código de país ISO 3166-1 alfa-3 para el ámbito
de
búsqueda de la dirección. Ejemplo: FRA
o
GBR.
|
Obligatorio |
| Taille |
{LENGTH}
|
Límite de caracteres para el campo de respuesta
Adresse. Se aplica solo a direcciones
con caracteres
latinos. Por defecto: 38. Mínimo
recomendado:
32.
|
Opcional |
| Instance |
{INSTANCE}
|
Se devuelve tal cual en el campo de respuesta
Instance. No tiene efecto en el
comportamiento
de la API - se puede omitir sin problema.
|
Opcional |
| Proposition |
{PROP}
|
Solo Francia. Controla cómo se devuelven los
resultados de
corrección.O - El registro "1"
contiene
el resultado de corrección estándar. Si la dirección
no se puede emparejar de forma única, se devuelven
sugerencias
adicionales como registros "2"
a "n".S - El registro "1"
devuelve
la dirección de entrada tal cual con su estado
de validación
(sin corregir). Si se encuentra una corrección
clara,
se devuelve como registro "2".
Activa
automáticamente Modification=O.
|
Opcional |
| Modification |
O
|
Valor fijo O. Añade
Code_Modification y
Status_Modification a la respuesta,
indicando qué campos de la dirección se ajustaron
(dirección adicional, dirección, localidad dependiente,
código postal o ciudad). Ver
Code_Modification.
|
Opcional |
| Version |
{VERSION}
|
1.1 - Añade campos de calidad de
geocodificación
(LibelleQualiteGeo, CodeQualiteGeo)
a la respuesta (solo Francia, se requiere
suscripción
- contacta con tu gestor de cuenta DQE para activarla).2 - Devuelve datos de dirección
adicionales
en un campo ListeComplement.
|
Opcional |
| Segmentation |
O
|
Solo Francia. Requiere suscripción Finesis
-
contacta con tu gestor de cuenta DQE para activarla.
Pon
O para añadir Sprofil,
Sportrait, Ssegment
(campos de segmentación de población) a la respuesta.
Por defecto: N.
|
Opcional |
Campos de la respuesta
La respuesta es un objeto JSON con una única clave "1"
cuyo valor es un diccionario de campos de dirección. Cuando
Proposition=O, se pueden devolver varios
registros
numerados.
| Key | Description | France | International |
|---|---|---|---|
| DQECodeDetail | Código de resultado de la validación. Ver DQECodeDetail codes a continuación. | String (2) | String (2) |
| DQELibErreur |
Etiqueta de texto plano del resultado de la validación
(OK
o una descripción de error).
|
String (38) | String (38) |
| Adresse | Normalised address line (street number, type and name). | String (38) | String (50) |
| Voie |
Nombre de la calle sin número ni tipo. Excepción: cuando el tipo de calle está incluido en el nombre de la calle como una sola palabra compuesta (p. ej. Tannenburgweg), aquí se devuelve el nombre completo y TypeVoie queda vacío.
|
String (38) | String (50) |
| TypeVoie |
Tipo de calle (p. ej., RUE, AVENUE,
BOULEVARD).Vacío cuando el tipo de calle está incluido en el nombre de la calle como una sola palabra compuesta (en cuyo caso el nombre completo se devuelve en Voie).
|
String (20) | String (20) |
| Numero | Número de calle completo incluyendo cualquier complemento (bis, ter, etc.). | String (10) | String (10) |
| NumSeul | Solo el número de calle, sin ningún complemento (bis, ter, etc.). | String (10) | String (10) |
| CompNum | Complemento del número de calle (bis, ter, etc.). | String (38) | String (50) |
|
NbNumero also: Nbnumero |
Cuando el número consultado no se encuentra o falta, devuelve el recuento total de números de calle válidos para esta calle. Puede ser una cadena vacía para algunas direcciones internacionales donde este dato no está disponible. | String | String |
| ListeNumero | Lista de todos los números válidos de esta calle, separados por punto y coma. Se completa cuando el número enviado es inválido o está ausente. | String (1024) | String (1024) |
| CodePostal | Código postal. | String (5) | String (10) |
| Localite | Nombre de la ciudad. | String (38) | String (50) |
| LieuDit | Localidad con nombre o aldea (Francia) o campo equivalente a nivel de distrito (internacional). La disponibilidad varía según el país. | String (38) | String (50) |
| Cedex |
Indicador CEDEX: 1 = dirección CEDEX,
0 = no CEDEX.
|
String (1) | String (1) |
| Ligne2 | Información adicional de la línea de dirección 2. | String (38) | String (38) |
| Complement | Información adicional de la dirección (nombre de edificio, piso, etc.). | String (1024) | String (150) |
| ListeComplement |
Lista de complementos de dirección disponibles
(edificios, residencias, etc.) para
la calle encontrada, separados por punto y coma.
Se devuelve cuando Version=2.
|
String (1024) | String (1024) |
| IDLocalite | Identificador único de la ciudad (código INSEE para Francia). | String (20) | String (20) |
|
IDVoie or CodeVoie |
Identificador único de la calle. | String (20) | String (20) |
| Pays | Código de país ISO 3166-1 alfa-3. | String (3) | String (3) |
| Province | Código ISO de la región o estado administrativo. |
Always "*"
|
String (50) |
| Region1 | Etiqueta de la región o estado. | No disponible | String |
| Region2 | Condado o nivel administrativo equivalente. | No disponible | String |
| Region3 | Condado o equivalente (nivel alternativo). | No disponible | String |
| Region4 | Información regional o administrativa adicional. | No disponible | String |
| Thoroughfare | Calle dependiente. | No disponible | UK only |
| Roudis | Código de enrutamiento Roudis. Solo Francia. | String (5) | No disponible |
| IDHexaposte | Identificador postal de la ciudad (código Hexaposte para Francia). | String (6) | No disponible |
| IDCle | Identificador único del número de calle (Hexaclé para Francia). | String (10) | No disponible |
| Latitude | Coordenadas geográficas de la dirección encontrada. No disponibles para todos los países - ver coverage. | String | String |
| Longitude | Coordenadas geográficas de la dirección encontrada. No disponibles para todos los países - ver coverage. | String | String |
| Status_IrisIlot | Origen de los códigos IRIS e Ilot. Se requiere suscripción - contacta con tu gestor de cuenta DQE para activarla. | String (5) | No disponible |
| iris | Código de unidad estadística IRIS. Solo Francia, se requiere suscripción - contacta con tu gestor de cuenta DQE para activarla. | String (9) | No disponible |
| ilot | Código Ilot. Se requiere suscripción - contacta con tu gestor de cuenta DQE para activarla. | String | No disponible |
| Instance | Campo interno. | String (3) | String (3) |
| LibelleQualiteGeo |
Etiqueta de calidad de geocodificación (p. ej.,
ENTREE,
BATIMENT). Se devuelve cuando
Version=1.1. Ver
Calidad de geocodificación.
|
String | No disponible |
| CodeQualiteGeo |
Código numérico de calidad de geocodificación.
Se devuelve
cuando
Version=1.1.
|
String | No disponible |
| Sprofil |
Perfil de población (Finesis). Se devuelve cuando
Segmentation=O.
|
String (10) | No disponible |
| Sportrait |
Retrato de población (Finesis). Se devuelve cuando
Segmentation=O.
|
String (10) | No disponible |
| Ssegment |
Segmento de población (Finesis). Se devuelve
cuando
Segmentation=O.
|
String (10) | No disponible |
| Code_Modification |
Cadena binaria de 5 caracteres que indica qué
campos
de la dirección
se ajustaron. Se devuelve cuando
Modification=O. Ver
Code_Modification.
|
String (5) | String (5) |
| Status_Modification |
O si se ajustó al menos un campo,
N en caso contrario. Se devuelve
cuando
Modification=O.
|
String (1) | String (1) |
|
DQECompte DQECodeErreur DQEPourcentErreur |
Campos heredados mantenidos por compatibilidad con integraciones antiguas. No usar en nuevas implementaciones. | String | No disponible |
Returned
with Version=1.1Returned
with Segmentation=OReturned
with Modification=O
Response examples
|1 Rue de la Louisiane||31200|Toulouse
DQECodeDetail codes
DQECodeDetail es el
indicador principal del resultado de
validación. Úsalo para determinar qué acción tomar al
enviar el
formulario.
Para ver los mensajes de interfaz recomendados asociados
a cada código,
consulta
la
guía de integración.
| Code | Description |
|---|---|
| 10 | Dirección correcta |
| 20 | Dirección correcta (street not recognized, but it is a CEDEX or P.O. box) |
| 21 | Población pequeña, número de calle fuera de rango |
| 22 | Población pequeña, falta el número de calle (el resto de la dirección es correcto) |
| 23 | Ciudad grande, número de calle fuera de rango |
| 24 | Ciudad grande, falta el número de calle (el resto de la dirección es correcto) |
| 25 | Dirección CEDEX desconocida para CEDEXA (si CEDEXA está activo) |
| 30 | Población pequeña, calle no reconocida |
| 31 | Población pequeña - calle no reconocida o ausente; información de distrito reconocida pero insuficiente para determinar la calle. Solo Francia. |
| 40 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 41 | Población pequeña, falta la calle |
| 50 | Ciudad grande, calle no reconocida |
| 51 | Ciudad grande, calle no reconocida o ausente (información de distrito reconocida pero insuficiente para determinar la calle). Solo Francia. |
| 60 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 61 | Ciudad grande, falta la calle |
| 70 | Código postal / ciudad no coinciden - calle presente |
| 71 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 80 | Código postal / ciudad no coinciden - falta la calle |
| 81 | Bloque de dirección de entrada vacío. No se devuelve para Francia. |
| 90 | Dirección internacional detectada - el código de país de entrada no parece coincidir con la dirección de entrada. |
| 95 | Código de país ausente o incorrecto |
31 y
51 indican que se reconoció un distrito:
una zona geográfica identificada por el motor (p. ej. una
aldea
o urbanización) que no se puede emparejar con una calle
específica.
Estos códigos son exclusivos de Francia.
DQECodeDetail - ejemplos de entrada
Entradas de ejemplo que producen cada código. Los campos no indicados se dejan vacíos.
| Code | France | International |
|---|---|---|
| 10 | |20 rue Jean-Baptiste Pigalle||75009|Paris |
Albert Buildings|3 Scott Drive||WA15 8AB|ALTRINCHAMGBR |
| 20 | |RUE DES FRERES LUMIERE|BP 30036|33564|CARBON BLANC |
- |
| 21 | |26 route du chardonnay||24130|Ginestet |
|Seulestraat 200||8950|HeuvellandBEL |
| 22 | |route du chardonnay||24130|Ginestet |
|Seulestraat||8950|HeuvellandBEL |
| 23 | |13 rue Jean-Baptiste Pigalle||75009|Paris |
|Rue Victor Hugo 235||7012|MonsBEL |
| 24 | |rue Jean-Baptiste Pigalle||75009|Paris |
|Rue Victor Hugo||7012|MonsBEL |
| 25 | |||82016|Montauban CEDEX |
- |
| 30 | |rue Jean-Baptiste Pigalle||24130|Ginestet |
|Via del lungo||70011|AlberobelloITA |
| 31 | |SAINT SYMPHORIEN||12490|VIALA DU TARN |
No se devuelve fuera de Francia |
| 40 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 41 | |||24130|Ginestet |
|||70011|AlberobelloITA |
| 50 | |route du chardonnay||75009|Paris |
|STREET ABCD||60607|CHICAGOUSA |
| 51 | |Lotissement Casella||20243|PRUNELLI DI FIUMORBO |
No se devuelve fuera de Francia |
| 60 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 61 | |||75009|Paris |
|||60607|CHICAGOUSA |
| 70 | |rue de la mairie||75009|Bordeaux |
|FRANKLIN GTWY SE||00067|MARIETTAUSA |
| 71 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 80 | |||75009|Bordeaux |
|||00067|MARIETTAUSA |
| 81 | No se devuelve para Francia | |||| |
| 90 |
|7C avenue Monbijou||4960|MalmedyPays: FRA - la dirección no parece francesa |
- |
| 95 | - | - |
Code_Modification
Se devuelve cuando se añade Modification=O a la solicitud. Status_Modification es O si se ajustó algún campo, N en caso contrario. Code_Modification es una cadena binaria de 5 caracteres, una posición por campo de dirección. 1 = ajustado por DQE, 0 = sin cambios.
| Code_Modification | Meaning |
|---|---|
00000 |
Ningún campo ajustado - dirección aceptada tal como se envió. |
11111 |
Los cinco campos ajustados. |
00011 |
Código postal y ciudad ajustados; los demás campos sin cambios. |
01111 |
Dirección, localidad dependiente, código postal y ciudad ajustados; dirección adicional sin cambios. |
10000 |
Solo se ajustó la dirección adicional. |
01000 |
Solo se ajustó la línea de dirección. |
00100 |
Solo se ajustó la localidad dependiente. |
Status_Modification is O, al menos un campo fue modificado por DQE. Muestra la corrección al usuario como una ventana emergente, conservando siempre la opción de mantener su entrada original.Calidad de geocodificación
Cuando se establece Version=1.1 y se tiene suscripción de geocodificación, se añaden dos campos: LibelleQualiteGeo (etiqueta) y CodeQualiteGeo (código numérico). Solo Francia.
| Code | LibelleQualiteGeo | Description |
|---|---|---|
| 1 | ENTREE | Punto de acceso principal a un recinto, grupo de edificios o parcela de terreno (placa de dirección). |
| 2 | BATIMENT | Edificio o parte de un edificio. |
| 3 | ESCALIERS | Hueco de escalera, normalmente dentro de un edificio. |
| 4 | LOGEMENT | Vivienda o habitación dentro de un edificio. |
| 5 | PARCELLE CADASTRALE | Parcela catastral. |
| 6 | SEGMENT DE VOIE | Posición derivada del tramo de calle de conexión. Puede estar fuera del polígono de la ciudad pero en la misma calle. |
| 7 | POINT D ACCESS TECHNIQUE | Punto de acceso técnico (corte de agua, electricidad, gas, etc.). |
| 8 | POINT DELIVRANCE POSTALE | Punto de entrega postal (buzón). |
| 9 | ZONE D ADRESSAGE | Punto ubicado en la localidad dependiente. |
| 10 | CENTRE VILLE | Centro de la ciudad. |
| 0 | CENTRE DE LA VOIE | Punto en el centro de la calle. |
| 90 | A CONTROLER | Calidad de geocodificación incierta - debe verificarse. |
| 99 | NON PRESENTE | Geocodificación no disponible para esta dirección. |
Errores
A diferencia de las API de sugerencia, RNVP devuelve códigos de error HTTP estándar (no un cuerpo vacío) cuando faltan parámetros obligatorios o son inválidos.
| HTTP | Error type | Response body |
|---|---|---|
| 400 | Falta o está vacío Licence
|
Bad Request Parameters empty fields |
| 401 |
Licence incorrecta |
unauthorized_client |
| 400 | Falta o está vacío Adresse
|
Bad Request Parameters empty fields |
| 400 | Falta o está vacío Pays
|
Bad Request Parameters empty fields |
| 400 | Valor de parámetro no válido | Bad Request Parameters empty fields |
Prueba la API
Haz clic en el botón de abajo para probar este endpoint en vivo en tu navegador.
Abrir consola
Ver también
Relacionada con