Skip to content

Claims API

The Claims API allows you to manage identity claims. Claims are typically created through the LMIF dashboard by creators, but platforms can query claim information.

List claims associated with your account.

GET /v1/lmif/claims
const claims = await lmif.claims.list({
limit: 20,
status: 'verified'
});
ParameterTypeDescription
limitintegerMax items (default: 20, max: 100)
offsetintegerItems to skip
statusstringFilter by status: pending, verified, rejected
entityTypestringFilter by entity type
{
"data": [
{
"id": "claim_xyz789",
"name": "Taylor Swift",
"variations": ["T. Swift", "Taylor Alison Swift"],
"entityType": "INDIVIDUAL",
"status": "verified",
"verificationTier": "GOLD",
"createdAt": "2024-01-01T00:00:00Z",
"verifiedAt": "2024-01-02T00:00:00Z",
"hasBox": true,
"boxId": "box_abc123"
}
],
"meta": {
"total": 1,
"limit": 20,
"offset": 0
}
}

Get details of a specific claim.

GET /v1/lmif/claims/{id}
const claim = await lmif.claims.get('claim_xyz789');
{
"data": {
"id": "claim_xyz789",
"name": "Taylor Swift",
"variations": ["T. Swift", "Taylor Alison Swift"],
"entityType": "INDIVIDUAL",
"status": "verified",
"verificationTier": "GOLD",
"verification": {
"method": "stripe_identity",
"completedAt": "2024-01-02T00:00:00Z",
"documents": ["government_id"]
},
"proofs": [
{
"type": "social_verification",
"platform": "twitter",
"handle": "@taylorswift13",
"verifiedAt": "2024-01-02T00:00:00Z"
}
],
"referenceImages": [
{
"id": "img_001",
"url": "https://...",
"isPrimary": true
}
],
"createdAt": "2024-01-01T00:00:00Z",
"verifiedAt": "2024-01-02T00:00:00Z",
"hasBox": true,
"boxId": "box_abc123"
}
}

Create a new identity claim.

POST /v1/lmif/claims
const claim = await lmif.claims.create({
name: "John Smith",
variations: ["J. Smith", "Johnny Smith"],
entityType: "INDIVIDUAL",
referenceImages: [
{ url: "https://example.com/photo1.jpg", isPrimary: true },
{ url: "https://example.com/photo2.jpg" }
]
});
FieldTypeRequiredDescription
namestringYesPrimary name
variationsstring[]NoAlternate names/spellings
entityTypestringYesINDIVIDUAL, ESTATE, CORPORATION, AGENCY
referenceImagesarrayYesReference images for detection
referenceImages[].urlstringYesImage URL
referenceImages[].isPrimarybooleanNoPrimary reference image
{
"data": {
"id": "claim_new123",
"name": "John Smith",
"variations": ["J. Smith", "Johnny Smith"],
"entityType": "INDIVIDUAL",
"status": "pending",
"verificationTier": "BRONZE",
"createdAt": "2024-01-15T10:00:00Z",
"nextStep": {
"action": "verify_identity",
"url": "https://lookmaimfamous.com/verify/claim_new123"
}
}
}

Update an existing claim.

PATCH /v1/lmif/claims/{id}
const updated = await lmif.claims.update('claim_xyz789', {
variations: ["T. Swift", "Taylor Alison Swift", "Tay Tay"]
});
FieldDescription
variationsAlternate names
referenceImagesReference images

Delete a claim. This also removes any associated box.

DELETE /v1/lmif/claims/{id}
await lmif.claims.delete('claim_xyz789');
{
"data": {
"id": "claim_xyz789",
"deleted": true,
"deletedAt": "2024-01-15T12:00:00Z"
}
}

Add a name variation to a claim.

POST /v1/lmif/claims/{id}/variations
await lmif.claims.addVariation('claim_xyz789', {
variation: "Tay Tay"
});

Add a reference image to a claim.

POST /v1/lmif/claims/{id}/images
await lmif.claims.addImage('claim_xyz789', {
url: "https://example.com/new-photo.jpg",
isPrimary: false
});
StatusDescription
pendingAwaiting verification
verifiedIdentity verified
rejectedVerification failed
suspendedTemporarily suspended
TierRequirementsBenefits
GOLDStripe Identity + additional proofHighest trust, fastest enforcement
SILVERStripe IdentityFull enforcement
BRONZEEmail onlyBasic claim, limited enforcement