1. Quickstart
CallerAPI Documentation
  • Quickstart
  • Use cases
    • For carriers (MNOs/MVNOs)
    • CPaaS platforms
    • Cloud communications providers
    • SIP trunking providers
    • PBX/Cloud PBX
    • UCaaS vendors
  • Account
    • Balance and email
      GET
  • Spam protection
    • Daily spam reports
      • Webhook
        • Subscribe to daily reports
        • Unsubscribe from daily reports
        • List webhook subscriptions
        • Manual dispatch of reports
        • Test webhook
      • REST
        • Fetch daily spam reports
    • Spam score + HLR
      GET
    • 15 days spam CSV snapshot
      GET
  • Mobile SDK
    • Get started
    • Quickstart
      • What you get
      • Get your keys
      • Android
      • iOS
      • Flutter
      • React Native
      • Check it works
    • Call screening
      • What each platform can do
      • Android
      • iOS prerequisites
      • iOS add the extension
      • iOS test on device
  • Data partners
    • Partner tems & docs
    • Upload spam reports
      POST
    • Upload contacts
      POST
  • Fraud prevention
    • Ported date
    • Porting history
    • Online presence
    • KYC user identity
  • Schemas
    • Spam protection
      • Spam score request
      • Business info
      • Carrier info
      • Complaint (without number)
      • Daily spam reports request
      • Complaint (with phone)
  1. Quickstart

Check it works

Two checks. The first proves your code works. The second proves the dashboard sees your app, which is what your bill is based on.

Check 1: a known business returns a name#

Look up this number:
+18883578668
It belongs to CallerAPI LC. If you get a name back, your credentials work and your integration is done.
If you get null or an error, go to Troubleshooting. Do not move on, because the second check cannot pass while this one fails.

Check 2: the dashboard sees your app#

Your app reports in when it starts. The dashboard shows that arrival, so you can confirm the connection without reading any logs.
1.
Run your app on a real device or an emulator, with a working internet connection.
2.
Open https://callerapi.com/dashboard/sdk-setup.
3.
Select your app in the Your apps list.
4.
Scroll to Check it works.
The page checks every five seconds on its own. Leave it open.
Screenshot 2026-07-29 at 22.15.26.png
When your app arrives, the card turns green and shows the platform it detected, the SDK version, and how many devices reported this month.
[screenshot of the "Check it works" card showing the connected state with a green tick, platform, and device count]

If the card never turns green#

The first report can take a minute. If it stays grey for longer, work through this list in order.
Confirm check 1 passes. A working lookup proves the credentials reach the server. Without it, nothing arrives.
Confirm you selected the right app. If you created several apps, the card only watches the one you selected.
Confirm the device has internet. An emulator without a network connection looks exactly like a broken integration.
Confirm your client key is present, on Android. Lookups work without CLIENT_KEY, but device counting does not. This is the most common cause of a working app with an empty dashboard. Check that all three meta-data entries are present and sit inside <application>.
Confirm your bundle identifier or application ID matches. The server refuses a credential presented by an app it was not issued to.

What the numbers mean#

The device count is your billable usage for the month. It counts distinct devices that reported with the feature turned on, not lookups. One device that runs a thousand lookups counts once.
Sandbox stops at 200 devices in a calendar month. Devices already counted keep working past the limit. New devices are refused, and the SDK reports sandbox_limit_reached.
See Limits and billing.

Next#

Your app can now name callers in your own screens.
To name callers on the system call screen, or to block spam automatically, go to Call screening. Read the first page before you start, because iOS and Android differ a lot in what they allow.
Modified at 2026-07-29 20:17:50
Previous
React Native
Next
What each platform can do
Built with