Errores
Esta página reúne la estructura de un error de la API v3 y los errores que pueden responder todos los endpoints. Los errores propios de cada endpoint están en la sección Errores de su página.
Estructura de un error
{
"success": false,
"code": 400,
"error": "El campo 'rut' es requerido."
}
| Campo | Tipo | Descripción |
|---|---|---|
success | boolean | Siempre false en un error. |
code | number | Código HTTP del error. |
error | string | Descripción del error, en español. |
codees igual al código HTTP de la respuesta. Úsalo para decidir cómo reaccionar ante un error.errores un texto para mostrar o registrar. No lo compares como si fuera un código.- Si una validación falla en varios campos,
errortrae un mensaje por campo, separados por un espacio. - Los valores variables del mensaje, como el RUT o un límite, se reemplazan por el dato real.
- Las respuestas
429incluyen el headerRetry-Aftercon los segundos de espera (ver Rate Limits).
Errores comunes
Pueden ocurrir en todos los endpoints que requieren token, es decir, en todos menos Obtener Token:
| Código | Cuándo ocurre | Mensaje en error |
|---|---|---|
400 | El usuario del token no tiene una cuenta asignada | El usuario no tiene una corporación asignada. |
401 | Falta el header Authorization | No se envió el token de autenticación. |
401 | El token está mal formado o firmado con otra clave | El token de autenticación no es válido. |
401 | El token venció | El token de autenticación expiró. Solicita uno nuevo. |
401 | El usuario del token no existe | Usuario no encontrado |
401 | El usuario del token está desactivado | El usuario se encuentra desactivado |
429 | Se superó el límite de solicitudes | Demasiadas solicitudes desde esta API externa, intente más tarde. |
500 | Ocurrió un error inesperado | Ocurrió un error interno. Intenta nuevamente más tarde. |
Los errores del token y cómo resolverlos se explican en Uso del token. Ante un 429, espera los segundos que indica el header Retry-After antes de reintentar. Ante un 500, intenta nuevamente más tarde.
Acceso al RUT
Pueden ocurrir en los endpoints que llevan {rut} en la ruta: Malla Societaria, Capas y Niveles de la Malla Societaria, CMF, Detalle de Compliance y Actualizar Marshal.
| Código | Cuándo ocurre | Mensaje en error | Qué hacer |
|---|---|---|---|
400 | El RUT tiene un formato o dígito verificador inválido | El RUT ingresado no es válido. Por favor verifica el formato. | Corrige el RUT de la ruta. |
403 | El RUT no está cargado en tu cuenta | No tienes permisos para consultar este RUT. | Cárgalo con Carga de RUT. |
404 | El RUT no existe en Sheriff | El RUT consultado no existe en el sistema. | Cárgalo con Carga de RUT. |
Carga del perfil
Si tu plan o tu cuenta no permiten cargar un RUT (por cupo, plan, demo, suscripción o sandbox), la API responde los errores que se listan en Carga de RUT. Esos mismos errores aplican al webhook de resumen cuando el RUT necesita cargarse.