Migration from 1.3.x to 2.0.x
This guide covers public API changes between 1.3.x and 2.0.x.
SDK 2.0.x requires enrollment-onboarding-server 2.1.0+.
Breaking Changes
- Document types are now backend strings (
typealias DocumentType = String).
val selectedTypes: List<DocumentType> = listOf("ID_CARD", "PASSPORT")
Use values returned by ConfigurationService.getConfiguration(processType).
- Verification status now returns
StatusResultwith state + server metadata.
verificationService.status { result ->
result.onSuccess { statusResult ->
val state = statusResult.state
val processId = statusResult.serverData.processId
val processType = statusResult.serverData.processType
}
}
- Consent flow was updated.
consentGet(...)was renamed togetConsent(...).consentApprove(...)was replaced bystart(consentApprovedByUser = ...).VerificationState.CONSENTwas removed.- Use
VerificationStateIntroData.consentRequiredto decide whether consent has to be resolved.
- OTP helpers moved from services to
DemoEndpoints.
DemoEndpoints.getOTP(activationService) { /* ... */ }
DemoEndpoints.getOTP(verificationService) { /* ... */ }
Additions
- Added
ConfigurationServiceand configuration response models. - Added
processTypeargument toActivationService.start(...). ActivationService.activate(...)now accepts optional OTP (String?).- Added
ActivationService.createActivationBuilder(...)for advanced activation workflows. - Added
VerificationState.ACTIVATION_FINISHandVerificationService.finishActivation(...). - Added
VerificationStateOtpData.otpResendPeriodInSeconds. - Added
VerificationStateEndstateData.rejectReason. - Added
ProcessingItem.ONBOARDING_APPROVAL.
Checklist
- Replace enum-style document type usage with backend string values.
- Update verification status handling to consume
StatusResult.stateandStatusResult.serverData. - Replace old consent methods with
getConsent(...)andstart(ConsentResponse...). - Move demo OTP retrieval to
DemoEndpoints.getOTP(...). - Handle
ACTIVATION_FINISH,rejectReason, and OTP resend cooldown in state handling.
Last updated on Apr 10, 2026 (08:54)
Edit on Github
Send Feedback