Licenses API
Licenses API
Section titled “Licenses API”The Licenses API allows platforms to request, manage, and report usage for licenses on protected identities.
List Licenses
Section titled “List Licenses”List licenses for your platform.
Endpoint
Section titled “Endpoint”GET /v1/lmif/licensesRequest
Section titled “Request”const licenses = await lmif.licenses.list({ status: 'active', limit: 20});curl https://api.lookmaimfamous.com/v1/lmif/licenses?status=active \ -H "Authorization: Bearer lmif_live_xxx"Query Parameters
Section titled “Query Parameters”| Parameter | Type | Description |
|---|---|---|
status | string | pending, active, expired, revoked |
boxId | string | Filter by box ID |
tier | string | Filter by tier |
limit | integer | Max items |
offset | integer | Items to skip |
Response
Section titled “Response”{ "data": [ { "id": "lic_abc123", "boxId": "box_xyz789", "identityName": "Taylor Swift", "tier": "commercial", "status": "active", "monthlyFee": 500, "royaltyRate": 0.10, "validFrom": "2024-01-01T00:00:00Z", "expiresAt": "2025-01-01T00:00:00Z", "autoRenew": true } ], "meta": { "total": 15, "limit": 20, "offset": 0 }}Get License
Section titled “Get License”Get details of a specific license.
Endpoint
Section titled “Endpoint”GET /v1/lmif/licenses/{id}Request
Section titled “Request”const license = await lmif.licenses.get('lic_abc123');curl https://api.lookmaimfamous.com/v1/lmif/licenses/lic_abc123 \ -H "Authorization: Bearer lmif_live_xxx"Response
Section titled “Response”{ "data": { "id": "lic_abc123", "boxId": "box_xyz789", "identityName": "Taylor Swift", "tier": "commercial", "status": "active", "monthlyFee": 500, "currency": "USD", "royaltyRate": 0.10, "validFrom": "2024-01-01T00:00:00Z", "expiresAt": "2025-01-01T00:00:00Z", "autoRenew": true, "terms": { "maxUsers": 50000, "contentGuidelines": "https://...", "nsfw": false, "exclusivity": false, "territory": "worldwide" }, "usage": { "currentPeriod": "2024-01", "subscribers": 5000, "messages": 250000, "revenue": 25000, "royaltyDue": 2500 } }}Request License
Section titled “Request License”Request a new license for a protected identity.
Endpoint
Section titled “Endpoint”POST /v1/lmif/licenses/requestRequest
Section titled “Request”const request = await lmif.licenses.request({ boxId: 'box_xyz789', tier: 'commercial', useCase: 'AI companion platform', estimatedUsers: 10000, acceptGuidelines: true});curl -X POST https://api.lookmaimfamous.com/v1/lmif/licenses/request \ -H "Authorization: Bearer lmif_live_xxx" \ -H "Content-Type: application/json" \ -d '{ "boxId": "box_xyz789", "tier": "commercial", "useCase": "AI companion platform", "estimatedUsers": 10000, "acceptGuidelines": true }'Request Body
Section titled “Request Body”| Field | Type | Required | Description |
|---|---|---|---|
boxId | string | Yes | ID of the protected box |
tier | string | Yes | personal, creator, commercial, enterprise |
useCase | string | Yes | Description of intended use |
estimatedUsers | integer | No | Estimated user count |
acceptGuidelines | boolean | Yes | Accept content guidelines |
message | string | No | Message to identity owner |
Response
Section titled “Response”{ "data": { "id": "req_new456", "boxId": "box_xyz789", "status": "pending", "tier": "commercial", "submittedAt": "2024-01-15T10:00:00Z", "estimatedReviewTime": "48-72 hours", "pricing": { "monthlyFee": 500, "royaltyRate": 0.10, "currency": "USD" } }}Get Request Status
Section titled “Get Request Status”Check the status of a license request.
Endpoint
Section titled “Endpoint”GET /v1/lmif/licenses/request/{id}Request
Section titled “Request”const status = await lmif.licenses.getRequestStatus('req_new456');curl https://api.lookmaimfamous.com/v1/lmif/licenses/request/req_new456 \ -H "Authorization: Bearer lmif_live_xxx"Response (Pending)
Section titled “Response (Pending)”{ "data": { "id": "req_new456", "status": "pending", "submittedAt": "2024-01-15T10:00:00Z" }}Response (Approved)
Section titled “Response (Approved)”{ "data": { "id": "req_new456", "status": "approved", "license": { "id": "lic_abc123", "tier": "commercial", "monthlyFee": 500, "validFrom": "2024-01-17T00:00:00Z", "expiresAt": "2025-01-17T00:00:00Z" } }}Response (Denied)
Section titled “Response (Denied)”{ "data": { "id": "req_new456", "status": "denied", "reason": "Use case not aligned with brand guidelines", "deniedAt": "2024-01-16T14:00:00Z" }}Renew License
Section titled “Renew License”Renew an existing license.
Endpoint
Section titled “Endpoint”POST /v1/lmif/licenses/{id}/renewRequest
Section titled “Request”const renewal = await lmif.licenses.renew('lic_abc123', { term: 12, // months tier: 'commercial' // can upgrade});curl -X POST https://api.lookmaimfamous.com/v1/lmif/licenses/lic_abc123/renew \ -H "Authorization: Bearer lmif_live_xxx" \ -H "Content-Type: application/json" \ -d '{ "term": 12, "tier": "commercial" }'Response
Section titled “Response”{ "data": { "id": "lic_abc123", "status": "active", "previousExpiry": "2025-01-17T00:00:00Z", "newExpiry": "2026-01-17T00:00:00Z" }}Cancel License
Section titled “Cancel License”Cancel an active license.
Endpoint
Section titled “Endpoint”DELETE /v1/lmif/licenses/{id}Request
Section titled “Request”await lmif.licenses.cancel('lic_abc123', { reason: 'no_longer_needed', effectiveDate: 'end_of_billing_period'});curl -X DELETE https://api.lookmaimfamous.com/v1/lmif/licenses/lic_abc123 \ -H "Authorization: Bearer lmif_live_xxx" \ -H "Content-Type: application/json" \ -d '{ "reason": "no_longer_needed", "effectiveDate": "end_of_billing_period" }'Report Usage
Section titled “Report Usage”Report usage metrics for royalty calculation.
Endpoint
Section titled “Endpoint”POST /v1/lmif/licenses/{id}/usageRequest
Section titled “Request”await lmif.licenses.reportUsage('lic_abc123', { period: '2024-01', metrics: { subscribers: 5000, messages: 250000, tips: 15000, adImpressions: 1000000 }, revenue: { subscriptions: 25000, messages: 5000, tips: 15000, ads: 2000 }});curl -X POST https://api.lookmaimfamous.com/v1/lmif/licenses/lic_abc123/usage \ -H "Authorization: Bearer lmif_live_xxx" \ -H "Content-Type: application/json" \ -d '{ "period": "2024-01", "metrics": { "subscribers": 5000, "messages": 250000, "tips": 15000 }, "revenue": { "subscriptions": 25000, "messages": 5000, "tips": 15000 } }'Request Body
Section titled “Request Body”| Field | Type | Required | Description |
|---|---|---|---|
period | string | Yes | Reporting period (YYYY-MM) |
metrics | object | Yes | Usage metrics |
revenue | object | Yes | Revenue by type |
Response
Section titled “Response”{ "data": { "licenseId": "lic_abc123", "period": "2024-01", "totalRevenue": 47000, "royaltyRate": 0.10, "royaltyDue": 4700, "paymentStatus": "pending", "dueDate": "2024-02-15T00:00:00Z" }}License Statuses
Section titled “License Statuses”| Status | Description |
|---|---|
pending | Request under review |
active | License in effect |
expired | License term ended |
revoked | Revoked by identity owner |
cancelled | Cancelled by platform |