API de Address Parsing: Extração e Segmentação de Endereço

Rota para separação de endereços em níveis.

Request

Header Params

Authorization

string

required

Token de autorização obtido no método user/authenticate.

Example:

Bearer {{bearer_token}}

Body Params application/json

country

string

required

Texto contendo a sigla do país, formatada conforme o padrão ISO 3166-1 alpha-3, utilizando letras maiúsculas. Exemplo: BRA.

address

string

required

Texto que contém o endereço que será processado, com suporte a caracteres de quebra de linha '\n'.

Example

{
  "country": "",
  "address": ""
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

result

object | null

optional

Lista contendo o resultado do método (consulte na documentação específica de cada um).

match

object | null

optional

Objeto que encapsula os detalhes do processamento realizado e inclui o resultado obtido após a comparação entre o endereço fornecido e o endereço correto.

requestId

string

required

Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.

elapsedMilliseconds

integer

required

Tempo de duração do processamento em milissegundos.

status

object

required

Objeto contendo o código de status e a mensagem de resposta.

code

string

required

Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.

message

string | null

required

Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.

errors

array [object {2}] | null

required

Lista de objetos do tipo Error, o formato é variável.

Example

{
  "result": {
    "match": {
      "language": "pt",
      "score": 0.8,
      "components": [
        {
          "name": "cep",
          "std_name": "postcode",
          "stdName": "postcode",
          "score": 1,
          "value": "30494-450",
          "std_value": "30494450",
          "stdValue": "30494450"
        },
        {
          "name": "pais",
          "std_name": "country",
          "stdName": "country",
          "score": null,
          "value": null,
          "std_value": "REPUBLICA FEDERATIVA DO BRASIL",
          "stdValue": "REPUBLICA FEDERATIVA DO BRASIL"
        },
        {
          "name": "estado",
          "std_name": "state",
          "stdName": "state",
          "score": 1,
          "value": "MG",
          "std_value": "MINAS GERAIS",
          "stdValue": "MINAS GERAIS"
        },
        {
          "name": "cidade",
          "std_name": "city",
          "stdName": "city",
          "score": 1,
          "value": "Belo Horizonte",
          "std_value": "BELO HORIZONTE",
          "stdValue": "BELO HORIZONTE"
        },
        {
          "name": "bairro",
          "std_name": "suburb",
          "stdName": "suburb",
          "score": 1,
          "value": "Estoril",
          "std_value": "ESTORIL",
          "stdValue": "ESTORIL"
        },
        {
          "name": "logradouro",
          "std_name": "place",
          "stdName": "place",
          "score": 1,
          "value": "Rua Desembargador Edésio Fernandes",
          "std_value": "RUA DESEMBARGADOR EDESIO FERNANDES",
          "stdValue": "RUA DESEMBARGADOR EDESIO FERNANDES"
        },
        {
          "name": "endereco",
          "std_name": "address",
          "stdName": "address",
          "score": null,
          "value": null,
          "std_value": null,
          "stdValue": null
        },
        {
          "name": "numero",
          "std_name": "number",
          "stdName": "number",
          "score": 1,
          "value": "148",
          "std_value": "148",
          "stdValue": "148"
        },
        {
          "name": "conjunto",
          "std_name": "suite",
          "stdName": "suite",
          "score": 1,
          "value": "Conj 208",
          "std_value": "CONJUNTO 208",
          "stdValue": "CONJUNTO 208"
        }
      ]
    }
  },
  "requestId": "0ovW4gXx9kC92qZMcfdPh",
  "elapsedMilliseconds": 396,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠401R117 Invalid authorization data

🟠400R101 A specified parameter is wrong

🔴500E100 The request could not be processed

Address Parsing [application/json]

Request

Request samples

Responses