Signs in with an extraction code and returns access and refresh tokens, the code's user profile, the extraction code with its data sources, its case, the saved app config (when one is sent) and whether collection events are on. Creates a session and records the login for collection tracking. Inactive, locked, unreviewed or rejected codes get 401, and a code used from the wrong white-label app gets 400.
POST
/extraction/auth/login-with-extraction
curl \
--request POST 'http://api.example.com/extraction/auth/login-with-extraction' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "user-agent: string" \
--data '{
"extractionCode": "string",
"appConfig": {
"systemId": "string",
"defaultBackupPath": "string",
"lastUsedBackupPath": "string",
"otherSettings": {},
"osDetails": {
"arch": "string",
"platform": "string",
"version": "string",
"osType": "string",
"machine": "string",
"totalMemory": 42.0,
"cpus": {},
"extraInformation": {}
},
"lastUsedAppVersion": "string",
"lastAppUsedAt": "string"
},
"app": "string",
"os": "string",
"arch": "string",
"isEmailLogin": true,
"client": "desktop"
}'
Request examples
# Headers
user-agent: string
# Payload
{
"extractionCode": "string",
"appConfig": {
"systemId": "string",
"defaultBackupPath": "string",
"lastUsedBackupPath": "string",
"otherSettings": {},
"osDetails": {
"arch": "string",
"platform": "string",
"version": "string",
"osType": "string",
"machine": "string",
"totalMemory": 42.0,
"cpus": {},
"extraInformation": {}
},
"lastUsedAppVersion": "string",
"lastAppUsedAt": "string"
},
"app": "string",
"os": "string",
"arch": "string",
"isEmailLogin": true,
"client": "desktop"
}
Response examples (200)
{
"data": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2NWExYjJjMyJ9.c2lnbmF0dXJl",
"refreshToken": "b7c1e2f0a9d84c3e8f6a5b4c3d2e1f00",
"userProfile": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "Jane Doe",
"email": "jane.doe@example.com",
"phone": [
"+15555550100"
],
"isActive": true,
"isEmailVerified": true,
"lastActive": "2026-01-15T14:30:00.000Z",
"roles": [
"user"
],
"avatar": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "photo.heic",
"providerId": "uploads/507f1f77bcf86cd799439011/photo.heic",
"convertedName": "photo.jpg",
"convertedProviderId": "uploads/507f1f77bcf86cd799439011/photo.jpg",
"provider": "s3",
"size": 204800,
"transferState": 42.0
},
"onboardingStatus": "completed",
"userType": "attorney",
"firstName": "Jane",
"lastName": "Doe",
"initials": "JD",
"userOrganizations": [
{
"organization": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "Example Law LLP",
"slug": "example-law-llp",
"email": "office@example.com",
"contact": "Jane Doe",
"city": "New York",
"state": "NY",
"country": "US",
"description": "Litigation practice",
"phone": [
"+15555550100"
],
"logo": "https://files.example.com/logo.png",
"isActive": true,
"isPriority": false,
"activePlan": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"subscription": {},
"relatedSubscription": [
{}
],
"organization": {},
"seats": 5,
"seatsUsed": 3,
"devices": 10,
"deviceUsed": 4,
"storage": 100000000000,
"storageUsed": 12000000000,
"payments": [
{}
],
"type": "admin",
"isActive": true,
"isBetweenPlanChanges": false,
"storageInKb": 100000000,
"storageUsedInKb": 12000000,
"storageInMb": 100000,
"storageUsedInMb": 12000,
"storageInGb": 100,
"storageUsedInGb": 12,
"storageInTb": 0.1,
"storageUsedInTb": 0.012,
"isFreePlan": false,
"remainingSeats": 2,
"remainingDevices": 6,
"remainingStorage": 88000000000
},
"metadata": {},
"type": "law_firm",
"version": "v1"
},
"permission": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"user": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "Jane Doe",
"email": "jane.doe@example.com",
"phone": [
"+15555550100"
],
"isActive": true,
"isEmailVerified": true,
"lastActive": "2026-01-15T14:30:00.000Z",
"roles": [
"user"
],
"avatar": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "photo.heic",
"providerId": "uploads/507f1f77bcf86cd799439011/photo.heic",
"convertedName": "photo.jpg",
"convertedProviderId": "uploads/507f1f77bcf86cd799439011/photo.jpg",
"provider": "s3",
"size": 204800,
"transferState": 42.0
},
"onboardingStatus": "completed",
"userType": "attorney",
"firstName": "Jane",
"lastName": "Doe",
"initials": "JD",
"userOrganizations": [
{}
]
},
"role": "member",
"organization": {},
"lastActiveAt": "2026-01-15T14:30:00.000Z"
},
"billing": {
"tier": "firm",
"tierName": "Firm",
"billingMode": "per-source",
"cadence": "monthly",
"baseFeeCents": 24900,
"paymentMethodOnFile": true,
"supportTier": "next-day",
"limits": {
"seatCap": 10,
"storageGB": 5000,
"perCaseSourceCap": 42.0
},
"features": [
"rsmf",
"ai",
"mcp",
"whiteLabel"
],
"prices": [
{
"skuKey": "collection.phone",
"name": "Phone collection",
"unitAmountCents": 17900,
"included": false,
"listAmountCents": 42.0,
"overridden": false,
"recurrence": "monthly",
"freeFirstPeriod": false
}
],
"overrides": {
"skuUnitAmountCents": {
"collection.phone": 9900
}
}
}
}
]
},
"appConfig": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"systemId": "3f8e1c5a9b2d4e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f",
"deviceSettings": [
{
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"systemId": "3f8e1c5a9b2d4e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f",
"deviceId": "00008110-001A2B3C4D5E",
"deviceType": "unknown",
"backupPaths": [
"/Users/jane/HearsayBackups"
],
"defaultBackupPath": "/Users/jane/HearsayBackups",
"lastUsedBackupPath": "/Users/jane/HearsayBackups",
"device": "507f1f77bcf86cd799439011",
"lastBackupAt": "2026-01-15T14:30:00.000Z",
"lastLocalBackupAt": "2026-01-15T14:30:00.000Z",
"autoBackupFrequency": "none",
"deviceMetadata": {
"name": "Jane Doe's iPhone",
"productType": "iPhone15,2",
"productVersion": "17.4.1",
"timeZone": "America/Chicago"
},
"otherSettings": {}
}
],
"defaultBackupPath": "/Users/jane/HearsayBackups",
"lastUsedBackupPath": "/Users/jane/HearsayBackups",
"otherSettings": {},
"osDetails": {
"arch": "arm64",
"platform": "darwin",
"version": "14.4",
"type": "Darwin",
"osType": "Darwin",
"machine": "arm64",
"totalMemory": 17179869184,
"cpus": {},
"extraInformation": {
"cpu": {
"manufacturer": "Apple",
"brand": "M2",
"physicalCores": 8
},
"mem": {
"total": 17179869184
},
"osInfo": {
"platform": "darwin",
"distro": "macOS",
"release": "14.4",
"arch": "arm64"
},
"battery": {
"hasBattery": true,
"percent": 80
}
}
},
"lastAppUsedAt": "2026-01-15T14:30:00.000Z",
"lastUsedAppVersion": "2.1.15",
"defaultSettings": {
"contactAdminDeviceRequestText": "Please add another device to my account."
}
},
"extractionCodeDetails": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"code": "K7Q2-9XPL",
"email": "jane.doe@example.com",
"name": "Jane Doe",
"phone": "+15555550100",
"isActive": true,
"label": "Primary phone",
"config": {
"type": "allow_client",
"origin": "Website",
"ignoreMediaPermissionAndroid": false,
"dateRange": {
"start": "2026-05-04T09:42:00Z",
"end": "2026-05-04T09:42:00Z"
},
"appConfig": {
"conversionConcurrency": [
{
"mediaType": "images",
"concurrency": [
4,
6,
12,
16
]
}
],
"compressionConcurrency": [
{
"mediaType": "images",
"concurrency": [
4,
6,
12,
16
]
}
],
"enableLocalMediaConversion": true,
"enableLocalMediaCompression": true,
"enableIosEncryptedBackupExtraction": false,
"allowOnlyEncryptedIosBackup": false,
"autoIncludeSafariData": false,
"autoIncludeNotesData": false,
"autoIncludeContacts": false,
"shareAction": "share"
},
"enableLocalExport": {
"formats": [
"pdf"
],
"defaultConfig": {
"chunkType": "year",
"includeAttachments": true
}
},
"allowClient": {
"allowSocialApps": [
"whatsapp"
],
"allowShareAll": false
},
"autoShare": {
"allowClientApproval": false,
"allowAdditionalShare": false,
"searches": [
{
"type": "name",
"values": [
"Jane Doe"
],
"apps": [
"whatsapp"
],
"dateRange": {
"start": "2026-05-04T09:42:00Z",
"end": "2026-05-04T09:42:00Z"
},
"exactMatch": false,
"include": true,
"conversationType": "all"
}
]
},
"shareAll": {
"apps": [
"whatsapp"
],
"includeAttachments": true,
"dateRange": {
"start": "2026-05-04T09:42:00Z",
"end": "2026-05-04T09:42:00Z"
},
"searchesExclude": [
{
"type": "name",
"values": [
"Jane Doe"
],
"apps": [
"whatsapp"
],
"exactMatch": false,
"conversationType": "all"
}
]
}
},
"devices": [
{}
],
"totalDevicesCount": 1,
"dueDate": "2026-01-15T14:30:00.000Z",
"sendEmail": true,
"lockedAt": "2026-05-04T09:42:00Z",
"hasDueDateCrossed": false,
"status": "pending",
"reviewStatus": "approved",
"reviewMessage": "string",
"lastApprovedBy": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "Jane Doe",
"email": "jane.doe@example.com",
"phone": [
"+15555550100"
],
"isActive": true,
"isEmailVerified": true,
"lastActive": "2026-01-15T14:30:00.000Z",
"roles": [
"user"
],
"avatar": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "photo.heic",
"providerId": "uploads/507f1f77bcf86cd799439011/photo.heic",
"convertedName": "photo.jpg",
"convertedProviderId": "uploads/507f1f77bcf86cd799439011/photo.jpg",
"provider": "s3",
"size": 204800,
"transferState": 42.0
},
"onboardingStatus": "completed",
"userType": "attorney",
"firstName": "Jane",
"lastName": "Doe",
"initials": "JD",
"userOrganizations": [
{}
]
},
"ocReviewedByOrg": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "Example Law LLP",
"slug": "example-law-llp",
"email": "office@example.com",
"contact": "Jane Doe",
"city": "New York",
"state": "NY",
"country": "US",
"description": "Litigation practice",
"phone": [
"+15555550100"
],
"logo": "https://files.example.com/logo.png",
"isActive": true,
"isPriority": false,
"activePlan": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"subscription": {},
"relatedSubscription": [
{}
],
"organization": {},
"seats": 5,
"seatsUsed": 3,
"devices": 10,
"deviceUsed": 4,
"storage": 100000000000,
"storageUsed": 12000000000,
"payments": [
{}
],
"type": "admin",
"isActive": true,
"isBetweenPlanChanges": false,
"storageInKb": 100000000,
"storageUsedInKb": 12000000,
"storageInMb": 100000,
"storageUsedInMb": 12000,
"storageInGb": 100,
"storageUsedInGb": 12,
"storageInTb": 0.1,
"storageUsedInTb": 0.012,
"isFreePlan": false,
"remainingSeats": 2,
"remainingDevices": 6,
"remainingStorage": 88000000000
},
"metadata": {},
"type": "law_firm",
"version": "v1"
},
"ocReviewedAt": "2026-05-04T09:42:00Z",
"ocRequired": true,
"allowShareAll": false,
"metadata": {},
"logsConfig": {},
"sources": [
{
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"case": {},
"extractionCode": {},
"dataSource": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "gmail",
"displayName": "Gmail",
"category": "email",
"config": {
"iosEnableEncryptedBackup": true,
"iosAllowOnlyEncryptedBackup": false,
"iosAllApps": [
"messages",
"call_log",
"whatsapp",
"photos"
],
"iosAllowedApps": [
"messages",
"call_log"
]
}
},
"caseDataSource": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"case": {},
"dataSource": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "gmail",
"displayName": "Gmail",
"category": "email",
"config": {
"iosEnableEncryptedBackup": true,
"iosAllowOnlyEncryptedBackup": false,
"iosAllApps": [
"messages",
"call_log",
"whatsapp",
"photos"
],
"iosAllowedApps": [
"messages",
"call_log"
]
}
},
"config": {
"iosEnableEncryptedBackup": true,
"iosAllowOnlyEncryptedBackup": false,
"iosAutoIncludeSafariData": true,
"iosAutoIncludeNotesData": false,
"iosAllowedApps": [
"messages",
"call_log",
"whatsapp"
]
}
},
"config": {
"iosEnableEncryptedBackup": true,
"iosAllowOnlyEncryptedBackup": false,
"iosAllApps": [
"messages",
"call_log",
"whatsapp",
"photos"
],
"iosAllowedApps": [
"messages",
"call_log"
]
}
}
],
"payment": {}
},
"caseDetails": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "Doe v. Example Corp",
"slug": "doe-v-example-corp",
"description": "Employment dispute",
"matterId": "MAT-0042",
"status": "open",
"assignStatus": "assigned",
"createdBy": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "Jane Doe",
"email": "jane.doe@example.com",
"phone": [
"+15555550100"
],
"isActive": true,
"isEmailVerified": true,
"lastActive": "2026-01-15T14:30:00.000Z",
"roles": [
"user"
],
"avatar": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "photo.heic",
"providerId": "uploads/507f1f77bcf86cd799439011/photo.heic",
"convertedName": "photo.jpg",
"convertedProviderId": "uploads/507f1f77bcf86cd799439011/photo.jpg",
"provider": "s3",
"size": 204800,
"transferState": 42.0
},
"onboardingStatus": "completed",
"userType": "attorney",
"firstName": "Jane",
"lastName": "Doe",
"initials": "JD",
"userOrganizations": [
{}
]
},
"assignedTo": [
"507f1f77bcf86cd799439011"
],
"organization": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"name": "Example Law LLP",
"slug": "example-law-llp",
"email": "office@example.com",
"contact": "Jane Doe",
"city": "New York",
"state": "NY",
"country": "US",
"description": "Litigation practice",
"phone": [
"+15555550100"
],
"logo": "https://files.example.com/logo.png",
"isActive": true,
"isPriority": false,
"activePlan": {
"createdAt": "2026-01-15T14:30:00.000Z",
"updatedAt": "2026-01-15T14:30:00.000Z",
"id": "507f1f77bcf86cd799439011",
"subscription": {},
"relatedSubscription": [
{}
],
"organization": {},
"seats": 5,
"seatsUsed": 3,
"devices": 10,
"deviceUsed": 4,
"storage": 100000000000,
"storageUsed": 12000000000,
"payments": [
{}
],
"type": "admin",
"isActive": true,
"isBetweenPlanChanges": false,
"storageInKb": 100000000,
"storageUsedInKb": 12000000,
"storageInMb": 100000,
"storageUsedInMb": 12000,
"storageInGb": 100,
"storageUsedInGb": 12,
"storageInTb": 0.1,
"storageUsedInTb": 0.012,
"isFreePlan": false,
"remainingSeats": 2,
"remainingDevices": 6,
"remainingStorage": 88000000000
},
"metadata": {},
"type": "law_firm",
"version": "v1"
},
"isActive": true,
"priority": "medium",
"attachedDevices": [
"507f1f77bcf86cd799439012"
],
"totalConversations": 128,
"archivedBy": {},
"exportJobId": "job-1234",
"metadata": {},
"extractionCodePaymentThreadId": "string",
"ocCase": false,
"isOcShared": false,
"proEnabled": false,
"isArchived": false
},
"collectionEventsEnabled": true
},
"statusCode": 200,
"timestamp": "2026-01-15T10:15:00.000Z"
}