Carga Masiva de Perfiles
Este endpoint permite cargar múltiples perfiles en una única solicitud, facilitando la carga de lotes de documentos. Todos estos serán cargados como consulta o monitoreo, según se especifique.
Si los documentos no se encuentran previamente cargados en la plataforma, se aplicará un cobro conforme a los términos establecidos en el acuerdo comercial vigente.
El modo Monitoreo garantiza la actualización automática y constante del perfil con información relevante, mientras que el modo Consulta permite el acceso temporal al mismo por un periodo de 48 horas para realizar una revisión puntual.
Endpoint
POST /v2/perfiles/cargar-masivo
La carga masiva está limitada a un máximo de 100 perfiles por solicitud. Si necesitas cargar más perfiles, divide tu lista en múltiples solicitudes.
La lista de documentos a cargar debe ser homogénea: todos deben ser del mismo tipo. Es decir, una solicitud puede contener solo DNIs, solo RUCs o solo Carnets de Extranjería, pero nunca una mezcla de distintos tipos. El docType que envíes aplica a todos los documentos de la lista.
Parámetros del Body
| Parámetro | Tipo | Requerido | Por Defecto | Descripción |
|---|---|---|---|---|
taxIds | string[] | Sí | - | Una lista de documentos a cargar, todos del mismo tipo (máximo 100) |
docType | string | Sí | - | Tipo de documento para todos los perfiles de la lista. Puede ser RUC, DNI o CE |
isMonitoring | boolean | No | true | Indica si los perfiles deben ser monitoreados |
months | number | No | — | Solo en planes de pago único y con isMonitoring: true: meses de duración, uno para todo el lote (1 a 12). El gasto es perfiles × meses. Si se omite, se activan los que quepan. Si el contrato termina a mitad de mes, el último mes se puede incluir igual: el monitoreo vence el día del contrato y ese mes consume un mes-monitoreo completo |
Tipos de documento soportados
docType | Documento | Formato del taxId |
|---|---|---|
RUC | Registro Único de Contribuyentes | 11 dígitos (prefijo 10, 15, 17 o 20) + dígito verificador |
DNI | Documento Nacional de Identidad | 8 dígitos |
CE | Carnet de Extranjería | Alfanumérico, 9 a 12 caracteres |
Ejemplo de Solicitud
curl -X POST https://api-public.thesheriff.pe/v2/perfiles/cargar-masivo \
-H "Authorization: Bearer <TU_TOKEN_JWT>" \
-H "Content-Type: application/json" \
-d '{
"taxIds": ["201XXX8056", "1045XXX654"],
"docType": "RUC"
}'
Ejemplo de Respuesta
{
"statusCode": 200,
"message": "Carga masiva completada: 2 perfiles cargados correctamente.",
"results": {
"successful": 2,
"failed": 0,
"skipped": 0,
"errors": []
}
}
Campos de results
| Campo | Tipo | Descripción |
|---|---|---|
successful | number | Perfiles cargados en esta solicitud |
skipped | number | Perfiles omitidos porque ya pertenecían a tu cartera |
failed | number | Perfiles con errores; el detalle va en errors |
errors | array | Un { taxId, reason } por cada perfil con error |
monitoringActivationFailed | number | Solo en planes de pago único con isMonitoring: true, y solo cuando ocurre: perfiles cuyo monitoreo quedó vencido en el acto porque el cupo cambió entre la validación y la activación (por ejemplo, por otra carga en paralelo). El monitoreo del lote se activa como una sola operación: o se activan todos los perfiles o ninguno. Los perfiles quedan cargados y la plataforma los muestra vencidos, con la acción de reactivar el monitoreo cuando tengas cupo. message lo explica |
Ejemplo de Respuesta con el monitoreo vencido
{
"statusCode": 200,
"message": "Carga masiva completada: 2 perfiles cargados correctamente. No pudimos activar el monitoreo de 2 perfiles porque tu cupo cambió mientras se procesaba: quedaron vencidos. Reactívalos desde la plataforma cuando tengas cupo.",
"results": {
"successful": 2,
"failed": 0,
"skipped": 0,
"errors": [],
"monitoringActivationFailed": 2
}
}