Overview

View as Markdown

FlashID Local API

Programmatic access to the FlashID desktop client over a local HTTP service.

Base URLhttp://127.0.0.1:58931 (the baseUrl variable)
AuthX-API-Key header on every request except GET /api/system/health
Binding127.0.0.1 only — not exposed to the network
Enabled by defaultOff — enable it on the client Settings page

Set your key in the apiKey collection variable. Each request includes a saved Example response.

Response envelope

Success: { "success": true, "code": 0, "data": {...} }

Error: { "success": false, "code": <number>, "message": "..." }

Error codes

Every response is HTTP 200 — the body code is the sole signal (success:false + non-zero code on error).

codeName
0SUCCESS
1001UNAUTHORIZED
1002INVALID_API_KEY
1003RATE_LIMITED
1004FORBIDDEN
1005NOT_IN_WORKSPACE
2001BAD_REQUEST
2002VALIDATION_FAILED
2003MISSING_PARAM
3001BROWSER_OPEN_FAILED
3002BROWSER_CLOSE_FAILED
3003BROWSER_NOT_FOUND
3004BROWSER_IN_USE
3005DISK_INSUFFICIENT
3006WRITE_PERMISSION_DENIED
3007KERNEL_ERROR
3008KERNEL_DOWNLOADING
3009BROWSER_LAUNCH_FAILED
3010CONFIG_FETCH_FAILED
3011FILE_PREPARE_FAILED
3012BROWSER_OPEN_TIMEOUT
4001PROXY_CHECK_FAILED
4002PROXY_INVALID
5001PROFILE_NOT_FOUND
5002PROFILE_FETCH_FAILED
5003QUOTA_EXCEEDED
5004PROFILE_CREATE_FAILED
5005SUBSCRIPTION_EXPIRED
6001FOLDER_NOT_FOUND
6002WORKSPACE_NOT_FOUND
9001INTERNAL_ERROR
9002SERVICE_UNAVAILABLE

Rate limiting