Parámetro

Descripción

Tipo

Obligatoriedad

Ejemplo

processTypeId

Tipo de proceso a crear. Puede ser:

• 1 (Solo Yo)

• 2 (Otros y Yo)

• 3 (Solo Otros)

Int

SI

3

signatureMethodId

Método de firma con el cual se creará el proceso.

• 1 Firma electrónica simple.

• 2 Firma electrónica certificada.

Int

SI

2

balanceTypeId

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

• 1 Saldo por firmas

• 2 Saldo por documentos

[Verifique la Versión usada, según se explica en el punto 2.1.3]

Int

SI

1

deadlineDays

Plazo máximo en días para que todos los signatarios firmen el documento asociado al proceso.

Int

SI

30

isInOrder

Parámetro que permite que el proceso sea por orden de firmantes predefinido. Valores:

• True, el proceso tendrá orden de firmantes.

• False, el proceso no tendrá orden de firmantes.

Boolean

No

True

templateId

Parámetro que permite indicar el número del ID del template de documento que se desea asignar al proceso de firma. (Este valor lo entregara el Usuario Administrador)

Int

No

null

isRead

Parámetro que identifica si se  configurará una obligatoriedad de lectura al PDF para poder ser firmado. Valores:

• True, con obligatoriedad de lectura

• False, sin obligatoriedad de lectura.

Boolean

SI

True

isSendByEmail

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por correo electrónico. Valores:

• True, SI se envía la notificación por correo electrónico

• False, NO se envía la notificación por correo electrónico

Boolean

SI

True

isSendByWhatsApp

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por WhatsApp. Valores:

• True, SI se envía la notificación por WhatsApp

• False, NO se envía la notificación por WhatsApp

Boolean

Si

True

language

Parámetro que permite agregar el idioma en que se maneja del firma manuscrita. Valores:

• en, Inglés

• es, Español.

No es obligatorio, por defecto lo toma como español

String

Si

es

isHandWritten

Parámetro que permite agregar firma manuscrita. Valores:

• True, proceso tendrá firma manuscrita

• False, el proceso no tendrá firma manuscrita.

Boolean

No

True

isPhotographic

Parámetro que permite agregar firma fotográfica. Valores:

• True, el proceso tendrá firma fotográfica.

• False, el proceso no tendrá firma fotográfica.

Boolean

No

True

signatures[]

Este array determina el listado de firmantes vinculados al proceso, sujeto al tipo de proceso. Acepta máximo 10 firmantes por proceso

order

(parámetro del array signatures) El orden de cada firmante en el proceso

Int

Si el valor isOrden = True

1

rol

(parámetro del array signatures)  Determina el rol  que se le asigna al Firmante.El parámetro es obligatorio si se le asigna una plantilla al proceso de firma.

String

Si

Empleado

processId

(parámetro del array signatures) Debe tener como valor 0.

Int

No

0

authenticationMethodId

(parámetro del array signatures) Método de autenticación OTP (One-Time Password) con el cual el firmante validará su proceso de firma.

• 1 OTP Llamada.

• 2 OTP SMS.

• 3 OTP Email.

• 4 OTP Whatsapp.

Int

SI

3

contactInformation{}

(objeto del array signatures) Objeto que contiene la información de contacto del firmante asociado al proceso a crear.

-

SI

-

phone{}

(objeto de contactInformation) Objeto que contiene la información del número de celular asociado al firmante.

-

SI

-

indicative

(parámetro del objeto phone) Indicativo de país asociado al número de celular del firmante. Ejemplo para Colombia: 57.

String

SI

57

number

(parámetro del objeto phone) Número celular del firmante. Máximo de caracteres para Colombia: 10. Máximo de caracteres para números extranjeros: 20.

String

SI

3188273865

email

(parámetro de contactInformation) Correo electrónico del firmante. Máximo: 100 caracteres.

String

SI

empresa.firma@empresa.com

person{}

(objeto de contactInformation) Objeto que contiene información básica asociada al firmante.

-

SI

-

firstName

(parámetro del objeto person) Primer nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Pablo

secondName

(parámetro del objeto person) Segundo nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres. (En caso de no enviarlo, su valor debe ser null.)

String

NO

Sebastian

firstLastName

(parámetro del objeto person) Primer apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Parra

secondLastName

(parámetro del objeto person) Segundo apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres. (En caso de no enviarlo, su valor debe ser null.)

String

NO

Manrique

identification

(parámetro del objeto person) Número de identificación del firmante. Mínimo: 5 caracteres (Cédula de Ciudadanía) o Máximo: 12 caracteres (Cédula Extranjera).

String

SI

1018444520

identificationTypeId

(parámetro del objeto person) Tipo de identificación del firmante.

• 1 Cédula de Ciudadanía.

• 2 Cédula Extranjera.

• 3,NUI

• 4,NIT

• 5,Pasaporte

• 6,Permiso por protección temporal

Int

SI

1

typePersonId

(parámetro del objeto person) Tipo de persona del firmante.

• 1 Persona Natural.

• 2 Persona Jurídica.

Int

SI

1

signatory_type

(objeto del array signatures) Tipo de firmante o Rol que se representa en la evidencia digital para cada firmante. 

String

No

Empleado

documents[]

Objeto que contiene la información del documento a firmar.

-

SI

-

filename

(parámetro del objeto documents) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Contrato de Trabajo

documentTypeId

(parámetro del objeto documents) 

• 1, Contrato

• 2,  Arrendamiento

• 3, Sarlaft

Int

SI

1

base64String

(parámetro del objeto documents) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

callback

URL donde se debe enviar el documento cuando el proceso se termine exitosamente. Este parámetro hace referencia a la estrategia callback mencionada en la sección 5.2

String

NO

Ver ejemplo en sección 5.2

subjectEmail

Asunto que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, el asunto por defecto es "solicitud de firma.") Máximo: 150 caracteres.

String

NO

Solicitud de Firma

messageEmail

Mensaje que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, no hay un mensaje por defecto.) Máximo: 500 caracteres.

String

NO

Por favor firmar este documento

copyEmails

Listado separado por comas de los correos electrónicos a los cuales se enviará una copia del documento una vez firmado por todos los involucrados. (No se incluyen correos asociados a los firmantes.) Máximo string: 255 caracteres. Máximo de correos electrónicos permitidos: 10.

String

NO

empresa.operaciones@empresa.com,empresa.contabilida@empresa.com

documentsOnlyRead []

Objeto que contiene  un documento que se le podría añadir a la notificación por correo electrónico cuando  el proceso haya sido montado en la APP

-

No

-

fileName

(parámetro del objeto documentsOnlyRead) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Carta de instrucciones

base64String

(parámetro del objeto documentsOnlyRead) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

Parámetro

Descripción

Tipo

Obligatoriedad

Ejemplo

processTypeId

Tipo de proceso a crear. Puede ser:

• 1 (Solo Yo)

• 2 (Otros y Yo)

• 3 (Solo Otros)

Int

SI

3

signatureMethodId

Método de firma con el cual se creará el proceso.

• 1 Firma electrónica simple.

• 2 Firma electrónica certificada.

Int

SI

2

balanceTypeId

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

• 1 Saldo por firmas

• 2 Saldo por documentos

[Verifique la Versión usada, según se explica en el punto 2.1.3]

Int

SI

1

deadlineDays

Plazo máximo en días para que todos los signatarios firmen el documento asociado al proceso.

Int

SI

30

isInOrder

Parámetro que permite que el proceso sea por orden de firmantes predefinido. Valores:

• True, el proceso tendrá orden de firmantes.

• False, el proceso no tendrá orden de firmantes.

Boolean

No

True

templateId

Parámetro que permite indicar el número del ID del template de documento que se desea asignar al proceso de firma. (Este valor lo entregara el Usuario Administrador)

Int

No

null

schema [] name

Marca el inicio de una sección en la solicitud, diseñada para definir la posición de cada firma en el documento. Este bloque de parámetros se puede repetir tantas veces como sea necesario para incluir múltiples roles de firma, lo cual permite especificar la ubicación y atributos de cada una. Recomendamos que nombre de manera diferente cada rol de firma (Empleado,Empleador) o use una secuencia de números para nombrar el inicio del bloque (EJ: additionalProp1, additionalProp2, additionalProp3 …)

Empleado

type

(parámetro del array schema) Define el tipo de contenido para el parámetro. por defecto coloque “signature”

String

Si

signature

backgroundColor 

(parámetro del array schema) Este parámetro especifica el color de fondo . Puede utilizar un valor hexadecimal para personalizar el fondo de la firma o elemento.

String

No

#958b8b

x

(parámetro del array schema) Representa la posición horizontal en el eje X, siendo 0 la posición inicial

String

Si

78.88

y

(parámetro del array schema) Representa la posición vertical en el eje Y, siendo 0 la posición inicial.

String

Si

78.77

width

(parámetro del array schema) Define el ancho del elemento, en píxeles, para ajustar el espacio ocupado en el documento.

String

Si

40

heigth

(parámetro del array schema) Define la altura del elemento, en píxeles, para especificar el espacio vertical ocupado.

String

Si

60

value

Debe colocar el nombre del Rol del firmante. Colocar el mismo dato que aparezca en schema [] name.

String

Si

Empleador

isRead

Parámetro que identifica si se  configurará una obligatoriedad de lectura al PDF para poder ser firmado. Valores:

• True, con obligatoriedad de lectura

• False, sin obligatoriedad de lectura.

Boolean

SI

True

isSendByEmail

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por correo electrónico. Valores:

• True, SI se envía la notificación por correo electrónico

• False, NO se envía la notificación por correo electrónico

Boolean

SI

True

isSendByWhatsApp

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por WhatsApp. Valores:

• True, SI se envía la notificación por WhatsApp

• False, NO se envía la notificación por WhatsApp

Boolean

Si

True

language

Parámetro que permite agregar el idioma en que se maneja del firma manuscrita. Valores:

• en, Inglés

• es, Español.

No es obligatorio, por defecto lo toma como español

String

Si

es

isHandWritten

Parámetro que permite agregar firma manuscrita. Valores:

• True, proceso tendrá firma manuscrita

• False, el proceso no tendrá firma manuscrita.

Boolean

No

True

isPhotographic

Parámetro que permite agregar firma fotográfica. Valores:

• True, el proceso tendrá firma fotográfica.

• False, el proceso no tendrá firma fotográfica.

Boolean

No

True

signatures[]

Este array determina el listado de firmantes vinculados al proceso, sujeto al tipo de proceso. Acepta máximo 10 firmantes por proceso

order

(parámetro del array signatures) El orden de cada firmante en el proceso

Int

Si el valor isOrden = True

1

rol

(parámetro del array signatures)  Determina el rol  que se le asigna al Firmante.El parámetro es obligatorio si se le asigna una plantilla al proceso de firma.

String

Si

Empleado

processId

(parámetro del array signatures) Debe tener como valor 0.

Int

No

0

authenticationMethodId

(parámetro del array signatures) Método de autenticación OTP (One-Time Password) con el cual el firmante validará su proceso de firma.

• 1 OTP Llamada.

• 2 OTP SMS.

• 3 OTP Email.

• 4 OTP Whatsapp.

Int

SI

3

contactInformation{}

(objeto del array signatures) Objeto que contiene la información de contacto del firmante asociado al proceso a crear.

-

SI

-

phone{}

(objeto de contactInformation) Objeto que contiene la información del número de celular asociado al firmante.

-

SI

-

indicative

(parámetro del objeto phone) Indicativo de país asociado al número de celular del firmante. Ejemplo para Colombia: 57.

String

SI

57

number

(parámetro del objeto phone) Número celular del firmante. Máximo de caracteres para Colombia: 10. Máximo de caracteres para números extranjeros: 20.

String

SI

3188273865

email

(parámetro de contactInformation) Correo electrónico del firmante. Máximo: 100 caracteres.

String

SI

empresa.firma@empresa.com

person{}

(objeto de contactInformation) Objeto que contiene información básica asociada al firmante.

-

SI

-

firstName

(parámetro del objeto person) Primer nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Pablo

secondName

(parámetro del objeto person) Segundo nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres. (En caso de no enviarlo, su valor debe ser null.)

String

NO

Sebastian

firstLastName

(parámetro del objeto person) Primer apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Parra

secondLastName

(parámetro del objeto person) Segundo apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres. (En caso de no enviarlo, su valor debe ser null.)

String

NO

Manrique

identification

(parámetro del objeto person) Número de identificación del firmante. Mínimo: 5 caracteres (Cédula de Ciudadanía) o Máximo: 12 caracteres (Cédula Extranjera).

String

SI

1018444520

identificationTypeId

(parámetro del objeto person) Tipo de identificación del firmante.

• 1 Cédula de Ciudadanía.

• 2 Cédula Extranjera.

• 3,NUI

• 4,NIT

• 5,Pasaporte

• 6,Permiso por protección temporal

Int

SI

1

typePersonId

(parámetro del objeto person) Tipo de persona del firmante.

• 1 Persona Natural.

• 2 Persona Jurídica.

Int

SI

1

signatory_type

(objeto del array signatures) Tipo de firmante o Rol que se representa en la evidencia digital para cada firmante. 

String

No

Empleado

documents[]

Objeto que contiene la información del documento a firmar.

-

SI

-

filename

(parámetro del objeto documents) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Contrato de Trabajo

documentTypeId

(parámetro del objeto documents) 

• 1, Contrato

• 2,  Arrendamiento

• 3, Sarlaft

Int

SI

1

base64String

(parámetro del objeto documents) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

callback

URL donde se debe enviar el documento cuando el proceso se termine exitosamente. Este parámetro hace referencia a la estrategia callback mencionada en la sección 5.2

String

NO

Ver ejemplo en sección 5.2

subjectEmail

Asunto que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, el asunto por defecto es "solicitud de firma.") Máximo: 150 caracteres.

String

NO

Solicitud de Firma

messageEmail

Mensaje que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, no hay un mensaje por defecto.) Máximo: 500 caracteres.

String

NO

Por favor firmar este documento

copyEmails

Listado separado por comas de los correos electrónicos a los cuales se enviará una copia del documento una vez firmado por todos los involucrados. (No se incluyen correos asociados a los firmantes.) Máximo string: 255 caracteres. Máximo de correos electrónicos permitidos: 10.

String

NO

empresa.operaciones@empresa.com,empresa.contabilida@empresa.com

balanceTypeId

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

• 1 Saldo por firmas

• 2 Saldo por documentos

[Verifique la Versión usada, según se explica en el punto 2.1.3]

Int

SI

0

documentsOnlyRead []

Objeto que contiene  un documento que se le podría añadir a la notificación por correo electrónico cuando  el proceso haya sido montado en la APP

-

No

-

fileName

(parámetro del objeto documentsOnlyRead) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Carta de instrucciones

base64String

(parámetro del objeto documentsOnlyRead) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

Parámetro

Descripción

Tipo

Obligatoriedad

Ejemplo

processTypeId

Tipo de proceso a crear. Puede ser:

• 1 (Solo Yo)

• 2 (Otros y Yo)

• 3 (Solo Otros)

Int

SI

3

signatureMethodId

Método de firma con el cual se creará el proceso.

• 1 Firma electrónica simple.

• 2 Firma electrónica certificada.

Int

SI

2

balanceTypeId

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

• 1 Saldo por firmas

• 2 Saldo por documentos

[Verifique la Versión usada, según se explica en el punto 2.1.3]

Int

SI

1

deadlineDays

Plazo máximo en días para que todos los signatarios firmen el documento asociado al proceso.

Int

SI

30

isInOrder

Parámetro que permite que el proceso sea por orden de firmantes predefinido. Valores:

• True, el proceso tendrá orden de firmantes.

• False, el proceso no tendrá orden de firmantes.

Boolean

No

True

templateId

Parámetro que permite indicar el número del ID del template de documento que se desea asignar al proceso de firma. (Este valor lo entregara el Usuario Administrador)

Int

No

023

isRead

Parámetro que identifica si se  configurará una obligatoriedad de lectura al PDF para poder ser firmado. Valores:

• True, con obligatoriedad de lectura

• False, sin obligatoriedad de lectura.

Boolean

SI

True

isSendByEmail

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por correo electrónico. Valores:

• True, SI se envía la notificación por correo electrónico

• False, NO se envía la notificación por correo electrónico

Boolean

SI

True

isSendByWhatsApp

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por WhatsApp. Valores:

• True, SI se envía la notificación por WhatsApp

• False, NO se envía la notificación por WhatsApp

Boolean

Si

True

language

Parámetro que permite agregar el idioma en que se maneja del firma manuscrita. Valores:

• en, Inglés

• es, Español.

No es obligatorio, por defecto lo toma como español

String

Si

es

isHandWritten

Parámetro que permite agregar firma manuscrita. Valores:

• True, proceso tendrá firma manuscrita

• False, el proceso no tendrá firma manuscrita.

Boolean

No

True

isPhotographic

Parámetro que permite agregar firma fotográfica. Valores:

• True, el proceso tendrá firma fotográfica.

• False, el proceso no tendrá firma fotográfica.

Boolean

No

True

signatures[]

Este array determina el listado de firmantes vinculados al proceso, sujeto al tipo de proceso. Acepta máximo 10 firmantes por proceso

order

(parámetro del array signatures) El orden de cada firmante en el proceso

Int

Si el valor isOrden = True

1

rol

(parámetro del array signatures)  Determina el rol  que se le asigna al Firmante.El parámetro es obligatorio si se le asigna una plantilla al proceso de firma.

String

Si

Empleado

processId

(parámetro del array signatures) Debe tener como valor 0.

Int

No

0

authenticationMethodId

(parámetro del array signatures) Método de autenticación OTP (One-Time Password) con el cual el firmante validará su proceso de firma.

• 1 OTP Llamada.

• 2 OTP SMS.

• 3 OTP Email.

• 4 OTP Whatsapp.

Int

SI

3

contactInformation{}

(objeto del array signatures) Objeto que contiene la información de contacto del firmante asociado al proceso a crear.

-

SI

-

phone{}

(objeto de contactInformation) Objeto que contiene la información del número de celular asociado al firmante.

-

SI

-

indicative

(parámetro del objeto phone) Indicativo de país asociado al número de celular del firmante. Ejemplo para Colombia: 57.

String

SI

57

number

(parámetro del objeto phone) Número celular del firmante. Máximo de caracteres para Colombia: 10. Máximo de caracteres para números extranjeros: 20.

String

SI

3188273865

email

(parámetro de contactInformation) Correo electrónico del firmante. Máximo: 100 caracteres.

String

SI

empresa.firma@empresa.com

person{}

(objeto de contactInformation) Objeto que contiene información básica asociada al firmante.

-

SI

-

firstName

(parámetro del objeto person) Primer nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Pablo

secondName

(parámetro del objeto person) Segundo nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres. (En caso de no enviarlo, su valor debe ser null.)

String

NO

Sebastian

firstLastName

(parámetro del objeto person) Primer apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Parra

secondLastName

(parámetro del objeto person) Segundo apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres. (En caso de no enviarlo, su valor debe ser null.)

String

NO

Manrique

identification

(parámetro del objeto person) Número de identificación del firmante. Mínimo: 5 caracteres (Cédula de Ciudadanía) o Máximo: 12 caracteres (Cédula Extranjera).

String

SI

1018444520

identificationTypeId

(parámetro del objeto person) Tipo de identificación del firmante.

• 1 Cédula de Ciudadanía.

• 2 Cédula Extranjera.

• 3,NUI

• 4,NIT

• 5,Pasaporte

• 6,Permiso por protección temporal

Int

SI

1

typePersonId

(parámetro del objeto person) Tipo de persona del firmante.

• 1 Persona Natural.

• 2 Persona Jurídica.

Int

SI

1

signatory_type

(objeto del array signatures) Tipo de firmante o Rol que se representa en la evidencia digital para cada firmante. 

String

No

Empleado

documents[]

Objeto que contiene la información del documento a firmar.

-

SI

-

filename

(parámetro del objeto documents) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Contrato de Trabajo

documentTypeId

(parámetro del objeto documents) 

• 1, Contrato

• 2,  Arrendamiento

• 3, Sarlaft

Int

SI

null

base64String

(parámetro del objeto documents) String con el documento PDF codificado en base64.

String

SI

null

callback

URL donde se debe enviar el documento cuando el proceso se termine exitosamente. Este parámetro hace referencia a la estrategia callback mencionada en la sección 5.2

String

NO

Ver ejemplo en sección 5.2

subjectEmail

Asunto que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, el asunto por defecto es "solicitud de firma.") Máximo: 150 caracteres.

String

NO

Solicitud de Firma

messageEmail

Mensaje que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, no hay un mensaje por defecto.) Máximo: 500 caracteres.

String

NO

Por favor firmar este documento

copyEmails

Listado separado por comas de los correos electrónicos a los cuales se enviará una copia del documento una vez firmado por todos los involucrados. (No se incluyen correos asociados a los firmantes.) Máximo string: 255 caracteres. Máximo de correos electrónicos permitidos: 10.

String

NO

empresa.operaciones@empresa.com,empresa.contabilida@empresa.com

documentsOnlyRead []

Objeto que contiene  un documento que se le podría añadir a la notificación por correo electrónico cuando  el proceso haya sido montado en la APP

-

No

-

fileName

(parámetro del objeto documentsOnlyRead) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Carta de instrucciones

base64String

(parámetro del objeto documentsOnlyRead) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

Parámetro

Descripción

Tipo

Obligatoriedad

Ejemplo

processTypeId

Tipo de proceso a crear. Puede ser:

• 1 (Solo Yo)

• 2 (Otros y Yo)

• 3 (Solo Otros)

Int

SI

3

signatureMethodId

Método de firma con el cual se creará el proceso.

• 1 Firma electrónica simple.

• 2 Firma electrónica certificada.

Int

SI

2

balanceTypeId

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

• 1 Saldo por firmas

• 2 Saldo por documentos

[Verifique la Versión usada, según se explica en el punto 2.1.3]

Int

SI

1

deadlineDays

Plazo máximo en días para que todos los signatarios firmen el documento asociado al proceso.

Int

SI

30

isInOrder

Parámetro que permite que el proceso sea por orden de firmantes predefinido. Valores:

• True, el proceso tendrá orden de firmantes.

• False, el proceso no tendrá orden de firmantes.

Boolean

No

True

templateId

Parámetro que permite indicar el número del ID del template de documento que se desea asignar al proceso de firma. (Este valor lo entregara el Usuario Administrador)

Int

No

023

Tags []name

En este array podrá relacionar cada “Tag” que haya creado el usuario administrador cuando use una plantilla HTML. Recuerde que esta información debe proporcionarles el usuario administrador, donde le proporcionará el nombre del TAG y el contenido que debe ir en el mismo.

String

Si

{

      "Empleado.Nombre": "Juan Pablo Salazar",

      "Empleador.Nombre": "Ricardo Alfonzo Urrutia",

      "Empleado.Cedula": "1018444596"

    }

isRead

Parámetro que identifica si se  configurará una obligatoriedad de lectura al PDF para poder ser firmado. Valores:

• True, con obligatoriedad de lectura

• False, sin obligatoriedad de lectura.

Boolean

SI

True

isSendByEmail

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por correo electrónico. Valores:

• True, SI se envía la notificación por correo electrónico

• False, NO se envía la notificación por correo electrónico

Boolean

SI

True

isSendByWhatsApp

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por WhatsApp. Valores:

• True, SI se envía la notificación por WhatsApp

• False, NO se envía la notificación por WhatsApp

Boolean

Si

True

language

Parámetro que permite agregar el idioma en que se maneja del firma manuscrita. Valores:

• en, Inglés

• es, Español.

No es obligatorio, por defecto lo toma como español

String

Si

es

isHandWritten

Parámetro que permite agregar firma manuscrita. Valores:

• True, proceso tendrá firma manuscrita

• False, el proceso no tendrá firma manuscrita.

Boolean

No

True

isPhotographic

Parámetro que permite agregar firma fotográfica. Valores:

• True, el proceso tendrá firma fotográfica.

• False, el proceso no tendrá firma fotográfica.

Boolean

No

True

signatures[]

Este array determina el listado de firmantes vinculados al proceso, sujeto al tipo de proceso. Acepta máximo 10 firmantes por proceso

order

(parámetro del array signatures) El orden de cada firmante en el proceso

Int

Si el valor isOrden = True

1

rol

(parámetro del array signatures)  Determina el rol  que se le asigna al Firmante.El parámetro es obligatorio si se le asigna una plantilla al proceso de firma.

String

Si

Empleado

processId

(parámetro del array signatures) Debe tener como valor 0.

Int

No

0

authenticationMethodId

(parámetro del array signatures) Método de autenticación OTP (One-Time Password) con el cual el firmante validará su proceso de firma.

• 1 OTP Llamada.

• 2 OTP SMS.

• 3 OTP Email.

• 4 OTP Whatsapp.

Int

SI

3

contactInformation{}

(objeto del array signatures) Objeto que contiene la información de contacto del firmante asociado al proceso a crear.

-

SI

-

phone{}

(objeto de contactInformation) Objeto que contiene la información del número de celular asociado al firmante.

-

SI

-

indicative

(parámetro del objeto phone) Indicativo de país asociado al número de celular del firmante. Ejemplo para Colombia: 57.

String

SI

57

number

(parámetro del objeto phone) Número celular del firmante. Máximo de caracteres para Colombia: 10. Máximo de caracteres para números extranjeros: 20.

String

SI

3188273865

email

(parámetro de contactInformation) Correo electrónico del firmante. Máximo: 100 caracteres.

String

SI

empresa.firma@empresa.com

person{}

(objeto de contactInformation) Objeto que contiene información básica asociada al firmante.

-

SI

-

firstName

(parámetro del objeto person) Primer nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Pablo

secondName

(parámetro del objeto person) Segundo nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres. (En caso de no enviarlo, su valor debe ser null.)

String

NO

Sebastian

firstLastName

(parámetro del objeto person) Primer apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Parra

secondLastName

(parámetro del objeto person) Segundo apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres. (En caso de no enviarlo, su valor debe ser null.)

String

NO

Manrique

identification

(parámetro del objeto person) Número de identificación del firmante. Mínimo: 5 caracteres (Cédula de Ciudadanía) o Máximo: 12 caracteres (Cédula Extranjera).

String

SI

1018444520

identificationTypeId

(parámetro del objeto person) Tipo de identificación del firmante.

• 1 Cédula de Ciudadanía.

• 2 Cédula Extranjera.

• 3,NUI

• 4,NIT

• 5,Pasaporte

• 6,Permiso por protección temporal

Int

SI

1

typePersonId

(parámetro del objeto person) Tipo de persona del firmante.

• 1 Persona Natural.

• 2 Persona Jurídica.

Int

SI

1

signatory_type

(objeto del array signatures) Tipo de firmante o Rol que se representa en la evidencia digital para cada firmante. 

String

No

Empleado

documents[]

Objeto que contiene la información del documento a firmar.

-

SI

-

filename

(parámetro del objeto documents) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Contrato de Trabajo

documentTypeId

(parámetro del objeto documents) 

• 1, Contrato

• 2,  Arrendamiento

• 3, Sarlaft

Int

SI

null

base64String

(parámetro del objeto documents) String con el documento PDF codificado en base64.

String

SI

null

callback

URL donde se debe enviar el documento cuando el proceso se termine exitosamente. Este parámetro hace referencia a la estrategia callback mencionada en la sección 5.2

String

NO

Ver ejemplo en sección 5.2

subjectEmail

Asunto que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, el asunto por defecto es "solicitud de firma.") Máximo: 150 caracteres.

String

NO

Solicitud de Firma

messageEmail

Mensaje que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, no hay un mensaje por defecto.) Máximo: 500 caracteres.

String

NO

Por favor firmar este documento

copyEmails

Listado separado por comas de los correos electrónicos a los cuales se enviará una copia del documento una vez firmado por todos los involucrados. (No se incluyen correos asociados a los firmantes.) Máximo string: 255 caracteres. Máximo de correos electrónicos permitidos: 10.

String

NO

empresa.operaciones@empresa.com,empresa.contabilida@empresa.com

documentsOnlyRead []

Objeto que contiene  un documento que se le podría añadir a la notificación por correo electrónico cuando  el proceso haya sido montado en la APP

-

No

-

fileName

(parámetro del objeto documentsOnlyRead) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Carta de instrucciones

base64String

(parámetro del objeto documentsOnlyRead) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

Parámetro

Descripción

Tipo

Obligatoriedad

Ejemplo

processTypeId

Tipo de proceso a crear. Puede ser:

• 1 (Solo Yo)

• 2 (Otros y Yo)

• 3 (Solo Otros)

Int

SI

3

signatureMethodId

Método de firma con el cual se creará el proceso.

• 1 Firma electrónica simple.

• 2 Firma electrónica certificada.

Int

SI

2

deadlineDays

Plazo máximo en días para que todos los signatarios firmen el documento asociado al proceso.

Int

SI

30

isInOrder

Parámetro que permite que el proceso sea por orden de firmantes predefinido. Valores:

• True, el proceso tendrá orden de firmantes.

• False, el proceso no tendrá orden de firmantes.

Boolean

No

True

isRead

Parámetro que identifica si se  configurará una obligatoriedad de lectura al PDF para poder ser firmado. Valores:

• True, con obligatoriedad de lectura

• False, sin obligatoriedad de lectura.

Boolean

SI

True

isSendByEmail

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por correo electrónico. Valores:

• True, SI se envía la notificación por correo electrónico

• False, NO se envía la notificación por correo electrónico

Boolean

SI

True

isSendByWhatsApp

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por WhatsApp. Valores:

• True, SI se envía la notificación por WhatsApp

• False, NO se envía la notificación por WhatsApp

Boolean

Si

True

isHandWritten

Parámetro que permite agregar firma manuscrita. Valores:

• True, proceso tendrá firma manuscrita

• False, el proceso no tendrá firma manuscrita.

Boolean

No

True

isPhotographic

Parámetro que permite agregar firma fotográfica. Valores:

• True, el proceso tendrá firma fotográfica.

• False, el proceso no tendrá firma fotográfica.

Boolean

No

True

nit

Parámetro que identifica el NIT de una cuenta Administradora ya creada en la plataforma de firma electrónica. Este proceso se activa para heredar los derechos de manejo del proceso de firma que se está creando a un tercero , por medio del consumo de la API y solo lo podrá usar un usuario administrador hacia otro usuario dentro de la misma cuenta a la cual pertenece . El consumo de saldo será descontado de la cuenta que se está relacionando. Este campo sólo podrá ser usado si el servicio se consume por medio de un token generado por un Usuario que le deben ser otorgados permisos por el Administrador de la plataforma de Firma. La gestión de permisos deberá hacerse por medio del gerente del proyecto. 

String

No

51933622

email_user

Parámetro que identifica el usuario de una cuenta Administradora ya creada en la plataforma de firma electrónica. Este proceso se activa para heredar los derechos de manejo del proceso de firma que se está creando a un tercero , por medio del consumo de la API y solo lo podrá usar un usuario administrador hacia otro usuario dentro de la misma cuenta a la cual pertenece . El consumo de saldo será descontado de la cuenta que se está relacionando. Este campo sólo podrá ser usado si el servicio se consume por medio de un token generado por un Usuario que le deben ser otorgados permisos por el Administrador de la plataforma de Firma. La gestión de permisos deberá hacerse por medio del gerente del proyecto. 

String

No

persona.tranferir@empresa.com

signatures[]

Este array determina el listado de firmantes vinculados al proceso, sujeto al tipo de proceso. Acepta máximo 10 firmantes por proceso

order

(parámetro del array signatures) El orden de cada firmante en el proceso

Int

Si el valor isOrden = True

1

rol

(parámetro del array signatures)  Determina el rol  que se le asigna al Firmante.El parámetro es obligatorio si se le asigna una plantilla al proceso de firma.

String

Si

Empleado

processId

(parámetro del array signatures) Debe tener como valor 0.

Int

No

0

authenticationMethodId

(parámetro del array signatures) Método de autenticación OTP (One-Time Password) con el cual el firmante validará su proceso de firma.

• 1 OTP Llamada.

• 2 OTP SMS.

• 3 OTP Email.

• 4 OTP Whatsapp.

Int

SI

3

contactInformation{}

(objeto del array signatures) Objeto que contiene la información de contacto del firmante asociado al proceso a crear.

-

SI

-

phone{}

(objeto de contactInformation) Objeto que contiene la información del número de celular asociado al firmante.

-

SI

-

indicative

(parámetro del objeto phone) Indicativo de país asociado al número de celular del firmante. Ejemplo para Colombia: 57.

String

SI

57

number

(parámetro del objeto phone) Número celular del firmante. Máximo de caracteres para Colombia: 10. Máximo de caracteres para números extranjeros: 20.

String

SI

3188273865

email

(parámetro de contactInformation) Correo electrónico del firmante. Máximo: 100 caracteres.

String

SI

empresa.firma@empresa.com

person{}

(objeto de contactInformation) Objeto que contiene información básica asociada al firmante.

-

SI

-

firstName

(parámetro del objeto person) Primer nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Pablo

firstLastName

(parámetro del objeto person) Primer apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Parra

identification

(parámetro del objeto person) Número de identificación del firmante. Mínimo: 5 caracteres (Cédula de Ciudadanía) o Máximo: 12 caracteres (Cédula Extranjera).

String

SI

1018444520

identificationTypeId

(parámetro del objeto person) Tipo de identificación del firmante.

• 1 Cédula de Ciudadanía.

• 2 Cédula Extranjera.

• 3,NUI

• 4,NIT

• 5,Pasaporte

• 6,Permiso por protección temporal

Int

SI

1

typePersonId

(parámetro del objeto person) Tipo de persona del firmante.

• 1 Persona Natural.

• 2 Persona Jurídica.

Int

SI

1

signatory_type

(objeto del array signatures) Tipo de firmante o Rol que se representa en la evidencia digital para cada firmante. 

String

No

Empleado

documents[]

Objeto que contiene la información del documento a firmar.

-

SI

-

templateId

Parámetro que permite indicar el número del ID del template de documento que se desea asignar al proceso de firma. (Este valor lo entregara el Usuario Administrador)

Int

No

null

filename

(parámetro del objeto documents) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Contrato de Trabajo

documentTypeId

(parámetro del objeto documents) 

• 1, Contrato

• 2,  Arrendamiento

• 3, Sarlaft

Int

SI

1

base64String

(parámetro del objeto documents) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

callback

URL donde se debe enviar el documento cuando el proceso se termine exitosamente. Este parámetro hace referencia a la estrategia callback mencionada en la sección 5.2

String

NO

Ver ejemplo en sección 5.2

subjectEmail

Asunto que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, el asunto por defecto es "solicitud de firma.") Máximo: 150 caracteres.

String

NO

Solicitud de Firma

messageEmail

Mensaje que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, no hay un mensaje por defecto.) Máximo: 500 caracteres.

String

NO

Por favor firmar este documento

copyEmails

Listado separado por comas de los correos electrónicos a los cuales se enviará una copia del documento una vez firmado por todos los involucrados. (No se incluyen correos asociados a los firmantes.) Máximo string: 255 caracteres. Máximo de correos electrónicos permitidos: 10.

String

NO

empresa.operaciones@empresa.com,empresa.contabilida@empresa.com

documentsOnlyRead []

Objeto que contiene  un documento que se le podría añadir a la notificación por correo electrónico cuando  el proceso haya sido montado en la APP

-

No

-

fileName

(parámetro del objeto documentsOnlyRead) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Carta de instrucciones

base64String

(parámetro del objeto documentsOnlyRead) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

Parámetro

Descripción

Tipo

Obligatoriedad

Ejemplo

processTypeId

Tipo de proceso a crear. Puede ser:

• 1 (Solo Yo)

• 2 (Otros y Yo)

• 3 (Solo Otros)

Int

SI

3

signatureMethodId

Método de firma con el cual se creará el proceso.

• 1 Firma electrónica simple.

• 2 Firma electrónica certificada.

Int

SI

2

deadlineDays

Plazo máximo en días para que todos los signatarios firmen el documento asociado al proceso.

Int

SI

30

isInOrder

Parámetro que permite que el proceso sea por orden de firmantes predefinido. Valores:

• True, el proceso tendrá orden de firmantes.

• False, el proceso no tendrá orden de firmantes.

Boolean

No

True

isRead

Parámetro que identifica si se  configurará una obligatoriedad de lectura al PDF para poder ser firmado. Valores:

• True, con obligatoriedad de lectura

• False, sin obligatoriedad de lectura.

Boolean

SI

True

isSendByEmail

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por correo electrónico. Valores:

• True, SI se envía la notificación por correo electrónico

• False, NO se envía la notificación por correo electrónico

Boolean

SI

True

isSendByWhatsApp

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por WhatsApp. Valores:

• True, SI se envía la notificación por WhatsApp

• False, NO se envía la notificación por WhatsApp

Boolean

Si

True

isHandWritten

Parámetro que permite agregar firma manuscrita. Valores:

• True, proceso tendrá firma manuscrita

• False, el proceso no tendrá firma manuscrita.

Boolean

No

True

isPhotographic

Parámetro que permite agregar firma fotográfica. Valores:

• True, el proceso tendrá firma fotográfica.

• False, el proceso no tendrá firma fotográfica.

Boolean

No

True

nit

Parámetro que identifica el NIT de una cuenta Administradora ya creada en la plataforma de firma electrónica. Este proceso se activa para heredar los derechos de administración y manejo a un tercero  de el proceso que se está  montando por medio del consumo de la API

String

No

51933622

email_user

Parámetro que identifica el usuario de una cuenta Administradora ya creada en la plataforma de firma electrónica. Este proceso se activa para heredar los derechos de administración y manejo a un tercero  de el proceso que se está  montando por medio del consumo de la API. El consumo de saldo será descontado de la cuenta que se está relacionando.

String

No

persona.tranferir@empresa.com

signatures[]

Este array determina el listado de firmantes vinculados al proceso, sujeto al tipo de proceso. Acepta máximo 10 firmantes por proceso

order

(parámetro del array signatures) El orden de cada firmante en el proceso

Int

Si el valor isOrden = True

1

rol

(parámetro del array signatures)  Determina el rol  que se le asigna al Firmante.El parámetro es obligatorio si se le asigna una plantilla al proceso de firma.

String

Si

Empleado

processId

(parámetro del array signatures) Debe tener como valor 0.

Int

No

0

authenticationMethodId

(parámetro del array signatures) Método de autenticación OTP (One-Time Password) con el cual el firmante validará su proceso de firma.

• 1 OTP Llamada.

• 2 OTP SMS.

• 3 OTP Email.

• 4 OTP Whatsapp.

Int

SI

3

contactInformation{}

(objeto del array signatures) Objeto que contiene la información de contacto del firmante asociado al proceso a crear.

-

SI

-

phone{}

(objeto de contactInformation) Objeto que contiene la información del número de celular asociado al firmante.

-

SI

-

indicative

(parámetro del objeto phone) Indicativo de país asociado al número de celular del firmante. Ejemplo para Colombia: 57.

String

SI

57

number

(parámetro del objeto phone) Número celular del firmante. Máximo de caracteres para Colombia: 10. Máximo de caracteres para números extranjeros: 20.

String

SI

3188273865

email

(parámetro de contactInformation) Correo electrónico del firmante. Máximo: 100 caracteres.

String

SI

empresa.firma@empresa.com

person{}

(objeto de contactInformation) Objeto que contiene información básica asociada al firmante.

-

SI

-

firstName

(parámetro del objeto person) Primer nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Pablo

firstLastName

(parámetro del objeto person) Primer apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Parra

identification

(parámetro del objeto person) Número de identificación del firmante. Mínimo: 5 caracteres (Cédula de Ciudadanía) o Máximo: 12 caracteres (Cédula Extranjera).

String

SI

1018444520

identificationTypeId

(parámetro del objeto person) Tipo de identificación del firmante.

• 1 Cédula de Ciudadanía.

• 2 Cédula Extranjera.

• 3,NUI

• 4,NIT

• 5,Pasaporte

• 6,Permiso por protección temporal

Int

SI

1

typePersonId

(parámetro del objeto person) Tipo de persona del firmante.

• 1 Persona Natural.

• 2 Persona Jurídica.

Int

SI

1

signatory_type

(objeto del array signatures) Tipo de firmante o Rol que se representa en la evidencia digital para cada firmante. 

String

No

Empleado

documents[]

Objeto que contiene la información del documento a firmar.

-

SI

-

templateId

Parámetro que permite indicar el número del ID del template de documento que se desea asignar al proceso de firma. (Este valor lo entregara el Usuario Administrador)

Int

No

null

filename

(parámetro del objeto documents) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Contrato de Trabajo

documentTypeId

(parámetro del objeto documents) 

• 1, Contrato

• 2,  Arrendamiento

• 3, Sarlaft

Int

SI

1

schema [] name

Marca el inicio de una sección en la solicitud, diseñada para definir la posición de cada firma en el documento. Este bloque de parámetros se puede repetir tantas veces como sea necesario para incluir múltiples roles de firma, lo cual permite especificar la ubicación y atributos de cada una. Recomendamos que nombre de manera diferente cada rol de firma (Empleado,Empleador) o use una secuencia de números para nombrar el inicio del bloque (EJ: additionalProp1, additionalProp2, additionalProp3 …)

Empleado

type

(parámetro del array schema) Define el tipo de contenido para el parámetro. por defecto coloque “signature”

String

Si

signature

backgroundColor 

(parámetro del array schema) Este parámetro especifica el color de fondo . Puede utilizar un valor hexadecimal para personalizar el fondo de la firma o elemento.

String

No

#958b8b

x

(parámetro del array schema) Representa la posición horizontal en el eje X, siendo 0 la posición inicial

String

Si

78.88

y

(parámetro del array schema) Representa la posición vertical en el eje Y, siendo 0 la posición inicial.

String

Si

78.77

width

(parámetro del array schema) Define el ancho del elemento, en píxeles, para ajustar el espacio ocupado en el documento.

String

Si

40

heigth

(parámetro del array schema) Define la altura del elemento, en píxeles, para especificar el espacio vertical ocupado.

String

Si

60

value

Debe colocar el nombre del Rol del firmante. Colocar el mismo dato que aparezca en schema [] name.

String

Si

Empleador

base64String

(parámetro del objeto documents) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

callback

URL donde se debe enviar el documento cuando el proceso se termine exitosamente. Este parámetro hace referencia a la estrategia callback mencionada en la sección 5.2

String

NO

Ver ejemplo en sección 5.2

subjectEmail

Asunto que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, el asunto por defecto es "solicitud de firma.") Máximo: 150 caracteres.

String

NO

Solicitud de Firma

messageEmail

Mensaje que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, no hay un mensaje por defecto.) Máximo: 500 caracteres.

String

NO

Por favor firmar este documento

copyEmails

Listado separado por comas de los correos electrónicos a los cuales se enviará una copia del documento una vez firmado por todos los involucrados. (No se incluyen correos asociados a los firmantes.) Máximo string: 255 caracteres. Máximo de correos electrónicos permitidos: 10.

String

NO

empresa.operaciones@empresa.com,empresa.contabilida@empresa.com

documentsOnlyRead []

Objeto que contiene  un documento que se le podría añadir a la notificación por correo electrónico cuando  el proceso haya sido montado en la APP

-

No

-

fileName

(parámetro del objeto documentsOnlyRead) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Carta de instrucciones

base64String

(parámetro del objeto documentsOnlyRead) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

Parámetro

Descripción

Tipo

Obligatoriedad

Ejemplo

processTypeId

Tipo de proceso a crear. Puede ser:

• 1 (Solo Yo)

• 2 (Otros y Yo)

• 3 (Solo Otros)

Int

SI

3

signatureMethodId

Método de firma con el cual se creará el proceso.

• 1 Firma electrónica simple.

• 2 Firma electrónica certificada.

Int

SI

2

deadlineDays

Plazo máximo en días para que todos los signatarios firmen el documento asociado al proceso.

Int

SI

30

isInOrder

Parámetro que permite que el proceso sea por orden de firmantes predefinido. Valores:

• True, el proceso tendrá orden de firmantes.

• False, el proceso no tendrá orden de firmantes.

Boolean

No

True

isRead

Parámetro que identifica si se  configurará una obligatoriedad de lectura al PDF para poder ser firmado. Valores:

• True, con obligatoriedad de lectura

• False, sin obligatoriedad de lectura.

Boolean

SI

True

isSendByEmail

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por correo electrónico. Valores:

• True, SI se envía la notificación por correo electrónico

• False, NO se envía la notificación por correo electrónico

Boolean

SI

True

isSendByWhatsApp

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por WhatsApp. Valores:

• True, SI se envía la notificación por WhatsApp

• False, NO se envía la notificación por WhatsApp

Boolean

Si

True

isHandWritten

Parámetro que permite agregar firma manuscrita. Valores:

• True, proceso tendrá firma manuscrita

• False, el proceso no tendrá firma manuscrita.

Boolean

No

True

isPhotographic

Parámetro que permite agregar firma fotográfica. Valores:

• True, el proceso tendrá firma fotográfica.

• False, el proceso no tendrá firma fotográfica.

Boolean

No

True

nit

Parámetro que identifica el NIT de una cuenta Administradora ya creada en la plataforma de firma electrónica. Este proceso se activa para heredar los derechos de administración y manejo a un tercero  de el proceso que se está  montando por medio del consumo de la API. El consumo de saldo será descontado de la cuenta que se está relacionando.

String

No

51933622

email_user

Parámetro que identifica el usuario de una cuenta Administradora ya creada en la plataforma de firma electrónica. Este proceso se activa para heredar los derechos de administración y manejo a un tercero  de el proceso que se está  montando por medio del consumo de la API. El consumo de saldo será descontado de la cuenta que se está relacionando.

String

No

persona.tranferir@empresa.com

signatures[]

Este array determina el listado de firmantes vinculados al proceso, sujeto al tipo de proceso. Acepta máximo 10 firmantes por proceso

order

(parámetro del array signatures) El orden de cada firmante en el proceso

Int

Si el valor isOrden = True

1

rol

(parámetro del array signatures)  Determina el rol  que se le asigna al Firmante.El parámetro es obligatorio si se le asigna una plantilla al proceso de firma.

String

Si

Empleado

processId

(parámetro del array signatures) Debe tener como valor 0.

Int

No

0

authenticationMethodId

(parámetro del array signatures) Método de autenticación OTP (One-Time Password) con el cual el firmante validará su proceso de firma.

• 1 OTP Llamada.

• 2 OTP SMS.

• 3 OTP Email.

• 4 OTP Whatsapp.

Int

SI

3

contactInformation{}

(objeto del array signatures) Objeto que contiene la información de contacto del firmante asociado al proceso a crear.

-

SI

-

phone{}

(objeto de contactInformation) Objeto que contiene la información del número de celular asociado al firmante.

-

SI

-

indicative

(parámetro del objeto phone) Indicativo de país asociado al número de celular del firmante. Ejemplo para Colombia: 57.

String

SI

57

number

(parámetro del objeto phone) Número celular del firmante. Máximo de caracteres para Colombia: 10. Máximo de caracteres para números extranjeros: 20.

String

SI

3188273865

email

(parámetro de contactInformation) Correo electrónico del firmante. Máximo: 100 caracteres.

String

SI

empresa.firma@empresa.com

person{}

(objeto de contactInformation) Objeto que contiene información básica asociada al firmante.

-

SI

-

firstName

(parámetro del objeto person) Primer nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Pablo

firstLastName

(parámetro del objeto person) Primer apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Parra

identification

(parámetro del objeto person) Número de identificación del firmante. Mínimo: 5 caracteres (Cédula de Ciudadanía) o Máximo: 12 caracteres (Cédula Extranjera).

String

SI

1018444520

identificationTypeId

(parámetro del objeto person) Tipo de identificación del firmante.

• 1 Cédula de Ciudadanía.

• 2 Cédula Extranjera.

• 3,NUI

• 4,NIT

• 5,Pasaporte

• 6,Permiso por protección temporal

Int

SI

1

typePersonId

(parámetro del objeto person) Tipo de persona del firmante.

• 1 Persona Natural.

• 2 Persona Jurídica.

Int

SI

1

signatory_type

(objeto del array signatures) Tipo de firmante o Rol que se representa en la evidencia digital para cada firmante. 

String

No

Empleado

documents[]

Objeto que contiene la información del documento a firmar.

-

SI

-

templateId

Parámetro que permite indicar el número del ID del template de documento que se desea asignar al proceso de firma. (Este valor lo entregara el Usuario Administrador)

Int

No

023

filename

(parámetro del objeto documents) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Contrato de Trabajo

documentTypeId

(parámetro del objeto documents) 

• 1, Contrato

• 2,  Arrendamiento

• 3, Sarlaft

Int

SI

1

base64String

(parámetro del objeto documents) String con el documento PDF codificado en base64.

String

SI

null

callback

URL donde se debe enviar el documento cuando el proceso se termine exitosamente. Este parámetro hace referencia a la estrategia callback mencionada en la sección 5.2

String

NO

Ver ejemplo en sección 5.2

subjectEmail

Asunto que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, el asunto por defecto es "solicitud de firma.") Máximo: 150 caracteres.

String

NO

Solicitud de Firma

messageEmail

Mensaje que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, no hay un mensaje por defecto.) Máximo: 500 caracteres.

String

NO

Por favor firmar este documento

copyEmails

Listado separado por comas de los correos electrónicos a los cuales se enviará una copia del documento una vez firmado por todos los involucrados. (No se incluyen correos asociados a los firmantes.) Máximo string: 255 caracteres. Máximo de correos electrónicos permitidos: 10.

String

NO

empresa.operaciones@empresa.com,empresa.contabilida@empresa.com

documentsOnlyRead []

Objeto que contiene  un documento que se le podría añadir a la notificación por correo electrónico cuando  el proceso haya sido montado en la APP

-

No

-

fileName

(parámetro del objeto documentsOnlyRead) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Carta de instrucciones

base64String

(parámetro del objeto documentsOnlyRead) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

Parámetro

Descripción

Tipo

Obligatoriedad

Ejemplo

processTypeId

Tipo de proceso a crear. Puede ser:

• 1 (Solo Yo)

• 2 (Otros y Yo)

• 3 (Solo Otros)

Int

SI

3

signatureMethodId

Método de firma con el cual se creará el proceso.

• 1 Firma electrónica simple.

• 2 Firma electrónica certificada.

Int

SI

2

deadlineDays

Plazo máximo en días para que todos los signatarios firmen el documento asociado al proceso.

Int

SI

30

isInOrder

Parámetro que permite que el proceso sea por orden de firmantes predefinido. Valores:

• True, el proceso tendrá orden de firmantes.

• False, el proceso no tendrá orden de firmantes.

Boolean

No

True

isRead

Parámetro que identifica si se  configurará una obligatoriedad de lectura al PDF para poder ser firmado. Valores:

• True, con obligatoriedad de lectura

• False, sin obligatoriedad de lectura.

Boolean

SI

True

isSendByEmail

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por correo electrónico. Valores:

• True, SI se envía la notificación por correo electrónico

• False, NO se envía la notificación por correo electrónico

Boolean

SI

True

isSendByWhatsApp

Parámetro que  indica si la notificación cuando esté montado el proceso en la App será enviada por WhatsApp. Valores:

• True, SI se envía la notificación por WhatsApp

• False, NO se envía la notificación por WhatsApp

Boolean

Si

True

isHandWritten

Parámetro que permite agregar firma manuscrita. Valores:

• True, proceso tendrá firma manuscrita

• False, el proceso no tendrá firma manuscrita.

Boolean

No

True

isPhotographic

Parámetro que permite agregar firma fotográfica. Valores:

• True, el proceso tendrá firma fotográfica.

• False, el proceso no tendrá firma fotográfica.

Boolean

No

True

nit

Parámetro que identifica el NIT de una cuenta Administradora ya creada en la plataforma de firma electrónica. Este proceso se activa para heredar los derechos de administración y manejo a un tercero  de el proceso que se está  montando por medio del consumo de la API. El consumo de saldo será descontado de la cuenta que se está relacionando.

String

No

51933622

email_user

Parámetro que identifica el usuario de una cuenta Administradora ya creada en la plataforma de firma electrónica. Este proceso se activa para heredar los derechos de administración y manejo a un tercero  de el proceso que se está  montando por medio del consumo de la API. El consumo de saldo será descontado de la cuenta que se está relacionando.

String

No

persona.tranferir@empresa.com

signatures[]

Este array determina el listado de firmantes vinculados al proceso, sujeto al tipo de proceso. Acepta máximo 10 firmantes por proceso

order

(parámetro del array signatures) El orden de cada firmante en el proceso

Int

Si el valor isOrden = True

1

rol

(parámetro del array signatures)  Determina el rol  que se le asigna al Firmante.El parámetro es obligatorio si se le asigna una plantilla al proceso de firma.

String

Si

Empleado

processId

(parámetro del array signatures) Debe tener como valor 0.

Int

No

0

authenticationMethodId

(parámetro del array signatures) Método de autenticación OTP (One-Time Password) con el cual el firmante validará su proceso de firma.

• 1 OTP Llamada.

• 2 OTP SMS.

• 3 OTP Email.

• 4 OTP Whatsapp.

Int

SI

3

contactInformation{}

(objeto del array signatures) Objeto que contiene la información de contacto del firmante asociado al proceso a crear.

-

SI

-

phone{}

(objeto de contactInformation) Objeto que contiene la información del número de celular asociado al firmante.

-

SI

-

indicative

(parámetro del objeto phone) Indicativo de país asociado al número de celular del firmante. Ejemplo para Colombia: 57.

String

SI

57

number

(parámetro del objeto phone) Número celular del firmante. Máximo de caracteres para Colombia: 10. Máximo de caracteres para números extranjeros: 20.

String

SI

3188273865

email

(parámetro de contactInformation) Correo electrónico del firmante. Máximo: 100 caracteres.

String

SI

empresa.firma@empresa.com

person{}

(objeto de contactInformation) Objeto que contiene información básica asociada al firmante.

-

SI

-

firstName

(parámetro del objeto person) Primer nombre del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Pablo

firstLastName

(parámetro del objeto person) Primer apellido del firmante. Mínimo: 2 caracteres. Máximo: 100 caracteres.

String

SI

Parra

identification

(parámetro del objeto person) Número de identificación del firmante. Mínimo: 5 caracteres (Cédula de Ciudadanía) o Máximo: 12 caracteres (Cédula Extranjera).

String

SI

1018444520

identificationTypeId

(parámetro del objeto person) Tipo de identificación del firmante.

• 1 Cédula de Ciudadanía.

• 2 Cédula Extranjera.

• 3,NUI

• 4,NIT

• 5,Pasaporte

• 6,Permiso por protección temporal

Int

SI

1

typePersonId

(parámetro del objeto person) Tipo de persona del firmante.

• 1 Persona Natural.

• 2 Persona Jurídica.

Int

SI

1

signatory_type

(objeto del array signatures) Tipo de firmante o Rol que se representa en la evidencia digital para cada firmante. 

String

No

Empleado

documents[]

Objeto que contiene la información del documento a firmar.

-

SI

-

templateId

Parámetro que permite indicar el número del ID del template de documento que se desea asignar al proceso de firma. (Este valor lo entregara el Usuario Administrador)

Int

No

023

filename

(parámetro del objeto documents) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Contrato de Trabajo

documentTypeId

(parámetro del objeto documents) 

• 1, Contrato

• 2,  Arrendamiento

• 3, Sarlaft

Int

SI

1

Tags []name

En este array podrá relacionar cada “Tag” que haya creado el usuario administrador cuando use una plantilla HTML. Recuerde que esta información debe proporcionarles el usuario administrador, donde le proporcionará el nombre del TAG y el contenido que debe ir en el mismo.

String

Si

{

      "Empleado.Nombre": "Juan Pablo Salazar",

      "Empleador.Nombre": "Ricardo Alfonzo Urrutia",

      "NombreEmpresa": "Porvenir SAS"

    }

base64String

(parámetro del objeto documents) String con el documento PDF codificado en base64.

String

SI

null

callback

URL donde se debe enviar el documento cuando el proceso se termine exitosamente. Este parámetro hace referencia a la estrategia callback mencionada en la sección 5.2

String

NO

Ver ejemplo en sección 5.2

subjectEmail

Asunto que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, el asunto por defecto es "solicitud de firma.") Máximo: 150 caracteres.

String

NO

Solicitud de Firma

messageEmail

Mensaje que se desea incluir en el correo electrónico con la solicitud de firma a los firmantes. (En caso de no enviarse, no hay un mensaje por defecto.) Máximo: 500 caracteres.

String

NO

Por favor firmar este documento

copyEmails

Listado separado por comas de los correos electrónicos a los cuales se enviará una copia del documento una vez firmado por todos los involucrados. (No se incluyen correos asociados a los firmantes.) Máximo string: 255 caracteres. Máximo de correos electrónicos permitidos: 10.

String

NO

empresa.operaciones@empresa.com,empresa.contabilida@empresa.com

documentsOnlyRead []

Objeto que contiene  un documento que se le podría añadir a la notificación por correo electrónico cuando  el proceso haya sido montado en la APP

-

No

-

fileName

(parámetro del objeto documentsOnlyRead) Nombre del documento PDF. Máximo: 100 caracteres.

String

SI

Carta de instrucciones

base64String

(parámetro del objeto documentsOnlyRead) String con el documento PDF codificado en base64.

String

SI

TDQc5698fHGDI4DHD………

Parámetro

Descripción

Ejemplo

uuid

Valor devuelto que identifica el proceso creado en la aplicación de Firma Electrónica

1ee83f3073ae4ee09c183fef4c683b

statusCode

Código que identifica el estado de la respuesta HTTP

200

Parámetro

Descripción

Ejemplo

requestId

Valor devuelto que identifica el proceso creado en la aplicación de Firma Electrónica

1ee83f3073ae4ee09c183fef4c683b

statusCode

Código que identifica el estado de la respuesta HTTP

200

Estado

Descripción

Solución

200

Respuesta exitosa.

No aplica

401

Debes Autenticarte

Revise  los parámetros de entrada

500

Error interno del servidor.

Ocurrió un error en el servidor.  Comuníquese con el Área de Soporte o intente más tarde.