Carga y Procesamiento de Perfiles

La API de Sheriff te permite cargar, como consulta o monitoreo, perfiles (RUCs o DNIs) de manera programática. Los perfiles se pueden cargar de forma individual o masiva, y una vez procesados, estarán disponibles para consulta a través de otros endpoints.

Carga de Perfiles

Si el RUC/DNI no se encuentra previamente cargado en la plataforma, se aplicará un cobro conforme a los términos establecidos en el acuerdo comercial vigente.

Monitoreo/Consulta

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.

Flujo de Carga

1. Carga el perfil: Utiliza uno de los endpoints de carga (/cargar o /cargar-masivo) para añadir perfiles a tu cuenta.
2. Procesamiento: La API procesará la solicitud de forma síncrona. Esto puede tardar unos segundos.
3. Consulta la información: Una vez procesado, la información del perfil estará disponible para ser consultada a través del resto de los endpoints.

---

Endpoints

Carga Individual

Este endpoint permite cargar un único perfil a tu cuenta para monitoreo o consulta.

POST /api/v1/perfiles/cargar

Parámetros del Body:

Parámetro	Tipo	Requerido	Por Defecto	Descripción
taxId	string	Sí	-	RUC o DNI de la persona jurídica o natural a cargar (ej: 20XXXXXX056)
docType	string	Sí	-	Tipo de documento. Puede ser RUC o DNI
isMonitoring	boolean	No	true	Indica si el perfil debe ser monitoreado continuamente

Ejemplo de Request

curl -X POST https://api.sheriff.pe/v1/perfiles/cargar \
  -H "Authorization: Bearer <TU_TOKEN_JWT>" \
  -H "Content-Type: application/json" \
  -d '{
        "taxId": "201XXX8056",
        "docType": "RUC"
      }'

Ejemplo de Response

Una respuesta exitosa (200 OK) indica que el perfil ha sido procesado.

{
  "statusCode": 200,
  "message": "Perfil procesado con éxito."
}

---

Carga Masiva

Este endpoint permite cargar múltiples perfiles en una sola solicitud.

POST /api/v1/perfiles/cargar-masivo

Límite de Carga Masiva

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.

Parámetros del Body:

Parámetro	Tipo	Requerido	Por Defecto	Descripción
taxIds	string[]	Sí	-	Una lista de RUCs o DNIs a cargar (máximo 100)
docType	string	Sí	-	Tipo de documento para todos los perfiles de la lista. Puede ser RUC o DNI
isMonitoring	boolean	No	true	Indica si los perfiles deben ser monitoreados

Ejemplo de Request

curl -X POST https://api.sheriff.pe/v1/perfiles/cargar-masivo \
  -H "Authorization: Bearer <TU_TOKEN_JWT>" \
  -H "Content-Type: application/json" \
  -d '{
        "taxIds": ["201XXX8056", "1045XXX654"],
        "docType": "RUC"
      }'

Ejemplo de Response

{
  "statusCode": 200,
  "message": "Carga masiva completada: 2 perfiles cargados correctamente.",
  "results": {
    "successful": 2,
    "failed": 0,
    "skipped": 0,
    "errors": []
  }
}

---