Onboarding Sessions

Verify an onboarding session

POST/onboarding-sessions/{id}/actions/verify
onboarding:adminverify_onboarding_session

Sensitive. Records that an administrator checked a completed session, with a note, and returns the session with its verification. The verifier is the token's own user, the service user for a service token. A session in any state can be verified, and each call records another verification. dry_run supported. Sends the onboarding_session.verified webhook. It can't be undone.

Path parameters

  • idstring (uuid)Required#

    The onboarding session's id, a uuid. An unknown id, or a session you cannot see, returns 404.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · OnboardingSessionVerify

  • notestringRequired#

    What was checked, recorded with the verification.

{
  "note": "Passport and proof of address checked."
}

Responses

200

The verified onboarding session.

OnboardingSession
{
  "data": {
    "id": "3f6e1c0a-8d52-4b7e-9a14-2c5d7e9b1f60",
    "flow_id": "48e0c1a6-6f3b-4d44-9d49-0a5a0b8f2d11",
    "user_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "status": "completed",
    "flow_test": false,
    "started_at": "2026-11-08T10:30:00Z",
    "completed_at": "2026-11-08T10:52:00Z",
    "verification": {
      "verified_by_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
      "note": "Passport and proof of address checked.",
      "verified_at": "2026-11-08T11:15:00Z"
    },
    "created_at": "2026-11-08T10:30:00Z",
    "updated_at": "2026-11-08T10:30:00Z"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/onboarding-sessions/{id}/actions/verify\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "note": "Passport and proof of address checked."
}'