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
    • Voice firewall
      • Get started
      • Quickstart
        • What you get
        • Before you start
        • Test with a recording
        • Connect your switch
        • Switch notes
        • Twilio and Telnyx
        • Send text instead of audio
      • Verdicts
        • Read a verdict
        • What to do with a verdict
        • Block a caller
        • Events and webhooks
      • Honeypot
        • Hand a call over
        • Audio, events, and limits
      • Reference
        • Endpoints
        • Errors
        • Limits and thresholds
        • Production checklist
      • REST
        • What this deployment can do
        • List the verdict categories
        • List the honeypot personas
        • Score a transcript or a recording
        • List your recent sessions
        • Get one session with verdict and intel
        • Twilio voice URL for a screened number
        • Preview the Twilio TwiML
        • Telnyx voice URL for a screened number
        • Twilio voice URL for a honeypot number
        • Telnyx voice URL for a honeypot number
      • WebSocket
        • Live scam filter stream
        • Honeypot stream
    • 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
    • 15 days spam CSV snapshot
      GET
    • Spam score + HLR
      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 call screening
      • iOS prerequisites
      • iOS add the extension
      • iOS test on device
    • Reference
      • Methods
      • Errors
      • Limits and billing
      • Troubleshooting
  • Data partners
    • Partner tems & docs
    • Upload spam reports
      POST
    • Upload contacts
      POST
  • Fraud prevention
    • Ported date
    • Porting history
    • Online presence
    • KYC user identity
  • Business Caller ID
    • Get started
    • Quickstart
      • Announce a call
      • Verify at INVITE
      • What you get
    • Verdicts
      • Show the name and logo
      • Read a verdict
    • REST
      • Verify the calling number
      • Fetch the logo
      • Announce a call
  • Signer reputation by SPC
    GET
  • Signers ranked by score
    GET
  • Schemas
    • Spam protection
      • Spam score request
      • Business info
      • Carrier info
      • Complaint (without number)
      • Daily spam reports request
      • Complaint (with phone)
    • Signer
  1. Quickstart

What you get

Ten minutes of work gives you two function calls.
lookupLabel("+18883578668")  ->  "CallerAPI LC"
isSpam("+19999999999")       ->  true
You call them from your own code, and you show the answer in your own screens.

What it does not give you#

The name does not appear on the system call screen. The phone does not block anything. Both of those need the operating system to hand control to your app, which is a separate setup. See What each platform can do.
Start here anyway. The quickstart proves your credentials work, and call screening builds on it.

The four steps#

1.
Get your keys from the dashboard. Two minutes.
2.
Add the SDK to your app. Five minutes. Pick your platform: Android, iOS, Flutter, React Native.
3.
Call lookupLabel. One minute.
4.
Check it works. Two minutes.

Rules that apply to every platform#

Send phone numbers in E.164 format. That means a plus sign, the country code, then the number, with no spaces, dashes, or brackets. +18883578668 is correct. (888) 357-8668 is not.
A null answer is normal. Most phone numbers do not belong to a business, so lookupLabel returns nothing for them. Show your own fallback text.
The first lookup for a number is slower. The SDK downloads a group of hashes and caches it. Later lookups in that group answer from the cache.

Free while you build#

A new app starts in sandbox mode. Sandbox is free and it returns the same real data as production.
When you are ready to ship to more than 100 customers, contact us to agree a price. No code changes when you switch.
Modified at 2026-08-18 21:40:24
Previous
Get started
Next
Get your keys
Built with