Start Veriff or BankID verification for an employee
Creates a verification session for the given employee (id). Intended usage:
-
Prerequisite:
partner_return_urlmust be allowed for your partner: it must match an approvedrequested_urlfromPOST /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), andverification_url. Openverification_urlin the end user’s browser — it points to EasyFreelance; the user is then routed to Veriff or BankID and later back to EasyFreelance before being redirected topartner_return_url. -
While the user is in the browser flow, your server should poll
GET /verification/status/{verificationSession}withverification_iduntilstatusis no longerpending(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.
Authorizations
Sanctum personal access token (access_tokens / partner API settings).
UUID API key stored for the partner user.
Path Parameters
Body
Identity provider to use for this session.
veriff, bankid 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.
2048Response
Session created. Use verification_id for polling; send the user to verification_url to start the browser flow.
Session ID — pass as verificationSession when polling GET /verification/status/{verificationSession}.
Initial session status from the server (typically pending until the user completes the flow).
URL on EasyFreelance where the user starts; they are then routed to the chosen provider and eventually redirected to partner_return_url.
URL the API exposes for checking this session; integrators should poll using verification_id on GET /verification/status/{verificationSession} as documented.
After this time the session may no longer be valid for completing verification.