Enviar uma solicitação de validação de endereço

Envie uma solicitação de validação de endereço emitindo uma solicitação POST para um dos seguintes endpoints:

• validateAddress (REST)
• ValidateAddress (gRPC)

Sua solicitação também precisa transmitir um corpo de solicitação JSON para a solicitação que define o endereço a ser validado. O corpo da solicitação a seguir contém um campo e três subcampos:

curl -X POST -d '{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  }
}' \
-H 'Content-Type: application/json' \
"https://addressvalidation.googleapis.com/v1:validateAddress?key=API_KEY"

Você também pode omitir locality e especificar como um elemento na matriz addressLines:

{
  "address": {
    "regionCode": "US",
    "addressLines": ["1600 Amphitheatre Pkwy", "Mountain View, CA, 94043"]
  },
}

Faça um teste

Campos de solicitação de endereço

O corpo da solicitação consiste em um único campo:

• address: um campo do tipo PostalAddress, que precisa conter pelo menos uma entrada em addressLines.

Ao enviar o campo address para a API Address Validation, você só precisa fornecer um campo: addressLines. No entanto, a solicitação de endereço mais simples precisa conter os seguintes subcampos:

• regionCode: recomendado. Esse é um campo opcional, mas, se omitido, a API Address Validation infere a região do endereço. No entanto, para melhores resultados, inclua o regionCode, se você souber. Para conferir uma lista de regiões com suporte, consulte Regiões com suporte.
• addressLines: obrigatório. Uma matriz com endereços que descrevem a estrutura inferior do endereço.

Consulte PostalAddress no guia de referência.

Opção USPS CASS™

O United States Postal Service® (USPS®)¹ mantém o Coding Accuracy Support System (CASS™) para auxiliar e certificar os provedores de validação de endereço.

Somente para as regiões dos EUA e de Porto Rico, é possível ativar o processamento CASS definindo enableUspsCass como true no corpo da solicitação. Para ter os melhores resultados ao usar o CASS, forneça um endereço que inclua a rua e o número da rua, além da cidade, do estado e do CEP:

{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "administrativeArea": "CA",
    "postalCode": "94043",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  },
  "enableUspsCass": true
}

Confira!

O API Explorer permite fazer solicitações de amostra para que você se familiarize com a API e as opções dela.

1. Selecione o ícone da API, , no lado direito da página.

2. Opcionalmente, abra Mostrar parâmetros padrão e defina o parâmetro fields como a máscara de campo.

3. Se preferir, edite o corpo da solicitação.

4. Selecione o botão Executar. Na caixa de diálogo, escolha a conta que você quer usar para fazer a solicitação.

5. No painel do API Explorer, selecione o ícone de expansão, , para abrir a janela do API Explorer.