- Solicitação HTTP
- Corpo da solicitação
- Corpo da resposta
- PostalAddress
- LanguageOptions
- ValidationResult
- Veredito
- Granularidade
- Endereço
- AddressComponent
- ComponentName
- ConfirmationLevel
- Geocódigo
- LatLng
- PlusCode
- Janela de visualização
- AddressMetadata
- UspsData
- UspsAddress
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 ( |
Campos | |
---|---|
address |
Obrigatório. O endereço que está sendo validado. Endereços não formatados devem ser enviados por O tamanho total dos campos dessa entrada não pode exceder 280 caracteres. Consulte as regiões compatíveis aqui. O valor A API Address Validation ignora os valores em |
previousResponseId |
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 |
enableUspsCass |
Ativa o modo compatível com CASS do USPS. Isso afeta apenas o campo É recomendável usar um |
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 |
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 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 ( |
Campos | |
---|---|
result |
O resultado da validação do endereço. |
responseId |
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 |
A revisão de esquema do |
regionCode |
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 |
languageCode |
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 |
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 |
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 |
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 |
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 |
Opcional. Sublocalidade do endereço. Por exemplo, pode ser bairro ou distrito. |
addressLines[] |
Obrigatório. Linhas de endereço não estruturadas que descrevem os níveis mais baixos de um endereço. |
recipients[] |
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 |
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 |
Visualização: retornar um |
ValidationResult
O resultado da validação de um endereço.
Representação JSON |
---|
{ "verdict": { object ( |
Campos | |
---|---|
verdict |
Sinalizações de veredito geral |
address |
Informações sobre o endereço em si, e não o geocódigo. |
geocode |
Informações sobre o local e o lugar para o qual o endereço foi geocodificado. |
metadata |
Outras informações relevantes para a entrega. Não há garantia de que o campo |
uspsData |
Sinalizações extras de entrega fornecidas pelo USPS. Fornecido apenas nas regiões |
englishLatinAddress |
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 Observação: os campos |
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 ( |
Campos | |
---|---|
inputGranularity |
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 Por exemplo, se o endereço de entrada incluir um número de apartamento específico, o |
validationGranularity |
O nível de granularidade em que a API pode validar totalmente o endereço. Por exemplo, O resultado da validação por componente de endereço pode ser encontrado em |
geocodeGranularity |
Informações sobre a granularidade da Às vezes, pode ser diferente do |
addressComplete |
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á |
hasUnconfirmedComponents |
Pelo menos um componente de endereço não pode ser categorizado ou validado. Consulte |
hasInferredComponents |
Pelo menos um componente de endereço foi inferido (adicionado) que não estava na entrada. Consulte |
hasReplacedComponents |
Pelo menos um componente de endereço foi substituído. Consulte |
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 ( |
Campos | |
---|---|
formattedAddress |
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 |
O endereço pós-processado representado como um endereço postal. |
addressComponents[] |
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[] |
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 |
unconfirmedComponentTypes[] |
Os tipos de componentes que estão presentes no |
unresolvedTokens[] |
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 |
AddressComponent
Representa um componente de endereço, como uma rua, cidade ou estado.
Representação JSON |
---|
{ "componentName": { object ( |
Campos | |
---|---|
componentName |
É o nome desse componente. |
componentType |
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 |
Indica o nível de certeza que temos de que o componente está correto. |
inferred |
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 |
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 |
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 |
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 |
O texto do nome. Por exemplo, "5th Avenue" para o nome da rua ou "1253" para o número do endereço. |
languageCode |
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 ( |
Campos | |
---|---|
location |
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 |
O Plus Code correspondente ao |
bounds |
Os limites do lugar geocodificado. |
featureSizeMeters |
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 |
O PlaceID do lugar para o qual a entrada é geocodificada. Para mais informações sobre IDs de lugar, clique aqui. |
placeTypes[] |
Os tipos de lugar para os quais a entrada foi geocodificada. Por exemplo, |
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 |
A latitude em graus. Precisa estar no intervalo [-90,0, +90,0]. |
longitude |
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 |
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 |
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 ehigh.longitude
= 180 graus, a janela de visualização incluirá todas as longitudes.Se
low.longitude
= 180 graus ehigh.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 ( |
Campos | |
---|---|
low |
Obrigatório. O ponto baixo da janela de visualização. |
high |
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 |
Indica que este é o endereço de uma empresa. Se não definido, indica que o valor é desconhecido. |
poBox |
Indica o endereço de uma caixa postal. Se não definido, indica que o valor é desconhecido. |
residential |
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 ( |
Campos | |
---|---|
standardizedAddress |
Endereço padronizado da USPS. |
deliveryPointCode |
Código do ponto de entrega de dois dígitos |
deliveryPointCheckDigit |
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 |
Os valores possíveis para confirmação do DPV. Retorna um único caractere ou não retorna nenhum valor.
|
dpvFootnote |
As notas de rodapé da validação do ponto de entrega. Várias notas de rodapé podem ser agrupadas na mesma string.
|
dpvCmra |
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.
|
dpvVacant |
Esse lugar está vazio? Retorna um único caractere.
|
dpvNoStat |
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.
|
dpvNoStatReasonCode |
Indica o tipo NoStat. Retorna um código de motivo como int.
|
dpvDrop |
A sinalização indica que o e-mail foi entregue a um único receptível em um site. Retorna um único caractere.
|
dpvThrowback |
Indica que a correspondência não é entregue no endereço. Retorna um único caractere.
|
dpvNonDeliveryDays |
A sinalização indica que a entrega de e-mails não é realizada todos os dias da semana. Retorna um único caractere.
|
dpvNonDeliveryDaysValues |
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 |
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.
|
dpvPbsa |
Indica que o endereço correspondeu ao registro PBSA. Retorna um único caractere.
|
dpvDoorNotAccessible |
A sinalização indica endereços onde a USPS não pode bater na porta para entregar correspondências. Retorna um único caractere.
|
dpvEnhancedDeliveryCode |
Indica que mais de um código de retorno DPV é válido para o endereço. Retorna um único caractere.
|
carrierRoute |
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:
|
carrierRouteIndicator |
Indicador de classificação da taxa de rota da transportadora. |
ewsNoMatch |
O endereço de entrega pode ser correspondido, mas o arquivo EWS indica que uma correspondência exata estará disponível em breve. |
postOfficeCity |
Principal cidade dos correios. |
postOfficeState |
Estado principal da agência dos correios. |
abbreviatedCity |
Cidade abreviada. |
fipsCountyCode |
Código do condado dos FIPS. |
county |
Nome do condado. |
elotNumber |
Número da linha de viagem otimizada (eLOT, na sigla em inglês). |
elotFlag |
Bandeira crescente/decrescente do eLOT (A/D). |
lacsLinkReturnCode |
Código de retorno LACSLink. |
lacsLinkIndicator |
Indicador LACSLink. |
poBoxOnlyPostalCode |
Código postal somente para caixa postal. |
suitelinkFootnote |
Notas de rodapé que correspondem a um registro de rua ou arranha-céu com informações de conjunto. Se o nome da empresa for correspondente, o número secundário vai ser retornado.
|
pmbDesignator |
Designador de unidade da caixa de correio particular (PMB, na sigla em inglês). |
pmbNumber |
Número de PMB (caixa de correio privada); |
addressRecordType |
Tipo do registro de endereço que corresponde ao endereço de entrada.
|
defaultAddress |
Indicador de que um endereço padrão foi encontrado, mas há endereços mais específicos. |
errorMessage |
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 |
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 |
Primeira linha de endereço. |
firm |
Nome da empresa. |
secondAddressLine |
Segunda linha de endereço. |
urbanization |
Nome de urbanização porto-riquenha. |
cityStateZipAddressLine |
Cidade + estado + código postal. |
city |
Nome da cidade. |
state |
Código de estado com duas letras. |
zipCode |
CEP, por exemplo 10009. |
zipCodeExtension |
Extensão de quatro dígitos do código postal, por exemplo, 5023. |