Skip to Content
API ReferenceOverview

API Reference

The Apostille system exposes three API groups, each with its own authentication requirements.

API Groups

APIBase PathAuthDescription
Citizen/citizenCognito (Citizen Pool)Endpoints for citizen portal
Admin/adminCognito (Admin Pool)Endpoints for admin portal
Public/publicNonePublic verification endpoint

Authentication

All protected endpoints require a valid JWT token in the Authorization header:

Authorization: Bearer <token>

Tokens are obtained through Cognito authentication flows.

Common Response Format

Success Response

{ "data": { ... }, "message": "Operation successful" }

Error Response

{ "error": { "code": "VALIDATION_ERROR", "message": "Description of the error" } }

HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request - Invalid input
401Unauthorized - Missing or invalid token
403Forbidden - Insufficient permissions
404Not Found
500Internal Server Error
Last updated on