Magdagdag ng Tagapirmá

Pangalan ng Parameter

Uri

Kailangan

Paliwanag

envelopeId

string

true

ID ng Envelope

signerInfos

array

true

Koleksyon ng impormasyon ng mga tagapirm

businessId

string

false

Custom na business ID ng developer, haba 500

roleTypes

array

false

Paraan ng operasyon ng tagapirm, default value ay ["sign", "fill"]

fill-punan

sign-pirmahan

string

false

userEmail

string

false

Email address ng tagapirm

documentVisibility

object

false

Konpigurasyon sa visibility ng file, kung saan lahat ay visible nang default.

documentViewType

string

false

Patakaran sa visibility, default na 'all'; ang 'all' ay nangangahulugang maaaring tingnan ang lahat ng mga nakapirming dokumento sa loob ng envelope, habang ang 'limited' ay nangangahulugang maaaring tingnan lamang ang sariling mga nakapirming dokumento at ang mga karagdagang dokumentong may pinagbubukod na visibility.

viewableFileKeys

array

false

Listahan ng mga fileKey na idinadagdag na pinayayari para tingnan ng tagapirma; pinapayagan lamang ipasok at aktibo kapag documentViewType=limited.

phoneNumber

object

false

Kailangan kapag kailangan ng SMS notification; parehong kailangang magpasok ng countryCode at number, default na walang laman.

countryCode

string

false

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

number

string

false

Walang format validation, maximum na haba ay 13 character.

customizeSettings

object

false

Custom configuration

notificationSettings

object

false

Custom configuration para sa mga notification

customizeMessage

string

false

Espesyal na mensahe sa notification, limitasyon sa character ay 200.

notificationLanguage

string

false

Wika ng notification, default na kinukuha mula sa konfigurasyon ng '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 Taylandes
id-ID Indonesyo
vi-VN Vietnames
ms-MY Malay
fil-PH Pilipino
de-DE Aleman
fr-FR Pranses
ru-RU Ruso
it-IT Italyano
ko-KR Koreano

userName

string

true

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

【Paalala】Hindi dapat maglaman ng mga sumusunod na 9 espesyal na karakter: / \ : * " < > | ? at lahat ng emoji

signOrder

int

true

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

signTaskSuspend

boolean

false

Ibigay ang pagtatakda ng node ng paghahadlang sa proseso bago ang posisyon ng pagpirma, na may default na false. true- Magtakda ng node ng paghahadlang; false- Huwag magtakda ng node ng paghahadlang. Ang mga konfigurasyon ng paghahadlang sa loob ng grupo ng o-sign na may parehong signOrder ay dapat magkapareho.

suspensionKey

string

false

Ang identifier ng node ng paghahadlang, na may maximum na 500 na karakter, at kailangang natatangi sa loob ng parehong envelope. Kailangan ito kapag signTaskSuspend=true; hindi dapat ipasa kapag signTaskSuspend=false o walang ipasa.

suspendReason

string

false

Ang dahilan ng paghahadlang, hindi maaaring walang laman kapag ipinapasa, na may maximum na 50 na karakter. Maaaring ipasa lamang kapag signTaskSuspend=true; kapag hindi ipinasa, ang default ay nangangahulugang kailangang hintayin ang proseso ng external system. Hindi dapat ipasa kapag signTaskSuspend=false o walang ipasa.

anySigner

boolean

false

Tukuyin kung sinuman pa lang ang maaaring sumailalim sa pagpirma, na may default na false

true- Sa parehong signOrder, sapat na isang tao lamang ang sumailalim sa pagpirma

false- Sa parehong signOrder, lahat ng tao ay kailangang sumailalim sa pagpirma

authModes

string

false

Paraan ng pagpapatunay ng identidad, na may default na noAuth

Uri ng enum:

authConfig

object

false

Pag-set ng Paraan ng Pagpapatunay

accessCode

object

false

Pag-set ng Passphrase, kapag ang authModes=accessCodeay kinakailangan

accessCode

string

false

Nilalaman ng passphrase, hindi nag-iiba sa pagkapareho ng malalaki at maliit na titik, maaaring maglaman ng mga letra at numero, haba ay 45

promptInfo

string

false

Paalala para sa access passphrase, hindi maaaring maglaman ng access passphrase, limitasyon sa haba ay 30, kapag ang authModes=accessCodeay kinakailangan.

sms

object

false

SMS OTP verification, kapag ang authModes=smsay kinakailangan

countryCode

string

false

International code ng bansa o rehiyon, walang kailangang dagdagan ng “+”

number

string

false

Walang format validation, maximum na haba ay 13 digit

idVerification

object

false

Pag-set ng Verification ng ID Card, kapag ang authModes=idVerificationay kinakailangan

name

string

false

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

emailAuth

object

false

Email OTP verification, kapag ang authModes=emailAuthay kinakailangan

authEmail

string

false

Email address para sa pagpapatunay ng identidad ng nag-sign

digitalId

array

false

Elektronikong pagpapatunay ng identidad, kailangan kapag authModes=digitalId

authApp

string

false

APP na ginagamit sa elektronikong pagpapatunay ng identidad

singpass-Paggamit ng Singpass para sa pagpapatunay ng identidad

iamsmart-Paggamit ng MyInfo para sa pagpapatunay ng identidad

idNumber

string

false

Numero ng ID card ng nag-sign na nasa hinihintay na pagpapatunay

Kapag authApp=singpass, ang format ng input ay: uppercase letter + 7 o 8 digit number + uppercase letter

Kapag authApp=iamsmart, ang format ng input ay:

1. Isang uppercase letter (A-Z), o dalawang uppercase letters (AA-ZZ), bilang simula ng sequence;

2. Sinundan ng 6 digit number;

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

whatsappAuth

object

false

WhatsApp OTP verification, kailangan kapag authModes=whatsappAuth

countryCode

string

false

International code ng bansa/rehiyon, huwag ipasok ang '+'

number

string

false

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

digitalSignature

boolean

false

Iba-iba kung i-e-enable ang digital signature, default false

true- I-e-enable

false- Hindi i-e-enable

tsp

string

false

Pumili ng TSP na gagamitin ng tagapirmian, default false.

Kapag hindi itinakda, pipiliin ng tagapirmian ang kailangang gamiting TSP. Kasama sa enumeration:

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

Kung may kalayaan ba ang tagapirmian na gumawa ng sariling tatak/pirma, default value false

Karagdagang paliwanag:

Kapag napili ang freeFormSign bilang true, hindi na kailangan ipasa ang iba pang parameter sa ilalim ng sealInfos. Kung sabay-sabay ipinasa, mas mataas ang priority ng freeFormSign kaysa sa sealInfos, at hindi gagana ang mga parameter sa ilalim ng sealInfos.

[Paalala] Ang free form sign ay nangangahulugang walang limitasyon sa bilang at posisyon ng mga tatak/pirma na maaaring isingit ng tagapirmian.

sealInfos

array

false

Impormasyon tungkol sa task ng pagpirma

fileKey

string

true

fileKey ng dokumentong pirman

signConfigs

array

false

Impormasyon tungkol sa lokasyon ng control, kailangang tukuyin ang lokasyon ng control bago makapaglagay ng electronic signature.

fieldType

string

false

Uri ng control, maaaring ipasa:

signature- Control para sa pirma

stamp-Kontrol ng tatak

Default ay signature

Kung kinakailangan o hindi, default ay kinakailangan

true-Kinakailangan

false-Hindi kinakailangan

signFieldStyle

string

false

Paraan ng paglalagay ng tatak sa kontrol ng pag-sign, default ay normalSeal.

normalSeal-Karaniwang tatak at pirma

pagingSeal-Tatak sa gilid ng pahina

Ang kontrol ng tatak at kontrol ng pirma lamang ang sumusuporta sa pag-set ng tatak sa gilid ng pahina.

pagingSealMode

string

false

Saklaw ng mga pahina para sa paglalagay ng tatak sa gilid ng pahina, default ay all.

all-Lahat ng numero ng pahina

assignedPages-Itinakdang numero ng pahina

even-Mga even na pahina

odd-Mga odd na pahina

Suportado ang pagtukod lamang kung 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- Custom na lapad at taas ng lugar ng lagda/tatak

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

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

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

Hindi kinakailangang 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,适用于 fieldType na signature/stamp, nasa px ang yunit, suportado lamang ang positibong integer bilang input, default ay auto (automatic na sukat ng sistema);

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

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

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

width

int

false

Lapad ng kontrol sa pag-sign,适用于 fieldType na signature/stamp, nasa px ang yunit, suportado lamang ang positibong integer bilang input, default ay auto (automatic na sukat ng sistema);

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

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

Hindi kailangan ang seal sa pagkakabit na ito para sa parameter na ito.

signatureOptions

string

false

Mga opsyon ng control ng lagda. Ito ay lamang para sa fieldType na signature.

Maaaring ipasok:

template

handDrawn

upload

aiHandDrawn

Maaaring pumili nang maramihan, hiwalayin gamit ang ",", default ay lahat

movable

boolean

false

Pinapayagan ang paggalaw ng posisyon habang nagsusulat, default ay false

false-Hindi pinapayagan ang tagapirming baguhin ang posisyon ng kanyang sariling control ng lagda

true-Pinapayagan ang tagapirming baguhin ang posisyon ng kanyang sariling control ng lagda

allowedOptions

array

false

Mga opsyon para sa pagpapatunay ng tagapirming, para sa fieldType na approval. Default ay ["approve", "decline"]

approve-Tugunan

decline-

pageNo

string

false

Pahina ng pagpirma; ang magkasunod na mga pahina ay hinati ng "-", at ang hiwalay na mga pahina ay hinati ng ",", halimbawa: 1-3, 6-10

Ipagbigay ang saklaw ng mga pahina kung saan ilalagay ang seal sa pagkakabit kapag pagingSealMode=assignedPages. Ang seal sa pagkakabit ay maaari lamang gamitin sa mga dokumentong may higit sa isang pahina.

posX

string

false

Koordinado sa X-axis

Karagdagang paliwanag:

Kung ang fieldType ay signature, ang koordinadong posisyon ay tumutukoy sa lugar ng lagdakaliwa sa ibaba；

Kung ang fieldType ay stamp, ang coordinate position ay tumutukoy sa gitnang posisyon ng stamp area.Gitnang puntoPosisyon

Mula Pebrero 3, 2026, kung ang fieldType ay signature o stamp, ang coordinate position ay tumutukoy sa gitnang posisyon ng stamp area.

Ang cross-page seal (骑缝章) ay maaaring magpadala ng 0, hindi pwedeng null; ang control ay nakafix sa kanang gilid ng file.

posY

string

false

Coordinate sa Y-axis

Karagdagang paliwanag:

Kung ang fieldType ay signature, ang coordinate position ay tumutukoy sa gitnang posisyon ng signature area.kaliwa sa ibaba；

Kung ang fieldType ay stamp, ang coordinate position ay tumutukoy sa gitnang posisyon ng stamp area.Gitnang puntoPosisyon

Mula Pebrero 3, 2026, kung ang fieldType ay signature o stamp, ang coordinate position ay tumutukoy sa gitnang posisyon ng stamp area.

fillConfigs

array

false

Punan ang impormasyon ng control

fieldName

string

false

Pangalan ng kontrol, limitasyon sa bilang ng karakter na 128

required

boolean

false

Kailangan ba ito, default ay kailangan

true-kailangan

false-hindi kailangan

fieldType

string

false

Uri ng kontrol:

1-isang linya ng teksto

15-checkbox

textField

object

false

Mga katangian ng text control

overflowType

int

false

Gumagana lamang para sa text, default 1

1-awtomatikong pagpapaliit ng laki ng font

2-paglimita ng input

minFontSize

float

false

Gumagana lamang para sa text, gumagana lamang kapag overflowType=1, default 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

Lapad ng kontrol, default 160px

font

int

false

Gumagana lamang para sa text, font, default Songti.

1-Songti

2-Songti

4-Heiti

5-Kaiti

6-Arial

7-Helvetica

9-Times New Roman

10-Fangsong

11-Georgia

12-Monospace

fontSize

float

false

Nakakaapekto lamang sa text, laki ng font, default 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

Nakakaapekto lamang sa text, kulay na hexadecimal, default itim #000

bold

boolean

false

Nakakaapekto lamang sa text, kung bold ang font, default false

true-bold

false-hindi bold

italic

boolean

false

Nakakaapekto lamang sa text, kung italic ang font, default false

true-italic

false-hindi italic

underline

boolean

false

Nakakaapekto lamang sa text, kung may underline ang font, default false

true-magdagdag ng underline

false-hindi magdagdag ng underline

lineThrough

boolean

false

Gumagana lamang sa text, kung magdagdag ng strikethrough, default false

true-dagdag ang strikethrough

false-huwag dagdagan ng strikethrough

horizontalAlignment

string

false

Gumagana lamang sa text, format ng horizontal na pagkakentrong, default left

LEFT- kaliwa

CENTER- gitna

RIGHT- kanan

tickBoxField

object

false

Mga katangian ng checkbox

tickOptions

array

false

Gumagana lamang sa Check, default 1

1-tanda

2-x

posX

float

false

X-coordinate ng posisyon ng control

posY

float

false

Y-coordinate ng posisyon ng control

pageNo

string

false

Numero ng pahina kung saan matatagpuan ang control

signDateConfigs

array

false

Impormasyon ng posisyon ng petsa ng pag-sign

movable

boolean

false

Pinagpapahintulutan ang paggalaw ng posisyon sa panahon ng pag-sign, default ay false

false-Hindi pinapayagan ang taga-sign na baguhin ang posisyon ng kanyang mga widget sa pag-sign

true-Pinapayagan ang taga-sign na baguhin ang posisyon ng kanyang mga widget sa pag-sign

pageNo

string

false

Mga pahina para sa pag-sign; ang magkasunod na mga pahina ay hinahati gamit ang "-", at ang hiwalay na mga pahina ay hinahati gamit ang ",", halimbawa: 1-3, 6-10

Kung hindi magkasunod, 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, ang 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

MM dd yyyy

dd MM yyyy