Valida um CEP (formato brasileiro)

GET/v1/utils/postcode-validation

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros de consulta

postcodestringobrigatório
O CEP a validar; o hífen é aceito.
countrystring
Código do país (padrão BR).

Respostas

200Sucesso

citystringobrigatóriopode ser nulo
Cidade; null quando não resolvida.
statestringobrigatóriopode ser nulo
Estado (sigla de duas letras); null quando não resolvido.
validbooleanobrigatório
Se o CEP é válido.
streetstringobrigatóriopode ser nulo
Logradouro; null quando não resolvido.
addressobjectobrigatóriopode ser nulo
O mesmo endereço, aninhado; null quando a consulta não resolveu.
+6 campos de address
- citystringobrigatório
  Cidade.
- statestringobrigatório
  Estado (sigla de duas letras).
- streetstringobrigatóriopode ser nulo
  Logradouro; null num CEP que cobre uma cidade inteira.
- districtstringobrigatóriopode ser nulo
  Bairro.
- postcodestringobrigatório
  CEP, só dígitos.
- complementstringobrigatóriopode ser nulo
  Complemento do logradouro (ex.: o lado da rua).
countrystringobrigatório
Código do país.
districtstringobrigatóriopode ser nulo
Bairro; null quando não resolvido.
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
postcodestringobrigatório
O CEP, só dígitos.
complementstringobrigatóriopode ser nulo
Complemento do logradouro; null quando não resolvido.

400Requisição inválida (validação)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorDetecta a bandeira de um cartão pelo BIN PróximaRegras de recorrência suportadas (assinaturas/preços)