API/Onboarding
Flöden
Onboarding
Innan ni kan skicka en utbetalning måste uppdragstagaren gå igenom fem steg. Fältet onboarding på användaren visar hela tiden vad som återstår.
Alla användarpayloads innehåller objektet onboarding (version v2). Där hittar du is_onboarded, en lista över missing_steps, och en detaljerad steps-översikt. Använd detta som facit i stället för att hålla eget tillstånd i ert system.
De fem stegen
| Steg | Endpoint | Så här slutförs det |
|---|---|---|
email_verified | POST /users | Sätts automatiskt när användaren skapas eller kopplas via API:et. |
terms_approved | POST /users/{id}/terms | Skicka {"approved": true} när uppdragstagaren har accepterat gällande villkor. |
profile | PUT /users/{id}/profile | Namn, adress, postnummer, ort, landskod, telefon och main_work – alla obligatoriska. |
bank_account | PUT /users/{id} | Antingen norskt kontonummer, eller IBAN och BIC tillsammans. Aldrig båda i samma anrop. |
id_verification | POST /users/{id}/verification/flows | Veriff eller BankID. Se Verifiering. |
Steget id_verification blir true först när entitetsverifieringen är godkänd och identitetsfälten från Veriff eller BankID är kompletta. En godkänd session utan personnummer ger fortfarande 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"
}
}Rekommenderad ordning
Registrera och få return-URL:en godkänd
POST /verification-return-urls. Godkännandet är manuell och kan ta tid, så gör detta först – inte när ni redan har en uppdragstagare som väntar. Att API:et svarar201betyder inte att URL:en är godkänd ännu.Skapa eller koppla användaren
POST /usersmed e-post, och gärnainternal_idså att ni kan matcha mot ert eget system. Finns e-postadressen sedan tidigare kopplas den befintliga användaren till ert partnerkonto.Godkänn villkoren
Hämta gällande villkor med
GET /terms, visa dem för uppdragstagaren och registrera svaret medPOST /users/{id}/terms.Registrera profil och bankkonto
PUT /users/{id}/profileför hela profilen, ochPUT /users/{id}för bankuppgifterna. Bankfälten följer en antingen–eller-regel: norskt kontonummer ensamt, eller IBAN och BIC tillsammans.Kör ID-verifiering
POST /users/{id}/verification/flows, skicka användaren tillverification_url, och pollaGET /verification/status/{verificationSession}var 2:e–5:e sekund tills statusen är terminal.Bekräfta att användaren är färdigonboardad
Hämta
GET /users/{id}och kontrollera attonboarding.is_onboardedärtrueoch attmissing_stepsär tom. Då kan ni skicka utbetalningar.
Bankuppgifter
Servern validerar att ni använder exakt en av varianterna. Blandar ni dem i samma begäran avvisas den.
| Variant | Fält | Anmärkning |
|---|---|---|
| Norskt konto | bank_account_number | Skickas ensamt. Kombinera inte med IBAN eller BIC. |
| Internationell | bank_iban_number + bank_bic_number | Måste skickas tillsammans. Om ni byter variant kan kolumnerna för den andra tömmas. |
Fält som inte styr onboarding
POST /users godtar en del extra fält – first_name, last_name, adress, phone, main_work, note – för bakåtkompatibilitet med äldre integrationer. De slutför inte profilsteget. Använd PUT /users/{id}/profile för det.