Only approved submissions with valid fullName and birthDate fields can be registered for ongoing monitoring.
Endpoint POST /submission/aml/monitor/{worklistId}
Base URLs https://rest-api.argosidentity.com/v3/submission/aml/monitor
Authentication Include your API key in the request header:
Your API key for authentication
Path Parameters The ID of the active worklist where records will be registered
Request Body Array of submission IDs to register for ongoing monitoring (1-25 submissions)
Email address of the administrator making the request (must be registered in the project’s admin list)
Request Example curl -X POST 'https://rest-api.argosidentity.com/v3/submission/aml/monitor/{worklistId}' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {yourAPIKey}' \ -d '{ "submissionIds": [ "SUBMISSION_ID_00A", "SUBMISSION_ID_01B", "SUBMISSION_ID_02C" ], "admin": "admin@company.com" }'
Response Success Response { "success" : true , "successCount" : 2 , "failedCount" : 1 , "successResults" : [ { "submissionId" : "SUBMISSION_ID_00A" , "recordIds" : [ "RECORD_ID_00A" ], "status" : "success" }, { "submissionId" : "SUBMISSION_ID_01B" , "recordIds" : [ "RECORD_ID_01B" ], "status" : "success" } ], "failedResults" : [ { "submissionId" : "SUBMISSION_ID_02C" , "recordIds" : [], "status" : "failed" , "error" : "This submission is not approved: SUBMISSION_ID_02C" } ] }
Response Fields Overall success status of the batch operation
Number of submissions successfully processed
Number of submissions that failed to process
Array of successfully processed submissions Show Success Result Properties
The submission ID that was successfully processed
Array of generated record IDs for the submission
Processing status (always “success” for this array)
Array of submissions that failed to process Show Failed Result Properties
The submission ID that failed to process
Empty array (no records created for failed submissions)
Processing status (always “failed” for this array)
Description of why the submission failed
Error Response { "errorCode" : "missing_required_parameters" , "errorMessage" : "Required parameters are missing: worklistId, submissionIds, projectId, alias" }
Error Codes Error Code HTTP Status Description invalid_path400 Invalid request method invalid_project400 Invalid project ID or Ongoing Monitoring option disabled invalid_worklist400 Worklist is inactive invalid_submissionIds400 Submission IDs array format error or exceeds maximum count invalid_admin400 Admin not found in project’s admin list missing_required_parameters400 Required request parameters missing all_submissions_failed500 All submissions failed to process processing_failed500 Record registration or data processing failed internal_server_error500 Unexpected server error
Important Notes Prerequisites for Registration:
Submissions must be approved before they can be registered
Each submission must have valid fullName and birthDate fields
Only active worklists can accept new records
Maximum 25 submissions per request
Best Practices:
Verify submission approval status before attempting registration
Use batch operations for multiple submissions to improve efficiency
Monitor the response for partial failures and handle them appropriately
Keep track of generated record IDs for future reference
Rate Limits This endpoint follows the standard rate limiting policies. Each request can process up to 25 submissions simultaneously.
Get Ongoing Monitoring Record Retrieve detailed information about a specific monitoring record
Delete Ongoing Monitoring Records Remove ongoing monitoring records from the system
