Carga de RUT
Este endpoint carga un RUT en tu cuenta de Sheriff, como consulta o como monitoreo. Una vez cargado, puedes consultar su información en el Resumen de un perfil y en los endpoints de detalle.
- Si el RUT no estaba cargado en tu cuenta, la carga tiene un cobro según los términos de tu acuerdo comercial vigente. Revisa tu acuerdo para conocer los cargos aplicables.
- Opcionalmente, puedes solicitar el análisis Marshal del RUT en la misma carga.
- Nuevo campo opcional
includeMarshalpara solicitar el análisis Marshal. includeEquifaxse valida como booleano: un valor distinto detrueofalseresponde400.- La respuesta cambia:
dataes un objeto conrutymessage, en lugar de un arreglo con el RUT. - Si el RUT ya estaba en tu cartera, la carga responde
409.
Ver la Guía de Migración.
Detalle de API
Request
- URL:
/helper/cargarRut - Método:
POST - Ejemplo request body:
{
"rut": "76123456-0",
"isMonitoring": false,
"includeEquifax": false,
"includeMarshal": true
}
| Valor | Tipo | Es requerido | Descripción |
|---|---|---|---|
rut | string | Sí | RUT de la persona o entidad que quieres cargar. Puede enviarse con o sin puntos (ej: 76123456-0). |
isMonitoring | bool | No | true carga el RUT en monitoreo; false, como consulta. Por defecto false. |
includeEquifax | bool | No | true incluye la consulta a Equifax. Solo aplica a clientes con la integración de Equifax. Por defecto false. |
includeMarshal | bool | No | true solicita el análisis Marshal del RUT. Requiere que tu plan cuente con Marshal. Por defecto false. |
Ejemplo request con curl
curl -X 'POST' \
'https://prod.api.thesheriff.cl/api/clients/v3/helper/cargarRut' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9EjemploDeToken123' \
-H 'Content-Type: application/json' \
-d '{
"rut": "76123456-0",
"isMonitoring": false,
"includeEquifax": false,
"includeMarshal": true
}'
Response
Success
-
Status code: 200
-
Example response body:
{
"success": true,
"data": {
"rut": "76123456-0",
"message": "El RUT 76123456-0 se ha cargado en la cartera de la corporación."
}
}
Success (RUT cargado por otro usuario de tu cuenta)
Si el RUT ya estaba activo en tu cuenta porque lo cargó otro usuario, también se agrega a tu cartera:
{
"success": true,
"data": {
"rut": "76123456-0",
"message": "El RUT 76123456-0 ya estaba cargado en tu corporación por otro usuario; se agregó también a tu cartera."
}
}
| Campo | Tipo | Descripción |
|---|---|---|
success | boolean | Indica si la carga fue aceptada. |
data.rut | string | RUT cargado, sin puntos (formato "12345678-9"). |
data.message | string | Mensaje informativo sobre la carga. |
Si el RUT ya estaba en tu propia cartera, la carga responde 409 y no cambia nada. La respuesta es la misma para personas naturales y jurídicas.
Después de responder, Sheriff sigue recolectando la información del RUT de forma asíncrona. Consulta el Resumen de un perfil para ver los datos a medida que las fuentes responden, o usa el webhook de resumen para recibir el resumen cuando esté listo.
Análisis Marshal
Marshal complementa el compliance del RUT con hallazgos en medios de prensa y detección de Personas Expuestas Políticamente (PEP). Al enviar includeMarshal: true:
- Tu plan debe contar con Marshal; de lo contrario, la solicitud responde
403y el RUT no se carga. - El análisis se ejecuta de forma asíncrona: la respuesta de la carga no lo espera y no cambia.
- Si además envías
isMonitoring: true, el RUT queda también en el monitoreo de Marshal.
Qué ocurre con includeMarshal: true según la situación del RUT:
| Situación del RUT | Qué ocurre |
|---|---|
| No existe en Sheriff | El RUT se carga con Marshal y la investigación queda EN_CURSO esperando la consulta de identificación (SII), porque necesita la razón social o el nombre. Cuando esa consulta termina, la investigación se envía a Marshal. Si no se obtiene la razón social, o la carga no incluye la consulta de identificación, la investigación queda FALLIDA con motivo SIN_RAZON_SOCIAL. |
| Existe en Sheriff, pero no está activo en tu cuenta (nunca se cargó o se eliminó de la cartera) | El RUT se carga con Marshal y se solicita el análisis, salvo que ya tenga un análisis completado recientemente en tu cuenta. Si el RUT aún no tiene razón social, la investigación espera la consulta de identificación o, si esta no se realiza, queda FALLIDA con motivo SIN_RAZON_SOCIAL. |
| Ya está activo en tu cartera (lo cargaste antes y sigue activo) | La carga no cambia nada y responde 409: se mantiene el includeMarshal de la carga original, sea true o false, y no se solicita un análisis nuevo. |
| Está activo en tu cuenta, cargado por otro usuario | El RUT se agrega a tu cartera marcado con Marshal (compliance.marshal: true), pero no se solicita un análisis nuevo. |
Volver a cargar un RUT que ya está activo no activa Marshal ni pide un análisis nuevo. La única forma de activar Marshal en un perfil cargado sin includeMarshal, o de actualizar su análisis, es Actualizar Marshal.
Otros casos:
- Si tu plan no tiene cupo disponible para Marshal, el análisis no se solicita y la carga responde igual
200. Si la investigación estaba esperando la consulta de identificación, quedaFALLIDAcon motivoSIN_CUPO. - Si el RUT ya tiene un análisis en curso, se reutiliza ese análisis.
- Las investigaciones solicitadas por la API quedan con
canal: "API". Puedes seguir su estado en Listar investigaciones.
Cómo ver el resultado:
- En el Resumen de un perfil,
compliance.marshalindica que el RUT fue cargado con Marshal ycompliance.estadoMarshalpasa a"PROCESADO"cuando el análisis se completa. - En el Detalle de Compliance, los hallazgos de Marshal aparecen en
noticiasy la detección de PEP enpepChile.marshalyfamiliaresPep.marshal. - Si prefieres recibir el resumen cuando el análisis termine, solicítalo con el webhook de resumen y
includeMarshal: true.
Errores
Además de los errores comunes, este endpoint puede responder:
400 - Parámetros inválidos
Algún campo del body falta, tiene un valor inválido o un tipo incorrecto. El mensaje indica el campo rechazado: corrígelo y vuelve a enviar la solicitud.
| Cuándo ocurre | Mensaje en error |
|---|---|
rut con formato inválido o incorrecto | El rut posee un formato inválido o es incorrecto. |
Falta rut | El campo 'rut' es requerido. |
rut vacío | El campo 'rut' no puede estar vacío. |
rut no es texto | El campo 'rut' debe ser texto. |
rut de más de 200 caracteres | El campo 'rut' debe tener como máximo 200 caracteres. |
isMonitoring no booleano | El campo 'isMonitoring' debe ser verdadero o falso. |
includeEquifax no booleano | El campo 'includeEquifax' debe ser verdadero o falso. |
includeMarshal no booleano | El campo 'includeMarshal' debe ser verdadero o falso. |
{
"success": false,
"code": 400,
"error": "El campo 'rut' es requerido."
}
400 / 403 / 404 / 503 - Carga del perfil
Tu plan o tu cuenta no permiten la carga (por cupo, plan, demo, suscripción o sandbox). Estos errores también aplican al webhook de resumen cuando el RUT necesita cargarse. Varios mensajes indican cómo resolver el caso; ante un 503, intenta nuevamente en unos minutos. Los valores entre llaves se reemplazan por el dato real:
| Código | Cuándo ocurre | Mensaje en error |
|---|---|---|
400 | Rol operador y RUT en la lista restringida de tu cuenta | No tienes permiso para consultar estos RUTs. |
400 | Suscripción inactiva | La suscripción de tu corporación se encuentra inactiva, contactate con un ejecutivo de ventas |
400 | Se alcanzó el límite de la versión demo | ¡Ya has cargado los {N} RUT de la versión demo! Si quieres cotizar un plan, escríbenos en la sección "Contacto". |
400 | Carga en monitoreo con un plan sin monitoreo | Lo sentimos, tu plan solo cuenta con consultas, Si quieres cotizar un plan con monitoreo, escríbenos en la sección "Contacto" |
400 | Carga en consulta con un plan sin consultas | Lo sentimos, tu plan solo cuenta con monitoreos, Si quieres cotizar un plan con consulta, escríbenos en la sección "Contacto" |
400 | Se alcanzó el límite de consultas del plan | Ya has alcanzado el límite de consultas ({N}) permitido por tu plan. Si quieres solicitar más consultas, escríbenos en la sección "Contacto" |
400 | Se alcanzó el límite de monitoreos del plan | Ya has alcanzado el límite de monitoreos ({N}) permitido por tu plan. Si quieres solicitar más monitoreos, escríbenos en la sección "Contacto" |
400 | Bolsa de consultas agotada | Has consumido el total de consultas disponibles en tu plan. Escribe al área comercial para solicitar más consultas |
400 | Bolsa de monitoreos agotada | Has consumido el total de monitoreos disponibles en tu plan. Escribe al área comercial para solicitar más monitoreos |
400 | Cuenta sandbox con un RUT fuera del catálogo de pruebas | Esta cuenta opera en modo sandbox y sólo puede cargar perfiles del catálogo de pruebas. Los siguientes no pertenecen al catálogo: {RUTs}. |
400 | Cuenta sandbox con un RUT del catálogo aún no disponible | Estos perfiles del catálogo de pruebas todavía no están disponibles: {RUTs}. |
403 | El plan no tiene consultas contratadas | Tu plan no incluye consultas. Si necesitas esta función, contacta a tu ejecutivo comercial. |
403 | El plan no tiene monitoreos contratados | Tu plan no incluye monitoreos. Si necesitas esta función, contacta a tu ejecutivo comercial. |
403 | Plan vencido | Tu plan venció. Para renovarlo, contacta a tu ejecutivo comercial. |
403 | Plan no vigente | Tu plan ya no está vigente. Contacta a tu ejecutivo comercial para reactivarlo. |
404 | RUT del catálogo de pruebas en una cuenta productiva | No se encontró información para el RUT indicado. |
503 | No se pudo validar el saldo del plan | No pudimos validar el saldo de tu plan en este momento. Intenta nuevamente en unos minutos. |
{
"success": false,
"code": 400,
"error": "Has consumido el total de consultas disponibles en tu plan. Escribe al área comercial para solicitar más consultas"
}
401 - No autorizado
El token no se envió, expiró o no es válido (ver Errores de autenticación). Si expiró, solicita uno nuevo en Obtener Token.
{
"success": false,
"code": 401,
"error": "El token de autenticación no es válido."
}
403 - Plan sin Marshal
Enviaste includeMarshal: true y tu plan no cuenta con Marshal. El RUT no se carga.
{
"success": false,
"code": 403,
"error": "El plan no cuenta con Marshal."
}
409 - RUT ya cargado
El RUT ya está activo en tu cartera. La carga no se repite ni cambia la carga existente (incluido includeMarshal). Para pedir un nuevo análisis Marshal, usa Actualizar Marshal.
{
"success": false,
"code": 409,
"error": "El RUT 76123456-0 ya estaba cargado en tu cartera."
}
429 - Demasiadas solicitudes
Superaste el límite de solicitudes (ver Rate Limits). Espera los segundos que indica el header Retry-After antes de reintentar.
{
"success": false,
"code": 429,
"error": "Demasiadas solicitudes desde esta API externa, intente más tarde."
}
500 - Error interno del servidor
Ocurrió un error inesperado. Intenta nuevamente más tarde.
{
"success": false,
"code": 500,
"error": "Ocurrió un error interno. Intenta nuevamente más tarde."
}