Perfiles

Este endpoint devuelve un resumen de perfiles asociados a un RUT (incluye el total y arrays separados para Monitoreo y Consulta) para un RUT previamente cargado en tu cuenta de Sheriff.

Detalle de API

Request

• URL: /profiles
• Método: GET

Ejemplo request con curl

curl -X 'GET' \
  'https://prod.api.thesheriff.cl/api/clients/v2/profiles' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9EjemploDeToken123' \
  -H 'x-client-identifier: SheriffSecureClient-v1'

Response

Success

• Status code: 200

• Example response body:

  {
    "success": true,
    "data": {
      "total": 2,
      "Monitoreo": [
        {
          "rut": "12345678-9",
          "cargadoPor": "Persona que cargo el rut",
          "equipo": "Equipo 1",
          "incluyeEquifax": true,
          "fechaCarga": "23-11-2024 00:00:00"
        }
      ],
      "Consulta": [
        {
          "rut": "98765432-1",
          "cargadoPor": "Persona que cargo el rut",
          "equipo": "Equipo 2",
          "incluyeEquifax": false,
          "fechaCarga": "23-11-2024 00:00:00"
        }
      ]
    }
  }

  A continuación se describen los campos devueltos en la respuesta JSON.

  Campo	Tipo	Descripción
  success	bool	Indica si la operación fue exitosa.
  data	object	Objeto con el resumen de perfiles y los arrays Monitoreo y Consulta

  Estructura del objeto data:

  Campo	Tipo	Descripción
  total	number	Total de perfiles encontrados.
  Monitoreo	array	Array de registros de monitoreo (puede estar vacío).
  Consulta	array	Array de registros de consulta (puede estar vacío).

  Cada elemento de Monitoreo[] y Consulta[] tiene la siguiente estructura:

  Campo	Tipo	Descripción
  rut	string	RUT asociado al perfil (ej. "12345678-9").
  cargadoPor	string	Usuario o persona que cargó el RUT.
  equipo	string	Equipo o proyecto asociado al RUT.
  incluyeEquifax	boolean	Indica si incluye datos de Equifax.
  fechaCarga	string	Fecha y hora de la carga (ej. "23-11-2024 00:00:00").

  Nota: Algunos campos pueden ser null o estar ausentes según disponibilidad de datos.

  Errores

  400 - Solicitud inválida

  {
    "success": false,
    "code": 400,
    "error": "Solicitud inválida"
  }

  401 - No autorizado

  {
    "success": false,
    "code": 401,
    "error": "No autorizado"
  }

  403 - No tienes permiso para acceder a este recurso

  {
    "success": false,
    "code": 403,
    "error": "No tienes permiso para acceder a este recurso"
  }

  404 - Recurso no encontrado

  {
    "success": false,
    "code": 404,
    "error": "Recurso no encontrado"
  }

  408 - Tiempo de espera agotado

  {
    "success": false,
    "code": 408,
    "error": "Tiempo de espera agotado"
  }

  429 - Demasiadas solicitudes

  {
    "success": false,
    "code": 429,
    "error": "Demasiadas solicitudes"
  }

  500 - Error interno del servidor

  {
    "success": false,
    "code": 500,
    "error": "Error interno del servidor"
  }