Documentation
Developer Docs
Everything you need to embed, verify, and register PixelSeal image identity.
PixelSeal allows you to embed a persistent identity directly into image data — designed to survive real-world transformations such as compression, resizing, and platform processing.
Quick Start
Install the SDK:
npm install @pixelseal/coreEmbed identity into an image:
await embed({ inputPath: "input.jpg", outputPath: "sealed.jpg", creatorId: "creator_123", assetId: "asset_456", secretKey: process.env.PIXELSEAL_KEY }); ```
Verify identity:
const result = await verify({ imagePath: "sealed.jpg", secretKey: process.env.PIXELSEAL_KEY });
console.log(result); ```
Embed API
The Embed API inserts a durable identity signal into image data.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| inputPath | string | ✔ | Source image path |
| outputPath | string | ✔ | Output image path |
| creatorId | string | ✔ | Unique creator identifier |
| assetId | string | ✔ | Unique asset identifier |
| secretKey | string | ✔ | Signing key for verification |
Return Value
{
success: boolean;
embedded: boolean;
message: string;
}Verify API
The Verify API detects and validates embedded identity.
What It Does
- Detects presence of an identity signal
- Validates authenticity using cryptographic verification
- Attempts recovery if image has been transformed
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| imagePath | string | ✔ | Image to verify |
| secretKey | string | ✔ | Signing key |
Return Value
{
detected: boolean;
verified: boolean;
confidence: number;
recovered: boolean;
message: string;
}Registry API
The Registry API allows you to associate images with public identity records.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /v1/registry/create | Register a creator profile |
| GET | /v1/registry/:id | Retrieve creator profile |
| POST | /v1/registry/asset | Register an image asset |
| GET | /v1/registry/asset/:id | Retrieve asset record |
Example
curl -X POST https://api.pixelseal.ai/v1/registry/asset \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"assetId": "asset_456",
"creatorId": "creator_123",
"title": "Sample Image"
}'Security Model
PixelSeal is designed to provide resilient identity verification under real-world conditions.
Key Principles
- Identity is embedded directly into image data
- Signals are designed to survive compression and platform processing
- Cryptographic verification ensures authenticity
- Recovery mechanisms allow detection even after transformation
What PixelSeal Protects Against
- Metadata stripping
- Platform recompression
- Resizing and format changes
- Partial image degradation
- Multi-step sharing workflows
What PixelSeal Does NOT Rely On
- EXIF or IPTC metadata
- File naming or storage systems
- External databases for detection
Important Note
Implementation details are intentionally abstracted to preserve system integrity while providing transparency on capabilities.
Key Management
PixelSeal uses a secret key to sign embedded identity.
Best Practices
- Store keys securely (e.g. environment variables, vaults)
- Rotate keys periodically
- Never expose keys client-side
Example
PIXELSEAL_KEY=your_secure_key_hereVerification Behavior
Verification is probabilistic and resilient.
Depending on transformations, PixelSeal may: - Fully verify identity - Recover identity with partial confidence - Detect presence without full verification
Confidence Levels
| Confidence | Meaning |
|---|---|
| High | Strong match and full verification |
| Medium | Partial recovery, likely match |
| Low | Weak signal detected |
Real-World Performance
PixelSeal is designed for real-world environments, not controlled lab conditions.
It performs across: - Social media uploads - Messaging platforms - Image editing workflows - Recompression pipelines
Alignment & Recovery
PixelSeal includes recovery mechanisms that allow identity detection even after:
- Cropping
- Resizing
- Compression
- Partial image loss
These systems operate automatically during verification.
Error Resilience
PixelSeal tolerates partial signal degradation.
Even when images are transformed, identity may still be: - Detected - Recovered - Verified with confidence
Need Help?
Can't find what you're looking for? We're here to help.
PixelSeal is built for real-world image distribution — not ideal conditions. You are encouraged to test it yourself:
Upload → process on any platform → verify. That is where the real value becomes clear.
