Changelog
Back to All
Added

`verification_mode: "verification_link"` on `POST /v1/users`

23 days ago by ReadMe API

What's new — POST /v1/users accepts verification_mode: "verification_link" for a hosted-link KYC/KYB flow. Send a minimal payload and Kira returns a verification_link URL where the end user completes verification themselves.

Required fields when using this mode:

  • Individuals: first_name, last_name, email
  • Businesses: business_legal_name, email

Optional redirect_uri controls where the user lands after submission.

Impact — Optional. The default verification_mode: "automatic" flow (full payload, server-side trigger) is unchanged. The legacy POST /v1/users/USERID/verifications route still works but is no longer the recommended path.

Upgrade

POST /v1/users
{
  "verification_mode": "verification_link",
  "first_name": "Ada",
  "last_name": "Lovelace",
  "email": "[email protected]",
  "redirect_uri": "https://yourapp.com/kyc-done"
}
// → { "user_id": "...", "verification_link": "https://verify.kira.../...", ... }

Reference — POST /v1/users