Skip to content
LMIF Docs

Quick Start

Quick Start

Section titled “Quick Start”

Get your first identity check working in under 5 minutes.

Prerequisites

Section titled “Prerequisites”
  • An LMIF API key (get one here)
  • A platform that creates AI avatars or uses likeness

  1. Get your API key

    Sign up at lookmaimfamous.com/developers to get your API key. You’ll receive:

    • A sandbox key (lmif_test_xxx) for development
    • A production key (lmif_live_xxx) when approved

  2. Install the SDK (optional)

    Terminal window
    npm install @lookmaimfamous/lmif

  3. Make your first identity check

    Before allowing a user to create an avatar, check if the identity is protected:

    import { LMIFClient } from '@lookmaimfamous/lmif';
    

    const lmif = new LMIFClient({
      apiKey: process.env.LMIF_API_KEY,
    });
    

    async function checkBeforeCreating(name: string, imageUrl: string) {
      const result = await lmif.identity.check({
        name,
        imageUrl,
      });
    

      if (result.isBoxed) {
        // Identity is protected - check policy
        if (result.policy === 'BLOCK_ALL') {
          throw new Error('This identity cannot be used for AI avatars');
        }
        if (result.policy === 'LICENSE') {
          // Redirect to licensing flow
          return { requiresLicense: true, boxId: result.boxId };
        }
        if (result.policy === 'MONETIZE') {
          // Proceed but track for revenue share
          return { proceed: true, royaltyRate: result.royaltyRate };
        }
      }
    

      // Identity is not protected - proceed
      return { proceed: true };
    }

  4. Handle the response

    The identity check returns:

    {
      "isBoxed": true,
      "boxId": "box_abc123",
      "policy": "MONETIZE",
      "claimId": "claim_xyz789",
      "entityType": "INDIVIDUAL",
      "verificationTier": "GOLD",
      "royaltyRate": 0.10,
      "confidence": 0.95
    }
    FieldDescription
    isBoxedWhether this identity is protected
    boxIdUnique identifier for the box (if protected)
    policyProtection policy: BLOCK_ALL, BLOCK_COMMERCIAL, MONETIZE, LICENSE, TEAM, OPEN
    claimIdThe claim that owns this box
    entityTypeINDIVIDUAL, ESTATE, CORPORATION, or AGENCY
    verificationTierGOLD, SILVER, or BRONZE
    royaltyRateRevenue share percentage (for MONETIZE policy)
    confidenceDetection confidence score (0-1)

  5. Set up webhooks (recommended)

    Register a webhook to receive real-time updates when identities get boxed:

    // Your webhook endpoint
    app.post('/webhooks/lmif', async (req, res) => {
      const signature = req.headers['x-lmif-signature'];
    

      // Verify the webhook signature
      if (!lmif.webhooks.verify(req.body, signature, process.env.LMIF_WEBHOOK_SECRET)) {
        return res.status(401).send('Invalid signature');
      }
    

      const event = req.body;
    

      switch (event.type) {
        case 'box.created':
          // A new identity was boxed - check your existing avatars
          await handleNewBox(event.data);
          break;
        case 'grace_period.started':
          // You have 30 days to comply
          await notifyAffectedUsers(event.data);
          break;
        case 'grace_period.ending':
          // Final warning - 2 days left
          await sendUrgentNotification(event.data);
          break;
      }
    

      res.status(200).send('OK');
    });

What’s Next?

Section titled “What’s Next?”