TrackHalal logo TrackHalal
Developer

API Documentation v1.0

Public verification and compliance APIs for the halal supply chain.

Base URL

https://trackhalal-302b60.web.app/api

All endpoints accept JSON. Rate limited to 30 requests/minute/IP.


Verification APIs

GET/api/v1/verify

Verify a Digital Halal Passport by ID. Returns product info, certification status, ingredient summary, and market readiness.

ParameterTypeRequiredDescription
idstringRequiredPassport ID (e.g., THP-2026-0001)
{ "verified": true, "passportId": "THP-2026-0001", "status": "verified", "productName": "Premium Oolong Tea", "manufacturer": "Taiwan Mountain Tea Co.", "certification": { "body": "thida", "number": "THIDA-2025-001", "valid": true }, "markets": [{ "market": "indonesia_bpjph", "readiness": "ready" }], "ingredientSummary": { "total": 5, "haram": 0, "mashbooh": 0, "resolved": 0 }, "verifyUrl": "https://trackhalal.app/verify?id=THP-2026-0001" }
GET/api/v1/supplier

Look up a verified supplier passport. Returns verification status, verified ingredients, and estimated time saved.

ParameterTypeRequiredDescription
namestringRequiredSupplier name
ingredientstringFilter by ingredient name
{ "found": true, "supplierName": "Taichung Chemical Co.", "status": "verified", "verificationLevel": 85, "verifiedIngredients": [...], "timeSavedDays": 9 }

Analysis APIs

POST/api/analyze-exportability

Instant export readiness check for Indonesia, Malaysia, and Singapore. Detects 13 hidden processing aid hazards.

ParameterTypeRequiredDescription
skuNamestringRequiredProduct/SKU name
ingredientsarrayRequiredArray of {name, eCode?}
hasCertbooleanHas valid halal certificate
certBodystringCertification body (thida, bpjph, jakim, muis)
hasImporterbooleanHas registered Indonesian importer
targetMarketsarrayMarkets to check (default: all 3)
{ "ok": true, "report": { "id": "EXR-2026-abc1", "overallStatus": "BLOCKED", "riskScore": 72, "riskLevel": "critical", "markets": [...], "hiddenHazards": [...] } }
POST/api/generate-submission-plan

Generate a resolution plan from an export readiness report. Returns step-by-step fix plan with importer handoff.

ParameterTypeRequiredDescription
exportReportobjectRequiredReport from analyzeExportability
POST/api/generate-supplier-chase

Generate bilingual supplier chase email drafts (Chinese, English, Indonesian).

ParameterTypeRequiredDescription
requestsarrayRequiredArray of chase requests

System APIs

GET/api/health

Platform health check. Returns status, Firestore connectivity, and daily analytics.

{ "status": "healthy", "version": "3.0.0", "uptime_ms": 123456, "region": "asia-east1", "checks": [{ "name": "firestore", "status": "pass", "duration_ms": 45 }], "today": { "exportChecks": 12, "hazardsFound": 8, "blockedProducts": 3 } }

Enterprise Access

Need higher rate limits, webhook integrations, or custom API access? Contact us at hello@trackhalal.app