¿Cómo crear un proceso de firma? v2

Selecciona la versión

EndPoint

Ir a la sección Process > api/v2/Process/create-full

https://demo.firmaseguro.co/api/v2/Process/create-full

Ejecutar el request ProcessCreateFull V2:

💡 Para la versión 2 de la API, se requiere especificar el tipo de saldo (BalanceTypeId) al enviar una solicitud. Debes usar el valor 1 para saldos basados en firmas y 2 para saldos basados en documentos.

Es importante destacar que cuando el tipo de saldo sea 2 (saldo por documentos), como por ejemplo, cuando se utiliza SMS (2) o e-mail (3) como método de autenticación, todos los firmantes deben utilizar el mismo método de autenticación.

Tener en cuenta que el tipo de autenticación por llamada (1) no está habilitado para saldos basados en documentos.

Descripción de parámetros

Parámetro

Descripción

Tipo

Obligatorio

balanceTypeId

Método con tipo de saldo el cual asignará un valor de 1 o 2.

Saldo por firmas: 1
Saldo por documentos: 2

Int

SI

Ejecutar request ProcessCreateFull: Sólo yo

Tipo de proceso “Solo yo”: Saldo por documentos - Único firmante.

{
  "processTypeId": 1,
  "signatureMethodId": 2,
  "isHandWritten": false,
  "isPhotographic": false,
  "deadlineDays": 11,
  "balanceTypeId": 2,
  "signatures": [
    {
      "processId": 0,
      "authenticationMethodId": 3,
      "contactInformation": {
        "phone": {
          "indicative": "57",
          "number": "3108783885"
        },
        "phoneId": 0,
        "email": "jhon.doe@email.com",
        "personId": 0,
        "person": {
          "firstName": "Jhon",
          "secondName": null,
          "firstLastName": "Doe",
          "secondLastName": null,
          "identification": "1012402467",
          "identificationTypeId": 1,
          "typePersonId": 1
        }
      }
    }
  ],
  "documents": {
    "fileName": "contrato prueba",
    "documentTypeId": 1,
    "base64String": "Reemplazar por un string base64 pdf"
  },
  "callback": "",
  "subjectEmail": "Prueba demo mi primera firma",
  "messageEmail": "primera firma desde la api firmaseguro",
  "copyEmails": "juan.perez@email.com, nina.tul@email.com"
}

Nota importante: En el tipo de proceso “Solo yo”, la persona que firma debe ser la misma que está autenticada en la API. Al seleccionar el tipo de saldo por documentos como "Email", todos los firmantes deben utilizar el mismo método de autenticación, que en este ejemplo es el correo electrónico.

Ejecutar request ProcessCreateFull: Otros y yo

Tipo de proceso “Otros y yo” - Saldo por documentos: Mínimo 2 firmantes, máximo 10

{
  "processTypeId": 2,
  "signatureMethodId": 1,
  "isHandWritten": false,
  "isPhotographic": false,
  "deadlineDays": 23,
  "balanceTypeId": 2,
  "signatures": [
    {
      "processId": 0,
      "authenticationMethodId": 2,
      "contactInformation": {
        "phone": {
          "indicative": "57",
          "number": "3108783885"
        },
        "phoneId": 0,
        "email": "jhon.doe@email.com",
        "personId": 0,
        "person": {
          "firstName": "Jhon",
          "secondName": null,
          "firstLastName": "Doe",
          "secondLastName": null,
          "identification": "1012402467",
          "identificationTypeId": 1,
          "typePersonId": 1
        }
      }
    },
    {
      "processId": 0,
      "authenticationMethodId": 2,
      "contactInformation": {
        "phone": {
          "indicative": "57",
          "number": "3114567894"
        },
        "phoneId": 0,
        "email": "juan.perez@email.com",
        "personId": 0,
        "person": {
          "firstName": "Juan",
          "secondName": "Manuel",
          "firstLastName": "Perez",
          "secondLastName": "Ortiz",
          "identification": "45784415",
          "identificationTypeId": 1,
          "typePersonId": 1
        }
      }
    }
  ],
  "documents": {
    "fileName": "contrato prueba",
    "documentTypeId": 1,
    "base64String": "Reemplazar por un string base64 pdf"
  },
  "callback": "",
  "subjectEmail": "Prueba demo mi primera firma",
  "messageEmail": "primera firma desde la api firmaseguro",
  "copyEmails": ""
}

Nota importante: En el tipo de proceso “Otros y yo”, la persona que firma y desempeña el papel de “yo”, debe ser la misma que está autenticada en la API. Esto garantiza la seguridad y la integridad del proceso. Al seleccionar el tipo de saldo por documentos como "SMS", todos los firmantes deben utilizar el mismo método de autenticación.

Ejecutar request ProcessCreateFull: Sólo otros

Tipo de proceso “Solo Otros”- Saldo por documentos: Mínimo 1 firmante, máximo 10

{
  "processTypeId": 3,
  "signatureMethodId": 2,
  "isHandWritten": false,
  "isPhotographic": false,
  "balanceTypeId": 2,
  "deadlineDays": 5,
  "signatures": [
    {
      "processId": 0,
      "authenticationMethodId": 2,
      "contactInformation": {
        "phone": {
          "indicative": "57",
          "number": "3108783885"
        },
        "phoneId": 0,
        "email": "jhon.doe@email.com",
        "personId": 0,
        "person": {
          "firstName": "Jhon",
          "secondName": null,
          "firstLastName": "Doe",
          "secondLastName": null,
          "identification": "1012402467",
          "identificationTypeId": 1,
          "typePersonId": 1
        }
      }
    }
  ],
  "documents": {
    "fileName": "contrato prueba",
    "documentTypeId": 1,
    "base64String": "Reemplazar por un string base64 pdf"
  },
  "callback": "",
  "subjectEmail": "Prueba demo mi primera firma",
  "messageEmail": "primera firma desde la api firmaseguro",
  "copyEmails": "juan.perez@email.com, nina.tul@email.com"
}

Nota importante: En el tipo de proceso “Sólo otros”, las personas que firman son otras personas distintas de la persona que está autenticada. Al seleccionar el tipo de saldo por documentos como "SMS", todos los firmantes deben utilizar el mismo método de autenticación.