API/Onboarding
Flyter
Onboarding
Før dere kan sende en utbetaling må oppdragstakeren gjennom fem steg. Feltet onboarding på brukeren forteller til enhver tid hva som gjenstår.
Alle brukerpayloads inneholder objektet onboarding (versjon v2). Der finner du is_onboarded, en liste over missing_steps, og en detaljert steps-oversikt. Bruk dette som fasit i stedet for å holde egen tilstand i deres system.
De fem stegene
| Steg | Endepunkt | Slik fullføres det |
|---|---|---|
email_verified | POST /users | Settes automatisk når brukeren opprettes eller kobles via API-et. |
terms_approved | POST /users/{id}/terms | Send {"approved": true} når oppdragstakeren har akseptert gjeldende vilkår. |
profile | PUT /users/{id}/profile | Navn, adresse, postnummer, sted, landkode, telefon og main_work – alle påkrevd. |
bank_account | PUT /users/{id} | Enten norsk kontonummer, eller IBAN og BIC sammen. Aldri begge deler i samme kall. |
id_verification | POST /users/{id}/verification/flows | Veriff eller BankID. Se Verifisering. |
Steget id_verification blir true først når entitetsverifiseringen er godkjent og identitetsfeltene fra Veriff eller BankID er komplette. En godkjent sesjon uten fødselsnummer gir fortsatt false.
Onboarding-objektet
{
"onboarding": {
"is_onboarded": false,
"missing_steps": [
"id_verification"
],
"steps": {
"email_verified": true,
"terms_approved": true,
"profile": true,
"id_verification": false,
"bank_account": true
},
"status_version": "v2",
"evaluated_at": "2026-07-08T12:00:05+00:00"
}
}Anbefalt rekkefølge
Registrer og få godkjent return-URLen
POST /verification-return-urls. Godkjenningen er manuell og kan ta tid, så gjør dette først – ikke når dere allerede har en oppdragstaker som venter. At API-et svarer201betyr ikke at URLen er godkjent ennå.Opprett eller koble brukeren
POST /usersmed e-post, og gjerneinternal_idså dere kan matche mot deres eget system. Finnes e-posten fra før, kobles den eksisterende brukeren til partnerkontoen deres.Godkjenn vilkårene
Hent gjeldende vilkår med
GET /terms, vis dem for oppdragstakeren, og registrer svaret medPOST /users/{id}/terms.Registrer profil og bankkonto
PUT /users/{id}/profilefor hele profilen, ogPUT /users/{id}for bankopplysningene. Bankfeltene følger en enten–eller-regel: norsk kontonummer alene, eller IBAN og BIC sammen.Kjør ID-verifisering
POST /users/{id}/verification/flows, send brukeren tilverification_url, og pollGET /verification/status/{verificationSession}hvert 2.–5. sekund til status er terminal.Bekreft at brukeren er ferdig onboardet
Hent
GET /users/{id}og sjekk atonboarding.is_onboardedertrueog atmissing_stepser tom. Da kan dere sende utbetalinger.
Bankopplysninger
Serveren validerer at dere bruker nøyaktig én av variantene. Blander dere dem i samme forespørsel, avvises den.
| Variant | Felt | Merknad |
|---|---|---|
| Norsk konto | bank_account_number | Sendes alene. Ikke kombiner med IBAN eller BIC. |
| Internasjonal | bank_iban_number + bank_bic_number | Må sendes sammen. Bytter dere variant, kan kolonnene for den andre bli tømt. |
Felter som ikke driver onboarding
POST /users godtar en del ekstra felter – first_name, last_name, adresse, phone, main_work, note – for bakoverkompatibilitet med eldre integrasjoner. De fullfører ikke profilsteget. Bruk PUT /users/{id}/profile for det.