Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://developers.argosidentity.com/llms.txt

Use this file to discover all available pages before exploring further.

Esta API es particularmente útil para administradores de proyecto que necesitan revisar manualmente los envíos KYC pendientes según la configuración de su proyecto. Cuando el revisor está configurado como ‘Client’ en la configuración del proyecto, los Agentes de ARGOS no revisarán estos envíos pendientes.
Solo los envíos pendientes pueden ser revisados usando esta API. Los envíos que ya están aprobados o rechazados no pueden ser modificados a través de este endpoint. Asegúrese de que el email del administrador esté registrado en el dashboard con los permisos adecuados para el proyecto.

​
1. Endpoint

POST https://rest-api.argosidentity.com/v3/submission/review

​
2. Autenticación

Incluya la clave API en el encabezado x-api-key:
x-api-key
x-api-key: {yourAPIKey}

​
3. Cuerpo de la Solicitud

Los parámetros de solicitud deben estar en formato de consulta URL. A continuación se encuentran las descripciones de cada parámetro:
​
admin
string
requerido
Cuenta de administrador registrada como administrador en el proyecto del envío a revisar
​
submissionId
string
requerido
ID único del envío pendiente a revisar
​
status
string
requerido
Valor de estado a cambiar: approved o rejected
​
rejectComment
string
requerido
Comentario explicando la decisión de revisión (opcional). Requerido cuando el estado es rejected
​
updateFields
string
Campos de datos a actualizar

​
4. Ejemplo de Solicitud

POST/Review
curl --location 'https://rest-api.argosidentity.com/v3/submission/review' \
--header 'Content-Type: application/json' \
--header 'x-api-key: {yourAPIKey}' \
--data-raw '{
    "submissionId": "string",
    "status": "string",
    "rejectComment": "string",
    "updateFields": {
      "fullName": "string",
      "gender": "string",
      "issueDate": "string",
      "expireDate": "string",
      "birthDate": "string",
      "idType": "string"
    },
    "admin": "string"
  }

​
5. Respuesta

​
5-1. Respuesta Exitosa

result.json
{
    "submissionId": "string",
    "message": "Success to review submission.",
    "finalStatus": "approved"
}

​
5-2. Respuesta de Error

Si ocurre un error, se devuelve un código de estado 400 con detalles en el cuerpo de la respuesta:
error.json
{
    "message": "Project not found."
}

​
5-3. Códigos de Error

Error TypeMessageDescripción
Validation : projectProject not found.Clave API o datos de proyecto inválidos
Validation : projectadmin is required.No se proporcionó el parámetro admin
Validation : projectAccess denied. The admin is not registered in the project.El admin no está registrado en el proyecto o datos de admin inválidos
Validation : submissionSubmission Id is required.No se proporcionó el ID de submission
Validation : submissionInvalid Submission Id.Datos de submission inválidos
Validation : submissionOnly submissions in pending status can be reviewedEl submission no está en estado pendiente
Validation : submissionThis submission cannot be reviewed by clientEl submission no es elegible para revisión del cliente
Validation : request parameterInvalid statusEl estado debe ser ‘approved’ o ‘rejected’
Validation : request parameterInvalid data format.El formato de updateFields es incorrecto (se requiere objeto)
Validation : request parameterReject comment is requiredSe requiere rejectedComment al cambiar estado a rejected
Validation : request parameterInvalid idTypeidType inválido
Validation : request parameterInvalid genderGénero inválido
Validation : request parameterInvalid issueDate format. Use YYYY-MM-DDFormato de fecha inválido (se requiere yyyy-mm-dd)
Validation : request parameterInvalid expireDate format. Use YYYY-MM-DDFormato de fecha inválido (se requiere yyyy-mm-dd)
Validation : request parameterInvalid birthDate format. Use YYYY-MM-DDFormato de fecha inválido (se requiere yyyy-mm-dd)
Processing ErrorFailed to process submissionOcurrió un error no definido durante el procesamiento de datos
Processing ErrorError in submission review process.Ocurrió un error no definido durante el procesamiento de revisión