Carga Individual de Perfil

La API de Sheriff te permite cargar, como consulta o monitoreo, perfiles (RUC, DNI o Carnet de Extranjería) de manera programática. Una vez procesado, el perfil estará disponible para consulta a través de otros endpoints.

Carga de Perfiles

Si el documento 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 el endpoint /cargar para añadir un perfil 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.

API Espejo

La carga de perfiles vía API refleja la misma funcionalidad que la carga manual a través del dashboard web de Sheriff. Cargar un perfil por cualquiera de estos medios lo hará disponible para consulta en ambos.

---

Endpoint

POST /v1/perfiles/cargar

Parámetros del Body

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

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/v1/perfiles/cargar \
  -H "Authorization: Bearer <TU_TOKEN_JWT>" \
  -H "Content-Type: application/json" \
  -d '{
        "taxId": "201XXX8056",
        "docType": "RUC"
      }'

Ejemplo de Respuesta

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

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