Obtener documento

Este endpoint le permite obtener la información completa de un documento.

GET https://api.enviafirma.com/documentos/{id}

Headers

Nombre	Tipo	Descripción
X-Auth-Token*	string	API Key

Params

Nombre	Descripción
id	Id del documento a consultar

Ejemplo de petición

const myHeaders = new Headers();
myHeaders.append("X-Auth-Token", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx");

const idDocumento = "abc21sas-x21s-d4sa-a2s";

const requestOptions = {
  method: "GET",
  headers: myHeaders
};

fetch(`https://api.enviafirma.com/documentos/${idDocumento}`, requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Ejemplo de respuesta - 200

  {
       "id": "7a6e8f5c-4415-4cc9-a0fe-03db889e1607",
       "fechaCreado": "2024-10-22T16:24:22.000Z",
       "fechaCompletado": "2024-10-22T16:27:39.000Z",
       "fechaCancelado": null,
       "estado": "pendiente",
       "hash": "4aab935c-bbb0-4017-ae40-e972c3b367de",
       "nombreDocumento": "Datos del certificado",
       "rutaDocumentoOriginal": "https://firebasestorage.googleapis.com/v0/b/enviafirma/o/12F1018535.pdf",
       "rutaDocumentoFirmado": "https://firebasestorage.googleapis.com/v0/b/enviafirma/o/12F1018535f.pdf",
       "metodoNotificacion": "whatsapp",
       "hashSha256": "fd984bad363e9a30021460091726467b65bb1e88c31752d93c68ade87e4946e4",
       "idiomaNotificaciones": "es",
       "webhook":"https://urlcliente.com",
       "firmantes": [
                      {
                        "nombre": "Jose Orozco",
                        "indicativoCelular": "+57",
                        "numeroCelular": "[phone]",
                        "email": null,
                        "estado": "firmado",
                        "hash": "b610ee6f-2e01-4429-9711-dd0f93f208ab",
                        "fechaCreado": "2024-10-22T16:24:22.000Z",
                        "fechaFirmado": "2024-10-23T16:24:22.000Z",
                        "fechaRechazado": null
                      },
                      {
                        "nombre": "Bernardo Morales",
                        "indicativoCelular": "+34",
                        "numeroCelular": "[phone]",
                        "email": null,
                        "estado": "pendiente",
                        "hash": "e30d0456-a460-4566-8062-3b0add086124",
                        "fechaCreado": "2024-10-22T16:24:22.000Z",
                        "fechaFirmado": null,
                        "fechaRechazado": null
                      }
                    ]
   }

Especificación de datos de respuesta

id	Id del documento
fechaCreado	Fecha en la que se creo el documento
fechaCompletado	Fecha en la que se completo todo el proceso de firma
fechaCancelado	Fecha en la que se cancelo un proceso de firma
estado	Estado del proceso de firma: pendiente: Pendiente de firma por 1 o varios firmantes. firmado: Documento firmado rechazado: Si uno o varios firmantes rechazaron el proceso de firma cancelado: Si el proceso de firma fue cancelado
hash	Identificador hash del documento firmado
nombreDocumento	Titulo del documento enviado a firmar
rutaDocumentoOriginal	Url que contiene el documento original que se cargo para enviar a firmar
rutaDocumentoFirmado	Url que contiene el documento firmado
metodoNotificacion	Metodo de notificación con el que se envian las notificaciones
hashSha256	Hash de firma electronica generado con el algoritmo Sha256
idiomaNotificaciones	Idioma en el que se envian las notificaciones a los firmantes
firmantes	Arreglo con la lista de firmantes del documento