eSign.AIeSign.AI
Centro de desarrolladores

Iniciar un sobre rápidamente

POST /esignglobal/v1/envelope/createAndStart

Descripción de la interfaz

Iniciar rápidamente un sobre, que incluye funciones como crear un sobre, agregar archivos pendientes de firma y agregar firmantes.

  • Soporta activación automática: Tras el éxito de la llamada a la interfaz, se crea y activa correctamente el sobre, comenzando automáticamente su flujo.
  • Soporta finalización automática: Una vez que todas las partes firmantes han completado la firma, el sobre se cierra automáticamente.

 

Parámetros de solicitud

Nombre del parámetro

Tipo

Obligatorio

Descripción

subject

string

true

Asunto del sobre

Ejemplo: "Carta de oferta"

remark

string

false

Notas del sobre, límite de longitud de 1000 caracteres

signerSettings

object

false

Operaciones permitidas para los firmantes

 

allowTransfer

boolean

false

¿Se permite al firmante transferir el sobre a otra persona para su firma? El valor predeterminado es false.

true: permite que el firmante del sobre tenga la facultad de transferir el sobre a otra persona;

false: no permite que el firmante del sobre tenga la facultad de transferir el sobre a otra persona;

 

allowModifyName

boolean

false

¿Se permite al firmante modificar su nombre? Esto solo se aplica a las firmas en plantillas. El valor predeterminado es false.

true: permite que el firmante modifique su nombre

false: no permite que el firmante modifique su nombre

expireAfterSeconds

long

false

Tiempo de vencimiento del sobre. El sobre caduca después de transcurridos este número de segundos.

Rango de vencimiento: desde 86,400 segundos (1 día) hasta 7,776,000 segundos (90 días).

redirectUrl

string

false

Debe ser una dirección https válida.

callBackUrl

string

false

Dirección de devolución de llamada (longitud máxima 500 caracteres). Debe cumplir con el protocolo https.

sendLaterAfterSeconds

long

false

Permite el envío diferido por parte del usuario, expresado en segundos.

Rango de tiempo admitido: desde 3,600 segundos (1 hora) hasta 259,200 segundos (30 días).

autoFinish

boolean

false

Controla si el sobre finaliza automáticamente. El valor predeterminado es true.

true- Finalización automática del sobre

false- Finalización manual del sobre

CCInfos

array

false

Conjunto de información del destinatario en copia

 

userEmail

string

false

Dirección de correo electrónico del destinatario en copia

 

userName

string

false

Nombre del destinatario en copia, utilizado para mostrar el nombre del destinatario en copia en la página de firma y en el sobre externo.

[Nota]: No debe contener los siguientes 9 caracteres especiales: / \ : * " < > | ? ni ningún emoji

 

ccOrder

int

false

Posición ordenada del destinatario en copia dentro del proceso de firma, que comparte el orden con signOrder del firmante. Si no se proporciona, se mantiene la lógica original de notificación al destinatario en copia.

 

customizeSettings

object

false

Configuración personalizada

 

 

notificationSettings

object

false

Configuración personalizada para notificaciones

 

 

 

notificationLanguage

string

false

Idioma de la notificación; por defecto, se utiliza la configuración 'idioma de notificación predeterminado'

en-US Inglés

zh-CN Chino simplificado

zh-Hant Chino tradicional

ja-JP Japonés

es-MX Español

pt-PT Portugués
th-TH Tailandés
id-ID Bahasa Indonesia
vi-VN Bahasa Vietnam
ms-MY Bahasa Melayu
fil-PH Bahasa Filipino
de-DE Bahasa Jerman
fr-FR Bahasa Prancis
ru-RU Bahasa Rusia
it-IT Bahasa Italia
ko-KR Bahasa Korea

signFiles

array

true

Conjunto de información de documentos firmados, el orden de visualización corresponde al orden en que se agregaron los documentos.

 

fileKey 

string

true

fileKey del documento firmado; solo se admite formato PDF

 documentFieldsarrayfalseLista de controles de dimensiones del documento. Se utiliza para agregar controles de dimensiones del documento a un archivo específico sin vincularlos a un firmante.

 

 

fieldType

string

false

Tipo de control. Indique eMeterai para representar el control de impuesto de timbre de Indonesia.

 

 

pageNo

string

false

Número de página donde se encuentra el control. El control de impuesto de timbre de Indonesia solo admite la especificación de una única página; debe proporcionarse un número de página individual y no se admiten formatos de múltiples páginas continuas o discontinuas como 1-3 o 1,3.

  posXfloatfalseDesplazamiento en el eje x, con el origen de coordenadas en la esquina inferior izquierda de la página. El rango de coordenadas es consistente con el rango de coordenadas de otros controles.
  posYfloatfalseDesplazamiento en el eje Y, con el origen de coordenadas en la esquina inferior izquierda de la página. El rango de coordenadas es consistente con el rango de coordenadas de otros controles.

attachments

array

false

Conjunto de archivos adjuntos del sobre, mostrados en el orden en que se agregaron los archivos.

 

fileKey 

string

false

fileKey del archivo

signerInfos

array

true

Conjunto de información del firmante

 

businessId

string

false

Número de negocio personalizado por el desarrollador, límite de longitud 500

 

roleTypes

array

false

Método de operación del firmante, valor predeterminado: ["sign", "fill"]

fill-completar

sign-firmar

 deliveryMethods

string

false

Método de notificación, valor predeterminado: auto

auto- Al pasar userEmail, enviar notificación por correo electrónico; al pasar phoneNumber, enviar notificación por SMS

none- No enviar notificaciones de mensajes

email- Enviar notificación por correo electrónico

sms- Enviar notificación por SMS

WhatsApp- Enviar notificación por WhatsApp

 

userEmail

string

false

Dirección de correo electrónico del firmante

 

userName

string

true

Nombre del firmante, utilizado para mostrar el nombre del firmante en la página de firma y en el sobre.

[Nota] No debe contener los siguientes 9 caracteres especiales: / \ : * " < > | ? ni ningún emoji

 minimumReadingDurationintfalseTiempo de cuenta regresiva obligatorio para la lectura en la página de configuración; valor predeterminado: 0 (unidad: segundos, máximo: 999)
0 o no enviar indica que no se activa; no hay cuenta regresiva de lectura
 readToEndRequiredbooleanfalseIndica si es obligatorio leer hasta el final. Valor predeterminado: false;
true indica activado; false o no enviar indica desactivado.

 

phoneNumber

object

false

Número de teléfono, vacío por defecto

Parámetro obligatorio cuando se requiere notificación por SMS; deben enviarse tanto countryCode como number

 

 

countryCode

string

false

Código internacional del país/región; no incluir el símbolo '+'

 

 

number

string

false

Sin validación de formato, solo límite de longitud máxima de 13 dígitos

 

customizeSettings

object

false

Configuración personalizada

 

 

notificationSettings

object

false

Configuración personalizada para notificaciones

 

 

 

customizeMessage

string

false

Notificación de mensaje exclusivo, límite de caracteres: 200

   

notificationLanguage

string

false

Idioma de notificación; toma por defecto la configuración 'idioma de notificación predeterminado'

en-US inglés

zh-CN Chino simplificado

zh-Hant Chino tradicional

ja-JP Japonés

es-MX Español

pt-PT Portugués
th-TH Tailandés
id-ID Indonesio
vi-VN Vietnamita
ms-MY Malayo
fil-PH Filipino
de-DE Alemán
fr-FR Francés
ru-RU Ruso
it-IT Italiano
ko-KR Coreano

 

signOrder

int

true

Orden de firma del firmante, con un valor mínimo de 1. En la firma sin orden, se pueden especificar valores de orden idénticos.

 

signTaskSuspend

boolean

false

Indica si se configura un nodo de bloqueo del proceso antes de esta posición de firma; el valor predeterminado es false. true: configurar un nodo de bloqueo; false: no configurar un nodo de bloqueo. La configuración de bloqueo dentro de un grupo de firmas OR con el mismo signOrder debe ser consistente.

 

suspensionKey

string

false

Identificador del nodo de bloqueo, con una longitud máxima de 500 caracteres y único dentro del mismo sobre. Obligatorio cuando signTaskSuspend=true; no se debe transmitir cuando signTaskSuspend=false o no se transmite.

 

suspendReason

string

false

Motivo del bloqueo. No puede estar vacío al transmitirse, con una longitud máxima de 50 caracteres. Solo se puede transmitir cuando signTaskSuspend=true; si no se transmite, se entiende por defecto que se requiere la espera del procesamiento del sistema externo. No se debe transmitir cuando signTaskSuspend=false o no se transmite.

 

anySigner

boolean

false

Indica si se permite la firma por cualquier persona; el valor predeterminado es false

true-Solo una persona del mismo signOrder necesita firmar

false-Todas las personas del mismo signOrder deben firmar

 

authModes

string

false

Método de verificación, el valor predeterminado es noAuth

noAuth-Sin verificación

accessCode-Verificación mediante contraseña de firma

sms-Verificación OTP por SMS

idVerification-Verificación de documento de identidad

emailAuth-Verificación OTP por correo electrónico

digitalId-Verificación de identidad electrónica

whatsappAuth-Verificación OTP por WhatsApp

 

authConfig

object

false

Configuración del método de verificación

 

 

accessCode

object

 

false

Configuración de la contraseña de firma, obligatoria cuando authModes=accessCode

 

 

 

accessCode

string

false

Contenido de la contraseña, sin distinción entre mayúsculas y minúsculas; puede contener letras y números; límite de longitud: 45 caracteres

   

promptInfo

string

false

Mensaje de提示 para la contraseña de acceso, no debe incluir la contraseña de acceso; límite de longitud: 30 caracteres; obligatorio cuando authModes=accessCode. 

 

 

sms

object

false

Verificación OTP por SMS, obligatoria cuando authModes=sms

 

 

 

countryCode

string

false

Código internacional del país/región; no es necesario incluir el símbolo '+'

 

 

 

number

string

false

No se realiza validación de formato; solo se limita la longitud máxima a 13 dígitos

 

 

idVerification

object

false

Configuración de verificación mediante documento de identidad, obligatoria cuando authModes=idVerification

 

 

 

name

string

false

Nombre completo tal como aparece en el documento de identidad del firmante; longitud máxima: 100 caracteres

  

emailAuth

object

false

Verificación OTP por correo electrónico, obligatoria cuando authModes=emailAuth

  

 

authEmail

string

false

Dirección de correo electrónico para la verificación de identidad del firmante

 

 

digitalId

array

false

Verificación de identidad electrónica, obligatoria cuando authModes=digitalId

 

 

 

authApp

string

false

Aplicación utilizada para la verificación de identidad electrónica

singpass- Utilizar Singpass para la autenticación de identidad

iamsmart- Utilizar i AM Smart para la autenticación de identidad

 

 

 

idNumber

string

false

Número de documento de identidad del firmante pendiente de verificación

Cuando authApp=singpassla regla de entrada es: letra mayúscula + 7 u 8 dígitos + letra mayúscula

Cuando authApp=iamsmartla regla de entrada es:

1. Una letra mayúscula (A-Z) o dos letras mayúsculas (AA-ZZ) como inicio de la secuencia;

2. seguido de 6 dígitos numéricos;

3. finalmente un código de control, que puede ser un número (0-9) o una letra (A-Z). Ejemplo: A888888(A)

 

 

whatsappAuth

object

false

Verificación OTP por WhatsApp, obligatoria cuando authModes=whatsappAuth

 

 

 

countryCode

string

false

Código internacional del país/región, sin incluir el símbolo '+'

 

 

 

number

string

false

No se realiza validación de formato, solo se limita la longitud máxima a 13 caracteres

 

digitalSignature

boolean

false

Si se activa la firma digital, valor predeterminado false

true: activado, false: no activado

 

tsp

string

false

Seleccione el TSP que utilizará el firmante, valor predeterminado false.

Si no se establece, el firmante elegirá libremente el TSP que desea utilizar. Los valores posibles incluyen:

vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni

belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia

estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom

harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId

mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign

smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe

certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha

 

freeFormSign

boolean

false

Indica si el firmante puede aplicar su sello de forma libre, valor predeterminado false

Notas adicionales:

Cuando freeFormSign está establecido en true, no es necesario transmitir otros parámetros bajo sealInfos. Si se transmiten simultáneamente, freeFormSign tiene prioridad sobre sealInfos y los parámetros dentro de sealInfos no surtirán efecto.

[Nota]La firma libre significa que no hay restricciones sobre la cantidad ni la posición de los sellos/firmas que el firmante puede arrastrar e insertar

 

documentVisibility

object

false

Configuración de visibilidad del documento, todos visibles por defecto.

 

 

documentViewType

string

false

Política de visibilidad, valor predeterminado all; all indica que se pueden ver todos los documentos de firma dentro del sobre, limited indica que solo se pueden ver los propios documentos de firma y los documentos adicionales permitidos para visualización.

 

 

viewableFileKeys

array

false

Lista de fileKey adicionales permitidos para ser vistos por la parte firmante; solo se permite transmitir y surte efecto cuando documentViewType=limited.

 

sealInfos

array

false

Información de la tarea de firma

 

 

fileKey

string

true

fileKey del documento firmado

 

 

signConfigs

array

false

Información de la posición del control. Es obligatorio especificar la información de la posición del control para realizar la firma electrónica.

 

 

 

fieldType

string

false

Tipo de control, el valor predeterminado es signature

signature-Control de firma

stamp-Control de sello

approval-Control de aprobación

   

required

boolean

false

Si es obligatorio, el valor predeterminado es obligatorio

true-Obligatorio

false-No obligatorio

   

signFieldStyle

string

false

Método de colocación del sello en el control de firma, el valor predeterminado es normalSeal.

normalSeal-Sello ordinario

pagingSeal-Sello de junta

Solo los controles de firma y de sello admiten la configuración del sello de junta.

   

pagingSealMode

string

false

Rango de páginas para la colocación del sello de junta, el valor predeterminado es all.

all-Todos los números de página

assignedPages-Números de página específicos

even-Páginas pares

odd-Páginas impares

Solo se admite la especificación cuando signFieldStyle=pagingSeal.

   

sizeRule

string

false

Modo de visualización del tamaño del área de firma

originalSize-Colocar el sello según el tamaño real de la firma/sello

targetSize-Ancho y alto personalizados para el área de firma/sello

Cuando sizeRule, height y width están vacíos, colocar el sello según el tamaño real de la firma/sello;

Cuando sizeRule está vacío pero height y width no lo están, colocar el sello según el tamaño especificado;

Cuando sizeRule no está vacío, colocar el sello según el modo de visualización especificado;

No es necesario especificar este parámetro para los sellos de junta; solo se colocan según el tamaño real.

 

 

 

height

int

false

Altura del control de firma, aplicable cuando fieldType es signature/stamp, en unidades de px. Solo se admiten enteros positivos como entrada. El valor predeterminado es auto (es decir, tamaño automático del sistema);

Cuando fieldType=signature, el rango admisible es de 20 a 250 px;

Cuando fieldType=stamp, el rango admisible es de 30 a 280 px;

No es necesario especificar este parámetro para los sellos de junta.

 

 

 

width

int

false

Anchura del control de firma, aplicable cuando fieldType es signature/stamp, en unidades de px. Solo se admiten enteros positivos como entrada. El valor predeterminado es auto (es decir, tamaño automático del sistema);

Cuando fieldType=signature, el rango se puede configurar entre 20 y 250 px;

Cuando fieldType=stamp, el rango se puede configurar entre 30 y 280 px;

El sello de unión no requiere especificar este parámetro.

 

 

 

signatureOptions

string

false

Opciones del control de firma. Solo aplicable cuando fieldType es signature

Parámetros de entrada posibles:

template: firma con plantilla

handDrawn: firma dibujada a mano

upload: subir imagen de firma localmente

aiHandDrawn: firma manuscrita con IA

Se pueden seleccionar varias opciones, separadas por ","; la selección predeterminada es todas

 

 

 

movable

boolean

false

Permitir mover la posición durante la firma, valor predeterminado false

false: no permite que el firmante ajuste la posición de su propio control de firma

true: permite que el firmante ajuste la posición de su propio control de firma

 

 

 

allowedOptions

array

false

Opciones que permiten al firmante aprobar, aplicable cuando fieldType es approval. El valor predeterminado es ["approve", "decline"]

approve-Aprobar

decline-Rechazar

 

 

 

pageNo

string

false

Número de página de firma; las páginas consecutivas se conectan con "-" y las páginas individuales se conectan con ","

Ejemplo: 1-3,6-10

Cuando pagingSealMode=assignedPages, se transmite el rango de páginas donde se aplica el sello de costura. El sello de costura solo puede utilizarse en archivos de más de una página.

 

 

 

posX

float

false

Coordenada del eje x

[Nota] Si fieldType es signature, la posición de coordenadas se refiere al área de firmaEsquina inferior izquierda;

Si fieldType es stamp, la posición de coordenadas se refiere al área de estampadoPunto centralPosición

A partir del 3 de febrero de 2026, cuando fieldType sea signature o stamp, su posición de coordenadas se refiere al punto central del área de estampado.

Para el sello de costura se puede transmitir 0, pero no null; el control está fijo en el borde derecho del documento.

 

 

 

posY

float

false

Coordenada del eje y

[Nota] Si fieldType es signature, la posición de coordenadas se refiere al área de firmaEsquina inferior izquierda;

Si fieldType es stamp, la posición de las coordenadas se refiere al área del sello.Punto centralPosición

A partir del 3 de febrero de 2026, si fieldType es signature o stamp, su posición de coordenadas se refiere al punto central del área del sello.

 

 

fillConfigs

array

false

Rellenar la información del control

 

 

 

fieldName

string

false

Nombre del control, límite de caracteres: 128

 

 

 

required

boolean

false

Campo obligatorio, por defecto obligatorio

true - obligatorio

false - no obligatorio

 

 

 

fieldType

string

false

Tipo de control:

1 - Texto de una sola línea

15 - Casilla de verificación

 

 

 

textField

object

false

Propiedades del control de texto

 

 

 

 

overflowType

int

false

Solo aplica a text, valor predeterminado: 1

1 - Reducir automáticamente el tamaño de fuente

2-Limitar entrada

 

 

 

 

minFontSize

float

false

Solo aplica a text, solo aplica cuando overflowType=1, valor por defecto 8

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

 

 

 

 

width

int

false

Ancho del control, valor por defecto 160px

 

 

 

 

font

int

false

Solo aplica a text, fuente, valor por defecto SimSun

1-SimSun

2-New SimSun

4-HeiTi

5-KaiTi

6-Arial

7-Helvetica

9-Times New Roman

10-FangSong

11-Georgia

12-Monospace

 

 

 

 

fontSize

float

false

Solo aplica a text, tamaño de fuente, valor por defecto 12

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

 

 

 

 

textColor

string

false

Solo aplica a text, color hexadecimal, valor por defecto negro #000

 

 

 

 

bold

boolean

false

Solo aplica a text, si la fuente está en negrita, valor por defecto false

true-Negrita

false-Sin negrita

 

 

 

 

italic

boolean

false

Solo aplica a text, si la fuente está en cursiva, valor por defecto false

true-Itálica

false-No itálica

 

 

 

 

underline

boolean

false

Solo aplica a text, indica si se añade subrayado al texto; valor predeterminado: false

true-Añadir subrayado

false-No añadir subrayado

 

 

 

 

lineThrough

boolean

false

Solo aplica a text, indica si se añade tachado al texto; valor predeterminado: false

true-Añadir tachado

false-No añadir tachado

 

 

 

 

horizontalAlignment

string

false

Solo aplica a text, formato de alineación horizontal; valor predeterminado: left

LEFT-Alineado a la izquierda

CENTER-Centrado

RIGHT-Alineado a la derecha

 

 

 

tickBoxField

object

false

Propiedades del cuadro de verificación

 

 

 

 

tickOptions

array

false

Solo aplica a tickBox; valor predeterminado: 1

1-Marcado

2-rama

 

 

 

posX

float

false

Coordenada X de la posición del control

 

 

 

posY

float

false

Coordenada Y de la posición del control

 

 

 

pageNo

string

false

Número de página donde se encuentra el control

 

 

signDateConfigs

array

false

Información de la posición de la fecha de firma

 

 

 

movable

boolean

false

Permitir mover la posición al firmar, valor predeterminado false

false: no se permite que el firmante ajuste la posición de su propio control de firma

true: se permite que el firmante ajuste la posición de su propio control de firma

 

 

 

pageNo

string

false

Número(s) de página(s) para firmar; los números de página consecutivos se conectan con "-", y los números de página individuales se separan con ",". Ejemplo: 1-3, 6-10;

Si no son consecutivos, utilice "," para dividir.

 

 

 

posX

float

false

Desplazamiento en el eje x, el origen de coordenadas es la esquina inferior izquierda de la página

 

 

 

posY

float

false

Desplazamiento en el eje y, el origen de coordenadas es la esquina inferior izquierda de la página

 

 

 

signDateFormat

string

false

Formato de la fecha de firma, el formato predeterminado es yyyy-MM-dd

Se admite especificar el formato:

dd de MM de yyyy

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MMM dd,yyyy

dd MMM yyyy

Ejemplo de solicitud

{
    "subject": "员工入职合约",
    "remark": "这是描述",
    "expireAfterSeconds": 86400,
    "redirectUrl": "https://app-sml.esignglobal.com/home/main/esign/contract/list/inbox",
    "CCInfos": [
      {
        "userEmail": "cc_user@esignglobal.com",
        "userName": "cc_user_name",
        "ccOrder": 1
      }
    ],
    "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
    "signerInfos": [
      {
        "userEmail": "sender_user@tsign.cn",
        "userName": "sender_user_name",
        "phoneNumber": {
        	"countryCode": "86",
        	"number": "158****9242"
        }
        "signOrder": 1,
        "signTaskSuspend": true,
        "suspensionKey": "approval-node-001",
        "suspendReason": "等待外部审批",
        "authModes": "sms",
        "authConfig": {
            "sms": {
                "countryCode": "86",
                "number": "158****9242"
            }
        },
        "sealInfos": [
        {
            "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
            "signConfigs": [
              {
                "fieldType": "stamp",
                "pageNo": "1,3-5",
                "posX": 100.22222,
                "posY": 100.11111
              }
              "fillConfigs": [
              {
                "fieldId": "df0dd777bc774a2ba3fec4d108de242d",
                "fieldKey": "必填单行文本自动缩小字号最小字号Arial",
                "pageNo": "1",
                "posX": "88.70021",
                "posY": 745.409,
                "fieldType": "1",
                "required": true,
                "textField": {
                    "overflowType": "1",
                    "minFontSize": 8,
                    "font": "6",
                    "fontSize": "12",
                    "textColor": "#54ACD2",
                    "bold": false,
                    "italic": true,
                    "lineThrough": false,
                    "horizontalAlignment": "RIGHT"
                }
              },
              {
                  "fieldId": "888b899853544c49bd819d9f6d1e52cf",
                  "fieldKey": "必填勾选控件不限制选中样式不显示边框",
                  "pageNo": "3",
                  "posX": 451.77127,
                  "posY": 429.07626,
                  "fieldType": "15",
                  "required": true,
                  "tickBoxField": {
                      "tickOptions": [1,2],
                      "showBorder": false
                  }
                }
              ]
            ],
            "signDateConfigs":[
              {
                "pageNo":"1",
                "posX": 100.22,
                "posY": 100,
                "signDateFormat": "dd MMM yyyy"
              }
            ]
        }
      ]
    }
  ]
}

 

Parámetros de respuesta

Nombre del parámetro

Tipo

Descripción

envelopeId

string

ID del sobre

CCInfos

array

Colección de información de destinatarios en copia

 

userEmail

string

Dirección de correo electrónico del destinatario en copia

 

userName

string

Nombre del destinatario en copia

signFiles

array

Colección de información de documentos a firmar

 

fileKey

string

fileKey del documento a firmar

attachments

array

Colección de archivos adjuntos del sobre

 

fileKey

string

fileKey del archivo

signerInfos

array

Información de firma

 

recipientId

string

ID del firmante

 

businessId

string

Número de negocio personalizado por el desarrollador, límite de longitud 500

 

userEmail

string

Dirección de correo electrónico del firmante

 

userName

string

Nombre del firmante

 signUrlstringURL del enlace de firma

 

signOrder

int

Orden de firma del firmante, mínimo 1

 

accessCode

string

Contraseña de acceso a la página de firma

Ejemplo de respuesta

{
  "code": "0",
    "data": {
    "signerInfos": [
      {
        "accessCode": "123456",
        "userEmail": "sender_user@tsign.cn",
        "signUrl": "http://app-test.esignglobal-inc.com/home/main/sign/start/base/dosign?envelopeId=4cd738a60225445f9d5f3afec468a639&signature=eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9.eNqqVkrOzytJrShRsqpWSs0rS83JL0gNSSzO9kxRslJKtjC1MDKxTDVIMzA0SU4xSTIwNjAxSDRNTTVKMTIxTFOqrQUAAAD__w.YMBA5X9O8Ylk7x2rma-s1WxGwo2cjqy-O9CCQopzw88&tenantToken=AA0DDgQ0Y2Q3MzhhNjAyMjU0NDVmOWQ1ZjNhZmVjNDY4YTYzuQ4GNGNkNzM4YTYwMjI1NDQ1ZjlkNWYzYWZlYzQ2OGE2M7kOCjRjZDczOGE2MDIyNTQ0NWY5ZDVmM2FmZWM0NjhhNjO5AIBjNDIwMzg1ZDMyYzU0MGE4YTk1ZTE3ZTNkZmZjMDNm4g%3D%3D",
        "userName": "sender_user_name",
        "signOrder": "1"
      }
    ],
      "signFiles": [
      {
        "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
      },
      {
        "fileKey": "$c7567683-2fc1-47a5-82c1-570d4839afd8$3119805980"
      }
    ],
      "envelopeId": "4cd738a60225445f9d5f3afec468a639"
  },
  "message": "success"
}