Developer Hub

Build Privacy Into Your Product

Integrate Porthas APIs to offer privacy scanning, identity monitoring, and security features in your application.

Available APIs

RESTful APIs with comprehensive documentation and SDKs.

Privacy Scan API

Stable

Scan 168+ data broker sites for personal information exposure.

POST /scanGET /scan/{id}GET /scan/{id}/results

Removal Request API

Stable

Submit and track data removal requests across brokers.

POST /removalGET /removal/{id}DELETE /removal/{id}

Identity Monitor API

Stable

Monitor emails, phone numbers, and SSNs for breaches.

POST /monitorGET /alertsGET /breaches

VPN Config API

Beta

Generate and manage WireGuard VPN configurations.

POST /vpn/configGET /vpn/serversDELETE /vpn/config

Backup API

Beta

Manage cloud backup and restore operations.

POST /backup/startGET /backup/statusPOST /restore

Webhook API

Stable

Receive real-time notifications for events.

POST /webhooksGET /webhooksDELETE /webhooks/{id}

Quick Start

Get started with the Porthas API in minutes.

1. Authentication

All API requests require an API key in the Authorization header.

cURL
curl -X GET "https://api.porthas.com/v1/scan" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

2. Run a Privacy Scan

Start a scan to find where someone's data is exposed.

cURL
curl -X POST "https://api.porthas.com/v1/scan" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Smith",
    "email": "john@example.com",
    "city": "New York",
    "state": "NY"
  }'

3. Get Results

Retrieve the scan results to see where data was found.

Response
{
  "scan_id": "scan_abc123",
  "status": "completed",
  "exposures_found": 47,
  "risk_score": 78,
  "brokers": [
    {
      "name": "WhitePages",
      "url": "https://whitepages.com/...",
      "data_found": ["name", "address", "phone"],
      "removal_supported": true
    },
    // ... more results
  ]
}

Official SDKs

Client libraries for popular languages.

🐍

Python

pip install porthas
📦

Node.js

npm install @porthas/sdk
🐹

Go

go get github.com/porthas/go-sdk
💎

Ruby

gem install porthas

Documentation

Comprehensive guides and API reference.

Read the docs →

Developer Support

Get help from our developer relations team.

Contact support →

GitHub

Open source SDKs and example code.

View on GitHub →