Saltar al contenido principal

Estado Carpeta Tributaria

Este endpoint permite consultar el estado del procesamiento de la Carpeta Tributaria más reciente asociada a un RUT, cargada previamente mediante Cargar Carpeta Tributaria.

  • Devuelve el estado de la Carpeta Tributaria más reciente del RUT.
  • Está pensado para consultarse de forma periódica (polling) después de la carga, hasta que el estado sea SUCCEEDED o FAILED.
  • Como alternativa al polling, puedes recibir el resultado automáticamente vía webhook (processTaxFolder); consulta Cargar Carpeta Tributaria.

Detalle de API​

Request​

  • URL: /helper/carpetaTributaria/{rut}/estado
  • Método: GET

Parámetros​

  • rut (requerido, path): El RUT del cual se desea consultar el estado de la Carpeta Tributaria. Formato del rut "12345678-9".

Ejemplo request con curl​

curl -X 'GET' \
  'https://prod.api.thesheriff.cl/api/clients/v2/helper/carpetaTributaria/12345678-9/estado' \
  -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": "SUCCEEDED"
    }

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

    CampoTipoDescripción
    successboolIndica si la operación fue exitosa.
    datastringEstado del procesamiento de la Carpeta Tributaria más reciente del RUT.

    El campo data puede tomar uno de los siguientes valores:

    ValorDescripción
    IN PROGRESSLa Carpeta Tributaria aún se está procesando.
    SUCCEEDEDEl procesamiento finalizó correctamente; el resultado estructurado ya está disponible.
    FAILEDEl procesamiento de la Carpeta Tributaria falló.
    Tiempo de espera

    La consulta incorpora un timeout: si una Carpeta Tributaria permanece demasiado tiempo en IN PROGRESS, al consultar su estado se marca automáticamente como FAILED.

    tip

    Cuando el estado sea SUCCEEDED, obtén los datos con Resultado Carpeta Tributaria.

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