Nasze API jest szybkie i łatwe w integracji — możesz zacząć korzystać w mniej niż 15 minut. Dodatkowo otrzymujesz 50 darmowych zapytań każdego dnia na start.
Wszystkie żądania API muszą być wysyłane metodą POST. Podstawowy endpoint dla wszystkich żądań to:
https://numvalid.com/api/v1/[api_key]
Zastąp [api_key] swoim osobistym kluczem API. Wszystkie parametry żądania muszą być przesyłane w treści żądania jako JSON. Swój klucz API możesz uzyskać w panelu użytkownika po rejestracji.
Metoda: test
Ta metoda służy do testowania połączenia z API. Sprawdza, czy Twój klucz API jest prawidłowy oraz czy usługa jest dostępna. Jeśli wszystko jest poprawnie skonfigurowane, API zwróci pomyślną odpowiedź.
Przykład żądania
{
"method": "test"
}Pomyślna odpowiedź
{
"error": 0,
"message": "Yippee-ki-yay"
}
Pola odpowiedzi
error — kod błędu (0 oznacza, że żądanie zakończyło się powodzeniem)
message — komunikat odpowiedzi z API
Metoda: info
Metoda info zwraca informacje o Twoim koncie i aktualnej subskrypcji, w tym liczbę wykorzystanych zapytań API.
Przykład żądania
{
"method": "info"
}Pomyślna odpowiedź
{
"error": 0,
"name": "John",
"surname": "Smith",
"email": "[email protected]",
"subscription": "Growth",
"count_request": 2349
}
Pola odpowiedzi
error — kod błędu (0 oznacza, że żądanie zakończyło się powodzeniem)
name — imię właściciela konta
surname — nazwisko właściciela konta
email — adres e-mail konta
subscription — aktualny plan subskrypcji
count_request — liczba zapytań API wykorzystanych w bieżącym okresie subskrypcji
Metoda: verify
Metoda verify sprawdza numer telefonu i zwraca szczegółowe informacje o walidacji.
Numery telefonów mogą być podawane w dowolnym formacie. API automatycznie obsługuje znaki takie jak (, ), -, + oraz spacje.
Przykład żądania
{
"phone": "491609502065",
"method": "verify"
}Pomyślna odpowiedź
{
"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
}
}
Pola odpowiedzi
error — kod błędu (0 oznacza, że żądanie zakończyło się powodzeniem)
request_phone — numer telefonu przesłany w żądaniu
valid_phone — wynik walidacji (true jeśli numer jest prawidłowy)
type — typ numeru telefonu (np. komórkowy, stacjonarny itp.)
Obiekt format
local — numer telefonu w formacie lokalnym
international — numer telefonu w formacie międzynarodowym
Obiekt country
code — kod kraju ISO
name — nazwa kraju
prefix — międzynarodowy prefiks telefoniczny
Obiekt requests
Informacje o wykorzystaniu Twojej aktualnej subskrypcji.
subscription — aktywny plan subskrypcji
count — liczba już wykorzystanych zapytań
start — data rozpoczęcia okresu subskrypcji
finish — data zakończenia okresu subskrypcji
limit — maksymalna liczba zapytań dozwolona w okresie subskrypcji
Masz pytania dotyczące dokumentacji API? Skontaktuj się z nami: