Certinal eSign (preview)
Met Certinal eSign kunnen ondernemingen veilig documenten verzenden, ondertekenen en beheren met wereldwijd compatibele eSignatures. Certinal is ontworpen voor gereguleerde branches en biedt realtime werkstroomtracking, controlepaden voor manipulatiecontrole en naadloze automatisering. Gebruik Certinal eSign in uw werkstromen om goedkeuringen te digitaliseren, processen te versnellen en wettelijk geldige handtekeningen in meer dan 70 landen te garanderen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Help en ondersteuning |
| URL | https://www.certinal.com/department/esignature-for-support |
| E-mailen | tech-support@certinal.com |
| Connector-metagegevens | |
|---|---|
| Uitgever | Certinal Inc. |
| Webpagina | https://www.certinal.com/ |
| Privacybeleid | https://www.certinal.com/privacy-policy |
| Categorieën | Productiviteit; Bedrijfsbeheer |
Certinal eSign
Overzicht
Certinal eSign biedt u een veilige, compatibele eSignature- en eConsent-werkstromen voor wereldwijde ondernemingen: documenten rechtstreeks verzenden, ondertekenen, bijhouden en beheren vanuit Power Automate.
Vereiste voorwaarden
U moet een Certinal Admin-account hebben om de connectortrigger te kunnen gebruiken. Als u de connectortrigger in deze integratie wilt gebruiken, moet Power Connector zijn ingeschakeld in de certinal-beheerinstellingen.
Referenties ophalen
Certinal gebruikt API-sleutel om de services te verifiëren. U moet de API-sleutel genereren vanuit het Certinal Admin-account.
Ondersteunde bewerkingen
De connector ondersteunt de volgende bewerkingen:
Transactiedetails ophalen
Transactiegegevens ophalen op transactie-id
Documenten voor transactie downloaden
Documenten voor de opgegeven transactie-id downloaden
Transactie maken
Transactie maken
Transactie maken met behulp van sjabloon
Transactie maken met behulp van een bepaalde sjabloon-id
Gebruikers weergeven
Gebruikers weergeven
Gebruikersdetails ophalen
Gebruikersgegevens ophalen voor de opgegeven gebruikers-id
Gebruiker maken
Gebruiker maken
Ondersteunde triggers
De connector ondersteunt de volgende triggers:
Wanneer een transactiestatus wordt gewijzigd
Een callback registreren voor een bepaalde transactie gebeurtenis
API-documenten:
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
Help en ondersteuning
https://esign.certinal.com/esign/certinal-docs/help-support
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Type | Description | Verplicht |
|---|---|---|---|
| API-sleutel | beveiligde string | De API-sleutel voor deze API | Klopt |
| Basis-API-eindpunt | touw | De basis-URL voor het API-eindpunt (bijvoorbeeld api.certinal.com) | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Abonnement verwijderen |
Abonnement verwijderen |
| Documenten voor transactie downloaden |
Documenten voor de opgegeven transactie-id downloaden |
| Gebruiker maken |
Gebruiker maken |
| Gebruikers weergeven |
Gebruikers weergeven |
| Gebruikersdetails ophalen |
Gebruikersgegevens ophalen voor de opgegeven gebruikers-id |
| Transactie maken |
Transactie maken |
| Transactie maken met behulp van sjabloon |
Transactie maken met behulp van een bepaalde sjabloon-id |
| Transactiedetails ophalen |
Transactiegegevens ophalen op transactie-id |
Abonnement verwijderen
Abonnement verwijderen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Webhook-id
|
webhookId | True | string |
De unieke id van het webhook-abonnement dat u wilt verwijderen |
Documenten voor transactie downloaden
Documenten voor de opgegeven transactie-id downloaden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Transactie-id
|
transactionId | True | string |
De unieke transactie-id |
|
Documenttype
|
documentType | True | string |
Type document dat moet worden gedownload |
Retouren
- response
- file
Gebruiker maken
Gebruiker maken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
E-mailadres
|
emailAddress | string |
E-mailadres |
|
|
Voornaam
|
firstName | string |
Voornaam |
|
|
Achternaam
|
lastName | string |
Achternaam |
|
|
Bedrijf
|
company | string |
Bedrijf |
|
|
Tijdzone
|
timezone | string |
Tijdzone |
|
|
Language
|
language | string |
Language |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Groet
|
salutation | string |
Groet |
|
|
Functietitel
|
jobTitle | string |
Functietitel |
|
|
Telefoonnummer
|
phoneNumber | string |
Telefoonnummer |
|
|
Landcode
|
phoneCountryCode | string |
Landcode |
|
|
Rollen
|
roles | array of string |
Rollen |
|
|
Is definitieve e-mail uitgeschakeld?
|
finalMailDisabled | boolean |
Is definitieve e-mail uitgeschakeld? |
|
|
Is Herinneringsmail uitgeschakeld?
|
reminderMailDisabled | boolean |
Is Herinneringsmail uitgeschakeld? |
|
|
Is e-mail van afzender uitgeschakeld?
|
senderMailDisabled | boolean |
Is e-mail van afzender uitgeschakeld? |
|
|
Is integratiegebruiker?
|
integrationUser | boolean |
Is integratiegebruiker? |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Tijdstempel
|
timestamp | integer |
Tijdstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Message
|
message | string |
Message |
|
Gebruikers-ID
|
data.user_id | string |
Gebruikers-ID |
Gebruikers weergeven
Gebruikers weergeven
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Paginanummer
|
pageNo | True | integer | |
|
Records per pagina
|
perPageRecords | True | integer |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Tijdstempel
|
timestamp | integer |
Tijdstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Message
|
message | string |
Message |
|
Totaal aantal records
|
data.totalRecords | integer |
totaal aantal records |
|
Totaal aantal pagina's
|
data.totalPages | integer |
Totaal aantal pagina's |
|
Records per pagina
|
data.perPageRecords | integer |
Records per pagina |
|
Paginanummer
|
data.pageNo | integer |
Paginanummer |
|
Gegevens
|
data.records | array of object |
Gebruikersrecords |
|
Voornaam
|
data.records.firstName | string |
Voornaam |
|
Achternaam
|
data.records.lastName | string |
Achternaam |
|
Bedrijf
|
data.records.company | string |
Bedrijf |
|
Tijdzone
|
data.records.timezone | string |
Tijdzone |
|
Language
|
data.records.language | string |
Language |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
Functietitel
|
data.records.jobTitle | string |
Functietitel |
|
Telefoonnummer
|
data.records.phoneNumber | string |
Telefoonnummer |
|
Landcode
|
data.records.phoneCountryCode | string |
Landcode |
|
Rollen
|
data.records.roles | array of string |
Rollen |
|
Is definitieve e-mail uitgeschakeld?
|
data.records.finalMailDisabled | boolean |
Is definitieve e-mail uitgeschakeld? |
|
Is Herinneringsmail uitgeschakeld?
|
data.records.reminderMailDisabled | boolean |
Is Herinneringsmail uitgeschakeld? |
|
Is e-mail van afzender uitgeschakeld?
|
data.records.senderMailDisabled | boolean |
Is e-mail van afzender uitgeschakeld? |
|
Is integratiegebruiker?
|
data.records.integrationUser | boolean |
Is integratiegebruiker? |
|
Groet
|
data.records.salutation | string |
Groet |
|
Is actief
|
data.records.active | boolean |
Is actief |
|
Identiteitsbewijs
|
data.records.id | string |
Identiteitsbewijs |
|
E-mailadres
|
data.records.emailAddress | string |
E-mailadres |
Gebruikersdetails ophalen
Gebruikersgegevens ophalen voor de opgegeven gebruikers-id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebruikers-ID
|
userId | True | string |
De unieke gebruikers-id |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Tijdstempel
|
timestamp | integer |
Tijdstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Message
|
message | string |
Message |
|
Voornaam
|
data.firstName | string |
Voornaam |
|
Achternaam
|
data.lastName | string |
Achternaam |
|
Bedrijf
|
data.company | string |
Bedrijf |
|
Tijdzone
|
data.timezone | string |
Tijdzone |
|
Language
|
data.language | string |
Language |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
Functietitel
|
data.jobTitle | string |
Functietitel |
|
Telefoonnummer
|
data.phoneNumber | string |
Telefoonnummer |
|
Landcode
|
data.phoneCountryCode | string |
Landcode |
|
Rollen
|
data.roles | array of string |
Rollen |
|
Is definitieve e-mail uitgeschakeld?
|
data.finalMailDisabled | boolean |
Is definitieve e-mail uitgeschakeld? |
|
Is Herinneringsmail uitgeschakeld?
|
data.reminderMailDisabled | boolean |
Is Herinneringsmail uitgeschakeld? |
|
Is e-mail van afzender uitgeschakeld?
|
data.senderMailDisabled | boolean |
Is e-mail van afzender uitgeschakeld? |
|
Is integratiegebruiker?
|
data.integrationUser | boolean |
Is integratiegebruiker? |
|
Groet
|
data.salutation | string |
Groet |
|
Is actief
|
data.active | boolean |
Is actief |
|
Identiteitsbewijs
|
data.id | string |
Identiteitsbewijs |
|
E-mailadres
|
data.emailAddress | string |
E-mailadres |
Transactie maken
Transactie maken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Transactienaam
|
name | True | string |
Transactienaam |
|
Message
|
message | string |
Bericht voor alle deelnemers per e-mail. |
|
|
Callback-URL
|
url | string |
Callback-URL |
|
|
Transactie-gebeurtenissen
|
transactionEvents | array of string |
Transactie-gebeurtenissen |
|
|
Deelnemersevenementen
|
participantEvents | array of string |
Deelnemersevenementen |
|
|
Transactiestatus
|
status | string |
Transactiestatus |
|
|
Externe id
|
externalId | string |
Externe id |
|
|
Verloopt bij tijdstempel
|
expiresAtTimestamp | string |
Transactie verloopt bij tijdstempel |
|
|
Herinneren aan tijdstempel
|
remindFromTimestamp | string |
Herinneren aan tijdstempel |
|
|
Herinneringsfrequentie
|
reminderFrequency | integer |
Frequentie van herinnering |
|
|
Standaardvelden
|
default | boolean |
Standaardvelden voor handtekeningblokken |
|
|
Volgorde van deelnemer
|
sequence | integer |
Sequentie |
|
|
Rol
|
role | string |
Rol |
|
|
Naam
|
name | string |
Naam van kandidaat |
|
|
E-mailadres
|
emailAddress | string |
E-mailadres van kandidaat |
|
|
Language
|
language | string |
Language |
|
|
Verificatiemodus
|
authenticationMode | string |
Verificatiemodus |
|
|
Verificatiemoduswaarde
|
authenticationModeValue | string |
Verificatiemoduswaarde |
|
|
Leveringskanalen
|
deliveryChannels | array of string |
Leveringskanalen |
|
|
Veld-id
|
fieldId | string |
Veld-id |
|
|
Bladzijden
|
pages | array of string |
Bladzijden |
|
|
Document-id
|
documentId | string |
Document-id |
|
|
Veldbreedte
|
width | float |
Veldbreedte |
|
|
Veldhoogte
|
height | float |
Veldhoogte |
|
|
Knopinfo
|
tooltip | string |
Knopinfo |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Aantal tekstgebiedregelen
|
textareaLineCount | string |
Aantal tekstgebiedregelen |
|
|
Veldnaam
|
fieldName | string |
Veldnaam |
|
|
X-positie
|
xposition | float |
X-positie van het veld |
|
|
Y-positie
|
yposition | float |
Y-positie van het veld |
|
|
Is dit vereist?
|
required | boolean |
Is dit een verplicht veld? |
|
|
Is alleen-lezen?
|
readOnly | boolean |
Is dit een alleen-lezenveld? |
|
|
Tekstgebied
|
textarea | boolean |
Tekstgebied |
|
|
Boven onder
|
topBottom | boolean |
Boven onder |
|
|
Verticaal
|
vertical | boolean |
Verticaal |
|
|
Id van radiogroep
|
radioGroupId | string |
Id van radiogroep |
|
|
Standaardwaarde
|
defaultValue | string |
Standaardwaarde |
|
|
Waarde
|
value | string |
Waarde |
|
|
Label weergeven
|
displayLabel | string |
Label weergeven |
|
|
Naam
|
name | string |
Naam |
|
|
E-mailadres
|
emailAddress | string |
E-mailadres |
|
|
Language
|
language | string |
Language |
|
|
Document-id
|
id | string |
Document-id |
|
|
Sequentie
|
sequence | integer |
Sequentie |
|
|
Is verwijderen mogelijk?
|
deletable | boolean |
Is verwijderen mogelijk? |
|
|
Is privé
|
private | boolean |
Is privé |
|
|
Veldwaarde
|
value | string |
Veldwaarde |
|
|
Veldnaam
|
fieldName | string |
Veldnaam |
|
|
Code
|
code | string |
Code |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Tijdstempel
|
timestamp | integer |
Tijdstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Message
|
message | string |
Message |
|
Transactie-id
|
data.transactionId | string |
Transactie-id |
Transactie maken met behulp van sjabloon
Transactie maken met behulp van een bepaalde sjabloon-id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Transactienaam
|
name | string |
Transactienaam |
|
|
Transactiestatus
|
status | string |
Transactiestatus |
|
|
Externe id
|
externalId | string |
Externe id |
|
|
Sjabloon-id
|
templateId | string |
Sjabloon-id |
|
|
Secundaire sjabloon-id's
|
secondaryTemplateIds | array of string |
Secundaire sjabloon-id's |
|
|
Message
|
message | string |
Bericht voor alle deelnemers per e-mail. |
|
|
Callback-URL
|
url | string |
Callback-URL |
|
|
Transactie-gebeurtenissen
|
transactionEvents | array of string |
Transactie-gebeurtenissen |
|
|
Deelnemersevenementen
|
participantEvents | array of string |
Deelnemersevenementen |
|
|
Volgorde van deelnemer
|
sequence | integer |
Sequentie |
|
|
Rol
|
role | string |
Rol |
|
|
Is automatisch proces?
|
autoProcess | boolean |
Is automatisch proces? |
|
|
Veldnaam
|
fieldName | string |
Veldnaam |
|
|
Veldwaarde
|
value | string |
Veldwaarde |
|
|
Naam
|
name | string |
Naam van kandidaat |
|
|
E-mailadres
|
emailAddress | string |
E-mailadres van kandidaat |
|
|
Message
|
message | string |
Message |
|
|
Language
|
language | string |
Language |
|
|
Leveringskanalen
|
deliveryChannels | array of string |
Leveringskanalen |
|
|
Aangepaste sms-hoofdtekst
|
customSMSBody | string |
Aangepaste sms-hoofdtekst |
|
|
Naam
|
name | string |
Naam |
|
|
Message
|
message | string |
Message |
|
|
Is dit vereist?
|
required | boolean |
Is dit vereist? |
|
|
Naam
|
name | string |
Naam |
|
|
E-mailadres
|
emailAddress | string |
E-mailadres |
|
|
Language
|
language | string |
Language |
|
|
Veldwaarde
|
value | string |
Veldwaarde |
|
|
Veldnaam
|
fieldName | string |
Veldnaam |
|
|
Code
|
code | string |
Code |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Tijdstempel
|
timestamp | integer |
Tijdstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Message
|
message | string |
Message |
|
Transactie-id
|
data.transactionId | string |
Transactie-id |
Transactiedetails ophalen
Transactiegegevens ophalen op transactie-id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Transactie-id
|
transactionId | True | string |
De unieke transactie-id |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Tijdstempel
|
timestamp | integer |
Tijdstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Message
|
message | string |
Message |
|
Transactienaam
|
data.name | string |
Transactienaam |
|
Transactiestatus
|
data.status | string |
Transactiestatus |
|
Transactie-id
|
data.transactionId | string |
Transactie-id |
|
Message
|
data.mail.message | string |
Bericht voor alle deelnemers per e-mail. |
|
Laatst bijgewerkt
|
data.lastUpdatedDate | string |
Laatst bijgewerkt |
|
Aanmaakdatum
|
data.createdDate | string |
Aanmaakdatum |
|
Gebruikers-ID
|
data.createdBy.id | string |
Gemaakt door gebruikers-id |
|
Gebruikersnaam
|
data.createdBy.username | string |
Gemaakt door gebruikersnaam |
|
E-mailadres
|
data.createdBy.emailAddress | string |
Gemaakt door e-mailadres |
|
Verzonden datum
|
data.sentDate | string |
Verzonden datum |
|
Gebruikers-ID
|
data.lastActionPerformedBy.userId | string |
Gebruikers-ID |
|
Gebruikersnaam
|
data.lastActionPerformedBy.userName | string |
Gebruikersnaam |
|
E-mailadres
|
data.lastActionPerformedBy.emailAddress | string |
E-mailadres |
|
Kandidaat-id
|
data.lastActionPerformedBy.candidateId | string |
Kandidaat-id |
|
Deelnemer-id
|
data.lastActionPerformedBy.participantId | string |
Deelnemer-id |
|
Verloopt bij tijdstempel
|
data.expiryAndReminders.expiresAtTimestamp | string |
Transactie verloopt bij tijdstempel |
|
Verloopdagen
|
data.expiryAndReminders.expiryDays | integer |
Verloopdagen |
|
Herinnering aan herinneringsdagen
|
data.expiryAndReminders.remindFromReminderDays | integer |
Herinnering aan herinneringsdagen |
|
Herinnering aan herinneringstijd
|
data.expiryAndReminders.remindFromReminderTime | string |
Herinnering aan herinneringstijd |
|
Herinneringsfrequentie
|
data.expiryAndReminders.reminderFrequency | integer |
Frequentie van herinnering |
|
Deelnemers
|
data.participants | array of object |
Deelnemers |
|
Deelnemer-id
|
data.participants.id | string |
Deelnemer-id |
|
Status van deelnemer
|
data.participants.status | string |
Status van deelnemer |
|
Laatst bijgewerkt
|
data.participants.lastUpdatedDate | string |
Laatst bijgewerkt |
|
Aanmaakdatum
|
data.participants.createdDate | string |
Aanmaakdatum |
|
Volgorde van deelnemer
|
data.participants.sequence | integer |
Sequentie |
|
Rol
|
data.participants.role | string |
Rol |
|
Handtekeningmethode
|
data.participants.signingMethodDTO | array of string |
Details van ondertekeningsmethode |
|
Ingediend door gebruiker
|
data.participants.submittedBys | array of object |
Verzonden door de details van de gebruiker |
|
Gebruikers-ID
|
data.participants.submittedBys.userId | string |
Verzonden door gebruikers-id |
|
Gebruikersnaam
|
data.participants.submittedBys.userName | string |
Verzonden door de naam van de gebruiker |
|
E-mailadres
|
data.participants.submittedBys.emailAddress | string |
Verzonden door het e-mailadres van de gebruiker |
|
Kandidaat-id
|
data.participants.submittedBys.candidateId | string |
Kandidaat-id |
|
Kandidaten
|
data.participants.candidates | array of object |
Kandidaten |
|
Kandidaat-id
|
data.participants.candidates.id | string |
Kandidaat-id |
|
Naam
|
data.participants.candidates.name | string |
Naam van kandidaat |
|
E-mailadres
|
data.participants.candidates.emailAddress | string |
E-mailadres van kandidaat |
|
Language
|
data.participants.candidates.language | string |
Language |
|
Type
|
data.participants.candidates.type | string |
Type |
|
Handeling
|
data.participants.candidates.action | string |
Handeling |
|
Actiedatum
|
data.participants.candidates.actionDate | string |
Actiedatum |
|
Aanmaakdatum
|
data.participants.candidates.createdDate | string |
Aanmaakdatum |
|
Verificatiemoduswaarde
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Verificatiemoduswaarde |
|
details van ondertekeningsmethode
|
data.participants.candidates.signingMethodDTO | array of string |
details van ondertekeningsmethode |
|
Bijlagen
|
data.participants.candidates.attachments | array of |
Bijlagen |
|
Leveringskanalen
|
data.participants.candidates.deliveryChannels | array of string |
Leveringskanalen |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
Identiteitsbewijs
|
data.participants.fields.id | string |
Identiteitsbewijs |
|
Laatst bijgewerkt
|
data.participants.fields.lastUpdatedDate | string |
Laatst bijgewerkt |
|
Aanmaakdatum
|
data.participants.fields.createdDate | string |
Aanmaakdatum |
|
Veld-id
|
data.participants.fields.fieldId | string |
Veld-id |
|
Pagina nee
|
data.participants.fields.pageNo | integer |
Pagina nee |
|
Document-id
|
data.participants.fields.documentId | string |
Document-id |
|
Veldbreedte
|
data.participants.fields.width | float |
Veldbreedte |
|
Veldhoogte
|
data.participants.fields.height | float |
Veldhoogte |
|
Knopinfo
|
data.participants.fields.tooltip | string |
Knopinfo |
|
Waarde
|
data.participants.fields.value | string |
Waarde |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Label weergeven
|
data.participants.fields.displayLabel | string |
Label weergeven |
|
Koppelingstype
|
data.participants.fields.linkType | string |
Koppelingstype |
|
Radio-id
|
data.participants.fields.radioId | integer |
Radio-id |
|
Id van radiogroep
|
data.participants.fields.radioGroupId | string |
Id van radiogroep |
|
Selectievakje-id
|
data.participants.fields.checkboxId | integer |
Selectievakje-id |
|
Veldnaam
|
data.participants.fields.fieldName | string |
Veldnaam |
|
X-positie
|
data.participants.fields.xposition | float |
X-positie van het veld |
|
Y-positie
|
data.participants.fields.yposition | float |
Y-positie van het veld |
|
Is dit vereist?
|
data.participants.fields.required | boolean |
Is dit een verplicht veld? |
|
Is alleen-lezen?
|
data.participants.fields.readOnly | boolean |
Is dit een alleen-lezenveld? |
|
Tekstgebied
|
data.participants.fields.textarea | boolean |
Tekstgebied |
|
Verticaal
|
data.participants.fields.vertical | boolean |
Verticaal |
|
Boven onder
|
data.participants.fields.topBottom | boolean |
Boven onder |
|
Standaardwaarde
|
data.participants.fields.defaultValue | string |
Standaardwaarde |
|
Formaat
|
data.participants.signatureBlock.format | array of object |
Formaat |
|
Identiteitsbewijs
|
data.participants.signatureBlock.format.id | string |
Identiteitsbewijs |
|
Sequentie
|
data.participants.signatureBlock.format.sequence | integer |
Sequentie |
|
Is dit vereist?
|
data.participants.signatureBlock.format.required | boolean |
Is dit vereist? |
|
Verstek
|
data.participants.signatureBlock.default | boolean |
Verstek |
|
Gemachtigde inschakelen
|
data.participants.enableDelegate | boolean |
Gemachtigde inschakelen |
|
Automatisch proces
|
data.participants.autoProcess | boolean |
Automatisch proces |
|
CC-gebruikers
|
data.ccUsers | array of object |
CC-gebruikers |
|
Naam
|
data.ccUsers.name | string |
Naam |
|
E-mailadres
|
data.ccUsers.emailAddress | string |
E-mailadres |
|
Language
|
data.ccUsers.language | string |
Language |
|
Documents
|
data.documents | array of object |
Documents |
|
Document-id
|
data.documents.id | string |
Document-id |
|
Sequentie
|
data.documents.sequence | integer |
Sequentie |
|
Bestandsnaam
|
data.documents.fileName | string |
Bestandsnaam |
|
Aantal pagina's
|
data.documents.pageCount | integer |
Aantal pagina's |
|
Is verwijderen mogelijk?
|
data.documents.deletable | boolean |
Is verwijderen mogelijk? |
|
Is privé
|
data.documents.private | boolean |
Is privé |
|
Aangepaste velden
|
data.customFields | array of object |
Aangepaste velden |
|
Aangepaste veld-id
|
data.customFields.customFieldId | string |
Aangepaste veld-id |
|
Veldwaarde
|
data.customFields.value | string |
Veldwaarde |
|
Veldnaam
|
data.customFields.fieldName | string |
Veldnaam |
|
Veldtype
|
data.customFields.fieldType | string |
Veldtype |
|
Meldingsabonnementen
|
data.notificationSubscriptions | array of |
Meldingsabonnementen |
|
tags
|
data.tags | array of |
tags |
|
Aanvullende documenten
|
data.additionalDocuments | array of object |
Aanvullende documenten |
|
Identiteitsbewijs
|
data.additionalDocuments.id | string |
Identiteitsbewijs |
|
Bestandsnaam
|
data.additionalDocuments.fileName | string |
Bestandsnaam |
|
Type
|
data.additionalDocuments.type | string |
Type |
|
Kandidaat-id
|
data.additionalDocuments.candidateId | string |
Kandidaat-id |
|
Afzonderlijke overeenkomsten
|
data.separateAgreements | boolean |
Afzonderlijke overeenkomsten |
Triggers
| Wanneer een transactiestatus wordt gewijzigd |
Een callback registreren voor een bepaalde transactie gebeurtenis |
Wanneer een transactiestatus wordt gewijzigd
Een callback registreren voor een bepaalde transactie gebeurtenis
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Gebeurtenistype
|
eventType | True | array |
Het type transactie-gebeurtenis waarvoor moet worden geregistreerd |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Tijdstempel
|
timestamp | integer |
Tijdstempel |
|
Statuscode
|
statusCode | integer |
Statuscode |
|
Message
|
message | string |
Message |
|
Transactienaam
|
data.name | string |
Transactienaam |
|
Transactiestatus
|
data.status | string |
Transactiestatus |
|
Transactie-id
|
data.transactionId | string |
Transactie-id |
|
Message
|
data.mail.message | string |
Bericht voor alle deelnemers per e-mail. |
|
Laatst bijgewerkt
|
data.lastUpdatedDate | string |
Laatst bijgewerkt |
|
Aanmaakdatum
|
data.createdDate | string |
Aanmaakdatum |
|
Gebruikers-ID
|
data.createdBy.id | string |
Gemaakt door gebruikers-id |
|
Gebruikersnaam
|
data.createdBy.username | string |
Gemaakt door gebruikersnaam |
|
E-mailadres
|
data.createdBy.emailAddress | string |
Gemaakt door e-mailadres |
|
Verzonden datum
|
data.sentDate | string |
Verzonden datum |
|
Gebruikers-ID
|
data.lastActionPerformedBy.userId | string |
Gebruikers-ID |
|
Gebruikersnaam
|
data.lastActionPerformedBy.userName | string |
Gebruikersnaam |
|
E-mailadres
|
data.lastActionPerformedBy.emailAddress | string |
E-mailadres |
|
Kandidaat-id
|
data.lastActionPerformedBy.candidateId | string |
Kandidaat-id |
|
Deelnemer-id
|
data.lastActionPerformedBy.participantId | string |
Deelnemer-id |
|
Verloopt bij tijdstempel
|
data.expiryAndReminders.expiresAtTimestamp | string |
Transactie verloopt bij tijdstempel |
|
Verloopdagen
|
data.expiryAndReminders.expiryDays | integer |
Verloopdagen |
|
Herinnering aan herinneringsdagen
|
data.expiryAndReminders.remindFromReminderDays | integer |
Herinnering aan herinneringsdagen |
|
Herinnering aan herinneringstijd
|
data.expiryAndReminders.remindFromReminderTime | string |
Herinnering aan herinneringstijd |
|
Herinneringsfrequentie
|
data.expiryAndReminders.reminderFrequency | integer |
Frequentie van herinnering |
|
Deelnemers
|
data.participants | array of object |
Deelnemers |
|
Deelnemer-id
|
data.participants.id | string |
Deelnemer-id |
|
Status van deelnemer
|
data.participants.status | string |
Status van deelnemer |
|
Laatst bijgewerkt
|
data.participants.lastUpdatedDate | string |
Laatst bijgewerkt |
|
Aanmaakdatum
|
data.participants.createdDate | string |
Aanmaakdatum |
|
Volgorde van deelnemer
|
data.participants.sequence | integer |
Sequentie |
|
Rol
|
data.participants.role | string |
Rol |
|
Handtekeningmethode
|
data.participants.signingMethodDTO | array of string |
Details van ondertekeningsmethode |
|
Ingediend door gebruiker
|
data.participants.submittedBys | array of object |
Verzonden door de details van de gebruiker |
|
Gebruikers-ID
|
data.participants.submittedBys.userId | string |
Verzonden door gebruikers-id |
|
Gebruikersnaam
|
data.participants.submittedBys.userName | string |
Verzonden door de naam van de gebruiker |
|
E-mailadres
|
data.participants.submittedBys.emailAddress | string |
Verzonden door het e-mailadres van de gebruiker |
|
Kandidaat-id
|
data.participants.submittedBys.candidateId | string |
Kandidaat-id |
|
Kandidaten
|
data.participants.candidates | array of object |
Kandidaten |
|
Kandidaat-id
|
data.participants.candidates.id | string |
Kandidaat-id |
|
Naam
|
data.participants.candidates.name | string |
Naam van kandidaat |
|
E-mailadres
|
data.participants.candidates.emailAddress | string |
E-mailadres van kandidaat |
|
Language
|
data.participants.candidates.language | string |
Language |
|
Type
|
data.participants.candidates.type | string |
Type |
|
Handeling
|
data.participants.candidates.action | string |
Handeling |
|
Actiedatum
|
data.participants.candidates.actionDate | string |
Actiedatum |
|
Aanmaakdatum
|
data.participants.candidates.createdDate | string |
Aanmaakdatum |
|
Verificatiemoduswaarde
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Verificatiemoduswaarde |
|
details van ondertekeningsmethode
|
data.participants.candidates.signingMethodDTO | array of string |
details van ondertekeningsmethode |
|
Bijlagen
|
data.participants.candidates.attachments | array of |
Bijlagen |
|
Leveringskanalen
|
data.participants.candidates.deliveryChannels | array of string |
Leveringskanalen |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
Identiteitsbewijs
|
data.participants.fields.id | string |
Identiteitsbewijs |
|
Laatst bijgewerkt
|
data.participants.fields.lastUpdatedDate | string |
Laatst bijgewerkt |
|
Aanmaakdatum
|
data.participants.fields.createdDate | string |
Aanmaakdatum |
|
Veld-id
|
data.participants.fields.fieldId | string |
Veld-id |
|
Pagina nee
|
data.participants.fields.pageNo | integer |
Pagina nee |
|
Document-id
|
data.participants.fields.documentId | string |
Document-id |
|
Veldbreedte
|
data.participants.fields.width | float |
Veldbreedte |
|
Veldhoogte
|
data.participants.fields.height | float |
Veldhoogte |
|
Knopinfo
|
data.participants.fields.tooltip | string |
Knopinfo |
|
Waarde
|
data.participants.fields.value | string |
Waarde |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Label weergeven
|
data.participants.fields.displayLabel | string |
Label weergeven |
|
Koppelingstype
|
data.participants.fields.linkType | string |
Koppelingstype |
|
Radio-id
|
data.participants.fields.radioId | integer |
Radio-id |
|
Id van radiogroep
|
data.participants.fields.radioGroupId | string |
Id van radiogroep |
|
Selectievakje-id
|
data.participants.fields.checkboxId | integer |
Selectievakje-id |
|
Veldnaam
|
data.participants.fields.fieldName | string |
Veldnaam |
|
X-positie
|
data.participants.fields.xposition | float |
X-positie van het veld |
|
Y-positie
|
data.participants.fields.yposition | float |
Y-positie van het veld |
|
Is dit vereist?
|
data.participants.fields.required | boolean |
Is dit een verplicht veld? |
|
Is alleen-lezen?
|
data.participants.fields.readOnly | boolean |
Is dit een alleen-lezenveld? |
|
Tekstgebied
|
data.participants.fields.textarea | boolean |
Tekstgebied |
|
Verticaal
|
data.participants.fields.vertical | boolean |
Verticaal |
|
Boven onder
|
data.participants.fields.topBottom | boolean |
Boven onder |
|
Standaardwaarde
|
data.participants.fields.defaultValue | string |
Standaardwaarde |
|
Formaat
|
data.participants.signatureBlock.format | array of object |
Formaat |
|
Identiteitsbewijs
|
data.participants.signatureBlock.format.id | string |
Identiteitsbewijs |
|
Sequentie
|
data.participants.signatureBlock.format.sequence | integer |
Sequentie |
|
Is dit vereist?
|
data.participants.signatureBlock.format.required | boolean |
Is dit vereist? |
|
Verstek
|
data.participants.signatureBlock.default | boolean |
Verstek |
|
Gemachtigde inschakelen
|
data.participants.enableDelegate | boolean |
Gemachtigde inschakelen |
|
Automatisch proces
|
data.participants.autoProcess | boolean |
Automatisch proces |
|
CC-gebruikers
|
data.ccUsers | array of object |
CC-gebruikers |
|
Naam
|
data.ccUsers.name | string |
Naam |
|
E-mailadres
|
data.ccUsers.emailAddress | string |
E-mailadres |
|
Language
|
data.ccUsers.language | string |
Language |
|
Documents
|
data.documents | array of object |
Documents |
|
Document-id
|
data.documents.id | string |
Document-id |
|
Sequentie
|
data.documents.sequence | integer |
Sequentie |
|
Bestandsnaam
|
data.documents.fileName | string |
Bestandsnaam |
|
Aantal pagina's
|
data.documents.pageCount | integer |
Aantal pagina's |
|
Is verwijderen mogelijk?
|
data.documents.deletable | boolean |
Is verwijderen mogelijk? |
|
Is privé
|
data.documents.private | boolean |
Is privé |
|
Aangepaste velden
|
data.customFields | array of object |
Aangepaste velden |
|
Aangepaste veld-id
|
data.customFields.customFieldId | string |
Aangepaste veld-id |
|
Veldwaarde
|
data.customFields.value | string |
Veldwaarde |
|
Veldnaam
|
data.customFields.fieldName | string |
Veldnaam |
|
Veldtype
|
data.customFields.fieldType | string |
Veldtype |
|
Meldingsabonnementen
|
data.notificationSubscriptions | array of |
Meldingsabonnementen |
|
tags
|
data.tags | array of |
tags |
|
Aanvullende documenten
|
data.additionalDocuments | array of object |
Aanvullende documenten |
|
Identiteitsbewijs
|
data.additionalDocuments.id | string |
Identiteitsbewijs |
|
Bestandsnaam
|
data.additionalDocuments.fileName | string |
Bestandsnaam |
|
Type
|
data.additionalDocuments.type | string |
Type |
|
Kandidaat-id
|
data.additionalDocuments.candidateId | string |
Kandidaat-id |
|
Afzonderlijke overeenkomsten
|
data.separateAgreements | boolean |
Afzonderlijke overeenkomsten |
Definities
bestand
Dit is het basisgegevenstype 'bestand'.