Archivar un documento

Archivar un documento lo saca de tus listados habituales para mantener ordenada tu carpeta de trabajo, sin borrarlo ni afectar su validez. Es útil para documentos ya concluidos que no quieres seguir viendo en el día a día.

Método: PATCH https://api.digitafirma.com/v1/documents/{uuid}/archive

Path Parameters

Campo	Tipo	Descripción
`uuid`	`string`	ID del documento que quieres archivar o desarchivar.

Este endpoint no recibe cuerpo (body).

Qué cambia al archivar

Sale de tus listados

El documento deja de aparecer en el listado de documentos de la carpeta (GET /v1/documents) y en el de invitaciones (GET /v1/documents/invited). A partir de ese momento aparece en el de archivados (GET /v1/documents/archived).

Sigue accesible por su ID

Puedes seguir consultándolo y descargando sus archivos con su uuid, igual que antes de archivarlo.

No detiene la firma

Archivar no cancela el proceso: si quedan firmantes pendientes, pueden seguir firmando con su enlace y se les siguen enviando recordatorios.

Quién puede archivarlo

Cualquier usuario que pertenezca a la carpeta de trabajo del documento. Los documentos que viven dentro de un contenedor no se archivan con este endpoint.

Ejemplo de integración

curl --location --request PATCH 'https://api.digitafirma.com/v1/documents/{uuid}/archive' \
--header 'X-Api-Key: {X-API-KEY}'

Regresa el documento con la misma estructura que Mostrar un documento. En esta respuesta isOwner siempre viene en null.

{
  "data": [
    {
      "type": "documents",
      "id": "ac110005-9df4-1d1b-819d-f60440bc003c",
      "links": {
        "self": "/documents/ac110005-9df4-1d1b-819d-f60440bc003c"
      },
      "attributes": {
        "original_hash": "D3F7B9D9EB5783B8B12A704BEF67C76F44CA4097183FDC4A9BC80CA4D13111A8",
        "file_name": "contrato-servicios.pdf",
        "sign_status": 3,
        "signed": true,
        "signature_mode": "PDF_SIGNATURE",
        "signature_ordered": "INACTIVE",
        "owner": "Juan Pérez <juan.perez@ejemplo.com>",
        "isOwner": null,
        "rejected_message": null,
        "tries": 3,
        "remember_at": "12:30:00",
        "remember_every": 3,
        "signed_at": "2026-05-06T10:15:32.481920",
        "created_at": "2026-05-04T20:42:47.172839",
        "redirect_url": null,
        "config": {
          "primary_color": null,
          "secondary_color": null,
          "identity_providers": ["VERIFICAMEX"],
          "lock_phone_for_otp": false,
          "allow_type_signatures": ["VERIFICAMEX"]
        },
        "notification_mode": "ENABLED",
        "createdBy": null
      },
      "relationships": {
        "signatories": {
          "data": [
            {
              "type": "signatures",
              "id": "ac110005-9df4-1d1b-819d-f60440c7003d",
              "links": {
                "self": "/signatures/ac110005-9df4-1d1b-819d-f60440c7003d"
              },
              "attributes": {
                "name": "María López",
                "email": "maria.lopez@ejemplo.com",
                "sign_status": "SIGNED"
              }
            }
          ],
          "links": {
            "self": "/signatures"
          }
        },
        "constancy": null
      }
    }
  ],
  "links": {
    "self": "/documents"
  }
}

{
  "errors": [
    {
      "status": 400,
      "title": "Domain Error",
      "detail": "El documento no fue encontrado"
    }
  ]
}

Errores comunes

Código	Mensaje	Causa
400	`El documento no fue encontrado`	El `uuid` no existe, tu usuario no pertenece a la carpeta de trabajo del documento, o el documento está dentro de un contenedor.
401	—	Falta la `X-Api-Key` o no es válida.