Choose Your Plan

Select the protection level that fits your needs. All plans include AI scam detection and DNC registration.

Charity
API → Explore Our API | CPS SHIELD
Developer Documentation

CPSShield API

Build powerful integrations with the CPSShield API. Access call protection features programmatically to stop robocalls, document TCPA violations, and manage DNC registrations.

⚠️ API Access Restricted
CPSShield API keys are currently not available for public access. This documentation is provided for reference purposes. For enterprise API access, please contact our sales team at support@cpsshield.com.

1. Introduction

The CPSShield API allows developers to integrate call protection features into their applications. Our RESTful API provides endpoints for call screening, violation logging, DNC registry management, and account management.

All API requests are made over HTTPS and require authentication using API keys. API keys are issued to approved enterprise partners and are not available for public use.

2. Authentication

All API requests must be authenticated using your API key. API keys are provided to approved partners only.

# Example authentication header Authorization: "Bearer your_api_key_here" # Or using query parameter ?api_key=your_api_key_here

⚠️ Public API Not Available
API keys are not issued to the general public. If you are interested in API access, please contact our enterprise sales team at support@cpsshield.com.

3. Base URL

https://api.cpsshield.com/v1/

All API endpoints are relative to this base URL. Ensure all requests use HTTPS.

4. API Endpoints

Below are the available API endpoints. These are for reference only; API access is restricted to approved enterprise partners.

Call Screening

GET /calls/screen Screen a phone number for spam/block status
POST /calls/log Log a suspicious call for documentation

Violation Tracking

GET /violations Retrieve documented TCPA violations
POST /violations/report Submit a violation report

Account Management

GET /account Get account information
PUT /account/preferences Update account preferences

DNC Registry

GET /dnc/status Check Do Not Call registration status
POST /dnc/register Register a number on the National DNC list

Data Removal

POST /data/remove Request removal from data broker databases
GET /data/status Check data removal request status

5. Rate Limits

To ensure service stability, API requests are subject to rate limits. Rate limits vary by endpoint and plan.

  • Standard: 100 requests per minute
  • Enterprise: 1,000 requests per minute
  • Burst: 10 requests per second

Exceeding rate limits will result in a 429 Too Many Requests response.

6. Response Format

All API responses are returned in JSON format with a consistent structure.

// Success Response { "status": "success", "data": { "id": 12345, "phone": "+15551234567", "status": "blocked" }, "timestamp": "2026-04-23T12:00:00Z" } // Error Response { "status": "error", "error": { "code": 401, "message": "Invalid API key" }, "timestamp": "2026-04-23T12:00:00Z" }

7. Error Codes

  • 200: Success — Request completed successfully
  • 400: Bad Request — Invalid parameters or malformed request
  • 401: Unauthorized — Invalid or missing API key
  • 403: Forbidden — Insufficient permissions
  • 404: Not Found — Endpoint or resource not found
  • 429: Too Many Requests — Rate limit exceeded
  • 500: Internal Server Error — Something went wrong on our end
  • 503: Service Unavailable — API is temporarily offline

8. Getting API Access

API keys are not available for public use at this time. We are currently in a closed beta for API access.

If you are interested in integrating with CPSShield, please contact our enterprise sales team:

Enterprise Partners: We offer custom API solutions for enterprise partners. Contact us to discuss your specific integration needs for call protection, robocall blocking, and TCPA compliance.

9. SDKs and Libraries

Official SDKs are available for the following languages (available to approved partners only):

  • Python: cpsshield-python
  • JavaScript: cpsshield-js
  • PHP: cpsshield-php
  • Ruby: cpsshield-ruby
  • Go: cpsshield-go

SDK documentation and installation instructions are provided to approved partners upon API key issuance.

10. Support

For API-related questions or support requests, please contact us:

Last Updated: September 11, 2026

© 2026 CPSShield. All rights reserved.