Ongoing Monitoring

Overview

The Ongoing Monitoring API provides functionality for managing ongoing monitoring for FICA applications. This includes disabling ongoing monitoring for individuals, entities, and trusts, which is essential for compliance and risk management in the FICA process.

Base URL

https://sandboxapi.efica.co.za/ongoing-monitoring

Authentication

All endpoints require Bearer token authentication. Include the token in the Authorization header:

Authorization: Bearer <your-jwt-token>

Core Endpoints

Remove Individual Ongoing Monitoring

Disable ongoing monitoring for a specific individual FICA application.

URL: POST /ongoing-monitoring/remove-individual
Authentication: Required
Content-Type: application/json

Request Body

{
  "ficaIndividualID": 123
}

Request Body Parameters

Parameter	Type	Required	Description	Example
ficaIndividualID	number	Yes	Individual FICA application ID	123

Example Request

curl -X POST "https://sandboxapi.efica.co.za/ongoing-monitoring/remove-individual" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ficaIndividualID": 123
  }'

Success Response (200 OK)

{
  "success": true,
  "message": "Ongoing monitoring disabled successfully for individual",
  "individualID": 123,
  "disabledAt": "2023-12-01T10:30:00.000Z"
}

Remove Entity Ongoing Monitoring

Disable ongoing monitoring for a specific entity FICA application.

URL: POST /ongoing-monitoring/remove-entity
Authentication: Required
Content-Type: application/json

Request Body

{
  "ficaEntityID": 456
}

Request Body Parameters

Parameter	Type	Required	Description	Example
ficaEntityID	number	Yes	Entity FICA application ID	456

Example Request

curl -X POST "https://sandboxapi.efica.co.za/ongoing-monitoring/remove-entity" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ficaEntityID": 456
  }'

Success Response (200 OK)

{
  "success": true,
  "message": "Ongoing monitoring disabled successfully for entity",
  "entityID": 456,
  "disabledAt": "2023-12-01T10:30:00.000Z"
}

Remove Trust Ongoing Monitoring

Disable ongoing monitoring for a specific trust FICA application.

URL: POST /ongoing-monitoring/remove-trust
Authentication: Required
Content-Type: application/json

Request Body

{
  "ficaTrustID": 789
}

Request Body Parameters

Parameter	Type	Required	Description	Example
ficaTrustID	number	Yes	Trust FICA application ID	789

Example Request

curl -X POST "https://sandboxapi.efica.co.za/ongoing-monitoring/remove-trust" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ficaTrustID": 789
  }'

Success Response (200 OK)

{
  "success": true,
  "message": "Ongoing monitoring disabled successfully for trust",
  "trustID": 789,
  "disabledAt": "2023-12-01T10:30:00.000Z"
}

Error Handling

HTTP Status Codes

Status Code	Description	Common Causes
200	Success	Request completed successfully
400	Bad Request	Invalid input data or missing required fields
401	Unauthorized	Invalid or missing authentication token
403	Forbidden	Insufficient permissions for the requested operation
404	Not Found	FICA application not found
409	Conflict	Ongoing monitoring already disabled
500	Internal Server Error	Server-side error

Error Response Format

{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request",
  "details": [
    {
      "field": "ficaIndividualID",
      "message": "Individual ID is required"
    }
  ]
}

Workflow Examples

Individual Monitoring Removal

Entity Monitoring Removal

Troubleshooting

Common Issues

1. Invalid Application ID

   • Verify the FICA application ID exists
   • Check that the ID belongs to the correct application type
   • Ensure the application is in the correct status
   • Validate ID format and range

2. Permission Errors

   • Verify user has appropriate permissions
   • Check role-based access controls
   • Ensure proper authentication
   • Contact administrator if needed

Support

For technical support or questions about the Ongoing Monitoring API:

1. Check the API documentation for endpoint details and examples
2. Review error messages for specific issue details
3. Contact support at melissa@efica.co.za
4. Include relevant information:
   • API endpoint being called
   • FICA application ID and type
   • Error response details
   • Steps to reproduce the issue

---

Last Updated: 14 August 2025