Interactive in-browser testing (Try it out) has been intentionally disabled on this reference server for security and audit integrity.
Authorized consumers exchange their Admin-Issued API key via POST /api/v1/external/auth/token to receive a 1-hour Bearer token, and then query records via GET (query parameters) or POST (JSON body — recommended for names containing spaces). Full schemas and response models are documented in the specification below.
Member & Legal Practitioner Gateway
Endpoint Path: /api/v1/external/members
Direct Alias: /api/v1/external/members
Allowed Methods: GET, POST (Read-Only Query / JSON Body)
Client ID: fid_ext_lpff_members_2026
API Key: Issued Securely by Administrator
Search Inputs: memberNumber / practitionerNo (e.g. 99999), identityNumber (e.g. 9901015000080), or firstName & surname (e.g. Jane Doe)
Data Returned: Profile, Compliance Standing, Active Employment History, Issued FFC Certificates, and Annual FFC Applications
Law Firm Compliance & Personnel Gateway
Endpoint Path: /api/v1/external/firms
Direct Alias: /api/v1/external/firms
Allowed Methods: GET, POST (Read-Only Query / JSON Body)
Client ID: fid_ext_lpff_firms_2026
API Key: Issued Securely by Administrator
Search Inputs: firmNumber (e.g. FIRM-99999 or 99999), firmName (e.g. Sample Legal Practice Inc.), or registrationNumber (e.g. 2020/000000/21)
Data Returned: Profile, Active Linked Practitioners/Partners, Trust Bank Accounts, Annual Audit Compliance, and Statutory Firm FFC Status
Banking Grade & POPIA Security Implementation:
- Transport Encryption: Enforced TLS 1.2+ / TLS 1.3 with Strict Transport Security (HSTS
max-age=31536000).
- POPIA Anti-Caching: Zero-store directives (
Cache-Control: no-store, private, Pragma: no-cache) prevent proxy and intermediary caching of PII.
- Authentication: HMAC-SHA256 signed OAuth2 JWTs with short 3600s TTL or 256-bit static API keys.
- SQL Injection Immunity: 100% parameterized query bindings with type enforcement.
- Immutable Audit Trail: Every request is recorded with caller IP, timestamp, parameters, and status code in
Frwk_ExternalApiAuditLogs.
Quick Integration Example (OAuth2 Token Exchange & API Call)
# 1. Request Signed Bearer JWT Access Token (using Administrator-issued API Key)
curl -s -X POST "https://lpc-ffc.lpffuat.co.za/api/v1/external/auth/token" -H "Content-Type: application/json" -d '{"apiKey":"<YOUR_ADMIN_ISSUED_KEY>"}'
# 2a. Query Practitioner Record via POST JSON Body (handles spaces in names automatically)
curl -s -X POST "https://lpc-ffc.lpffuat.co.za/api/v1/external/members" -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" -H "Content-Type: application/json" -d '{"firstName":"Jane Alex","surname":"Van Der Merwe"}'
# 2b. Or Query Practitioner Record via GET (use --data-urlencode or %20/+ for spaces)
curl -s -G "https://lpc-ffc.lpffuat.co.za/api/v1/external/members" -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" --data-urlencode "firstName=Jane Alex" --data-urlencode "surname=Van Der Merwe"
# 3a. Query Law Firm Record via POST JSON Body (handles spaces in firm names automatically)
curl -s -X POST "https://lpc-ffc.lpffuat.co.za/api/v1/external/firms" -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" -H "Content-Type: application/json" -d '{"firmName":"Sample Legal Practice Inc."}'
# 3b. Or Query Law Firm Record via GET (use --data-urlencode or %20/+ for spaces)
curl -s -G "https://lpc-ffc.lpffuat.co.za/api/v1/external/firms" -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" --data-urlencode "firmName=Sample Legal Practice Inc."