Verid for utviklere

Verid er et verktøy for forsterkede kundetiltak etter hvitvaskingsloven, for eiendomsmeglingsforetak. Det offentlige API-et gir de samme fakta som forsiden, som JSON: hvilke kilder Verid henter fra og om de er i drift, stegene megleren går gjennom, kapitlene i rapporten, spørsmålene et foretak stiller før de tar Verid i bruk, og hvordan personopplysningene behandles.

API-et er ikke et API for saker, personer eller foretak, og det gjør ingen oppslag. Alt bak innloggingen er bare for meglerforetakets egne brukere.

Tilgang

Offentlig, uten nøkkel og uten innlogging. Alle operasjoner er GET og endrer ingenting. Svarene er på norsk (Content-Language: nb).

Hurtigstart

Hva Verid er:

curl https://verid.no/api/v1/tjeneste

Kildene som er i drift:

curl "https://verid.no/api/v1/kilder?status=i%20drift"

Svaret har denne formen (første kilde):

{
  "kilder": [
    {
      "navn": "Enhetsregisteret",
      "henter": "Foretaksdata, konkurs, under avvikling og under tvangsavvikling",
      "adresse": "data.brreg.no",
      "status": "i drift"
    }
  ]
}

Ett spørsmål med svar:

curl https://verid.no/api/v1/sporsmal/hva

Adressene

• GET /api/v1/tjeneste: navn, beskrivelse, stegene, rapportens kapitler og vedlegg, behandlingen av personopplysninger, kontakt og lenker.
• GET /api/v1/kilder: kildene, med valgfri status (i drift, krever avtale, venter på tilgang, under arbeid).
• GET /api/v1/sporsmal: spørsmålene og svarene fra forsiden.
• GET /api/v1/sporsmal/{id}: ett spørsmål, etter id-en fra listen.

Skjemaene for hvert svar står i OpenAPI-beskrivelsen (OpenAPI 3.1), og API-katalogen etter RFC 9727 ligger på /.well-known/api-catalog.

Grenser

600 kall per 60 sekunder, felles for alle klienter. Telleren står i databasen og gjelder uansett hvilken server som svarer. Vi lagrer ingenting om den som spør, verken IP-adresse eller avtrykk av den.

Hvert svar under /api/v1 sier hvor mye som er igjen:

RateLimit-Policy: "verid-api";q=600;w=60
RateLimit: "verid-api";r=599;t=60

r er kall igjen i vinduet, t sekunder til det nullstilles. Over grensen svarer API-et 429 med Retry-After i sekunder. Hodene følger IETF-utkastet RateLimit header fields for HTTP.

Versjonering og utfasing

Hovedversjonen står i stien: /api/v1/. Innenfor v1 kommer bare endringer som ikke bryter en klient: nye felter, nye adresser og nye verdier i oppramsinger som status. Se bort fra felter du ikke kjenner. En endring som kan bryte en klient, kommer i /api/v2/, og v1 svarer videre ved siden av.

Når v1 skal fases ut, får hvert svar fra v1 hodet Deprecation (RFC 9745), hodet Sunset (RFC 8594) med datoen, og en Link med rel="deprecation" til denne siden. v1 svarer i minst 90 dager etter at Deprecation ble sendt første gang. Ingen adresse er faset ut i dag.

Feil

Feil kommer som application/problem+json etter RFC 9457, med en stabil code du kan styre etter: not_found (404), invalid_parameter (400) og rate_limited (429).

Innholdet for språkmodeller

• llms.txt: hva Verid er, og når en agent skal og ikke skal peke noen hit.
• Forsiden som Markdown, eller Accept: text/markdown mot forsiden.
• Sitemap over de offentlige sidene.

Kontakt

Spørsmål om API-et sender du til christer.hagen@gmail.com. Andre henvendelser står på kontaktsiden.

Forsiden · Om Verid · Personvern