Retrieves identity verification onboarding sessions with comprehensive filtering and pagination. An onboarding represents a customer's identity verification journey, tracking their progress from link creation through document capture and verification completion. Each onboarding…
uidstringFilter by specific onboarding unique identifier (returns single result if found)
pageintegerZero-based page index for pagination (default is 0)
dateTostringFilter onboardings created on or before this date (yyyy-MM-dd)
statusstringFilter by verification journey status: CREATED (link generated), CLICKED (user accessed), CAPTURE_ONGOING (actively capturing documents), SUCCESS (verified), EXPIRED (time limit exceeded), ERROR (failed)
dateFromstringFilter onboardings created on or after this date (yyyy-MM-dd)
errorCodestringFilter by error cause category (only applicable when status is ERROR): NETWORK_ERROR (connectivity issues), USER_ERROR (user abandoned/incorrect actions), DEVICE_ERROR (camera/hardware problems), DOCUMENT_ERROR (invalid/unreadable documents), INTERNAL_ERROR (system failures)
businessUidstringFilter by your custom business/customer identifier (the external reference you provided when creating the onboarding)
notificationTypestringFilter by delivery method of the onboarding link: EMAIL (sent via email), PHONE (sent via SMS), NONE (link generated but not automatically sent)
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.