Saltar a contenido

Referencia

  • https://api.csfacturacion.com/buzon-imss

API REST application/json

Credenciales de contratación vigente mediante Http Basic

Opinión de Cumplimiento del IMSS

Obtener la Opinión de Cumplimiento del IMSS a partir del certificado digital del contribuyente.

/opinion Obtiene la Opinión de Cumplimiento del IMSS

Petición

Tipo

application/json

Cuerpo

Campo Descripción Tipo
certificado* Archivo .cer del CSD o FIEL del contribuyente, codificado en Base64 estricto String
Ejemplo Basic Auth
POST /opinion HTTP/1.1
Authorization: Basic QUFBMDEwMTAxQUFBOkllaGVlKnRoMjAzNg==
Host: api.csfacturacion.com
Content-Type: application/json
Content-Length: 150

{
    "certificado": "MIIGpDCCBA2gAwIBAgIUE/+39bXbKzAgvupXIVZ..."
}

Response

200 OK

application/json

Ejemplo
{
    "documento": "JVBERi0xLjcKCjEgMCBvYmo...",
    "sentido": "POSITIVO",
    "no_empleados": 42
}
Campo Tipo Descripción
documento string Carta de opinión en Base64 (PDF)
sentido string Resultado: POSITIVO o NEGATIVO
no_empleados integer Número de trabajadores registrados en el IMSS
401 Credenciales Inválidas

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "Credenciales de autenticación ausentes o inválidas"
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.
403 Acceso Prohibido

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "Sin contratación válida o sin transacciones disponibles"
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.
422 Datos Inválidos

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "certificado vacío, no es Base64 válido, o el RFC no coincide"
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.
500 Error del Servidor

Tipo

application/json

Cuerpo

Ejemplo
{
    "error": {
        "message": "Servicio del IMSS o CsAuth no disponible"
    }
}

Schema

  • error: Objeto JSON
    Representa un error en la petición HTTP.
  • message: String
    Resumen/descripción del error
  • details: Objeto JSON
    Representa los detalles del error. Aplica para código 422
  • message: String
    Indica por que el campo es erróneo.
    • field: String
      El campo con dato erróneo.

Campos de Respuesta

Campo Tipo Descripción
documento string Carta de opinión en formato PDF, codificada en Base64
sentido string Sentido de la opinión: POSITIVO (cumple) o NEGATIVO (incumple)
no_empleados integer Número total de trabajadores registrados en el IMSS según el padrón