What is ScanControl?

Summary
ScanControl is a system used by AHI to regulate who can access Scans. This control is in place for both your Developer Account and your Production Account. However, the specific rules governing access will vary between these two types of accounts.

ScanControl operates on a credit-based system. Each user receives a 'virtual wallet' that contains scan credits. These credits can be redeemed to conduct a specified number of scans within a set timeframe. For your Production Account, ScanControl is exceptionally flexible, allowing for the creation of complex business rules that are customized to meet the specific requirements of each client. These rules are established based on the contractual terms agreed upon with AHI.

In addition to your Production Account, ScanControl is also implemented in your Developer Account. Here, you are provided with a finite amount of 'Free Scan Credits' each month. These credits are intended for use in testing and development activities, enabling you to trial and refine your applications without incurring additional costs.

ScanControl: Add Credit

Adding scan credit for the user is done as either scan purchase or subscription payment (different billing identifiers to signal each type). The client app or server calls the AHI payment API, which complies with RevenueCat Webhook specification, to deposit scan credit into the user's scan credit wallet:

ScanControl: Request Scan (Sentinel)

When a user requests to do a scan, the AHI SDK will check if the user is in credit to do that scan or not, using the ScanControl Sentinel mechanism. ScanControl Sentinel simply checks the user's wallet to see if they are in credit before allowing the scan to proceed. There is a GET API the client app or server can call to first check what scan credit the user has before attempting to do a scan for convenience.

ScanControl: Scan Completed (Redeem)

Once a user successfully completes a scan and retrieves a scan result, the scan credit will be redeemed from the user's wallet.

More

How does the ScanControl payment service work? Click Here.