Version 1 Oppdatert 2026-03-17

Dokumentasjon API

Vår API er rask og enkel å integrere — du kan være i gang på under 15 minutter. I tillegg får du 50 gratis forespørsler hver dag for å komme i gang.

Grunnleggende

Alle API-forespørsler må sendes med POST-metoden. Basis-endepunktet for alle forespørsler er:

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

Erstatt [api_key] med din personlige API-nøkkel. Alle forespørselsparametere må sendes i request body som JSON. Du kan få din API-nøkkel fra dashbordet etter registrering.

Test

Metode: test

Denne metoden brukes til å teste API-tilkoblingen. Den bekrefter at API-nøkkelen din er gyldig og at tjenesten er tilgjengelig. Hvis alt er riktig konfigurert, vil API-et returnere et vellykket svar.

Eksempel på forespørsel

{
    "method": "test"
}

Vellykket svar

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

Svarfelter
error — feilkode (0 betyr at forespørselen var vellykket)
message — svarmelding fra API-et

Info

Metode: info

Metoden info returnerer informasjon om kontoen din og gjeldende abonnement, inkludert antall brukte API-forespørsler.

Eksempel på forespørsel

{
    "method": "info"
}

Vellykket svar

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

Svarfelter
error — feilkode (0 betyr at forespørselen var vellykket)
name — kontoeierens fornavn
surname — kontoeierens etternavn
email — kontoens e-postadresse
subscription — nåværende abonnementsplan
count_request — antall API-forespørsler brukt i gjeldende abonnementsperiode

Verifisering

Metode: verify

Metoden verify sjekker et telefonnummer og returnerer detaljert valideringsinformasjon.

Telefonnumre kan sendes i hvilket som helst format. API-et håndterer automatisk tegn som (, ), -, + og mellomrom.

Eksempel på forespørsel

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

Vellykket svar

{
  "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
  }
}

Svarfelter
error — feilkode (0 betyr at forespørselen var vellykket)
request_phone — telefonnummer sendt i forespørselen
valid_phone — valideringsresultat (true hvis nummeret er gyldig)
type — type telefonnummer (f.eks. mobil, fasttelefon osv.)

Format-objekt
local — telefonnummer i lokalt format
international — telefonnummer i internasjonalt format

Land-objekt
code — ISO-landkode
name — landsnavn
prefix — internasjonalt telefonprefiks

Forespørsler-objekt
Informasjon om bruken av ditt nåværende abonnement.
subscription — aktiv abonnementsplan
count — antall forespørsler allerede brukt
start — startdato for abonnementsperioden
finish — sluttdato for abonnementsperioden
limit — maksimalt antall forespørsler tillatt i abonnementsperioden

Spørsmål om dokumentasjonen vår?

Har du spørsmål om API-dokumentasjonen vår? Ta kontakt med oss: