Saltar al contenido principal

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": {
    "page": 1,
    "totalPages": 1,
    "cantidadConsultas:": 1,
    "cantidadMonitoreos:": 1,
    "casos": [
    {
    "rut": "12345678-9",
    "tipo": "Consulta",
    "cargadoPor": "Persona que cargo el rut",
    "equipo": "Equipo 1",
    "incluyeEquifax": true,
    "fechaCarga": "23-11-2024 00:00:00"
    },
    {
    "rut": "98765432-1",
    "tipo": "Monitoreo",
    "cargadoPor": "Persona que cargo el rut",
    "equipo": "Equipo 2",
    "incluyeEquifax": false,
    "fechaCarga": "23-11-2024 00:00:00"
    }
    ],
    "ultimaActualizacion": "15-06-2024 11:11:11"
    }
    }

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

    CampoTipoDescripción
    successboolIndica si la operación fue exitosa.
    dataobjectObjeto que contiene la información de Perfiles activos.

    Campos dentro de data:

    CampoTipoDescripción
    pagenumberPágina actual de resultados.
    totalPagesnumberCantidad total de páginas disponibles.
    cantidadConsultasnumberNúmero total de casos encontrados de tipo Consultas.
    cantidadMonitoreosnumberNúmero total de casos encontrados de tipo Monitoreos.
    casosarrayLista de objetos, uno por cada caso registrado en Perfiles activos.
    ultimaActualizacionstringFecha última actualización de información

    Estructura de cada objeto dentro de casos:

    CampoTipoDescripción
    rutstringRUT asociado al perfil (ej. "12345678-9").
    tipostringTipo de perfil: "Consulta" o "Monitoreo".
    cargadoPorstringUsuario o persona que cargó el RUT.
    equipostringEquipo o proyecto asociado al RUT.
    incluyeEquifaxbooleanIndica si incluye datos de Equifax.
    fechaCargastringFecha y hora de la carga (ej. "23-11-2024 00:00:00").

    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"
    }