Pular para o conteúdo principal

Get regex patterns for field validation by country

GET 
/company/country/regex/:code

Retorna padrões de expressão regular organizados por código de país para validar formatos específicos de campos como identificações fiscais, números de telefone, matrículas de veículos e endereços de e-mail.

Objetivo​

Permitir a validação no cliente e no servidor de dados fornecidos pelo usuário de acordo com os requisitos de formato específicos de cada país. Isso garante a qualidade dos dados e a conformidade com os padrões regionais.

Casos de uso​

  • Validar números de identificação fiscal (NIF, CIF, VAT) durante o registro de empresas
  • Verificar formatos de número de telefone antes de armazenar informações de contato
  • Verificar formatos de matrícula ao registar camiões
  • Validar formatos de e-mail com um padrão genérico

Fluxo de validação​

flowchart TD
  A[Pedido do cliente com parâmetro code] --> B{Tipo de código válido?}
  B -->|taxID| C[Retornar padrões de ID fiscal para 15 países]
  B -->|phoneNumber| D[Retornar padrões telefónicos para 46+ países]
  B -->|plate| E[Retornar padrões de matrícula para 3 países]
  B -->|email| F[Retornar padrão genérico de e-mail]
  B -->|Outro| G[Retornar objeto vazio]
  C --> H[200 OK com mapa país:regex]
  D --> H
  E --> H
  F --> H
  G --> H

Estrutura da resposta​

A resposta é um mapa onde as chaves são códigos de país (códigos ISO de 2 letras) e os valores são strings regex.

Notas importantes:

  • Os códigos de país podem estar em MAIÚSCULAS ou minúsculas, dependendo do tipo de validação
  • taxID: códigos em minúsculas (es, pt, fr, it, de, lu, pl, se, dk, nl, be, gb, ie, ad, ch)
  • phoneNumber: códigos em MAIÚSCUL

Request​

Responses​

Operação bem-sucedida. Retorna um dicionário de padrões regex organizados por código de país.

A estrutura da resposta é sempre {status: 200, data: {...}}, onde data contém o mapa de regex.

Cobertura por tipo:

  • taxID: 15 países europeus
  • phoneNumber: 46+ países incluindo o padrão genérico ALL
  • plate: 3 países (ES, FR, PT)
  • email: Padrão genérico com a chave ALL
Response Headers