Method: validateAddress

Valida um endereço.

Solicitação HTTP

POST https://addressvalidation.googleapis.com/v1:validateAddress

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
Campos
address

object (PostalAddress)

Obrigatório. O endereço que está sendo validado. Endereços não formatados devem ser enviados por addressLines.

O tamanho total dos campos dessa entrada não pode exceder 280 caracteres.

Consulte as regiões compatíveis aqui.

O valor languageCode no endereço de entrada é reservado para usos futuros e ignorado no momento. O resultado do endereço validado será preenchido com base no idioma de preferência do endereço especificado, conforme identificado pelo sistema.

A API Address Validation ignora os valores em recipients e organization. Quaisquer valores nesses campos serão descartados e não serão retornados. Não os defina.
previousResponseId

string

Este campo precisa estar vazio para a primeira solicitação de validação de endereço. Se mais solicitações forem necessárias para validar totalmente um único endereço (por exemplo, se as mudanças feitas pelo usuário após a validação inicial precisarem ser revalidadas), cada solicitação de acompanhamento vai precisar preencher esse campo com responseId desde a primeira resposta na sequência de validação.
enableUspsCass

boolean

Ativa o modo compatível com CASS do USPS. Isso afeta apenas o campo google.maps.addressvalidation.v1.ValidationResult.usps_data do google.maps.addressvalidation.v1.ValidationResult. Observação: para solicitações do USPS com CASS ativado para endereços em Porto Rico, um google.type.PostalAddress.region_code de address precisa ser fornecido como "PR", ou um google.type.PostalAddress.administrative_area de address precisa ser fornecido como "Porto Rico". (não diferencia maiúsculas de minúsculas) ou "PR".

É recomendável usar um address em componentes ou especificar pelo menos dois google.type.PostalAddress.address_lines, em que a primeira linha contém o número e o nome da rua e a segunda linha contém a cidade, o estado e o CEP.
languageOptions

object (LanguageOptions)

Opcional. Pré-lançamento: este recurso está em pré-lançamento (pré-GA). Os produtos e recursos em pré-GA têm suporte limitado, e é possível que as mudanças neles não sejam compatíveis com outras versões nessa fase. Todos os produtos em pré-GA são cobertos pelos Termos de Serviço específicos da Plataforma Google Maps. Para mais informações, consulte as descrições da fase de lançamento.

Permite que a API Address Validation inclua mais informações na resposta.
sessionToken

string

Opcional. String que identifica uma sessão de preenchimento automático para fins de faturamento. Precisa ser uma string base64 segura para URL e nome de arquivo com no máximo 36 caracteres ASCII. Caso contrário, será retornado um erro INVALID_MCC.

A sessão começa quando o usuário faz uma consulta do Autocomplete e termina quando ele seleciona um lugar e uma chamada para Place Details ou Address Validation é feita. Cada sessão pode ter várias consultas do Autocomplete, seguidas por uma solicitação de Place Details ou Address Validation. As credenciais usadas para cada solicitação em uma sessão precisam pertencer ao mesmo projeto do console do Google Cloud. Após a conclusão de uma sessão, o token perde a validade. seu aplicativo precisa gerar um novo token para cada sessão. Se o parâmetro sessionToken for omitido ou você reutilizar um token, a sessão vai ser cobrada como se nenhum token de sessão tivesse sido fornecido (cada solicitação será faturada separadamente).

Observação: a Address Validation pode ser usada apenas em sessões com a API Autocomplete (novo), não com a API Autocomplete. Consulte https://developers.google.com/maps/documentation/places/web-service/session-pricing para ver mais detalhes.

Corpo da resposta

A resposta a uma solicitação de validação de endereço.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Campos
result

object (ValidationResult)

O resultado da validação do endereço.
responseId

string

O UUID que identifica essa resposta. Caso o endereço precise ser revalidado, esse UUID precisa acompanhar a nova solicitação.

PostalAddress

Representa um endereço postal, por exemplo, para endereços para pagamento ou distribuição postal. Com um endereço postal, o serviço de correios pode entregar itens em um local, uma caixa postal ou outro local semelhante. Não se destina a modelar locais geográficos (estradas, cidades, montanhas).

No uso normal, um endereço seria criado por digitação do usuário ou pela importação de dados existentes, dependendo do tipo de processo.

Dicas sobre inserção / edição de endereços: - Use um widget de endereço pronto para internacionalização, como https://github.com/google/libaddressinput. - Os usuários não devem receber elementos da interface para entrada ou edição de campos fora dos países em que o campo é usado.

Para mais orientações sobre como usar este esquema, consulte: https://support.google.com/business/answer/6397478.

Representação JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Campos
revision

integer

A revisão de esquema do PostalAddress. Qualquer valor diferente de 0 fará com que a API retorne um erro INVALID_ARGUMENT.
regionCode

string

Opcional. Código de região CLDR do país/região do endereço. Para mais detalhes, consulte https://cldr.unicode.org/ e https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemplo: "CH" para Suíça. Se o código da região não for fornecido, ele será inferido a partir do endereço. Para ter o melhor desempenho, recomenda-se incluir o código da região, se você o souber. Ter regiões inconsistentes ou repetidas pode levar a um desempenho ruim. Por exemplo, se o addressLines já inclui a região, não forneça o código de região novamente neste campo. Consulte as regiões compatíveis nas Perguntas frequentes.
languageCode

string

O código de idioma no endereço de entrada está reservado para usos futuros e é ignorado no momento. A API retorna o endereço no idioma apropriado do local em que ele está.
postalCode

string

Opcional. Código postal do endereço. Nem todos os países usam ou exigem códigos postais, mas nos locais onde são usados, eles podem desencadear uma validação adicional com outras partes do endereço (por exemplo, validação de estado/CEP nos EUA).
sortingCode

string

Opcional. Código de classificação adicional específico de país. Não é usado na maioria das regiões. Nos locais em que é usado, o valor é uma string como “CEDEX”, que pode ser seguida por um número (por exemplo, “CEDEX 7”), ou apenas um número sozinho, representando o “código do setor” (Jamaica), o “indicador de área de entrega” (Malawi) ou o “indicador de agência de correio” (por exemplo, Costa do Marfim).
administrativeArea

string

Opcional. A maior subdivisão administrativa que é usada para endereços postais de um país ou uma região. Por exemplo, pode ser um estado, uma província, uma zona ou uma prefeitura. Especificamente na Espanha, é a província, e não a comunidade autônoma (por exemplo, “Barcelona”, não “Catalunha”). Muitos países não usam área administrativa em endereços postais. Por exemplo, na Suíça, isso deve ser deixado em branco.
locality

string

Opcional. Geralmente se refere à parte do endereço relativa a cidade/município. Exemplos: cidade nos EUA, comunidade na Itália, distrito postal no Reino Unido. Em regiões onde as localidades não são claramente definidas ou não se encaixam bem nessa estrutura, deixe a localidade em branco e use addressLines.
sublocality

string

Opcional. Sublocalidade do endereço. Por exemplo, pode ser bairro ou distrito.
addressLines[]

string

Obrigatório. Linhas de endereço não estruturadas que descrevem os níveis mais baixos de um endereço.

Como os valores em addressLines não têm informações de tipo e podem conter diversos valores em um único campo (por exemplo, "Austin, TX"), é importante que a ordem da linha seja clara. Ela precisa estar em "ordem de envelope" para o país ou região do endereço.

A representação estrutural mínima permitida de um endereço consiste em todas as informações inseridas no addressLines. Se um regionCode não for fornecido, a região será inferida a partir das linhas de endereço.

Criar um endereço contendo apenas addressLines e depois geocodificar é a maneira recomendada de lidar com endereços totalmente não estruturados (em vez de adivinhar quais partes do endereço devem ser localidades ou áreas político-administrativas).
recipients[]

string

Evite definir esse campo. No momento, ela não é usada pela API Address Validation. Embora, no momento, a API não rejeite solicitações com esse conjunto de campos, as informações serão descartadas e não serão retornadas na resposta.
organization

string

Evite definir esse campo. No momento, ela não é usada pela API Address Validation. Embora, no momento, a API não rejeite solicitações com esse conjunto de campos, as informações serão descartadas e não serão retornadas na resposta.

LanguageOptions

Pré-lançamento: este recurso está em pré-lançamento (pré-GA). Os produtos e recursos em pré-GA têm suporte limitado, e é possível que as mudanças neles não sejam compatíveis com outras versões nessa fase. Todos os produtos em pré-GA são cobertos pelos Termos de Serviço específicos da Plataforma Google Maps. Para mais informações, consulte as descrições da fase de lançamento.

Permite que a API Address Validation inclua mais informações na resposta.

Representação JSON 
{
  "returnEnglishLatinAddress": boolean
}
Campos
returnEnglishLatinAddress

boolean

Visualização: retornar um google.maps.addressvalidation.v1.Address em inglês. Consulte google.maps.addressvalidation.v1.ValidationResult.english_latin_address para mais detalhes.

ValidationResult

O resultado da validação de um endereço.

Representação JSON 
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
Campos
verdict

object (Verdict)

Sinalizações de veredito geral
address

object (Address)

Informações sobre o endereço em si, e não o geocódigo.
geocode

object (Geocode)

Informações sobre o local e o lugar para o qual o endereço foi geocodificado.
metadata

object (AddressMetadata)

Outras informações relevantes para a entrega. Não há garantia de que o campo metadata será totalmente preenchido para todos os endereços enviados à API Address Validation.
uspsData

object (UspsData)

Sinalizações extras de entrega fornecidas pelo USPS. Fornecido apenas nas regiões US e PR.
englishLatinAddress

object (Address)

Pré-lançamento: este recurso está em pré-lançamento (pré-GA). Os produtos e recursos em pré-GA têm suporte limitado, e é possível que as mudanças neles não sejam compatíveis com outras versões nessa fase. Todos os produtos em pré-GA são cobertos pelos Termos de Serviço específicos da Plataforma Google Maps. Para mais informações, consulte as descrições da fase de lançamento.

O endereço traduzido para o inglês.

Endereços traduzidos não são reutilizáveis como entradas de API. O serviço os fornece para que o usuário possa usar o idioma nativo para confirmar ou negar a validação do endereço fornecido originalmente.

Se parte do endereço não tiver uma tradução para o inglês, o serviço a retornará em um idioma alternativo que usa script latino. Clique aqui para conferir uma explicação sobre como o idioma alternativo é selecionado. Se parte do endereço não tiver traduções ou transliterações em um idioma que usa script latino, o serviço vai retornar essa parte no idioma local associado ao endereço.

Ative essa saída usando a sinalização google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

Observação: os campos google.maps.addressvalidation.v1.Address.unconfirmed_component_types em englishLatinAddress e google.maps.addressvalidation.v1.AddressComponent.confirmation_level em englishLatinAddress.address_components não são preenchidos.

Veredito

Visão geral de alto nível do resultado da validação de endereço e do geocódigo.

Representação JSON 
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
Campos
inputGranularity

enum (Granularity)

A granularidade do endereço de entrada. Esse é o resultado da análise do endereço de entrada e não fornece sinais de validação. Para indicadores de validação, consulte validationGranularity abaixo.

Por exemplo, se o endereço de entrada incluir um número de apartamento específico, o inputGranularity aqui será SUB_PREMISE. Se não conseguirmos fazer a correspondência com o número do apartamento nos bancos de dados ou se o número for inválido, o validationGranularity provavelmente será PREMISE ou menor.
validationGranularity

enum (Granularity)

O nível de granularidade em que a API pode validar totalmente o endereço. Por exemplo, validationGranularity de PREMISE indica que todos os componentes de endereço no nível PREMISE ou mais aproximados podem ser validados.

O resultado da validação por componente de endereço pode ser encontrado em google.maps.addressvalidation.v1.Address.address_components.
geocodeGranularity

enum (Granularity)

Informações sobre a granularidade da geocode. Isso pode ser entendido como o significado semântico de quão aproximada ou fina é a localização geocodificada.

Às vezes, pode ser diferente do validationGranularity acima. Por exemplo, nosso banco de dados pode registrar a existência de um número de apartamento, mas não ter uma localização precisa do apartamento dentro de um grande complexo de apartamentos. Nesse caso, a validationGranularity vai ser SUB_PREMISE, mas a geocodeGranularity vai ser PREMISE.
addressComplete

boolean

O endereço é considerado completo quando não há tokens não resolvidos nem componentes de endereço inesperados ou ausentes. Se não for definido, o valor será false. Consulte os campos missingComponentTypes, unresolvedTokens ou unexpected para saber mais detalhes.
hasUnconfirmedComponents

boolean

Pelo menos um componente de endereço não pode ser categorizado ou validado. Consulte google.maps.addressvalidation.v1.Address.address_components para mais detalhes.
hasInferredComponents

boolean

Pelo menos um componente de endereço foi inferido (adicionado) que não estava na entrada. Consulte google.maps.addressvalidation.v1.Address.address_components para mais detalhes.
hasReplacedComponents

boolean

Pelo menos um componente de endereço foi substituído. Consulte google.maps.addressvalidation.v1.Address.address_components para saber detalhes.

Granularidade

As diversas granularidades que um endereço ou geocódigo pode ter. Quando usados para indicar a granularidade de um endereço, esses valores indicam a granularidade com que o endereço identifica um destino de correspondência. Por exemplo, um endereço como "123 Main Street, Redwood City, CA, 94061" identifica um PREMISE, enquanto algo como "Redwood City, CA, 94061" identifica um LOCALITY. No entanto, se não for possível localizar um geocódigo para "123 Main Street" em Redwood City, o geocódigo retornado pode ter a granularidade de LOCALITY, mesmo que o endereço seja mais granular.

Enums
GRANULARITY_UNSPECIFIED Valor padrão. Esse valor não é usado.
SUB_PREMISE Resultado abaixo do nível do edifício, como um apartamento.
PREMISE Resultado no nível do edifício.
PREMISE_PROXIMITY Um geocódigo que se aproxima da localização no nível do edifício do endereço.
BLOCK O endereço ou geocódigo indica um bloco. Usado apenas em regiões que têm endereçamento no nível de bloco, como o Japão.
ROUTE O geocódigo ou endereço é granular para um trajeto, como uma rua, uma estrada ou uma rodovia.
OTHER Todas as outras granularidades, que são agrupadas porque não são entregáveis.

Endereço

Detalhes do endereço pós-processado. O pós-processamento inclui a correção de partes do endereço com erros de ortografia, a substituição de partes incorretas e a inferência de partes ausentes.

Representação JSON 
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Campos
formattedAddress

string

O endereço pós-processado, formatado como um endereço de linha única seguindo as regras de formatação de endereço da região onde o endereço está localizado.
postalAddress

object (PostalAddress)

O endereço pós-processado representado como um endereço postal.
addressComponents[]

object (AddressComponent)

Lista não ordenada. Os componentes de endereço individuais do endereço formatado e corrigido, além das informações de validação. Isso fornece informações sobre o status de validação dos componentes individuais.

Os componentes de endereço não são ordenados de determinada maneira. Não presuma a ordem dos componentes de endereço na lista.
missingComponentTypes[]

string

Os tipos de componentes que deveriam estar presentes em um endereço de correspondência formatado corretamente, mas não foram encontrados na entrada E não puderam ser inferidos. Componentes desse tipo não estão presentes em formattedAddress, postalAddress ou addressComponents. Por exemplo, ['street_number', 'route'] para uma entrada como "Boulder, Colorado, 80301, USA". Confira a lista de tipos possíveis aqui.
unconfirmedComponentTypes[]

string

Os tipos de componentes que estão presentes no addressComponents, mas não foram confirmados como corretos. Esse campo é fornecido por conveniência: o conteúdo dele é equivalente a iterar por addressComponents para encontrar os tipos de todos os componentes em que confirmationLevel não é CONFIRMED ou a flag inferred não está definida como true. Confira a lista de tipos possíveis aqui.
unresolvedTokens[]

string

Quaisquer tokens na entrada que não foram resolvidos. Pode ser uma entrada que não foi reconhecida como parte válida de um endereço. Por exemplo, em uma entrada como "123235253253 Main St, San Francisco, CA, 94105", os tokens não resolvidos podem ser semelhantes a ["123235253253"], porque não parece um número de rua válido.

AddressComponent

Representa um componente de endereço, como uma rua, cidade ou estado.

Representação JSON 
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
Campos
componentName

object (ComponentName)

É o nome desse componente.
componentType

string

O tipo do componente de endereço. Consulte a Tabela 2: outros tipos retornados pelo serviço Places para uma lista dos possíveis tipos.
confirmationLevel

enum (ConfirmationLevel)

Indica o nível de certeza que temos de que o componente está correto.
inferred

boolean

Indica que o componente não fazia parte da entrada, mas inferimos que ele é o local do endereço e acreditamos que ele deve ser fornecido para um endereço completo.
spellCorrected

boolean

Indica uma correção de um erro de ortografia no nome do componente. A API nem sempre sinaliza mudanças de uma variante ortográfica para outra, como ao mudar a "centro" ao "centro". Ela também nem sempre sinaliza erros de ortografia comuns, como ao alterar "Amphitheater Pkwy" para "Amphitheatre Pkwy".
replaced

boolean

Indica que o nome do componente foi substituído por outro completamente diferente, por exemplo, um CEP errado foi substituído por outro que esteja correto no endereço. Essa não é uma mudança estética, o componente de entrada foi alterado para um diferente.
unexpected

boolean

Indica um componente de endereço que não deve estar presente em um endereço postal da região especificada. Nós o retemos apenas porque era parte da entrada.

ComponentName

Um wrapper para o nome do componente.

Representação JSON 
{
  "text": string,
  "languageCode": string
}
Campos
text

string

O texto do nome. Por exemplo, "5th Avenue" para o nome da rua ou "1253" para o número do endereço.
languageCode

string

O código de idioma BCP-47. Não estará presente se o nome do componente não estiver associado a um idioma, como o número da rua.

ConfirmationLevel

Os diferentes valores possíveis para níveis de confirmação.

Enums
CONFIRMATION_LEVEL_UNSPECIFIED Valor padrão. Esse valor não é usado.
CONFIRMED Conseguimos verificar se esse componente existe e faz sentido no contexto do restante do endereço.
UNCONFIRMED_BUT_PLAUSIBLE Este componente não pôde ser confirmado, mas é provável que ele exista. Por exemplo, o número da rua em um intervalo válido de números de uma rua em que números específicos de casas não são conhecidos.
UNCONFIRMED_AND_SUSPICIOUS Este componente não foi confirmado e é provável que esteja errado. Por exemplo, um bairro que não cabe no restante do endereço.

Geocódigo

Contém informações sobre o lugar para o qual a entrada foi geocodificada.

Representação JSON 
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Campos
location

object (LatLng)

O local geocodificado da entrada.

É preferível usar IDs de lugar em vez de usar endereços, coordenadas de latitude/longitude ou Plus Codes. O uso de coordenadas durante o trajeto ou no cálculo de rotas de carro sempre faz com que o ponto seja direcionado para a estrada mais próxima dessas coordenadas. Talvez essa não seja uma estrada que leve ao destino de forma rápida ou segura e não esteja próxima de um ponto de acesso à propriedade. Além disso, quando um local é geocodificado de forma reversa, não há garantia de que o endereço retornado corresponderá ao original.
plusCode

object (PlusCode)

O Plus Code correspondente ao location.
bounds

object (Viewport)

Os limites do lugar geocodificado.
featureSizeMeters

number

O tamanho do lugar geocodificado, em metros. Essa é outra medida da grossura da localização geocodificada, mas em tamanho físico e não em significado semântico.
placeId

string

O PlaceID do lugar para o qual a entrada é geocodificada.

Para mais informações sobre IDs de lugar, clique aqui.
placeTypes[]

string

Os tipos de lugar para os quais a entrada foi geocodificada. Por exemplo, ['locality', 'political']. A lista completa de tipos pode ser encontrada aqui.

LatLng

Um objeto que representa um par de latitude/longitude. Ele é expresso como um par de valores duplos para representar graus de latitude e longitude. Salvo indicação em contrário, esse objeto precisa estar em conformidade com o padrão WGS84. Os valores precisam estar dentro de intervalos normalizados.

Representação JSON 
{
  "latitude": number,
  "longitude": number
}
Campos
latitude

number

A latitude em graus. Precisa estar no intervalo [-90,0, +90,0].
longitude

number

A longitude em graus. Precisa estar no intervalo [-180,0, +180,0].

PlusCode

O Plus Code (http://plus.codes) é uma referência de local com dois formatos: o código global que define um 14mx14m (1/8.000 de grau) ou um retângulo menor e o código composto, substituindo o prefixo por um local de referência.

Representação JSON 
{
  "globalCode": string,
  "compoundCode": string
}
Campos
globalCode

string

O código global (completo) do lugar, como "9FWM33GV+HQ", representando uma área de 1/8.000 por 1/8.000 grau (aproximadamente 14 por 14 metros).
compoundCode

string

O código composto do lugar, como "33GV+HQ, Ramberg, Noruega", contendo o sufixo do código global e substituir o prefixo por um nome formatado de uma entidade de referência.

Janela de visualização

Uma janela de visualização de latitude e longitude, representada como dois pontos diagonalmente opostos low e high. Uma janela de visualização é considerada uma região fechada, ou seja, inclui seus limites. Os limites de latitude devem variar entre -90 e 90 graus, e os limites de longitude devem variar entre -180 e 180 graus. Os vários casos incluem:

  • Se low = high, a janela de visualização consistirá nesse único ponto.

  • Se low.longitude > high.longitude, o intervalo de longitude será invertido (a janela de visualização cruza a linha de 180 graus de longitude).

  • Se low.longitude = -180 graus e high.longitude = 180 graus, a janela de visualização incluirá todas as longitudes.

  • Se low.longitude = 180 graus e high.longitude = -180 graus, o intervalo de longitude está vazio.

  • Se low.latitude > high.latitude, o intervalo de latitude está vazio.

Tanto low quanto high precisam ser preenchidos, e a caixa representada não pode ficar vazia (conforme especificado pelas definições acima). Uma janela de visualização vazia resultará em erro.

Por exemplo, esta janela de visualização abrange totalmente Nova York:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Representação JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Campos
low

object (LatLng)

Obrigatório. O ponto baixo da janela de visualização.
high

object (LatLng)

Obrigatório. O ponto alto da janela de visualização.

AddressMetadata

Os metadados do endereço. Não há garantia de que o campo metadata será totalmente preenchido para todos os endereços enviados à API Address Validation.

Representação JSON 
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
Campos
business

boolean

Indica que este é o endereço de uma empresa. Se não definido, indica que o valor é desconhecido.
poBox

boolean

Indica o endereço de uma caixa postal. Se não definido, indica que o valor é desconhecido.
residential

boolean

Indica que este é o endereço de uma residência. Se não definido, indica que o valor é desconhecido.

UspsData

Os dados do USPS para o endereço. Não há garantia de que o campo uspsData será totalmente preenchido para todos os endereços dos EUA ou PR enviados para a API Address Validation. É recomendado integrar os campos de endereço de backup na resposta se você utilizar uspsData como parte principal da resposta.

Representação JSON 
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}
Campos
standardizedAddress

object (UspsAddress)

Endereço padronizado da USPS.
deliveryPointCode

string

Código do ponto de entrega de dois dígitos
deliveryPointCheckDigit

string

Dígito de verificação do ponto de entrega. Este número é adicionado ao final do delivery_point_barcode para mensagens digitalizadas mecanicamente. A soma de todos os dígitos de delivery_point_barcode, deliveryPointCheckDigit, CEP e ZIP+4 gera um número divisível por 10.
dpvConfirmation

string

Os valores possíveis para confirmação do DPV. Retorna um único caractere ou não retorna nenhum valor.

  • N: as informações dos números principais e secundários não foram confirmadas pelo DPV.
  • D: o endereço foi confirmado por DPV somente para o número principal, e as informações do número secundário estavam ausentes.
  • S: o endereço foi confirmado por DPV apenas para o número principal, e as informações do número secundário estavam presentes, mas não foram confirmadas.
  • Y: o endereço foi confirmado por DPV para números principais e secundários.
  • Vazio: se a resposta não contiver um valor dpvConfirmation, o endereço não foi enviado para confirmação do DPV.
dpvFootnote

string

As notas de rodapé da validação do ponto de entrega. Várias notas de rodapé podem ser agrupadas na mesma string.

  • AA: endereço de entrada correspondente ao arquivo ZIP+4
  • A1: o endereço de entrada não corresponde ao arquivo ZIP+4
  • BB: correspondente ao DPV (todos os componentes)
  • CC: número secundário não correspondente e não obrigatório
  • C1: o número secundário não corresponde, mas é obrigatório
  • N1: endereço de arranha-céu sem número secundário
  • M1: número principal ausente
  • M3: o número principal é inválido
  • P1: o número da caixa de entrada do endereço de entrada, RR ou HC está ausente
  • P3: o número da caixa de entrada, PO, RR ou HC do endereço de entrada é inválido
  • F1: endereço de entrada correspondente a um endereço militar
  • G1: endereço de entrada correspondente a um endereço geral de entrega
  • U1: endereço de entrada correspondente a um CEP exclusivo
  • PB: endereço de entrada correspondente ao registro PBSA
  • RR: endereço confirmado por DPV com informações do PMB
  • R1: endereço confirmado por DPV sem informações do PMB
  • R7: registro Carrier Route R777 ou R779
  • IA: endereço informado identificado
  • TA: número principal que é correspondido com a inclusão de um alfa à direita
dpvCmra

string

Indica se o endereço é uma Agência de recebimento de correspondências comerciais (CMRA, na sigla em inglês), ou seja, uma empresa privada que recebe correspondências de clientes. Retorna um único caractere.

  • Y: o endereço é um CMRA
  • N: o endereço não é um CMRA
dpvVacant

string

Esse lugar está vazio? Retorna um único caractere.

  • Y: o endereço está vago
  • N: o endereço não está vazio
dpvNoStat

string

Esse é um endereço sem estatísticas ou ativo? Nenhum endereço de estatística é aquele que não está continuamente ocupado ou endereços que o USPS não atende. Retorna um único caractere.

  • Y: o endereço não está ativo
  • N: o endereço está ativo
dpvNoStatReasonCode

integer

Indica o tipo NoStat. Retorna um código de motivo como int.

  • 1: IDA (endereço de entrega interno): endereços que não recebem correspondências diretamente do USPS, mas são entregues em um local que atende.
  • 2: CDS – Endereços que ainda não estão disponíveis para entrega. Por exemplo, uma nova subdivisão em que lotes e números primários foram determinados, mas ainda não existe uma estrutura para ocupação.
  • 3: Colisão: endereços que não são confirmados pelo DPV.
  • 4: CMZ (faculdade, militar e outros tipos) – ZIP + quatro registros que o USPS incorporou nos dados.
  • 5 (regular): indica que os endereços que não estão recebendo entregas e que não são contabilizados como possíveis entregas.
  • 6: secundário obrigatório: o endereço precisa de informações secundárias.
dpvDrop

string

A sinalização indica que o e-mail foi entregue a um único receptível em um site. Retorna um único caractere.

  • Y: os e-mails são entregues a um único receptível em um site.
  • N: o e-mail não é entregue a um único receptível em um local.
dpvThrowback

string

Indica que a correspondência não é entregue no endereço. Retorna um único caractere.

  • Y: a correspondência não é entregue no endereço.
  • N: a correspondência é entregue no endereço.
dpvNonDeliveryDays

string

A sinalização indica que a entrega de e-mails não é realizada todos os dias da semana. Retorna um único caractere.

  • Y: a entrega de e-mails não é realizada todos os dias da semana.
  • N: não há indicação de que a entrega de e-mails não é realizada todos os dias da semana.
dpvNonDeliveryDaysValues

integer

Número inteiro que identifica os dias de não exibição. Ele pode ser interrogado usando sinalizações de bit: 0x40 – Domingo é um dia de não entrega 0x20 – Segunda-feira é um dia de não entrega 0x10 – Terça é um dia de não entrega 0x08 – Quarta-feira é um dia de não entrega 0x04 – Quinta-feira é um dia de não entrega 0x02 – Sexta é um dia de não entrega 0x08 – Sexta é um dia de não entrega 0x08 – Quinta-feira é um dia de não entrega 0x02 – Sexta é um dia de não entrega 0x0
dpvNoSecureLocation

string

A sinalização indica que a porta está acessível, mas o pacote não será deixado por questões de segurança. Retorna um único caractere.

  • Y: o pacote não será deixado por motivos de segurança.
  • N: não há nenhuma indicação de que o pacote não será deixado por questões de segurança.
dpvPbsa

string

Indica que o endereço correspondeu ao registro PBSA. Retorna um único caractere.

  • Y: o endereço correspondeu ao registro PBSA.
  • N: o endereço não corresponde ao registro PBSA.
dpvDoorNotAccessible

string

A sinalização indica endereços onde a USPS não pode bater na porta para entregar correspondências. Retorna um único caractere.

  • Y: a porta não está acessível.
  • N: não há indicação de que a porta não está acessível.
dpvEnhancedDeliveryCode

string

Indica que mais de um código de retorno DPV é válido para o endereço. Retorna um único caractere.

  • Y: o endereço foi confirmado por DPV para números principais e secundários.
  • N: as informações dos números principais e secundários não foram confirmadas pelo DPV.
  • S: o endereço foi confirmado por DPV somente para o número principal, e as informações do número secundário estavam presentes, mas não foram confirmadas, ou um único alfa à direita de um número principal foi descartado para fazer uma correspondência de DPV e exigir informações secundárias.
  • D: o endereço foi confirmado por DPV somente para o número principal, e as informações do número secundário estavam ausentes.
  • R: o endereço confirmado, mas atribuído à rota fantasma R777 e R779, e a entrega do USPS não foi fornecida.
carrierRoute

string

O código de rota da operadora. Um código de quatro caracteres composto de um prefixo de uma letra e um indicador de rota de três dígitos.

Prefixos:

  • C: rota da transportadora (ou da cidade)
  • R: trajeto rural
  • H: rota de contrato da rodovia
  • B: seção de caixas dos correios
  • G: unidade de entrega geral
carrierRouteIndicator

string

Indicador de classificação da taxa de rota da transportadora.
ewsNoMatch

boolean

O endereço de entrega pode ser correspondido, mas o arquivo EWS indica que uma correspondência exata estará disponível em breve.
postOfficeCity

string

Principal cidade dos correios.
postOfficeState

string

Estado principal da agência dos correios.
abbreviatedCity

string

Cidade abreviada.
fipsCountyCode

string

Código do condado dos FIPS.
county

string

Nome do condado.
elotNumber

string

Número da linha de viagem otimizada (eLOT, na sigla em inglês).
elotFlag

string

Bandeira crescente/decrescente do eLOT (A/D).
poBoxOnlyPostalCode

boolean

Código postal somente para caixa postal.
pmbDesignator

string

Designador de unidade da caixa de correio particular (PMB, na sigla em inglês).
pmbNumber

string

Número de PMB (caixa de correio privada);
addressRecordType

string

Tipo do registro de endereço que corresponde ao endereço de entrada.

  • F: FIRM. Esta é uma correspondência com um registro firme, que é o melhor nível de correspondência disponível para um endereço.
  • G: ENTREGA GERAL. Trata-se de uma correspondência para um registro de entrega geral.
  • H: EDIFÍCIO / APARTAMENTO. Corresponde a um registro de edifício ou apartamento.
  • P: CAIXA DE POSTAGEM. Corresponde a uma caixa postal.
  • R: RURAL ROUTE ou HIGHWAY CONTRACT: corresponde a um registro de trajeto rural ou de contrato de rodovia, ambos os quais podem ter intervalos de número de caixa associados.
  • S: STREET RECORD: corresponde a um registro de rua que contém um intervalo de números principal válido.
defaultAddress

boolean

Indicador de que um endereço padrão foi encontrado, mas há endereços mais específicos.
errorMessage

string

Mensagem de erro para a recuperação de dados do USPS. Essa informação é preenchida quando o processamento do USPS é suspenso devido à detecção de endereços criados artificialmente.

Os campos de dados do USPS podem não ser preenchidos quando esse erro estiver presente.
cassProcessed

boolean

Indicador de que a solicitação foi processada pelo CASS.

UspsAddress

Representação do USPS de um endereço nos EUA.

Representação JSON 
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
Campos
firstAddressLine

string

Primeira linha de endereço.
firm

string

Nome da empresa.
secondAddressLine

string

Segunda linha de endereço.
urbanization

string

Nome de urbanização porto-riquenha.
cityStateZipAddressLine

string

Cidade + estado + código postal.
city

string

Nome da cidade.
state

string

Código de estado com duas letras.
zipCode

string

CEP, por exemplo 10009.
zipCodeExtension

string

Extensão de quatro dígitos do código postal, por exemplo, 5023.