Mabilis na Simulan ang Envelope

Pangalan ng Parameter

Uri

Kailangan

Paliwanag

subject

string

true

Paksa ng Envelope

Halimbawa: "Offer Letter"

remark

string

false

Tala ng Envelope, limitasyon ng haba ay 1000 karakter

signerSettings

object

false

Mga Aksyon na Pinapayagan para sa Tagapirmahan

allowTransfer

boolean

false

Pinapayagan ba na ipasa ng tagapirmang ito ang envelope sa iba para mag-sign, default false

true-Pinapayagan ang mga tagapirmang nasa envelope na magpaipasa ng envelope sa iba;

false-Hindi pinapayagan ang mga tagapirmang nasa envelope na magpaipasa ng envelope sa iba;

allowModifyName

boolean

false

Pinapayagan ba na baguhin ng tagapirma ang pangalan, lamang para sa template signature, default false

true-Pinapayagan ang tagapirmang baguhin ang pangalan

false-Hindi pinapayagan ang tagapirmang baguhin ang pangalan

expireAfterSeconds

long

false

Oras ng expiration ng envelope, pagkatapos ng ilang segundo ay magiging expired ang envelope

Saklaw ng expiration: 86,400 segundo (1 araw) ~ 7,776,000 segundo (90 araw)

redirectUrl

string

false

Kailangan maging valid na https address

callBackUrl

string

false

Callback address (length 500), kailangan sumunod sa https protocol address.

sendLaterAfterSeconds

long

false

Suportado ang delayed sending ng user, sa seconds

Saklaw ng oras: 3600 segundo (1 oras) ~ 259200 segundo (30 araw)

autoFinish

boolean

false

Kontrol kung ang envelope ay awtomatikong matatapos, default true

true-Awtomatikong matatapos ang envelope

false-Manu-manong matatapos ang envelope

CCInfos

array

false

Koleksyon ng impormasyon ng mga kopya

userEmail

string

false

Email address ng mga kopya

userName

string

false

Pangalan ng kopya, ginagamit sa pahina ng pag-sign at sa panlabas na ipinapakita ng envelope para sa pangalan ng kopya.

[Paalala]: Hindi dapat maglaman ng sumusunod na 9 espesyal na character: / \ : * " < > | ? at lahat ng emoji

customizeSettings

object

false

Custom na configuration

notificationSettings

object

false

Custom na configuration para sa notification

notificationLanguage

string

false

Wika ng notification, default na kinukuha mula sa 'default na wika ng notification' configuration

en-US Ingles

zh-CN Simplified Chinese

zh-Hant Traditional Chinese

ja-JP Hapon

es-MX Espanyol

pt-PT Portuges
th-TH Thai
id-ID Indones
vi-VN Wikang Vietnamese
ms-MY Wikang Malay
fil-PH Wikang Filipino
de-DE Wikang Aleman
fr-FR Wikang Pranses
ru-RU Wikang Ruso
it-IT Wikang Italyano
ko-KR Wikang Koreano

signFiles

array

true

Koleksyon ng impormasyon ng mga dokumentong isinusulat, ipinapakita ayon sa pagkakasunod-sunod ng pagdaragdag ng dokumento.

fileKey 

string

true

fileKey ng dokumentong isinusulat, suportado lamang ang format na PDF

attachments

array

false

Koleksyon ng mga attachment ng envelope, ipinapakita ayon sa pagkakasunod-sunod ng pagdaragdag ng dokumento.

fileKey 

string

false

fileKey ng dokumento

signerInfos

array

true

Koleksyon ng impormasyon ng tagapirmahan

businessId

string

false

Custom na business number ng developer, limitasyon ng haba 500

roleTypes

array

false

Paraan ng operasyon ng tagapirmahan, default na halaga ay ["sign", "fill"]

fill-Ilagay

sign-Pirmahan

string

false

Paraan ng abiso, default na auto

auto-Kapag ipinapasa ang userEmail, magpapadala ng email notification; kapag ipinapasa ang phoneNumber, magpapadala ng SMS notification

none-Hindi magpapadala ng mensaheng abiso

email-Magpapadala ng email notification

sms-Magpapadala ng SMS notification

WhatsApp-Magpapadala ng WhatsApp notification

userEmail

string

false

Email address ng tagapirmahan

userName

string

true

Pangalan ng tagapirmahan, ginagamit sa pahina ng pagpirmahan at sa labas ng envelope upang ipakita ang pangalan ng tagapirmahan.

[Tandaan] Huwag maglaman ng sumusunod na 9 espesyal na karakter: / \ : * " < > | ? at lahat ng emoji

phoneNumber

object

false

Numero ng telepono, walang laman bilang default

Kailangan isagawa kapag kailangan ng SMS na paalala; ang countryCode at number ay parehong kailangang ipasa

countryCode

string

false

International code ng bansa o rehiyon; huwag ipasa ang "+"

number

string

false

Walang format validation, limitado lamang sa maximum na haba na 13 character

customizeSettings

object

false

Custom configuration

notificationSettings

object

false

Custom configuration para sa mga notification

customizeMessage

string

false

Espesyal na mensahe ng notification, limitasyon sa 200 character

notificationLanguage

string

false

Wika ng notification, default na kinukuha mula sa configuration na "Default na wika ng notification"

en-US Ingles

zh-CN Simplified Chinese

zh-Hant Traditional Chinese

ja-JP Hapon

es-MX Espanyol

pt-PT Portuges
th-TH Thai
id-ID Indonesian
vi-VN Vietnamese
ms-MY Malay
fil-PH Filipino
de-DE German
fr-FR French
ru-RU Russian
it-IT Italian
ko-KR Korean

signOrder

int

true

Sunod-sunod na pagpirma ng mga tagapirmahan, pinakamababa ay 1. Maaaring magtakda ng parehong halaga ng sunod-sunod para sa walang order na pagpirma.

anySigner

boolean

false

Suportado ba ang anumang tao na pumirma, default false

true- Para sa iisang signOrder, sapat na isang tao lamang na pumirma

false- Para sa iisang signOrder, kailangan lahat ng tao na pumirma

authModes

string

false

Paraan ng pagpapatunay, default noAuth

noAuth- Walang pagpapatunay

accessCode-Gamit ang pagpapatunay ng password sa pag-sign

sms-Pagpapatunay ng SMS OTP

idVerification-Pagpapatunay ng ID

emailAuth-Pagpapatunay ng email OTP

digitalId-Digital na pagpapatunay ng identidad

whatsappAuth-Pagpapatunay ng WhatsApp OTP

authConfig

object

false

Mga Setting para sa Paraan ng Pagpapatunay

accessCode

object

false

Setting ng password sa pag-sign, kapag authModes=accessCoderequired

accessCode

string

false

Nilalaman ng password, hindi sensitive sa case, maaaring maglaman ng alphanumeric, limitasyon ng haba ay 45

promptInfo

string

false

Paalala para sa access password, hindi dapat kasama ang access password, limitasyon ng haba ay 30, kapag authModes=accessCoderequired.  

sms

object

false

Pagsusuri ng SMS OTP, kapag authModes=smsrequired

countryCode

string

false

International code ng bansa o rehiyon, huwag isama ang '+'

number

string

false

Hindi mag-validate ng format, limitahan lamang ang haba na maximum ay 13 digit

idVerification

object

false

Mga setting para sa pagpapatunay ng ID, kapag authModes=idVerificationrequired

name

string

false

Buong pangalan sa ID card ng tagapirmian, maximum na haba ay 100 character

emailAuth

object

false

Pagpapatunay ng OTP sa email, kapag authModes=emailAuthrequired

authEmail

string

false

Email address para sa pagpapatunay ng identidad ng tagapirmian

digitalId

array

false

Digital identity verification, required kapag authModes=digitalId

authApp

string

false

App na ginagamit para sa digital identity verification

singpass-Gamitin ang Singpass para sa pagpapatunay ng identidad

iamsmart-Gamitin ang i AM Smart para sa pagpapatunay ng identidad

idNumber

string

false

Numero ng ID card ng tagapirmian na kailangan ipatunay

Kapag authApp=singpassAng rule ng pagpasok: uppercase letter + 7 o 8 digit number + uppercase letter

Kapag authApp=iamsmartoras, ang ipinapasa na patakaran ay:

1. Isang malaking titik (A-Z), o dalawang malaking titik (AA-ZZ), bilang simula ng serye;

2. Sinundan ng anim na digit;

3. Sa huli, isang check code, maaaring numero (0-9) o letra (A-Z). Halimbawa: A888888(A)

whatsappAuth

object

false

WhatsApp OTP verification, kinakailangan kapag authModes=whatsappAuth

countryCode

string

false

Internasyonal na code ng bansa/rehiyon, hindi kailangang magpasok ng "+"

number

string

false

Walang format validation, limitado lamang sa maximum na haba na 13 na digit

digitalSignature

boolean

false

Kung ito ay nagpapagana ng digital signature, default false

true-nagpapagana, false-hindi nagpapagana

freeFormSign

boolean

false

Kung ang tagapirmahan ay may kalayaan sa paglagay ng seal, default value false

Karagdagang paliwanag:

Kapag pinili ang freeFormSign=true, hindi na kailangang magpasok ng iba pang parameter sa ilalim ng sealInfos. Kung sabay-sabay na ipinasok, mas mataas ang priority ng freeFormSign kaysa sa sealInfos, at hindi gagana ang mga parameter sa ilalim ng sealInfos

[Paalala]Ang libreng pag-sign ay nangangahulugang walang limitasyon sa bilang at posisyon ng mga tatak/signature na maaaring i-drag ng tagapirmahan

sealInfos

array

false

Impormasyon tungkol sa gawain ng pag-sign

fileKey

string

true

I-sign ang fileKey ng dokumento

signConfigs

array

false

Impormasyon sa lokasyon ng kontrol, kailangang tukuyin ang impormasyon sa lokasyon ng kontrol upang makagawa ng electronic signature.

fieldType

string

false

Uri ng kontrol, default na signature

signature-Kontrol para sa pag-sign

stamp-Kontrol para sa seal

approval-Kontrol para sa approval

required

boolean

Kung required o hindi, default na required

true-Required

false-Hindi required

signFieldStyle

string

false

Paraan ng paglalagay ng seal sa kontrol para sa pag-sign, default na normalSeal.

normalSeal-Karaniwang seal

pagingSeal-Edge seal

Ang edge seal ay suportado lamang sa mga kontrol para sa pag-sign at seal.

pagingSealMode

string

false

Saklaw ng pahina para sa paglalagay ng edge seal, default na all.

all-Lahat ng mga numero ng pahina

assignedPages-Tukuyin ang pahina

even-Parehong bilang na mga pahina

odd-Kakaiba na bilang na mga pahina

Suportado lamang kapag signFieldStyle=pagingSeal.

sizeRule

string

false

Paraan ng pagpapakita ng sukat ng lugar ng pag-sign

originalSize-Ilagay ang tatak base sa aktwal na sukat ng lagda/tatak

targetSize-I-customize ang lapad at taas ng lugar ng lagda/tatak

Kapag walang halaga sa sizeRule, height, at width, ilalagay ang tatak base sa aktwal na sukat ng lagda/tatak;

Kapag walang halaga sa sizeRule pero may halaga sa height at width, ilalagay ang tatak base sa tinukoy na sukat;

Kapag may halaga sa sizeRule, ilalagay ang tatak base sa tinukoy na paraan ng pagpapakita;

Hindi kailangang tukuyin ang parameter na ito para sa paging seal; ilalagay lamang base sa aktwal na sukat.

height

int

false

Taas ng kontrol sa pag-sign, para sa fieldType na signature/stamp, nasa px, lamang positibong integer ang suportado, default ay auto (awtomatikong sukat ng sistema);

Kapag fieldType=signature, ang saklaw ng setting ay 20-250px;

Kapag fieldType=stamp, ang saklaw ng setting ay 30-280px;

Hindi kailangang tukuyin ang parameter na ito para sa paging seal.

width

int

false

Lapad ng lapad ng kontrol sa pag-sign, na angkop kapag ang fieldType ay signature/stamp, ang unit ay px, lamang ang mga positibong integer ang suportado, default na auto (kung saan awtomatikong itatakda ng sistema ang sukat);

Kapag ang fieldType=signature, ang sakop ng pag-set ay 20-250px;

Kapag ang fieldType=stamp, ang sakop ng pag-set ay 30-280px;

Hindi kailangang itakda ang parameter na ito para sa seal na nakasakay sa gilid.

signatureOptions

string

false

Mga opsyon ng kontrol sa pag-sign. Angkop lamang kapag ang fieldType ay signature

Maaaring ipasok:

template: Signature mula sa template

handDrawn: Hand-drawn na signature

upload: I-upload ang larawan ng signature mula sa lokal na device

Maaaring pumili ng maramihan, hiwalayan gamit ang ",", default na lahat ay napipili

movable

boolean

false

Pinahihintulutan ang paggalaw ng posisyon habang nagse-sign, default na false

false-Hindi pinahihintulutan ang taga-sign na baguhin ang posisyon ng kanyang sariling kontrol sa pag-sign

true-Pinahihintulutan ang taga-sign na baguhin ang posisyon ng kanyang sariling kontrol sa pag-sign

allowedOptions

array

false

Mga opsyon na pinahihintulutan ang taga-sign na mag-apruba, angkop kapag ang fieldType ay approval. Default na ["approve", "decline"]

approve-Tumugon

decline-Tanggihan

pageNo

string

false

Pahina ng pagpirma; ang mga sunod-sunod na pahina ay idinadagdag gamit ang "-", at ang hiwalay na pahina ay hinati gamit ang ","

Halimbawa: 1-3,6-10

Kapag ang pagingSealMode=assignedPages, ipasa ang sakop ng mga pahina kung saan ilalagay ang seal sa gilid

posX

float

false

Koordinado sa x-axis

[Paalala] Kung ang fieldType ay signature, ang lokasyon ng koordinado ay tumutukoy sa lugar ng pirmaKaliwang ibaba；

Kung ang fieldType ay stamp, ang lokasyon ng koordinado ay tumutukoy sa lugar ng stampGitnang puntoLokasyon

Mula Pebrero 3, 2026, kapag ang fieldType ay signature o stamp, ang lokasyon ng koordinado ay tumutukoy sa gitnang punto ng lugar ng stamp.

Para sa seal sa gilid, maaaring ipasa ang 0, hindi maaaring ipasa ang null, at kontrolado ito sa kanang gilid ng file.

posY

float

false

Koordinado sa y-axis

[Paalala] Kung ang fieldType ay signature, ang lokasyon ng koordinado ay tumutukoy sa lugar ng pirmaKaliwang ibaba；

Kung ang fieldType ay stamp, ang posisyon ng koordinado ay tumutukoy sa gitnang punto ng lugar ng pag-stamp.Gitnang PuntoPosisyon

Mula Pebrero 3, 2026, kung ang fieldType ay signature o stamp, ang posisyon ng koordinado ay tumutukoy sa gitnang punto ng lugar ng pag-stamp.

fillConfigs

array

false

Punan ang impormasyon ng control

fieldName

string

false

Pangalan ng control, limitasyon ng karakter na 128

required

boolean

false

Kailangan ba itong punan, default ay kailangan

true - Kailangan

false - Hindi kailangan

fieldType

string

false

Uri ng control:

1 - Single-line text

15 - Checkbox

textField

object

false

Atributo ng text control

overflowType

int

false

Gumagana lamang para sa text, default na 1

1 - Awtomatikong pababaan ang laki ng font

2-Limit input

minFontSize

float

false

Only applies to text, only applies when overflowType=1, default is 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

Control width, default is 160px

font

int

false

Only applies to text, font, default is 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

Only applies to text, font size, default is 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

Only applies to text, hexadecimal color, default is black #000

bold

boolean

false

Only applies to text, whether the font is bold, default is false

true-Bold

false-Not bold

italic

boolean

false

Only applies to text, whether it is italic, default is false

true-maita

false-hindi maita

underline

boolean

false

Nag-e-apply lamang sa text, kung may underline o hindi, default false

true-add ng underline

false-wag magdagdag ng underline

lineThrough

boolean

false

Nag-e-apply lamang sa text, kung may strikethrough o hindi, default false

true-add ng strikethrough

false-wag magdagdag ng strikethrough

horizontalAlignment

string

false

Nag-e-apply lamang sa text, horizontal alignment format, default left

LEFT-align sa kaliwa

CENTER-align sa gitna

RIGHT-align sa kanan

tickBoxField

object

false

Mga katangian ng checkbox

tickOptions

array

false

Nag-e-apply lamang sa tickBox, default 1

1-checked

2-branch

posX

float

false

X-coordinate ng posisyon ng kontrol

posY

float

false

Y-coordinate ng posisyon ng kontrol

pageNo

string

false

Numero ng pahina kung saan matatagpuan ang kontrol

signDateConfigs

array

false

Impormasyon ng posisyon ng petsa ng pag-sign

movable

boolean

false

Pinapayagan na ilipat ang posisyon habang nagse-sign, default ay false

false-hindi pinapayagan ang tagapagsign na ayusin ang sariling posisyon ng kontrol sa pag-sign

true-pinapayagan ang tagapagsign na ayusin ang sariling posisyon ng kontrol sa pag-sign

pageNo

string

false

Numero ng pahina para sa pag-sign; magkabit na mga numero ng pahina ay hinahati gamit ang "-", hiwalay na mga numero ng pahina ay hinahati gamit ang ",", halimbawa: 1-3, 6-10;

Kung hindi magkabit, ipasa ang "," upang hatiin.

posX

float

false

Offset sa x-axis, ang kaliwang ibaba ng pahina ang pinagmulan ng koordinado

posY

float

false

Offset sa y-axis, ang kaliwang ibaba ng pahina ang pinagmulan ng koordinado

signDateFormat

string

false

Format ng petsa ng pag-sign, default na format ay yyyy-MM-dd

Suportado ang espesipikong format:

yyyy taon MM buwan dd araw

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MMM dd,yyyy

dd MMM yyyy

Pangalan ng Parameter

Uri

Paliwanag

envelopeId

string

ID ng Balita

CCInfos

array

Koleksyon ng Impormasyon ng mga Naka-Cc

userEmail

string

Email Address ng Naka-Cc

userName

string

Pangalan ng Naka-Cc

signFiles

array

Koleksyon ng Impormasyon ng mga Inilalagdaang Dokumento

fileKey

string

fileKey ng Inilalagdaang Dokumento

attachments

array

Koleksyon ng mga Attachment ng Balita

fileKey

string

fileKey ng Dokumento

signerInfos

array

Impormasyon ng Paglagda

recipientId

string

ID ng Naglagda

businessId

string

Ang developer ay nagde-define ng custom na business ID, may limit sa haba na 500

userEmail

string

Email address ng tagapirmahan

userName

string

Pangalan ng tagapirmahan

signOrder

int

Sunod-sunod na pagkakasunod ng pag-sign ng tagapirmahan, ang pinakamababa ay 1

accessCode

string

Password para sa access sa pahina ng pag-sign