Saltar al contenido principal
Solo los envíos aprobados con campos fullName y birthDate válidos pueden ser registrados para monitoreo continuo.

​
Endpoint

POST /submission/aml/monitor/{worklistId}

​
URL Base

https://rest-api.argosidentity.com/v3/submission/aml/monitor

​
Autenticación

Incluya su clave API en el encabezado de la solicitud:
​
x-api-key
string
requerido
Su clave API para autenticación

​
Parámetros de Ruta

​
worklistId
string
requerido
El ID de la lista de trabajo activa donde se registrarán los registros

​
Cuerpo de la Solicitud

​
submissionIds
array
requerido
Array de IDs de envío para registrar para monitoreo continuo (1-25 envíos)
​
admin
string
requerido
Dirección de correo electrónico del administrador que realiza la solicitud (debe estar registrado en la lista de administradores del proyecto)

​
Ejemplo de Solicitud

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"
  }'

​
Respuesta

​
Respuesta Exitosa

{
  "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"
    }
  ]
}

​
Campos de la Respuesta

​
success
boolean
requerido
Estado general de éxito de la operación por lotes
​
successCount
number
requerido
Número de envíos procesados exitosamente
​
failedCount
number
requerido
Número de envíos que fallaron al procesarse
​
successResults
array
requerido
Array de envíos procesados exitosamente
​
failedResults
array
requerido
Array de envíos que fallaron al procesarse

​
Respuesta de Error

{
  "errorCode": "missing_required_parameters",
  "errorMessage": "Required parameters are missing: worklistId, submissionIds, projectId, alias"
}

​
Códigos de Error

Código de ErrorEstado HTTPDescripción
invalid_path400Método de solicitud no válido
invalid_project400ID de proyecto no válido o opción de Monitoreo Continuo deshabilitada
invalid_worklist400Lista de trabajo inactiva
invalid_submissionIds400Error de formato en el array de IDs de envío o supera el conteo máximo
invalid_admin400Administrador no encontrado en la lista de administradores del proyecto
missing_required_parameters400Parámetros de solicitud requeridos faltantes
all_submissions_failed500Todos los envíos fallaron al procesarse
processing_failed500Falló el registro de registro o el procesamiento de datos
internal_server_error500Error inesperado del servidor

​
Notas Importantes

Requisitos Previos para el Registro:
  • Los envíos deben estar aprobados antes de poder registrarse
  • Cada envío debe tener campos fullName y birthDate válidos
  • Solo las listas de trabajo activas pueden aceptar nuevos registros
  • Máximo 25 envíos por solicitud
Mejores Prácticas:
  • Verifique el estado de aprobación del envío antes de intentar el registro
  • Utilice operaciones por lotes para múltiples envíos para mejorar la eficiencia
  • Monitoree la respuesta para fallas parciales y maneje las adecuadamente
  • Mantenga un registro de los IDs de registro generados para referencia futura

​
Límites de Velocidad

Este endpoint sigue las políticas estándar de limitación de velocidad. Cada solicitud puede procesar hasta 25 envíos simultáneamente.

​
Endpoints Relacionados

Obtener Registro de Monitoreo Continuo

Recupere información detallada sobre un registro de monitoreo específico

Eliminar Registros de Monitoreo Continuo

Elimine registros de monitoreo continuo del sistema