20 December 2023 - Release Notes
- Enhancement to customer onboarding
idScan
responses 🆔 - Reliability and performance enhancements to the Avenu platform
Avenu API Release Notes 1.8.6
Overview
Enhancement to customer onboarding idScan
endpoint
idScan
endpointThis release includes enhancing the customer status information to provide more helpful information during the customer onboarding process.
Reliability and performance enhancements to the Avenu platform
In the continuous effort to improve reliability and performance several upgrades were made to the Avenu platform.
What's New?
The following release notes detail the updates we have included in this release.
Enhancement to customer onboarding idScan
endpoint
idScan
endpointPOST {avenu_base_url}/onboard/v1/customer/idScans
The response received by Avenu from submission of the ID scan images is now being translated to provide more helpful information to the customer status during the onboarding process when there is an issue with the ID scan. See table below for information, statuses, and next steps when receiving each status.
Customer Onboarding status with ID scan response (and next action)
idScan Response [status] | idScan Actions [statusInfo] | Customer [status] | Customer [statusInfo] | Next Step |
---|---|---|---|---|
Pending | PENDING | IDScan Pending | Poll for Status | |
Fail | Pass back each qualifier; {{id-scan-verification-result/qualifier}} | FAILED | IDScan Failure | Initiate Onboarding |
Pass | PENDING | IDScan Pending | Poll for Status | |
Fail | Photo ID Not Valid | FAILED | Photo ID Not Valid | Initiate Onboarding |
Pending | Photo ID Not Readable, please try again | FAILED | Photo ID Not Valid, please try again | Initiate Onboarding |
Fail | Timed Out | FAILED | IDScan Timed Out | Initiate Onboarding |
Fail | Abandoned Session | FAILED | Abandoned Session | Initiate Onboarding |
Invalid Username and Password | ERROR | Unknown App Error | Please contact system administrator |