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 passar um corpo da solicitação JSON a ela 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"

Também é possível omitir locality e especificá-lo como um elemento na a 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 deve conter em pelo menos uma entrada em addressLines.

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

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

Opção USPS CASSTM

O United States Postal Service® (USPS®)¹ mantém Sistema de suporte à precisão de programação (CASSTM, na sigla em inglês), que oferece suporte e certificação provedores de validação de endereço.

Somente para regiões dos EUA e PR, é possível ativar o processamento do CASS configurando enableUspsCass a true no corpo da solicitação. Para melhores resultados ao usar CASS, forneça um endereço que inclua a rua e o número, junto com a cidade, o estado e o CEP:

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

Confira!

Com o APIs Explorer, você pode fazer solicitações de amostra para se familiarizar com a API e as opções de API.

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

2. Como opção, expanda Mostrar parâmetros padrão e defina fields parâmetro ao campo máscara.

3. É possível editar o Corpo da solicitação.

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

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