DEHU

DEHU

Conecta tus aplicaciones con funciones DEHU.

Parámetros en la cabecera HTTP

  • Authorization (caracteres): Autorización de la API. Ejemplo: Bearer {token}
  • X-Cert-Secret (caracteres) : Clave secreta asociada al certificado del cliente.

URL base

https://api.saltra.es/api/v4/dehu

Errores

Los errores recibidos en la API del DEHU o errores de validación.

  • success (booleano) : La respuesta "true" cuando todo esta correcto, y "false" cuando hay errores.
  • message (caracteres) : El mensaje de la respuesta.
  • errors (arreglo) : Los errores capturados en la API, ya sea del DEHU o errores de validación.
    • dehu: Errores relacionados con el DEHU.
    • regimen: Errores de validación.
  • maintenance (booleano) : Cuando el DEHU se encuentra en mantenimiento.

Respuesta

Respuesta
{
  "success": false,
  "message": "Página no operativa, inténtelo de nuevo más tarde. StatusCode: 500",
  "status": 500,
  "data": [],
  "errors": {
    "dehu": [
      "Página no operativa, inténtelo de nuevo más tarde. StatusCode: 500"
    ]
  },
  "maintenance": true
}

Limitaciones

Está limitada a 60 peticiones por minuto por usuario en Saltra. Saltra incluye en los headers de respuesta los valores X-Ratelimit-Limit y X-Ratelimit-Remaining.

  • X-Ratelimit-Limit (número entero): Número máximo de peticiones permitidas por minuto. Para usuarios autenticados, el límite se aplica por usuario y ruta; para no autenticados, por IP.
  • X-Ratelimit-Remaining (número entero): Peticiones que aún puedes realizar dentro de la ventana de un minuto antes de alcanzar el límite.

Obtener estadísticas

GET /notification-stats
{}

Respuesta

Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "totalNotReadCommunications": "29",
    "totalPendingNotifications": "78",
    "newDeviceForPushNotify": "0",
    "userHasUnverifiedEmail": "0",
    "userHasNotContact": "0"
  }
}

Buscar estado de notificación

Parámetros (filtros)

  • id (número entero) : campo "identifier" de la notificación.
GET /notification-finder
{
  "id": "N259998999"
}

Respuesta

Respuesta
{
  "success": true,
  "message": "OK",
  "status": 200,
  "data": [
    {
      "type": "notifications/pending",
      "emitterSourceEntity": "Ministerio de Inclusión, Seguridad Social y Migraciones",
      "sentReference": "446dee88a09c99995754f4d68dc7weq3ea3c909873991",
      "state": "PENDIENTE"
    }
  ]
}

Notificaciones Pendientes

Parámetros

  • page (número entero) : Número de página actual, por defecto es 1.
  • limit (número entero) : Registros por petición, opcional; por defecto y como límite 50 registros.
  • titularNif (caracteres) : NIF del titular, opcional.
  • startDate: Fecha de inicio en formato Y-m-d, opcional.
  • endDate: Fecha de fin en formato Y-m-d, opcional.
GET /notifications-pending
{
  "page": 1,
  "startDate": "2025-01-01",
  "endDate": "2025-01-02"
}

Respuesta

  • sentReference: Identificador de la notificación.
Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "count": 50,
    "total": 51,
    "limit": 50,
    "page": 1,
    "items": [
      {
        "emitterEntity": "Tesoreria General de la Seguridad Social",
        "emitterSourceEntity": "Ministerio de Inclusión, Seguridad Social y Migraciones",
        "nifTitular": "B19994999",
        "sentReference": "446dee88a09c99995754f4d68dc7weq3ea3c909873991",
        "identifier": "N259998999",
        "concept": "REGIMENES SEG. SOCIAL OBLIGADOS A RED / 2101V0999999990999 / PROVIDENCIA DE APREMIO",
        "description": null,
        "postalDelivery": false,
        "availabilityDate": "2025-10-05T00:03:49+02:00",
        "expirationDate": "2025-10-16T23:59:59+02:00",
        "finalDate": null,
        "bondType": "DESTINATARIO",
        "notificationPriority": "NORMAL",
        "unsynchronizedAppearance": null,
        "assuranceLevel": "low"
      }
    ]
  }
}

Notificaciones Realizadas

Parámetros

  • page (número entero) : Número de página actual, por defecto es 1.
  • limit (número entero) : Registros por petición, opcional; por defecto y como límite 50 registros.
  • titularNif (caracteres) : NIF del titular, opcional.
  • startDate: Fecha de inicio en formato Y-m-d, opcional.
  • endDate: Fecha de fin en formato Y-m-d, opcional.
GET /notifications-done
{
  "page": 1,
  "startDate": "2025-01-01",
  "endDate": "2025-01-02"
}

Respuesta

  • sentReference: Identificador de la notificación.
Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "count": 50,
    "total": 51,
    "limit": 50,
    "page": 1,
    "items": [
      {
        "emitterEntity": "Tesoreria General de la Seguridad Social",
        "emitterSourceEntity": "Ministerio de Inclusión, Seguridad Social y Migraciones",
        "vinculoReceptor": "TITULAR",
        "nifTitular": "B21999999",
        "sentReference": "446dee88a09c99995754f4d68dc7weq3ea3c909873991",
        "state": "ACEPTADA",
        "identifier": "N259993999",
        "concept": "REGIMENES SEG. SOCIAL OBLIGADOS A RED / 2190A4525099999999 / RESOLUCION ALTAS/BAJAS (RED)",
        "postalDelivery": false,
        "availabilityDate": "2025-10-10T01:28:53+02:00",
        "expirationDate": "2025-10-21T23:59:59+02:00",
        "finalDate": "2025-10-10T08:26:02+02:00",
        "bondType": "DESTINATARIO",
        "hasAnnexes": false,
        "notificationPriority": "NORMAL",
        "assuranceLevel": "low"
      }
    ]
  }
}

Comunicaciones

Parámetros (filtros)

  • page (número entero) : Número de página actual, por defecto es 1.
  • limit (número entero) : Registros por petición, opcional; por defecto y como límite 50 registros.
  • titularNif (caracteres) : NIF del titular, opcional.
  • startDate: Fecha de inicio en formato Y-m-d, opcional.
  • endDate: Fecha de fin en formato Y-m-d, opcional.
GET /communications
{
  "page": 1,
  "startDate": "2025-01-01",
  "endDate": "2025-01-02"
}

Respuesta

  • sentReference: Identificador de la notificación.
Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "count": 50,
    "total": 51,
    "limit": 50,
    "page": 1,
    "items": [
      {
        "emitterEntity": "Tesoreria General de la Seguridad Social",
        "emitterSourceEntity": "Ministerio de Inclusión, Seguridad Social y Migraciones",
        "vinculoReceptor": "",
        "nifTitular": "99936799A",
        "sentReference": "446dee88a09c99995754f4d68dc7weq3ea3c909873991",
        "state": "PENDIENTE",
        "identifier": "C59999999",
        "concept": "REGIMENES SEG. SOCIAL OBLIGADOS A RED / 2101D2999942419999 / COMUNICACIÓN CON DESTINO NACIONAL",
        "postalDelivery": false,
        "availabilityDate": "2025-10-09T00:02:48+02:00",
        "finalDate": null,
        "document": [],
        "bondType": "DESTINATARIO",
        "hasAnnexes": false
      }
    ]
  }
}

Obtener detalle de una notificación realizada

Parámetros (filtros)

  • id (caracteres) : Identificador de la notificación (sentReference).
  • duplicate (número) : Opcional. obtiene el "content" del document en base64 si lo tiene.
  • voucher (número) : Opcional. obtiene el "content" del resguardo en base64 si lo tiene.
GET /notification-done
{
  "id": "446dee88a09c99995754f4d68dc7weq3ea3c909873991"
}

Respuesta

Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "emitterEntity": "Tesoreria General de la Seguridad Social",
    "emitterSourceEntity": "Ministerio de Inclusión, Seguridad Social y Migraciones",
    "nifReceptor": "99999962X",
    "nameReceptor": "JOSE JUAN PEREZ",
    "receiver": {
      "nif": "99999962X",
      "name": "JOSE JUAN PEREZ",
      "dir3Code": null,
      "direCode": null
    },
    "nifTitular": "B99999999",
    "dir3Code": null,
    "direCode": null,
    "cantAnnexes": 0,
    "sentReference": "446dee88a09c99995754f4d68dc7weq3ea3c909873991",
    "state": "ACEPTADA",
    "identifier": "N999609999",
    "concept": "REGIMENES SEG. SOCIAL OBLIGADOS A RED / 99999999904 / RECLAMACIÓN DE DEUDA",
    "description": null,
    "availabilityDate": "2025-10-01T01:37:22+02:00",
    "expirationDate": "2025-10-12T23:59:59+02:00",
    "finalDate": "2025-10-01T10:29:32+02:00",
    "document": {
      "publicMetadata": null,
      "privateMetadata": null,
      "documentLink": null,
      "name": "SINT_FGDE_999999999.pdf",
      "mimeType": "application/pdf",
      "content": null
    },
    "bondType": "DESTINATARIO",
    "unsuccessfulState": null,
    "hasAnnexes": false,
    "siaCode": "2997999",
    "siaDenomination": "NOTIFICACIONES ELECTRÓNICAS TGSS",
    "voucher": {
      "mimeType": "application/pdf",
      "name": "Resguardo_xxx.pdf",
      "enabled": true,
      "content": null
    }
  }
}

Obtener duplicado de una notificación

Parámetros (filtros)

  • id (caracteres) : Identificador de la notificación (sentReference).
GET /notification-document
{
  "id": "446dee88a09c99995754f4d68dc7weq3ea3c909873991"
}

Respuesta

Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "content": "base64",
    "name": "SINT_FGDE_999999999.pdf",
    "mimeType": "application/pdf",
    "contentType": "application/pdf",
    "privateMetadata": null
  }
}

Obtener resguardo de una notificación

Parámetros (filtros)

  • id (caracteres) : Identificador de la notificación (sentReference).
GET /notification-voucher
{
  "id": "446dee88a09c99995754f4d68dc7weq3ea3c909873991"
}

Respuesta

Respuesta
{
  "success": true,
  "message": "OK",
  "data": {
    "content": "base64",
    "name": "Resguardo_1xxbbb9x.pdf",
    "mimeType": "application/pdf",
    "contentType": "application/pdf",
    "enabled": true
  }
}