Start Veriff or BankID verification for an employee

curl --request POST \
  --url https://app.easyfreelance.no/api/v1/users/{id}/verification/flows \
  --header 'API-key: <api-key>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partner_return_url": "<string>"
}
'

{
  "verification_id": "<string>",
  "provider": "<string>",
  "status": "<string>",
  "verification_url": "<string>",
  "status_check_url": "<string>",
  "expires_at": "<string>"
}

VerificationFlow

Start Veriff or BankID verification for an employee

Creates a verification session for the given employee (id). Intended usage:

Prerequisite: partner_return_url must be allowed for your partner: it must match an approved requested_url from POST /verification-return-urls (same registered base string, or the same base plus allowed dynamic segments per server rules). Otherwise the API may return 422 (return URL not allowed).
Response: You receive verification_id (use this value as {verificationSession} when polling status), and verification_url. Open verification_url in the end user’s browser — on EasyFreelance the user is then routed to Veriff or BankID and later back to EasyFreelance before being redirected to partner_return_url. verification_url is always the EasyFreelance verification bouncer for both providers (then Veriff or BankID). For provider: veriff, you must send id_type: local uses the Norwegian-only Veriff integration (Norwegian ID documents); international uses the integration that accepts non‑Norwegian documents only.
While the user is in the browser flow, your server should poll GET /verification/status/{verificationSession} with verification_id until status is no longer pending (or handle completion via your own webhook integration if provided by your deployment — not part of this OpenAPI document).

status_check_url in the response is the URL the API associates with checking this session (typically aligned with the polling endpoint above); prefer using verification_id with GET /verification/status/{verificationSession} as documented.

POST

users

{id}

verification

flows

Start Veriff or BankID verification for an employee

curl --request POST \
  --url https://app.easyfreelance.no/api/v1/users/{id}/verification/flows \
  --header 'API-key: <api-key>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partner_return_url": "<string>"
}
'

{
  "verification_id": "<string>",
  "provider": "<string>",
  "status": "<string>",
  "verification_url": "<string>",
  "status_check_url": "<string>",
  "expires_at": "<string>"
}

Authorizations

Authorization

string

header

required

Sanctum personal access token (access_tokens / partner API settings).

API-key

string

header

required

UUID API key stored for the partner user.

Path Parameters

integer

required

Body

application/json

provider

enum<string>

required

Identity provider to use for this session.

Available options:

veriff,

bankid

partner_return_url

string

required

Where to send the user after verification completes on EasyFreelance. Must match an approved registration: the same requested_url you had approved (or an allowed extension of that base per server rules). The normalized_* fields on the return-URL record are auxiliary; they do not define matching by themselves. Query parameters may be appended by EasyFreelance when redirecting; design this URL to tolerate or ignore unknown query params.

Maximum string length: 2048

id_type

enum<string>

Required when provider is veriff. Select local for the Norwegian ID Veriff integration, or international for foreign ID documents. Ignored for bankid (may be omitted).

Available options:

local,

international

Response

Session created. Use verification_id for polling; send the user to verification_url to start the browser flow.

verification_id

string

required

Session ID — pass as verificationSession when polling GET /verification/status/{verificationSession}.

provider

string

required

status

string

required

Initial session status from the server (typically pending until the user completes the flow).

id_type

enum<string> | null

required

Set for Veriff (local vs international); null for BankID.

Available options:

local,

international

verification_url

string

required

EasyFreelance verification bouncer URL for this session — open in the browser; the user is then routed to Veriff or BankID. Use promptly; the session deadline is expires_at.

status_check_url

string

required

URL the API exposes for checking this session; integrators should poll using verification_id on GET /verification/status/{verificationSession} as documented.

expires_at

string

required

After this time the session may no longer be valid for completing verification.

Partial update (profile, note, bank, internal_id)Poll verification session status