This page provides a reference for the code values sent within the details object of entitlementFailed webhook events. Use these codes to programmatically determine the reason for failure and provide feedback to your users.
Identity & Documentation
These codes are typically emitted during Onboarding or IDV workflows when there are issues with the user's provided identity documents.
| Code | Description | Recommended Action |
|---|
idDocumentExpired | The provided ID document has expired. | Ask the user to provide a valid, unexpired ID. |
idDocumentAboutToExpire | The ID document will expire within the next 3 months. | Notify the user they will need to provide a new ID soon. |
residentPermitExpired | The provided resident permit has expired. | Ask the user for a valid resident permit. |
residentPermitAboutToExpire | The resident permit will expire within the next 3 months. | Notify the user they will need to provide a new permit soon. |
FL0001 | Generic Fourthline IDV risk rejection. | The user failed the automated IDV check. Manual review or secondary IDV may be required. |
| Code | Description | Recommended Action |
|---|
impossibleAddress | The provided address could not be verified or is physically impossible. | Ask the user to double-check and re-submit their address details. |
suspiciousEmailProvider | The email address uses a domain known for disposable or suspicious accounts. | Ask the user to provide a standard personal or business email. |
Duplicate Entity Checks
The system checks for duplicate accounts to prevent fraud and ensure data integrity.
| Code | Description | Recommended Action |
|---|
duplicateClient | A client with the same Name and Date of Birth already exists. | Investigate if the user already has an active account. |
duplicateClientEmail | The provided email address is already in use by another account. | Ask the user to log in to their existing account or use a different email. |
duplicateClientPhone | The provided phone number is already in use by another account. | Ask the user to use a unique phone number. |
duplicateClientID | The provided ID/Passport number is already registered. | Investigate potential duplicate applications. |
Derivatives Workflow
These codes are specific to the Derivatives access workflows and the Appropriateness Test.
| Code | Description | Recommended Action |
|---|
R0001 | User is temporarily blacklisted. | Inform the user that they cannot apply for derivatives at this time. |
R0002 | User failed USA Condition Appraisal. | The user's residency or conditions do not permit derivatives trading. |
R0003 | Acknowledgements Verification Failed. | User did not properly acknowledge the required risks. |
CAR0001 | General qualification failure. | The user does not meet the minimum criteria for derivatives access. |
retailDerivatives30DaysBlacklist | User failed Appropriateness test. Locked for 30 days. | User can re-take the test after the lock_release_date. |
retailDerivatives6MonthsBlacklist | User failed Appropriateness test. Locked for 6 months. | User can re-take the test after the lock_release_date. |
General
| Code | Description | Recommended Action |
|---|
onboardingFailed | A generic failure occurred during the onboarding process. | Contact DLT support if no specific reason is provided. |