Developers

API Documentation

Design proposal for the future NAISAR COPS integration API (NSW pilot proposal).

Roadmap item — not operational. The NAISAR API has not been built: no endpoints listed on this page are currently live, and no API keys are being issued. The documentation below is a design proposal for the NSW Police pilot proposal only. Contact partnerships@naisar.org.au to register interest in the future pilot.

GET /api/v1/risk-assessment/ Not yet implemented — proposed future capability

Retrieve the current NAISAR risk assessment matrix.

Authentication: API Key
Example response (proposed): 
{"tiers": [...], "scores": [...]}
POST /api/v1/incident-report/ Not yet implemented — proposed future capability

Submit an incident report for tier classification.

Authentication: API Key + OAuth2
Parameters:
  • location
  • incident_type
  • parties_involved
  • risk_indicators
Example response (proposed): 
{"tier": "N-2", "confidence": 0.94, ...}
GET /api/v1/articles/ Not yet implemented — proposed future capability

List all published framework articles.

Authentication: None (public)
Example response (proposed): 
{"articles": [{"slug": "...", "title": "..."}]}
GET /api/v1/articles/<slug>/ Not yet implemented — proposed future capability

Retrieve a single article by slug.

Authentication: None (public)
Example response (proposed): 
{"slug": "...", "title": "...", "content": "..."}
POST /api/v1/feedback/ Not yet implemented — proposed future capability

Submit feedback or correction on an article.

Authentication: API Key
Parameters:
  • article_slug
  • feedback_type
  • message
Example response (proposed): 
{"status": "received", "ticket_id": "..."}