Lista de parámetros

• Formatos de envío de la dirección
• Parámetros obligatorios
• Parámetros opcionales
• Ejemplos de solicitud

Formatos de envío de la dirección

La dirección puede enviarse de dos formas:

• Label – Texto único con los componentes de la dirección separados por comas, en el orden road, number, district, zipcode, city, state;
• Estructurado – Cada componente de la dirección informado en un parámetro separado.

Los dos formatos pueden enviarse en la misma solicitud. En ese caso, los parámetros estructurados tienen prioridad y el label se ignora:

Tabla con el formato considerado según los parámetros enviados

Parámetros obligatorios

Los parámetros obligatorios dependen del formato de envío de la dirección.

Formato estructurado

• road – Texto con la calle. Puede contener el número y el complemento, que se separan en la respuesta. Límite de 150 caracteres;
• zipcode – Texto con el código postal (CEP) de la dirección. Acepta el CEP con o sin guión (ejemplo: 01310-200 o 01310200). Después de quitar el guión, debe tener exactamente 8 dígitos;
• city – Texto con el nombre del municipio.

Formato label

• label – Texto con la dirección completa, con los componentes separados por comas en el orden road, number, district, zipcode, city, state. La calle, el CEP y el municipio deben estar completos en el label.
  • Las cinco comas de separación deben estar presentes, incluso cuando algún componente esté vacío. Ejemplo: "av paulista,1578,,01310200,sao paulo,";
  • Si falta alguna coma, se devolverá el error Structure error on label field. Esta validación se aplica antes de la validación del formato del CEP.

Nota: las solicitudes sin road, sin zipcode o city se rechazan con el error 400.

Parámetros opcionales

• number – Texto con el número del inmueble. Puede enviarse vacío o contener un complemento después del número (ejemplo: "654 bloco 3"); en ese caso, el texto después del número se devuelve en complement. Si no se informa, el número se identifica en el road;
• district – Texto con el nombre del barrio;
• state – Texto con la sigla del estado (UF).

Ejemplos de solicitud

Ejemplo con el formato label

{
  "label": "r da cantarera 306 box 12,,centro,01024-000,sao paulo,SP"
}

Ejemplo con el formato estructurado

{
  "road": "r da cantarera 306 box 12",
  "number": "",
  "zipcode": "01024-000",
  "district": "centro",
  "city": "sao paulo",
  "state": "SP"
}

Ejemplo con label y parámetros estructurados

En este caso, solo se consideran los parámetros estructurados:

{
  "label": "r da cantarera 306 box 12,,centro,01024-000,sao paulo,SP",
  "road": "r da cantarera 306 box 12",
  "number": "",
  "zipcode": "01024-000",
  "district": "centro",
  "city": "sao paulo",
  "state": "SP"
}