Skip to main content
← Back to Pixclaim

API Documentation

Integrate Pixclaim's AI-powered photo licensing into your applications. Browse photos, manage licenses, and automate your workflow via our REST API.

Base URL: https://pixclaim.com/api/v1

Quick Start

1. Authentication

All authenticated endpoints require a Bearer token in the Authorization header.

# Register
curl -X POST https://pixclaim.com/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"SecurePass1","role":"PHOTOGRAPHER","firstName":"John","lastName":"Doe"}'

# Login
curl -X POST https://pixclaim.com/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","password":"SecurePass1"}'

# Response: { "accessToken": "eyJ...", "refreshToken": "..." }

2. Make Requests

Use the access token for all subsequent requests. Tokens expire after 15 minutes.

# Browse photos
curl https://pixclaim.com/api/v1/photos/browse?page=1&limit=20 \
  -H "Authorization: Bearer eyJ..."

# Upload a photo (get presigned URL)
curl -X POST https://pixclaim.com/api/v1/photos/upload \
  -H "Authorization: Bearer eyJ..." \
  -H "Content-Type: application/json" \
  -d '{"filename":"sunset.jpg","mimeType":"image/jpeg","fileSizeBytes":2048000}'

# Refresh expired token
curl -X POST https://pixclaim.com/api/v1/auth/refresh \
  -H "Content-Type: application/json" \
  -d '{"refreshToken":"..."}'

Response Format

All successful responses are wrapped in a standard envelope:

{
  "success": true,
  "data": { ... },        // The actual payload
  "timestamp": "2026-03-05T12:00:00.000Z"
}

// Error responses:
{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

Rate Limiting

100 requests / minute per IP

Token Expiry

Access: 15 min, Refresh: 30 days

Content Type

application/json

User Roles

PHOTOGRAPHER

Upload photos, manage collections, accept licenses, receive payouts.

BRAND

Browse photos, get AI matches, create license offers, manage lightbox.

ENTERPRISE

API keys, advanced search, webhooks, and all standard features.

Endpoints

Authentication

Register, login, and manage user sessions with JWT tokens.

https://pixclaim.com/api/v1/auth
POST/auth/registerRegister a new user account (PHOTOGRAPHER or BRAND)
POST/auth/loginLogin with email and password. Returns access + refresh tokens.
POST/auth/refreshRefresh an expired access token using a refresh token.
POST/auth/forgot-passwordRequest a password reset email.
POST/auth/reset-passwordReset password using the token from email.
POST/auth/verify-emailVerify email address with token from email.
POST/auth/logoutInvalidate current session.
AUTH
GET/auth/meGet the current authenticated user profile.
AUTH

Photos

Upload photos, trigger AI analysis, browse available stock photos.

https://pixclaim.com/api/v1/photos
POST/photos/uploadGet a presigned S3 URL for uploading a photo.
AUTHPHOTOGRAPHER
POST/photos/:id/confirmConfirm upload completed. Triggers AI analysis pipeline.
AUTHPHOTOGRAPHER
GET/photos/myList your uploaded photos with analysis results.
AUTHPHOTOGRAPHER
GET/photos/browseBrowse available photos with filters and pagination.
GET/photos/:idGet full details of a specific photo.
AUTH
DELETE/photos/:idDelete one of your photos.
AUTHPHOTOGRAPHER

Brands

Create brand profiles, get AI-matched photos, manage matches.

https://pixclaim.com/api/v1/brands
GET/brands/profileGet your brand profile.
AUTHBRAND
POST/brands/profileCreate a brand profile with preferred categories, styles.
AUTHBRAND
PATCH/brands/profileUpdate brand profile.
AUTHBRAND
GET/brands/matchesGet AI-matched photos tailored to your brand.
AUTHBRAND
PATCH/brands/matches/:idUpdate match status: VIEWED, INTERESTED, or DISMISSED.
AUTHBRAND
GET/brands/photosBrowse all available photos as a brand.
AUTHBRAND

Licenses

Create, negotiate, and manage photo license offers.

https://pixclaim.com/api/v1/licenses
POST/licenses/Create a license offer for a photo (brand to photographer).
AUTH
GET/licenses/List your licenses.
AUTH
GET/licenses/:idGet license details.
AUTH
PATCH/licenses/:id/acceptAccept a license offer.
AUTHPHOTOGRAPHER
PATCH/licenses/:id/counterSend a counter-offer.
AUTHPHOTOGRAPHER
PATCH/licenses/:id/cancelCancel a license offer.
AUTH

Contracts

View and sign licensing contracts.

https://pixclaim.com/api/v1/contracts
GET/contracts/List your contracts.
AUTH
GET/contracts/:idGet contract details.
AUTH
POST/contracts/:id/signSign a contract.
AUTH

Payments

Stripe Connect onboarding, checkout sessions, and payment management.

https://pixclaim.com/api/v1/payments
POST/payments/connect/onboardGet Stripe Connect onboarding URL for receiving payouts.
AUTHPHOTOGRAPHER
GET/payments/connect/statusGet Stripe Connect account status.
AUTHPHOTOGRAPHER
POST/payments/create-checkoutCreate a Stripe Checkout session for a license payment.
AUTH
GET/payments/List your payments.
AUTH
GET/payments/:idGet payment details.
AUTH

Subscriptions

Manage subscription plans and billing.

https://pixclaim.com/api/v1/subscriptions
GET/subscriptions/plansGet available subscription plans for your role.
GET/subscriptions/currentGet your current subscription.
AUTH
POST/subscriptions/checkoutCreate Stripe Checkout session for plan upgrade.
AUTH
DELETE/subscriptions/cancelCancel subscription at period end.
AUTH

Payouts

View photographer earnings and payout history.

https://pixclaim.com/api/v1/payouts
GET/payouts/List your payouts.
AUTHPHOTOGRAPHER
GET/payouts/statsGet earnings statistics.
AUTHPHOTOGRAPHER
GET/payouts/:idGet payout details.
AUTHPHOTOGRAPHER

Collections

Organize photos into public or private collections.

https://pixclaim.com/api/v1/collections
POST/collections/Create a new collection.
AUTHPHOTOGRAPHER
GET/collections/myList your collections.
AUTHPHOTOGRAPHER
GET/collections/public/:slugView a public collection by slug.
GET/collections/:idGet collection details.
AUTH
PATCH/collections/:idUpdate collection title, description, visibility.
AUTHPHOTOGRAPHER
DELETE/collections/:idDelete a collection.
AUTHPHOTOGRAPHER
POST/collections/:id/photosAdd a photo to a collection.
AUTHPHOTOGRAPHER
DELETE/collections/:id/photos/:photoIdRemove a photo from a collection.
AUTHPHOTOGRAPHER

Portfolio

Manage your public photographer portfolio.

https://pixclaim.com/api/v1/portfolio
GET/portfolio/manage/settingsGet your portfolio settings.
AUTHPHOTOGRAPHER
PATCH/portfolio/manage/settingsUpdate portfolio settings (bio, social links, theme).
AUTHPHOTOGRAPHER
PATCH/portfolio/manage/featuredSet featured photos and their order.
AUTHPHOTOGRAPHER
GET/portfolio/:usernameView a photographer's public portfolio.

Releases

Submit model and property releases for photos with people or logos.

https://pixclaim.com/api/v1/releases
POST/releases/modelSubmit a model release.
AUTHPHOTOGRAPHER
GET/releases/modelList your model releases.
AUTHPHOTOGRAPHER
POST/releases/propertySubmit a property release.
AUTHPHOTOGRAPHER
GET/releases/propertyList your property releases.
AUTHPHOTOGRAPHER

Notifications

In-app and push notifications management.

https://pixclaim.com/api/v1/notifications
GET/notifications/List your notifications.
AUTH
PATCH/notifications/:id/readMark a notification as read.
AUTH
PATCH/notifications/read-allMark all notifications as read.
AUTH
POST/notifications/push-tokenRegister a device push token.
AUTH

Analytics

Dashboard analytics for photographers and brands.

https://pixclaim.com/api/v1/analytics
GET/analytics/photographer/dashboardPhotographer analytics: views, earnings, top photos.
AUTHPHOTOGRAPHER
GET/analytics/brand/dashboardBrand analytics: matches, licenses, spending.
AUTHBRAND

Webhooks

Register webhook endpoints to receive real-time event notifications.

https://pixclaim.com/api/v1/webhooks
POST/webhooks/endpointsRegister a new webhook endpoint URL.
AUTHBRAND
GET/webhooks/endpointsList your registered webhook endpoints.
AUTHBRAND
PATCH/webhooks/endpoints/:idUpdate a webhook endpoint.
AUTHBRAND
DELETE/webhooks/endpoints/:idDelete a webhook endpoint.
AUTHBRAND
GET/webhooks/endpoints/:id/deliveriesView delivery history for an endpoint.
AUTHBRAND
POST/webhooks/endpoints/:id/testSend a test webhook delivery.
AUTHBRAND

Enterprise

Enterprise-tier features: API keys and advanced search.

https://pixclaim.com/api/v1/enterprise
POST/enterprise/api-keysCreate an API key (Enterprise plan required).
AUTH
GET/enterprise/api-keysList your API keys.
AUTH
DELETE/enterprise/api-keys/:idRevoke an API key.
AUTH
GET/enterprise/searchAdvanced photo search with enterprise filters.
AUTH

GDPR

GDPR compliance: data export, account deletion, consent management.

https://pixclaim.com/api/v1/gdpr
POST/gdpr/exportRequest a full data export (Article 20).
AUTH
POST/gdpr/deletionRequest account deletion (Article 17).
AUTH
GET/gdpr/requestsView your GDPR request history.
AUTH
PATCH/gdpr/consentUpdate your consent settings.
AUTH

Webhook Events

Register webhook endpoints to receive real-time notifications for these events:

photo.analyzedAI analysis completed for a matched photo
photo.availableA new photo matching your brand is available
license.createdA new license offer was created
license.acceptedA license offer was accepted
license.counteredA counter-offer was received
payment.completedPayment was processed successfully
contract.signedA contract was signed by both parties
match.newNew AI brand match found