API ReferenceNotifications
Send a notification
Sends a notification using a template through the specified channel
POST
/v1/notifications/sendRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/v1/notifications/send" \ -H "Content-Type: application/json" \ -d '{ "channel": "email", "to": "user@example.com", "templateName": "welcome", "templateVariables": { "userName": "John Doe", "userEmail": "john@example.com" } }'{ "success": true, "statusCode": 200, "message": "Request processed successfully", "timestamp": "2025-10-20T16:30:00.000Z", "path": "/v1/auth/register", "data": { "success": true, "message": "Notification sent successfully" }}{ "success": false, "statusCode": 400, "message": "Validation failed", "errors": [ { "field": "email", "message": "Email must be a valid email address" } ], "timestamp": "2025-10-20T16:30:00.000Z", "path": "/v1/auth/register"}Enhanced phone lookup
Resolve a phone number (MSISDN) to a NIN identity record via TruztFix resolution + NIMC lookup. Requires an active Enhanced Phone Lookup subscription. Primary path: TruztFix resolves MSISDN→NIN, then NIMC raw lookup. Fallback path: NIMC phone-number lookup when TruztFix cannot resolve the MSISDN.
Get available notification channels
Returns list of configured notification channels