Saltar al contenido principal

Introducción

Sheriff API Perú te permite consultar información de riesgo y cumplimiento de personas naturales o personas jurídicas en Perú directamente desde tu ERP, CRM o aplicación.

Versión Beta

Actualmente, esta API se encuentra en fase Beta pública para Perú. Eventualmente, se agregarán más endpoints y funcionalidades hasta cubrir toda la data disponible en el dashboard web de Sheriff.

Base URL​

https://api-public.thesheriff.pe/v1

¿Qué puedes hacer?​

Con una integración simple, accedes a la misma data que ves en nuestra plataforma web:

  • ✅ Evaluar riesgo en tiempo real al cargar clientes o proveedores.
  • ✅ Obtener indicadores de riesgo con nuestros distintos ayudantes (Legal, Financiero, Comercio Exterior, etc).
  • ✅ Monitorear cambios en los perfiles de tus clientes y proveedores.

¿Cómo funciona?​

Sheriff API actúa como un espejo de tu cuenta:

  1. Cargas un perfil (RUC, DNI o Carnet de Extranjería) a través del Dashboard de Sheriff o vía API con los endpoints de carga de perfiles.
  2. Consultas la API para obtener toda la data procesada de ese perfil.

Inicio Rápido​

1. Obtén tus credenciales​

Estas credenciales son necesarias para autenticarte en la API. Debes obtenerlas desde el dashboard web de Sheriff.

  • accessKey: Tu llave pública (ej: ak_132145...)
  • accessSecret: Tu llave secreta (ej: sk_xyz789...)

2. Autentícate​

Con tus credenciales, obtén un token JWT para autenticar tus solicitudes.

# Obtener token JWT
curl -X POST https://api-public.thesheriff.pe/v1/autenticacion/obtener-token \
  -H "Authorization: Basic $(echo -n 'tu-key:tu-secret' | base64)"

# Response: { "statusCode": 200, "data": { "token": "eyJhbGci...", "expiresIn": "1h" } }

3. Usa el token para hacer solicitudes​

Con el token JWT, ahora puedes hacer solicitudes a los endpoints de la API. Incluye el token en el header Authorization como un Bearer token. Consulta la documentación en Plataforma para ver la lista completa de endpoints.

# Consultar perfil
curl https://api-public.thesheriff.pe/v1/perfiles/:ruc/resumen \
  -H "Authorization: Bearer eyJhbGci..."

Próximos pasos​