Automatic KYC

automatic-kyc is HollaEx's built-in identity verification for your exchange's users. It runs through HollaEx's partnership with iDenfy: each check covers the user's ID document, a live selfie and AML screening. This page is the settings reference. For credits, pricing, setup and review, see the main guide, KYC & AML for your users.

What you need

• The Enterprise plan on HollaEx Cloud.
• KYC credits. You buy them on the dashboard's KYC & AML page. See How much does it cost?
• No iDenfy account. The plugin connects to iDenfy through the HollaEx Network.
• No other KYC plugin. Only one KYC plugin can be installed at a time (automatic-kyc, Sumsub, Persona, Shufti Pro or MetaMap), so remove any other one first.

Set it up

1. Go to Operator Controls → Exchange → Plugins, find automatic-kyc under Available to install and click Install.
2. Open the plugin with Configure and set the options below. Save.
3. Sign in to your exchange as a test user, open Verification and start identity verification. An approved test uses one credit.

There is no separate activation step. Verifications run for as long as your exchange has credits.

Setting	What it does
manual_review	On (default): verifications iDenfy approves stay pending until an admin approves them, and admins get an email asking for a review. Off: users iDenfy approves are verified straight away.
auto_reject	On (default): a user iDenfy denies or marks as suspected is rejected. Off: they are set to pending for you to review.
utility_bill	On (default): users must also upload a utility bill as proof of address.
success_path	Page on your exchange users return to after a successful check. Default /verification.
error_path	Page users return to after a failed check. Default /verification.
unverified_path	Page users return to when the check wasn't completed, for example if they cancel right away. Default /verification.
country	Optional. Two-letter country code the document must come from, for example gb. Empty accepts any country.
documents	Optional. Comma-separated document types the user may present, for example PASSPORT,ID_CARD. Empty accepts any. Allowed values: ID_CARD, PASSPORT, RESIDENCE_PERMIT, DRIVER_LICENSE, VISA, BORDER_CROSSING, ASYLUM, NATIONAL_PASSPORT, INTERNATIONAL_PASSPORT, PROVISIONAL_DRIVER_LICENSE, VOTER_CARD, OLD_ID_CARD, TRAVEL_DOCUMENT, PHOTO_CARD, MILITARY_CARD, PROOF_OF_AGE_CARD, DIPLOMATIC_ID, PAN_CARD, AADHAAR.

warning

A wrong documents value blocks verification

If documents contains a value the plugin doesn't recognise, new verifications stop until you fix it. Users see "Identity verification is temporarily unavailable" and your operators get an email. The plugin does not fall back to accepting every document.

What your users see

Users start the check from the Verification page on your exchange. When they finish, they return to the page set in success_path, error_path or unverified_path. Users get an email when their verification is approved or rejected.

How it works

• A verified user's status is set to approved. To move verified users to a higher tier automatically, add a tier upgrade plugin, or change their tier yourself. Use tiers to decide what verified users can do.
• Results normally arrive from iDenfy on their own. Every 10 minutes the plugin also re-checks identifications from the last 24 hours that have no result yet.
• A session still unfinished two hours after it started is rejected so the user can start again. No credit is used for it.
• You review users in Operator Controls → Operations → Review Queue → ID Verification. The plugin's own admin page, opened from Operator Controls → Exchange → Plugins, shows your remaining credits, identifications waiting for iDenfy or for you, and recent results. From there you can refresh a user's result from iDenfy, approve or revoke them.

Troubleshooting

• Users see "Identity verification is temporarily unavailable." Your exchange is out of KYC credits, or the documents setting has a value the plugin doesn't recognise. Check the operator alert email for the reason. Buy credits on the KYC & AML page, or fix the setting.
• A user sees that they already have a pending or completed document. They can't start a new check while one is pending or after they are approved. Review the pending one in the Review Queue.

More cases are covered in Troubleshooting automatic KYC.

Need help? Open a ticket from your HollaEx dashboard.