Version 1 Atualizado em 2026-03-17

Documentação API

Nossa API é rápida e fácil de integrar — você pode começar em menos de 15 minutos. Além disso, você recebe 50 requisições gratuitas por dia para começar.

Básico

Todas as requisições da API devem ser enviadas usando o método POST. O endpoint base para todas as requisições é:

https://numvalid.com/api/v1/[api_key]

Substitua [api_key] pela sua chave de API pessoal. Todos os parâmetros da requisição devem ser enviados no corpo da requisição em formato JSON. Você pode obter sua chave de API no painel após o registro.

Teste

Método: test

Este método é usado para testar a conexão com a API. Ele verifica se sua chave de API é válida e se o serviço está acessível. Se tudo estiver configurado corretamente, a API retornará uma resposta de sucesso.

Exemplo de requisição

{
    "method": "test"
}

Resposta de sucesso

{
  "error": 0,
  "message": "Yippee-ki-yay"
}

Campos da resposta
error — código de erro (0 significa que a requisição foi bem-sucedida)
message — mensagem de resposta da API

Info

Método: info

O método info retorna informações sobre sua conta e a assinatura atual, incluindo o número de requisições usadas.

Exemplo de requisição

{
    "method": "info"
}

Resposta de sucesso

{
    "error": 0,
    "name": "John",
    "surname": "Smith",
    "email": "[email protected]",
    "subscription": "Growth",
    "count_request": 2349
}

Campos da resposta
error — código de erro (0 significa que a requisição foi bem-sucedida)
name — nome do proprietário da conta
surname — sobrenome do proprietário da conta
email — endereço de e-mail da conta
subscription — plano de assinatura atual
count_request — número de requisições usadas no período atual da assinatura

Verificação

Método: verify

O método verify verifica um número de telefone e retorna informações detalhadas de validação.

Os números de telefone podem ser enviados em qualquer formato. A API lida automaticamente com caracteres como (, ), -, + e espaços.

Exemplo de requisição

{
  "phone": "491609502065",
  "method": "verify"
}

Resposta de sucesso

{
  "error": 0,
  "request_phone": "491609502065",
  "valid_phone": true,
  "type": "mobile",
  "format": {
    "local": "01609502065",
    "international": "+491609502065"
  },
  "country": {
    "code": "DE",
    "name": "Germany (Federal Republic of)",
    "prefix": "+49"
  },
  "requests": {
    "subscription": "Growth",
    "count": 2,
    "start": "2026-04-06 10:29:40",
    "finish": "2026-10-06 10:29:40",
    "limit": 9000
  }
}

Campos da resposta
error — código de erro (0 significa que a requisição foi bem-sucedida)
request_phone — número de telefone enviado na requisição
valid_phone — resultado da validação (true se o número for válido)
type — tipo de número de telefone (ex: móvel, fixo, etc.)

Objeto de formato
local — número de telefone em formato local
international — número de telefone em formato internacional

Objeto de país
code — código ISO do país
name — nome do país
prefix — prefixo de discagem internacional

Objeto de requisições
Informações sobre o uso atual da sua assinatura.
subscription — plano de assinatura ativo
count — número de requisições já utilizadas
start — data de início do período da assinatura
finish — data de término do período da assinatura
limit — número máximo de requisições permitidas no período da assinatura

Dúvidas sobre nossa documentação?

Tem dúvidas sobre nossa documentação da API? Entre em contato conosco: