API de direcciones - Verificar y validar una dirección (RESTful)

Support DQE

Actualización 18 de septiembre de 2026 13:00

Validación - RESTful

Valida y normaliza una dirección completa. Devuelve una dirección corregida, un veredicto de entregabilidad (DQEDetailCode) y, opcionalmente, un desglose de los campos que fueron ajustados.

Cuándo llamar a este endpoint - CheckAddress es el paso de validación de Nivel 2. Actívelo cuando el usuario escriba una dirección manualmente o modifique una sugerencia de DQE antes de enviarla. Si el usuario aceptó una sugerencia de DQE tal cual, la calidad ya está garantizada - no es necesaria ninguna llamada.

Solicitud

Se admiten los métodos GET y POST.

{SERVER_ADDRESS}, {VERSION} y {LICENCE_CODE} son proporcionados por DQE al crear la cuenta. Contacte con su gestor de cuenta DQE para obtener estas credenciales.

La dirección introducida debe estar codificada en URL - por ejemplo, l'église → l%27%C3%A9glise.

GET POST

GEThttps://{SERVER_ADDRESS}/{VERSION}/checkaddress/?Address={INPUT}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}

Ejemplos de cURL

Francia - con Modification=O y Version=1.1

curl "https://{SERVER_ADDRESS}/v1/checkaddress/?Address=%7C1%20rue%20de%20la%20louisiane%7C%7C31200%7Ctoulouse&Country=FRA&Length=38&Modification=O&Version=1.1&Licence={LICENCE_CODE}"

Internacional - Italia

curl "https://{SERVER_ADDRESS}/v1/checkaddress/?Address=%7CSTRADA%20BARDONEY%7C%7C11028%7CVALTOURNENCHE&Country=ITA&Length=38&Licence={LICENCE_CODE}"

POSThttps://{SERVER_ADDRESS}/{VERSION}/checkaddress/

Envíe 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.

Ejemplo de cURL

Francia - dirección completa con indicador Modification

curl -X POST "https://{SERVER_ADDRESS}/v1/checkaddress/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "Address=%7C1+rue+de+la+louisiane%7C%7C31200%7Ctoulouse" \
  -d "Country=FRA" \
  -d "Length=38" \
  -d "Modification=O" \
  -d "Version=1.1" \
  -d "Licence={LICENCE_CODE}"

Parámetros

Parámetro	Valor	Descripción	Obl. / Opc.
Licence	`{LICENCE_CODE}`	Su clave de licencia DQE o token OAuth2. Contacte con soporte si aún no dispone de una.	Obligatorio
Address	`{INPUT}`	Cadena de dirección separada por barras verticales (pipes). 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: `\|1 rue de la louisiane\|\|31200\|toulouse`	Obligatorio
Country	`{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
Length	`{LENGTH}`	Límite de caracteres para el campo de respuesta `Address`. Se aplica únicamente a direcciones con caracteres latinos. Valor predeterminado: `38`. Mínimo recomendado: `32`.	Opcional
Suggestion	`{PROP}`	Solo para 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 asociar de forma única, se devuelven sugerencias adicionales como registros `"2"` a `"n"`. `S` - El registro `"1"` devuelve la dirección introducida 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 `ChangedAddressTag` e `IsAddressChanged` a la respuesta, indicando qué campos de la dirección fueron ajustados (dirección adicional, dirección, localidad dependiente, código postal o ciudad). Consulte ChangedAddressTag.	Opcional
Version	`{VERSION}`	`1.1` - Añade campos de calidad de geocodificación (`LatLonLabel`, `LatLonCode`) a la respuesta (solo Francia, requiere suscripción - contacte con su gestor de cuenta DQE para activarla).	Opcional

Campos de la respuesta

La respuesta es un objeto JSON con dos claves de nivel superior: Found (entero) y Addresses (array de objetos de dirección). Cuando Suggestion=O, se pueden devolver varios objetos de dirección.

Campos de complemento - La validación se aplica hasta el número de calle. Cuando se envía un complemento (nombre del edificio, piso, etc.) y coincide con un complemento de referencia, el motor lo enriquece con el nombre completo registrado. Cuando no se envía ningún complemento, se devuelve la lista completa de complementos disponibles (separados por punto y coma). Los complementos no reconocidos se devuelven tal cual.

Mayúsculas/minúsculas de salida - El uso de mayúsculas y minúsculas sigue la norma postal del país correspondiente.

Nivel superior

Clave	Descripción	Tipo
Found	Número de objetos de dirección devueltos.	Integer
Addresses	Array de objetos de dirección.	Array

Objeto de dirección - `Addresses[0]`

Clave	Descripción	Francia	Internacional
Address	Línea de dirección normalizada (número, tipo y nombre de la calle).	String (38)	String (50)
PostalCode	Código postal.	String (5)	String (10)
City	Nombre de la ciudad.	String (38)	String (50)
Hamlet	Localidad o aldea con nombre (Francia) o campo equivalente a nivel de distrito (internacional). La disponibilidad varía según el país.	String (38)	String (50)
SpecialDistribution	Indicador CEDEX: `1` = dirección CEDEX, `0` = no CEDEX.	String (1)	String (1)
Country	Código de país ISO 3166-1 alfa-3.	String (3)	String (3)
StateCode	Código ISO del estado o región administrativa.	Siempre `"*"`	String (50)
SubLocality	Sublocalidad.	Vacío	String (50)
CityId	Identificador único de ciudad (código INSEE para Francia).	String (20)	String (20)
Input	No se rellena para este endpoint. Siempre devuelve una cadena vacía.	String	String
Label	Etiqueta de visualización formateada para la dirección. No se devuelve para todos los conjuntos de datos internacionales.	String	String
AdditionalAddress	Información adicional de la dirección (nombre del edificio, piso, etc.).	String (1024)	String (150)
StreetNumber	Número de calle completo, incluyendo cualquier complemento (bis, ter, etc.).	String (10)	String (10)
StreetType	Tipo de vía (por ejemplo, `RUE`, `AVENUE`, `BOULEVARD`).	String (20)	String (20)
Street	Nombre de la calle sin número ni tipo.	String (38)	String (50)
StreetId	Identificador único de calle.	String (20)	String (20)
IsValidStreetNumber	Indicador de validez del número de calle. `1` si el número existe en los datos de referencia, `0` en caso contrario. Devuelve una cadena vacía para algunas direcciones internacionales donde la validación a nivel de número no está disponible.	Integer	Integer
StreetNumberListCount	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
StreetNumberList	Lista de todos los números válidos de esta calle, separados por punto y coma. Se rellena cuando el número enviado es inválido o está ausente.	String (1024)	String (1024)
StreetNumberOnly	Solo el número de calle, sin ningún complemento (bis, ter, etc.).	String (10)	String (10)
StateLabel	Etiqueta del estado o región.	No disponible	String
AdministrativeArea	Departamento o nivel administrativo equivalente.	Vacío	String
Suburb	Barrio periférico.	Vacío	String
Company	Nombre de la empresa asociada a la dirección.	String (38)	String (38)
Latitude	Coordenadas geográficas de la dirección encontrada. No disponible para todos los países - consulte la cobertura.	String	String
Longitude	Coordenadas geográficas de la dirección encontrada. No disponible para todos los países - consulte la cobertura.	String	String
Informations	Objeto de metadatos de validación de DQE. Consulte más abajo.	Object	Object

Objeto Informations - `Addresses[0].Informations`

Clave	Descripción	Francia	Internacional
DQEDetailCode	Código de resultado de la validación. Consulte DQEDetailCode más abajo.	String (2)	String (2)
DQEErrorAddressLabel	Etiqueta de resultado de la validación en texto simple (`OK` o una descripción del error).	String (38)	String (38)
AdditionalAddressComp	Información adicional de la línea de dirección 2.	String (38)	String (38)
StreetNumberComp	Complemento del número de calle (bis, ter, etc.).	String (38)	String (50)
StreetNumberId	Identificador único del número de calle (Hexaclé para Francia).	String (10)	No disponible
PostalCityId	Identificador postal de la ciudad (código Hexaposte para Francia).	String (6)	No disponible
IrisCode	Código de unidad estadística IRIS. Solo Francia, requiere suscripción - contacte con su gestor de cuenta DQE para activarla.	String (9)	No disponible
RoudisCode	Código de enrutamiento Roudis. Solo Francia.	String (5)	No disponible
LatLonLabel	Etiqueta de calidad de geocodificación (por ejemplo, `ENTREE`, `BATIMENT`). Se rellena cuando `Version=1.1`. Consulte Calidad de geocodificación.	String	No disponible
LatLonCode	Código numérico de calidad de geocodificación. Se rellena cuando `Version=1.1`.	String	No disponible
IsAddressChanged	`1` si se ajustó al menos un campo, `0` en caso contrario. Siempre presente en la respuesta.	String (1)	String (1)
ChangedAddressTag	Cadena binaria de 5 caracteres que indica qué campos de la dirección fueron ajustados. Consulte ChangedAddressTag. Siempre presente; se rellena cuando se establece `Modification=O`.	String (5)	String (5)

Se rellena cuando Version=1.1 Se rellena cuando Modification=O

Ejemplo de respuesta

1 Rue de la Louisiane 31200 Toulouse

{
  "Found": 1,
  "Addresses": [
    {
      "Address":              "1 RUE DE LA LOUISIANE",
      "PostalCode":           "31200",
      "City":                 "TOULOUSE",
      "Hamlet":               "",
      "SpecialDistribution":  "",
      "Country":              "FRA",
      "StateCode":            "*",
      "SubLocality":          "",
      "CityId":               "31555",
      "Input":                "",
      "Label":                "",
      "AdditionalAddress":    "BATIMENT D RESIDENCE ALLEE DES CEDRES;BATIMENT A RESIDENCE ALLEE DES CEDRES;BATIMENT B RESIDENCE ALLEE DES CEDRES;BATIMENT C RESIDENCE ALLEE DES CEDRES",
      "StreetNumber":         "",
      "StreetType":           "RUE",
      "Street":               "DE LA LOUISIANE",
      "StreetId":             "2408474",
      "IsValidStreetNumber":  "",
      "StreetNumberListCount":"",
      "StreetNumberList":     "",
      "StreetNumberOnly":     "1",
      "StateLabel":           "",
      "AdministrativeArea":   "",
      "Suburb":               "",
      "Company":              "",
      "Latitude":             "43.634746",
      "Longitude":            "1.430098",
      "Informations": {
        "DQEDetailCode":        "10",
        "DQEErrorAddressLabel": "OK",
        "AdditionalAddressComp":"",
        "StreetNumberComp":     "",
        "StreetNumberId":       "3155526YEA",
        "PostalCityId":         "14411",
        "IrisCode":             "3701",
        "RoudisCode":           "4221",
        "LatLonLabel":          "",
        "LatLonCode":           "",
        "IsAddressChanged":     "1",
        "ChangedAddressTag":    "" }
    }
  ]
}

DQEDetailCode

Addresses[0].Informations.DQEDetailCode es el indicador principal del resultado de la validación. Utilícelo para determinar la acción a realizar tras el envío del formulario.
Para conocer los mensajes de interfaz recomendados asociados a cada código, consulte la Guía de integración.

Código	Descripción
10	Dirección correcta
20	Dirección correcta (calle no reconocida, pero es un CEDEX o apartado de correos)
21	Población pequeña, número de calle fuera de rango
22	Población pequeña, número de calle ausente (el resto de la dirección es correcto)
23	Ciudad grande, número de calle fuera de rango
24	Ciudad grande, número de calle ausente (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, calle ausente
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, calle ausente
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 - calle ausente
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 introducido no parece coincidir con la dirección introducida.
95	Código de país ausente o incorrecto

Población pequeña frente a ciudad grande - En Francia, una ciudad se considera Grande cuando tiene más de 2500 habitantes. A nivel internacional, el umbral es de 500 calles. Esta distinción determina si se aplican los códigos de población pequeña (21, 22, 30, 31, 41) o los códigos de ciudad grande (23, 24, 50, 51, 61).

Distrito - Los códigos 31 y 51 indican que se reconoció un distrito: una zona geográfica identificada por el motor (por ejemplo, una aldea o urbanización) que no se puede asociar a una calle específica. Estos códigos son exclusivos de Francia.

DQEDetailCode - ejemplos de entrada

Ejemplos de entrada que producen cada código. Los campos no indicados se dejan vacíos.

Código	Francia	Internacional
10	`\|20 rue Jean-Baptiste Pigalle\|\|75009\|Paris`	`Albert Buildings\|3 Scott Drive\|\|WA15 8AB\|ALTRINCHAM` GBR
20	`\|RUE DES FRERES LUMIERE\|BP 30036\|33564\|CARBON BLANC`	-
21	`\|26 route du chardonnay\|\|24130\|Ginestet`	`\|Seulestraat 200\|\|8950\|Heuvelland` BEL
22	`\|route du chardonnay\|\|24130\|Ginestet`	`\|Seulestraat\|\|8950\|Heuvelland` BEL
23	`\|13 rue Jean-Baptiste Pigalle\|\|75009\|Paris`	`\|Rue Victor Hugo 235\|\|7012\|Mons` BEL
24	`\|rue Jean-Baptiste Pigalle\|\|75009\|Paris`	`\|Rue Victor Hugo\|\|7012\|Mons` BEL
25	`\|\|\|82016\|Montauban CEDEX`	-
30	`\|rue Jean-Baptiste Pigalle\|\|24130\|Ginestet`	`\|Via del lungo\|\|70011\|Alberobello` ITA
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\|Alberobello` ITA
50	`\|route du chardonnay\|\|75009\|Paris`	`\|STREET ABCD\|\|60607\|CHICAGO` USA
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\|CHICAGO` USA
70	`\|rue de la mairie\|\|75009\|Bordeaux`	`\|FRANKLIN GTWY SE\|\|00067\|MARIETTA` USA
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\|MARIETTA` USA
81	No se devuelve para Francia	`\|\|\|\|`
90	`\|7C avenue Monbijou\|\|4960\|Malmedy` País: FRA - la dirección parece no ser francesa	-
95	-	-

ChangedAddressTag

Se rellena cuando se añade Modification=O a la solicitud. IsAddressChanged es 1 si se ajustó algún campo, 0 en caso contrario. ChangedAddressTag es una cadena binaria de 5 caracteres, una posición por cada campo de la dirección. 1 = ajustado por DQE, 0 = sin cambios.

dirección adicional|dirección|localidad dependiente|código postal|ciudad

ChangedAddressTag	Significado
`00000`	Ningún campo ajustado - dirección aceptada tal como se envió.
`11111`	Los cinco campos fueron ajustados.
`00011`	Código postal y ciudad ajustados; el resto de los 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.

Consejo - Cuando IsAddressChanged es 1, DQE modificó al menos un campo. Muestre la corrección al usuario mediante una ventana emergente, conservando siempre la opción de mantener su entrada original.

Calidad de geocodificación

Cuando se establece Version=1.1 y la geocodificación está suscrita, se rellenan dos campos dentro del objeto Informations: LatLonLabel (etiqueta) y LatLonCode (código numérico). Solo Francia.

Código	LatLonLabel	Descripción
1	ENTREE	Punto de acceso principal a un recinto, conjunto 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 segmento 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 (agua, electricidad, corte de 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 - a verificar.
99	NON PRESENTE	Geocodificación no disponible para esta dirección.

Errores

El endpoint RESTful devuelve un cuerpo de error JSON estructurado con un código de estado HTTP, un mensaje y un identificador de error.

HTTP	Tipo de error	Cuerpo de la respuesta
400	Falta el parámetro `Licence`	`{"status":400,"message":"Missing parameters","details":"Licence","error":"bad request"}`
400	Parámetro `Licence` vacío	`{"status":400,"message":"Licence must be filled","details":"Empty","error":"bad request"}`
401	Número de licencia incorrecto	`{"status":401,"message":"Your licence is not allowed to cover this functionnality","details":"{WRONG}","error":"unauthorized_client"}`
400	Falta el parámetro `Address`	`{"status":400,"message":"Missing parameters","details":"Address","error":"bad request"}`
400	Falta el parámetro `Country`	`{"status":400,"message":"Missing parameters","details":"Country","error":"bad request"}`
400	Parámetro `Country` vacío	`{"status":400,"message":"Country must be filled","details":"Empty","error":"bad request"}`
400	Error tipográfico en el nombre del parámetro	`{"status":400,"message":"Missing parameters","details":"Address","error":"bad request"}`

Probar la API

Haga clic en el botón de abajo para probar este endpoint en directo en su navegador.

Abrir consola

Ver también

Relacionada con

Address
API

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0

API de direcciones - Verificar y validar una dirección (RESTful)

Solicitud

Ejemplos de cURL

Ejemplo de cURL

Parámetros

Campos de la respuesta

Nivel superior

Objeto de dirección - `Addresses[0]`

Objeto Informations - `Addresses[0].Informations`

Ejemplo de respuesta

DQEDetailCode

DQEDetailCode - ejemplos de entrada

ChangedAddressTag

Calidad de geocodificación

Errores

Probar la API

Ver también

¿Fue útil este artículo?

Artículo anterior

Artículo siguiente

Solicitud

Ejemplos de cURL

Ejemplo de cURL

Parámetros

Campos de la respuesta

Nivel superior

Objeto de dirección - Addresses[0]

Objeto Informations - Addresses[0].Informations

Ejemplo de respuesta

DQEDetailCode

DQEDetailCode - ejemplos de entrada

ChangedAddressTag

Calidad de geocodificación

Errores

Probar la API

Ver también

¿Fue útil este artículo?

Artículo anterior

Artículo siguiente

Objeto de dirección - `Addresses[0]`

Objeto Informations - `Addresses[0].Informations`