Delen via

SignNow

SignNow maakt veilige, compatibele en auditklare eSignature-werkstromen mogelijk voor bedrijven, juridische, HR-, gezondheidszorg- en financiële teams. Verzend en traceer handtekeningaanvragen in op rollen gebaseerde volgorde, vul documentvelden vooraf in en beheer documentgroepen met behulp van de SignNow-connector.

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 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 China-regio's
     - Us Department of Defense (DoD)
Power Apps Premium Alle Power Apps-regio's , met uitzondering van het volgende:
     - 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 High)
     - China Cloud beheerd door 21Vianet
     - Us Department of Defense (DoD)
Contactpersoon
Naam Helpcentrum
URL https://support.signnow.com/
E-mailen integrations@pdffiller.com
Connectormetagegevens
Uitgever DaDaDocs
Webpagina https://signnow.com
Privacybeleid https://www.signnow.com/privacy_policy
Categorieën Productiviteit; Personeel

SignNow-connector

SignNow maakt veilige, compatibele en auditklare eSignature-werkstromen mogelijk voor bedrijven, juridische, HR-, gezondheidszorg- en financiële teams. Verzend en traceer handtekeningaanvragen in op rollen gebaseerde volgorde, vul documentvelden vooraf in en beheer documentgroepen met behulp van de SignNow-connector.

Pre-requisites

U hebt een SignNow-account en een SignNow API-abonnement nodig om door te gaan.

Het voorbeeld implementeren

Werk eerst de clientId-waarde in de apiProperties.json bij met uw eigen waarde.

Voer de volgende opdrachten uit en volg de aanwijzingen:

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

Ondersteunde acties en triggers

Raadpleeg de documentatie voor meer informatie.

Beperkingslimieten

Name Aanroepen Verlengingsperiode
API-aanroepen per verbinding 100 60 seconden

Acties

Afgeschaft - Uitnodigen om de documentgroep te ondertekenen

De actie is afgeschaft. Anderen uitnodigen om de documentgroep in te vullen en te ondertekenen
Afgeschaft - Uitnodigen om te ondertekenen

De actie is afgeschaft. Anderen uitnodigen om het document in te vullen en te ondertekenen
Afgeschaft - Uitnodiging voor geavanceerd document

De actie is afgeschaft. Uitnodigingsaanvraag met handmatig gedefinieerd schema. Hiermee kunt u uitnodiging instellen voor een document dat in de toekomst wordt gegenereerd
Document downloaden

Een document downloaden van SignNow
Document maken op sjabloon

Een document genereren op basis van een geselecteerde sjabloon
Document uploaden

Een document uploaden naar SignNow
Document verwijderen

Een document verwijderen uit SignNow
Documentgegevens ophalen

Documenteigenschappen ophalen, zoals naam, id, datums maken/bijwerken, enzovoort.
Documentgroep maken op basis van de groepssjabloon

De documentgroep maken op basis van een geselecteerde groepssjabloon
Documentgroep maken van meerdere bestanden

Een documentgroep maken door meerdere bestanden te uploaden als met base64 gecodeerde tekenreeksen
Documentgroep ophalen

Een lijst met documentgroepen van gebruikers ophalen
Documentgroepen ophalen

Een lijst met documentgroepen van gebruikers ophalen
Documentschema ophalen [AFGESCHAFT]

Deze actie is afgeschaft. Gebruik in plaats daarvan documentschema Ophalen .

OpenAPI-documentschema ophalen
Documentvelden ophalen

Waarden ophalen uit de invulbare velden in het document
Documentvelden ophalen [AFGESCHAFT]

Deze actie is afgeschaft. Gebruik in plaats daarvan Documentvelden ophalen .

Waarden voor documentvelden ophalen.
Geadresseerden vervangen in uitnodiging voor documenten

Met deze actie worden geadresseerden in de uitnodiging voor het document vervangen op basis van hun rollen. Hiermee kunt u ook instellingen voor uitnodigingen bijwerken, zoals verificatietype, verloopdagen en andere geavanceerde parameters voor elke rol
Geadresseerden vervangen in uitnodiging voor documentgroep

Met deze actie worden geadresseerden in een documentgroepuitnodiging vervangen door de uitnodigings-id. U kunt ook een verlooptijd voor uitnodigingen, herinneringen instellen, machtigingen opnieuw toewijzen en opties voor weigeren voor elk document instellen
Ingesloten koppeling voor documentgroep maken

Met deze actie wordt een ingesloten koppeling voor verzenden voor een specifieke documentgroep gegenereerd, zodat gebruikers van derden de documentgroep kunnen voorbereiden en verzenden voor handtekening
Ingesloten uitnodiging voor document maken

Met deze actie maakt u een ingesloten uitnodiging voor ondertekening voor een document. Zodra de uitnodiging is gemaakt, genereert u een ingesloten ondertekeningskoppeling
Ingesloten uitnodiging voor document verwijderen

Met deze actie wordt een ingesloten uitnodiging voor een document verwijderd
Ingesloten uitnodiging voor documentgroep maken

Met deze actie maakt u een ingesloten uitnodiging voor ondertekening voor een documentgroep. Zodra de uitnodiging is gemaakt, genereert u een ingesloten ondertekeningskoppeling
Ingesloten uitnodiging voor documentgroep verwijderen

Met deze actie wordt een ingesloten uitnodiging voor een specifieke documentgroep verwijderd
Ingesloten uitnodigingskoppeling voor document genereren

Met deze actie wordt een koppeling gegenereerd voor de ingesloten uitnodiging voor het document
Ingesloten uitnodigingskoppeling voor documentgroep genereren

Met deze actie wordt een koppeling gegenereerd voor de ingesloten uitnodiging voor de documentgroep
Koppeling Voor ingesloten documenten maken

Met deze actie wordt een ingesloten koppeling voor verzenden voor een specifiek document gegenereerd, zodat gebruikers van derden het document kunnen voorbereiden en verzenden voor handtekening
Koppeling voor ondertekening maken

Genereer een koppeling naar het document en deel het om het document te laten ondertekenen
Lijst met documenten ophalen

Een lijst met gebruikersdocumenten ophalen
Slimme veldwaarden voor documentgroep vooraf doorvoeren

Automatisch slimme velden in de documenten vullen met specifieke waarden
Status van documentnodiging ophalen

Met deze actie wordt informatie opgehaald over een uitnodiging voor een document, inclusief de status van elke stap en actie
Uitnodigen om document te ondertekenen

Met deze actie wordt een veldnodiging gemaakt en verzonden voor een document dat moet worden ondertekend
Uitnodigen om documentgroep te ondertekenen

Met deze actie maakt u een uitnodiging voor het ondertekenen van een documentgroep. U kunt een werkstroom met meerdere stappen configureren, waarbij verschillende geadresseerden in verschillende fasen op de documentgroep reageren
Uitnodiging annuleren

Annulering van handtekeningnodiging
Uitnodigingsstatus voor documentgroep ophalen

Met deze actie wordt informatie opgehaald over een uitnodiging voor een documentgroep, inclusief de status van elke stap en actie
Veldwaarden voor documentgroep vooraf invullen

Vulbare velden in de documenten automatisch in met specifieke waarden
Veldwaarden vooraf doorvoeren

Vulbare velden in het document automatisch in met specifieke waarden
Veldwaarden vooraf invullen [AFGESCHAFT]

Deze actie is afgeschaft. Gebruik in plaats daarvan vooraf invulwaarden voor documentvelden .

Vooraf invullen van veldwaarden en eigenschappen.
Waarden voor slim veld vooraf doorvoeren

Smart Field-waarden vooraf invullen voor het opgegeven document

Afgeschaft - Uitnodigen om de documentgroep te ondertekenen

Bewerkings-id:
SendGroupInvite

De actie is afgeschaft. Anderen uitnodigen om de documentgroep in te vullen en te ondertekenen

Parameters

Name Sleutel Vereist Type Description
Template
 template True boolean

Opgeven of documentgroepen of groepssjablonen moeten worden opgehaald
Documentgroep
 template_group_id True string

Selecteer de documentgroep in de lijst
body
 body True dynamic

Retouren

response
object

Afgeschaft - Uitnodigen om te ondertekenen

Bewerkings-id:
SendInvite

De actie is afgeschaft. Anderen uitnodigen om het document in te vullen en te ondertekenen

Parameters

Name Sleutel Vereist Type Description
Template
 template True boolean

Opgeven of documenten of sjablonen moeten worden opgehaald
Document
 template_id True string

Selecteer een sjabloon in de lijst
body
 body True dynamic

Retouren

response
object

Afgeschaft - Uitnodiging voor geavanceerd document

Bewerkings-id:
SendUserDefinedInvite

De actie is afgeschaft. Uitnodigingsaanvraag met handmatig gedefinieerd schema. Hiermee kunt u uitnodiging instellen voor een document dat in de toekomst wordt gegenereerd

Parameters

Name Sleutel Vereist Type Description
Document-id
 doc_id True string

Een document-id opgeven
Naam
 role string

Rolnaam van ondertekenaar
E-mail
 email email

E-mail opgeven voor ondertekenaar
Telefoonnummer (uitnodigen via sms)
 phone_invite string

Geef het telefoonnummer van de geadresseerde +XXXXXXXXXXXX op. Vereist voor uitnodiging via sms.
Bestelling
 order integer

De volgorde van ondertekening voor meerdere ondertekenaars instellen
Persoonlijk onderwerp
 subject string

Gepersonaliseerde onderwerp toevoegen voor ondertekenaar
Persoonlijk bericht
 message string

Persoonlijk bericht toevoegen voor ondertekenaar
Verificatietype
 authentication_type string

Gebruikersidentiteit verifiëren via wachtwoord, sms of telefoongesprek
Wachtwoord
 password string

Het wachtwoord voor wachtwoord voor verificatietype instellen
Telefoon
 phone string

Geef +XXXXXXXXXXXX-telefoonnummer op voor verificatietype Telefoon of SMS
Dagen tot verloop
 expiration_days integer

Laat de ondertekenaar op de hoogte worden gesteld van het aantal dagen dat de uitnodiging verloopt
Herinnering verzenden in
 reminder integer

Het aantal dagen na het verzenden van de uitnodiging om automatisch op te volgen met een e-mailherinnering
Herinnering elke x dagen verzenden
 remind_repeat integer

De geadresseerde ontvangt elke ingestelde hoeveelheid dagen een herinnering per e-mail.
Doorsturen toestaan
 reassign boolean

Ondertekenaar toestaan de ondertekening te delegeren aan iemand anders
Weigeren weergeven bij handtekening
 decline_by_signature boolean

Een handtekeningveld stempelen als Weigeren om te ondertekenen als de geadresseerde weigerde het document te ondertekenen
CC
 cc string

Een door komma's gescheiden e-mailberichten die carbon worden gekopieerd in de uitnodiging
Onderwerp
 subject string

Typ uw onderwerp
Message
 message string

Typ uw bericht
Alle partijen e-mailen na voltooiing
 on_complete string

Alle partijen ontvangen een e-mailmelding wanneer het document is ondertekend

Retouren

response
object

Document downloaden

Bewerkings-id:
DownloadDocument

Een document downloaden van SignNow

Parameters

Name Sleutel Vereist Type Description
Document-id
 doc_id True string

Geef een unieke document-id op of selecteer een document in de lijst
Formaat
 mode string

Een documentindeling selecteren om te downloaden

Retouren

response
binary

Document maken op sjabloon

Bewerkings-id:
CreateFromTemplate

Een document genereren op basis van een geselecteerde sjabloon

Parameters

Name Sleutel Vereist Type Description
Documentsjabloon
 doc_id True string

Selecteer een sjabloon in de lijst
Documentnaam
 document_name string

Voer een nieuwe bestandsnaam in voor het document

Retouren

Name Pad Type Description
Document-id
 id DocumentId

Unieke document-id

Document uploaden

Bewerkings-id:
UploadDocument

Een document uploaden naar SignNow

Parameters

Name Sleutel Vereist Type Description
Bestand
 file True file

Te uploaden bestand

Retouren

Name Pad Type Description
Document-id
 id DocumentId

Unieke document-id

Document verwijderen

Bewerkings-id:
DeleteDoc

Een document verwijderen uit SignNow

Parameters

Name Sleutel Vereist Type Description
Document-id
 doc_id True string

Een unieke document-id opgeven

Retouren

Name Pad Type Description
Toestand
 status string

Status van documentverwijdering

Documentgegevens ophalen

Bewerkings-id:
GetDoc

Documenteigenschappen ophalen, zoals naam, id, datums maken/bijwerken, enzovoort.

Parameters

Name Sleutel Vereist Type Description
Template
 template True boolean

Opgeven of documenten of sjablonen moeten worden opgehaald
Document-id
 doc_id True string

Geef een unieke document-id op of selecteer een document in de lijst

Retouren

Body
DocumentProperties

Documentgroep maken op basis van de groepssjabloon

Bewerkings-id:
CreateFromTemplateGroup

De documentgroep maken op basis van een geselecteerde groepssjabloon

Parameters

Name Sleutel Vereist Type Description
Groepssjabloon
 doc_group_id True string

Selecteer de groepssjabloon in de lijst
Naam van documentgroep
 group_name string

Voer een nieuwe naam in voor de documentgroep

Retouren

Name Pad Type Description
Documentgroep-id
 id DocumentGroupId

Unieke documentgroep-id

Documentgroep maken van meerdere bestanden

Bewerkings-id:
CreateDocGroupFromFiles

Een documentgroep maken door meerdere bestanden te uploaden als met base64 gecodeerde tekenreeksen

Parameters

Name Sleutel Vereist Type Description
Naam van documentgroep
 group_name True string

Voer een naam in voor de documentgroep
Documentnaam
 name True string

Documentnaam met extensie: Report.pdf, Letter.docx enzovoort
Bestandsinhoud
 content True string

Met Base64 gecodeerde tekenreeks die de inhoud van het document vertegenwoordigt

Retouren

Body
CreateDocumentGroupFromFilesResponse

Documentgroep ophalen

Bewerkings-id:
GetDocumentGroup

Een lijst met documentgroepen van gebruikers ophalen

Parameters

Name Sleutel Vereist Type Description
Groepssjabloon
 doc_group_id True string

Selecteer de groepssjabloon in de lijst
Template
 template True boolean

Opgeven of de documentgroep of groepssjabloon moet worden opgehaald

Retouren

Body
DocumentGroupProperties

Documentgroepen ophalen

Bewerkings-id:
GetListDocGroups

Een lijst met documentgroepen van gebruikers ophalen

Parameters

Name Sleutel Vereist Type Description
Template
 template True boolean

Opgeven of documentgroepen of groepssjablonen moeten worden opgehaald
Limit
 limit integer

Totaal aantal geretourneerde items (tussen 1 en 50)
Offset
 offset integer

De offset (op nul gebaseerd) van het eerste item in de verzameling dat moet worden geretourneerd

Retouren

Body
DocumentGroupsResponse

Documentschema ophalen [AFGESCHAFT]

Bewerkings-id:
GetDocSchema

Deze actie is afgeschaft. Gebruik in plaats daarvan documentschema Ophalen .

OpenAPI-documentschema ophalen

Parameters

Name Sleutel Vereist Type Description
Document-id
 doc_id string

Een unieke document-id opgeven
Veldtypefilter
 select string

Scheid met een komma welke veldtypen u wilt ophalen

Retouren

Name Pad Type Description
properties
 properties object

Documentvelden ophalen

Bewerkings-id:
GetDocFields_V2

Waarden ophalen uit de invulbare velden in het document

Parameters

Name Sleutel Vereist Type Description
Template
 template_id True string

Een documentsjabloon opgeven waaruit velden moeten worden opgehaald
Document-id
 doc_id True string

Een unieke document-id opgeven

Retouren

De uitvoer van deze bewerking is dynamisch.

Documentvelden ophalen [AFGESCHAFT]

Bewerkings-id:
GetDocFields

Deze actie is afgeschaft. Gebruik in plaats daarvan Documentvelden ophalen .

Waarden voor documentvelden ophalen.

Parameters

Name Sleutel Vereist Type Description
Template
 template_id True string

Een documentsjabloon opgeven waaruit velden moeten worden opgehaald
Document-id
 doc_id True string

Een unieke document-id opgeven

Retouren

De uitvoer van deze bewerking is dynamisch.

Geadresseerden vervangen in uitnodiging voor documenten

Bewerkings-id:
ReplaceRecipientsInDocumentInvite

Met deze actie worden geadresseerden in de uitnodiging voor het document vervangen op basis van hun rollen. Hiermee kunt u ook instellingen voor uitnodigingen bijwerken, zoals verificatietype, verloopdagen en andere geavanceerde parameters voor elke rol

Parameters

Name Sleutel Vereist Type Description
Document-id
 id True string

Document-id
Rol
 role True string

Rolnaam van de geadresseerde die moet worden vervangen
Nieuwe e-mail
 email True string

E-mailadres van nieuwe geadresseerde
Rol
 role True string

Rolnaam waarvoor aanvullende uitnodigingsparameters zijn vereist
Verloopdagen
 expiration_days integer

In hoeveel dagen de uitnodiging verloopt. Maximaal 30 dagen
Weigeren per handtekening toestaan
 decline_by_signature boolean

Hiermee definieert u of de optie Weigeren voor ondertekenen op handtekeningvelden moet worden weergegeven. Waar: de optie weigeren weergeven; Onwaar: de optie weigeren verbergen
Herinnering
 reminder integer

In hoeveel dagen een herinnering naar de geadresseerde moet worden verzonden. Maximaal 30 dagen
Verificatietype
 authentication_type string

Verificatietype dat wordt gebruikt voor verificatie van geadresseerden tijdens de ondertekeningssessie. Toegestane waarden: 'Wachtwoord', 'Telefoongesprek' en 'Sms'
Verificatiewachtwoord
 authentication_password string

Wachtwoord ingesteld voor de ondertekenaarverificatie. Vereist voor het verificatietype Wachtwoord
Telefoon voor verificatie
 authentication_phone string

Telefoonnummer dat wordt gebruikt om de ondertekenaar te verifiëren. Vereist voor het verificatietype Telefoongesprek en Sms. Voorbeeld: +1XXXXXXXXXXX
Sms-bericht voor verificatie
 authentication_sms_message string

Aangepast sms-bericht dat naar de ondertekenaar wordt verzonden, met de tijdelijke aanduiding {password}. Wordt gebruikt met het verificatietype Sms. Zonder deze parameter ontvangt de ondertekenaar een standaard-sms met een automatisch gegenereerd wachtwoord (ontgrendelingscode) - 'Ontgrendelingscode voor SignNow-document uitnodigen: 123456'. Voorbeeld: Voer het wachtwoord {password} in om uw document te ontgrendelen

Retouren

Name Pad Type Description
Vervangingen
 replacements array of object

Details van de nieuwe geadresseerden
Nieuwe uitnodigings-id
 replacements.new_invite_id string

De uitnodigings-id van het nieuwe veld
Rol
 replacements.role string

Rolnaam van de ontvanger die is vervangen
Nieuwe e-mail
 replacements.new_email string

E-mailadres van nieuwe geadresseerde

Geadresseerden vervangen in uitnodiging voor documentgroep

Bewerkings-id:
ReplaceRecipientsInDocumentGroupInvite

Met deze actie worden geadresseerden in een documentgroepuitnodiging vervangen door de uitnodigings-id. U kunt ook een verlooptijd voor uitnodigingen, herinneringen instellen, machtigingen opnieuw toewijzen en opties voor weigeren voor elk document instellen

Parameters

Name Sleutel Vereist Type Description
Documentgroep-id
 id True string

Documentgroep-id
Uitnodigings-id
 invite_id True string

Uitnodigings-id van documentgroep
Stap-id
 step_id string

Id van de uitnodigingsstap uit de uitnodiging voor de documentgroep
Geadresseerde die moet worden vervangen
 recipient_to_update string

E-mail van de geadresseerde die moet worden vervangen
Nieuwe geadresseerde
 new_recipient string

E-mail van de nieuwe geadresseerde
Verloopdagen
 expiration_days integer

In hoeveel dagen de uitnodiging verloopt; Maximaal 30 dagen
Herinnering
 reminder integer

In hoeveel dagen een herinnering naar de ondertekenaar moet worden verzonden; Maximaal 30 dagen
Document-id
 document_id True string

Document-id uit documentgroep
Doorsturen toestaan
 allow_forwarding boolean

Of ontvangers deze uitnodiging al dan niet opnieuw mogen toewijzen aan een ander e-mailadres. Mogelijke waarden: Onwaar - niet toegestaan. Waar - toegestaan.
Weigeren per handtekening toestaan
 decline_by_signature boolean

Hiermee definieert u of de optie Weigeren voor ondertekenen op handtekeningvelden moet worden weergegeven. Waar: de optie weigeren weergeven; Onwaar: de optie weigeren verbergen

Retouren

Name Pad Type Description
Toestand
 status string

Status van vervanging van geadresseerden

Ingesloten koppeling voor documentgroep maken

Bewerkings-id:
CreateDocGroupEmbeddedInviteSettingsLink

Met deze actie wordt een ingesloten koppeling voor verzenden voor een specifieke documentgroep gegenereerd, zodat gebruikers van derden de documentgroep kunnen voorbereiden en verzenden voor handtekening

Parameters

Name Sleutel Vereist Type Description
Documentgroep-id
 id True string

Documentgroep-id
Typologie
 type string

Hiermee geeft u de verzendstap op waarmee de ingesloten koppeling moet worden geopend: 'beheren': hiermee opent u de koppeling op de pagina Documenten toevoegen aan documentgroep; 'bewerken': hiermee opent u de koppeling in de editor; 'send-invite': hiermee opent u de koppeling op de pagina Uitnodiging verzenden
Omleidings-URI
 redirect_uri string

De pagina die wordt geopend nadat het ingesloten verzenden is ingesteld. Vereist als omleidingsdoel wordt toegevoegd
Verlooptijd van koppeling
 link_expiration integer

Hiermee geeft u op hoeveel minuten de koppeling actief blijft. Het toegestane bereik: 15 tot 45 minuten. Gebruikers op beheerdersniveau kunnen de duur instellen tot maximaal 43200 minuten
Omleidingsdoel
 redirect_target string

Bepaalt of de omleidings-URI moet worden geopend op een nieuw tabblad in de browser of op hetzelfde tabblad na de ondertekeningssessie. Mogelijke waarden: 'In het nieuwe tabblad': hiermee opent u de koppeling op een nieuw tabblad, 'Op hetzelfde tabblad'. Hiermee opent u de koppeling op hetzelfde tabblad

Retouren

Name Pad Type Description
URL
 url string

De koppeling naar de ingesloten documentgroep die wordt verzonden

Ingesloten uitnodiging voor document maken

Bewerkings-id:
CreateEmbeddedInvites

Met deze actie maakt u een ingesloten uitnodiging voor ondertekening voor een document. Zodra de uitnodiging is gemaakt, genereert u een ingesloten ondertekeningskoppeling

Parameters

Name Sleutel Vereist Type Description
Document-id
 id True string

Document-id
E-mailadres van ondertekenaar
 email True email

E-mailadres van geadresseerde
Rol
 role True string

Naam van de geadresseerderol, bijvoorbeeld 'Ondertekenaar 1' (viewerrollen worden niet ondersteund)
Bestelling
 order True integer

De volgorde van ondertekening
Naamformule
 name_formula string

Een formule voor het genereren van een voltooide documentnaam met behulp van een voorvoegsel (tekst) en opvulbare veldgegevens. Voorbeeld: Contract|signer_name|signed_date, waarbij Contract het voorvoegsel is en 'signer_name' en 'signed_date' namen zijn van invulbare velden
Rol
 role True string

Naam van de geadresseerderol, bijvoorbeeld 'Ondertekenaar 1' (viewerrollen worden niet ondersteund)
Language
 language string

Hiermee geeft u de taal van de ondertekeningssessie en e-mailberichten voor meldingen voor de ondertekenaar. Mogelijke waarden: En voor Engels, Es voor Spaans en Fr voor Frans. Als deze niet is ingesteld, wordt de taal bepaald door de taal van uw SignNow-account
Voornaam
 first_name string

Voornaam van geadresseerde
Achternaam
 last_name string

Achternaam van geadresseerde
Vereiste vooraf ingestelde handtekeningnaam
 required_preset_signature_name string

Vooraf ingevulde tekst voor het handtekeningveld, vergrendeld voor bewerking door de ontvanger. Kan niet worden gebruikt met 'prefill_signature_name' of 'force_new_signature'
Naam van handtekening vooraf doorvoeren
 prefill_signature_name string

Een tekenreeks met een handtekeningnaam die wordt weergegeven wanneer een ondertekenaar op een handtekeningveld klikt. De ondertekenaar kan de handtekening bewerken
Nieuwe handtekening vereisen
 force_new_signature boolean

Hiermee bepaalt u of de ondertekenaar de opgeslagen handtekening kan gebruiken of niet. Als deze optie is ingesteld op 'true', moet de ondertekenaar een nieuwe handtekening toevoegen. Als deze optie is ingesteld op 'false', kan de ondertekenaar de opgeslagen handtekening gebruiken
Omleidings-URI
 redirect_uri string

De koppeling die wordt geopend nadat de ondertekeningssessie is voltooid
Omleidings-URI weigeren
 decline_redirect_uri string

De koppeling die wordt geopend nadat de geadresseerde het document heeft geweigerd te ondertekenen
Omleidings-URI sluiten
 close_redirect_uri string

De koppeling die wordt geopend wanneer de geadresseerde op Voortgang opslaan klikt en Later voltooien tijdens een ondertekeningssessie of sluiten in de weergavemodus
Omleidingsdoel
 redirect_target string

Bepaalt of de omleidings-URI moet worden geopend op een nieuw tabblad in de browser of op hetzelfde tabblad na de ondertekeningssessie. Mogelijke waarden: 'In het nieuwe tabblad': hiermee opent u de koppeling op een nieuw tabblad, 'Op hetzelfde tabblad'. Hiermee opent u de koppeling op hetzelfde tabblad
Verificatietype
 authentication_type string

Verificatietype dat wordt gebruikt voor verificatie van geadresseerden tijdens de ondertekeningssessie. Toegestane waarden: 'Wachtwoord', 'Telefoongesprek' en 'Sms'
Verificatiewachtwoord
 authentication_password string

Wachtwoord ingesteld voor de ondertekenaarverificatie. Vereist voor het verificatietype Wachtwoord
Telefoon voor verificatie
 authentication_phone string

Telefoonnummer dat wordt gebruikt om de ondertekenaar te verifiëren. Vereist voor het verificatietype Telefoongesprek en Sms. Voorbeeld: +1XXXXXXXXXXX
Sms-bericht voor verificatie
 authentication_sms_message string

Aangepast sms-bericht dat naar de ondertekenaar wordt verzonden, met de tijdelijke aanduiding {password}. Wordt gebruikt met het verificatietype Sms. Zonder deze parameter ontvangt de ondertekenaar een standaard-sms met een automatisch gegenereerd wachtwoord (ontgrendelingscode) - 'SignNow-document ontgrendelingscode: 123456' Voorbeeld: voer het wachtwoord {password} in om uw document te ontgrendelen
Leveringstype
 delivery_type string

Definieert hoe de uitnodiging wordt verzonden
Verlooptijd van koppeling
 link_expiration integer

In hoeveel minuten de uitnodiging voor de e-mail verloopt. Kan alleen worden gebruikt als 'Leveringstype=e-mail'. Geldig bereik: 15-43200 minuten
Verlooptijd van sessie
 session_expiration integer

In hoeveel minuten de ondertekeningssessie verloopt. Als er een koppeling voor deze uitnodiging wordt gegenereerd, wordt de verlooptijd van de sessie opnieuw ingesteld. Alleen van toepassing wanneer 'Delivery type=email' en voor 'sign'-acties. Geldig bereik: 15-1440 minuten
QES-handtekening
 signature string

Type of QES. Mogelijke waarden: 'Eideasy', 'Nom151'. Wordt gebruikt voor het aanvragen van QES-handtekeningen van ondertekenaars. Alle ondertekenaars in de uitnodiging moeten hetzelfde handtekeningtype gebruiken. Als u een uitnodiging wilt maken met QES, moet de gebruiker deel uitmaken van een organisatie waarvoor QES is ingeschakeld

Retouren

Name Pad Type Description
gegevens
 data array of object

Gegevens
Identiteitsbewijs
 data.id string

Id van de ingesloten uitnodiging
E-mailen
 data.email string

E-mailadres van geadresseerde
Rol-id
 data.role_id string

Rol-id van ontvanger
Bestelling
 data.order integer

Volgorde van ondertekening van geadresseerde
Toestand
 data.status string

Status van ingesloten uitnodiging

Ingesloten uitnodiging voor document verwijderen

Bewerkings-id:
DeleteEmbeddedInvites

Met deze actie wordt een ingesloten uitnodiging voor een document verwijderd

Parameters

Name Sleutel Vereist Type Description
Document-id
 id True string

Document-id

Ingesloten uitnodiging voor documentgroep maken

Bewerkings-id:
CreateDocGroupEmbeddedInvites

Met deze actie maakt u een ingesloten uitnodiging voor ondertekening voor een documentgroep. Zodra de uitnodiging is gemaakt, genereert u een ingesloten ondertekeningskoppeling

Parameters

Name Sleutel Vereist Type Description
Documentgroep-id
 id True string

Documentgroep-id
Bestelling
 order True integer

Stap voor ondertekeningsorder. Alle ondertekenaars die zijn toegewezen aan een specifieke order stap (bijvoorbeeld order: 1) ontvangen de uitnodigingsmail tegelijk. E-mailberichten voor de volgende orderstap (bijvoorbeeld order: 2) worden pas verzonden nadat alle acties in de vorige orderstap zijn voltooid
E-mailen
 email True string

E-mailadres van geadresseerde
Document-id
 id True string

Id van het document
Rol
 role string

De rol van geadresseerde in het document. Rollen mogen niet worden opgegeven voor de actie Weergave
Handeling
 action True string

De actie die is vereist voor de geadresseerde in het document. Toegestane waarden: 'sign', 'view'
Bestelling
 order True string

Stap voor ondertekeningsorder
E-mailen
 email True string

E-mailadres van geadresseerde
Language
 language string

Hiermee geeft u de taal van de ondertekeningssessie en e-mailberichten voor meldingen voor de ondertekenaar. Mogelijke waarden: En voor Engels, Es voor Spaans en Fr voor Frans. Als deze niet is ingesteld, wordt de taal bepaald door de taal van uw SignNow-account
Voornaam
 first_name string

Voornaam van geadresseerde
Achternaam
 last_name string

Achternaam van geadresseerde
Vereiste vooraf ingestelde handtekeningnaam
 required_preset_signature_name string

Vooraf ingevulde tekst voor het handtekeningveld, vergrendeld voor bewerking door de geadresseerde
Omleidings-URI
 redirect_uri string

De koppeling die wordt geopend nadat de ondertekeningssessie is voltooid
Omleidings-URI weigeren
 decline_redirect_uri string

De koppeling die wordt geopend nadat de geadresseerde het document heeft geweigerd te ondertekenen
Omleidings-URI sluiten
 close_redirect_uri string

De koppeling die wordt geopend wanneer de geadresseerde op Voortgang opslaan klikt en Later voltooien tijdens een ondertekeningssessie of sluiten in de weergavemodus
Omleidingsdoel
 redirect_target string

Bepaalt of de omleidings-URI moet worden geopend op een nieuw tabblad in de browser of op hetzelfde tabblad na de ondertekeningssessie. Mogelijke waarden: 'In het nieuwe tabblad': hiermee opent u de koppeling op een nieuw tabblad, 'Op hetzelfde tabblad'. Hiermee opent u de koppeling op hetzelfde tabblad
Leveringstype
 delivery_type string

Definieert hoe de uitnodiging wordt verzonden
Verlooptijd van koppeling
 link_expiration integer

In hoeveel minuten de uitnodiging voor de e-mail verloopt. Kan alleen worden gebruikt als 'Leveringstype=e-mail'. Geldig bereik: 15-43200 minuten
Verlooptijd van sessie
 session_expiration integer

In hoeveel minuten de ondertekeningssessie verloopt. Als er een koppeling voor deze uitnodiging wordt gegenereerd, wordt de verlooptijd van de sessie opnieuw ingesteld. Alleen van toepassing wanneer 'Delivery type=email' en voor 'sign'-acties. Geldig bereik: 15-1440 minuten
Verificatietype
 authentication_type string

Verificatietype dat wordt gebruikt voor verificatie van geadresseerden tijdens de ondertekeningssessie. Toegestane waarden: 'Wachtwoord', 'Telefoongesprek' en 'Sms'
Verificatiewachtwoord
 authentication_password string

Wachtwoord ingesteld voor de verificatie van de ondertekenaar. Vereist voor het verificatietype Wachtwoord
Telefoon voor verificatie
 authentication_phone string

Telefoonnummer dat wordt gebruikt om de ondertekenaar te verifiëren. Vereist voor het verificatietype Telefoongesprek en Sms. Voorbeeld: +1XXXXXXXXXXX
Sms-bericht voor verificatie
 authentication_sms_message string

Aangepast sms-bericht dat naar de ondertekenaar wordt verzonden, met de tijdelijke aanduiding {password}. Wordt gebruikt met het verificatietype Sms. Zonder deze parameter ontvangt de ondertekenaar een standaard-sms met een automatisch gegenereerd wachtwoord (ontgrendelingscode) - 'Ontgrendelingscode voor SignNow-document uitnodigen: 123456'. Voorbeeld: Voer het wachtwoord {password} in om uw document te ontgrendelen
QES-handtekening
 signature string

Type of QES. Mogelijke waarden: 'Eideasy', 'Nom151'. Wordt gebruikt voor het aanvragen van QES-handtekeningen van ondertekenaars. Alle ondertekenaars in de uitnodiging moeten hetzelfde handtekeningtype gebruiken. Als u een uitnodiging wilt maken met QES, moet de gebruiker deel uitmaken van een organisatie waarvoor QES is ingeschakeld

Retouren

Name Pad Type Description
Uitnodigings-id
 id string

Id van de ingesloten uitnodiging

Ingesloten uitnodiging voor documentgroep verwijderen

Bewerkings-id:
DeleteDocGroupEmbeddedInvites

Met deze actie wordt een ingesloten uitnodiging voor een specifieke documentgroep verwijderd

Parameters

Name Sleutel Vereist Type Description
Documentgroep-id
 id True string

Documentgroep-id

Ingesloten uitnodigingskoppeling voor document genereren

Bewerkings-id:
GenerateEmbeddedInviteLink

Met deze actie wordt een koppeling gegenereerd voor de ingesloten uitnodiging voor het document

Parameters

Name Sleutel Vereist Type Description
Document-id
 id True string

Document-id
Veld uitnodigen-id
 field_invite_id True string

Ingesloten uitnodigings-id van de actie Document ingesloten uitnodiging maken
Verlooptijd van koppeling
 link_expiration integer

Hiermee geeft u op hoeveel minuten de koppeling actief blijft. Geldig bereik:15-45 minuten
Verlooptijd van sessie
 session_expiration integer

Hiermee geeft u op hoeveel minuten de ondertekeningssessie actief blijft. Geldig bereik:15-1440 minuten

Retouren

Name Pad Type Description
Link
 data.link string

Gegenereerde ingesloten uitnodigingskoppeling voor het document

Ingesloten uitnodigingskoppeling voor documentgroep genereren

Bewerkings-id:
GenerateDocGroupEmbeddedInviteLink

Met deze actie wordt een koppeling gegenereerd voor de ingesloten uitnodiging voor de documentgroep

Parameters

Name Sleutel Vereist Type Description
Documentgroep-id
 id True string

Documentgroep-id
Ingesloten uitnodigings-id voor documentgroep
 invite_id True string

Id van de ingesloten uitnodiging voor documentgroep maken vanuit de actie Ingesloten uitnodiging voor documentgroep maken
E-mailen
 email True email

E-mailadres van geadresseerde
Verlooptijd van koppeling
 link_expiration integer

Hiermee geeft u op hoeveel minuten de koppeling actief blijft. Geldig bereik:15-45 minuten
Verlooptijd van sessie
 session_expiration integer

Hiermee geeft u op hoeveel minuten de ondertekeningssessie actief blijft. Geldig bereik:15-1440 minuten

Retouren

Name Pad Type Description
Ingesloten uitnodigingskoppeling
 link string

De koppeling voor ingesloten uitnodiging voor documentgroep

Koppeling Voor ingesloten documenten maken

Bewerkings-id:
CreateEmbeddedInviteSettingsLink

Met deze actie wordt een ingesloten koppeling voor verzenden voor een specifiek document gegenereerd, zodat gebruikers van derden het document kunnen voorbereiden en verzenden voor handtekening

Parameters

Name Sleutel Vereist Type Description
Document-id
 id True string

Document-id
Typologie
 type string

Hiermee geeft u de verzendstap op waarmee de koppeling moet worden geopend. Mogelijke waarden: 'Uitnodigen': hiermee opent u de pagina Uitnodiging verzenden voor het document, waarin de gebruiker e-mailberichten voor ondertekenaar, onderwerp, bericht, enzovoort, 'Document' kan toevoegen: hiermee opent u het document in de editor om vulbare velden toe te voegen en opent u vervolgens de pagina Uitnodiging verzenden
Omleidings-URI
 redirect_uri string

De pagina die wordt geopend nadat het ingesloten verzenden is ingesteld. Vereist als omleidingsdoel wordt toegevoegd
Verlooptijd van koppeling
 link_expiration integer

Hiermee geeft u op hoeveel minuten de koppeling actief blijft. Het toegestane bereik: 15 tot 45 minuten. Gebruikers op beheerdersniveau kunnen de duur instellen tot maximaal 43200 minuten
Omleidingsdoel
 redirect_target string

Bepaalt of de omleidings-URI moet worden geopend op een nieuw tabblad in de browser of op hetzelfde tabblad na de ondertekeningssessie. Mogelijke waarden: 'In het nieuwe tabblad': hiermee opent u de koppeling op een nieuw tabblad, 'Op hetzelfde tabblad'. Hiermee opent u de koppeling op hetzelfde tabblad

Retouren

Name Pad Type Description
URL
 url string

De koppeling naar het ingesloten document dat wordt verzonden

Koppeling voor ondertekening maken

Bewerkings-id:
CreateSigningLink

Genereer een koppeling naar het document en deel het om het document te laten ondertekenen

Parameters

Name Sleutel Vereist Type Description
Document-id
 doc_id True string

Geef een unieke document-id op of selecteer een document in de lijst
velden
 fields dynamic

Retouren

Name Pad Type Description
URL
 url_no_signup string

Koppeling voor ondertekening

Lijst met documenten ophalen

Bewerkings-id:
GetListDoc

Een lijst met gebruikersdocumenten ophalen

Parameters

Name Sleutel Vereist Type Description
Template
 template boolean

Opgeven of documenten of sjablonen moeten worden opgehaald
Standaardsjabloon opnemen
 includeDefaultTemplate boolean

Opgeven of de standaardsjabloon moet worden toegevoegd aan de lijst met sjablonen

Retouren

response
array of DocumentProperties

Slimme veldwaarden voor documentgroep vooraf doorvoeren

Bewerkings-id:
UpdateGroupSmartFieldValues

Automatisch slimme velden in de documenten vullen met specifieke waarden

Parameters

Name Sleutel Vereist Type Description
Template
 template_group_id True string

Een documentgroepsjabloon opgeven voor het ophalen van velden uit
Documentgroep-id
 doc_group_id True string

Een unieke documentgroep-id opgeven
velden
 fields dynamic

Retouren

Name Pad Type Description
Documentgroep-id
 id DocumentGroupId

Unieke documentgroep-id

Status van documentnodiging ophalen

Bewerkings-id:
GetInviteStatus

Met deze actie wordt informatie opgehaald over een uitnodiging voor een document, inclusief de status van elke stap en actie

Parameters

Name Sleutel Vereist Type Description
Document-id
 id True string

Document-id

Retouren

Name Pad Type Description
Document geweigerd
 is_document_declined boolean

Waar als het document is geweigerd door de ondertekenaar of fiatteur, anders onwaar
steps
 steps array of object

Steps
Ondertekeningsorder
 steps.signing_order integer

Volgorde van ondertekening
E-mailadres van geadresseerde
 steps.signer_email string

E-mailadres van geadresseerde
Rolnaam
 steps.role_name string

Naam van de rol van geadresseerde
Actietype
 steps.action_type string

De actie die is vereist voor de geadresseerde in het document. Mogelijke waarden: 'Sign', 'View', 'Approve' of 'FreeFormSign'
Uitnodigings-id
 steps.invite_id string

Uitnodigings-id
Toestand
 steps.status string

Ondertekeningsstatus. Mogelijke waarden: 'created', 'pending', 'fulfilled', 'canceled', 'skipped'
Geweigerd
 steps.declined boolean

Retourneert 'true' als de ontvanger van deze stap het document heeft geweigerd
Reden voor weigeren
 steps.decline_reason string

Bericht van de geadresseerde bij het weigeren van het document
Gecreëerd
 steps.created integer

Datum waarop de stap is gemaakt
Updated
 steps.updated integer

Datum waarop de stapstatus voor het laatst is bijgewerkt

Uitnodigen om document te ondertekenen

Bewerkings-id:
InviteToSignAllOptions

Met deze actie wordt een veldnodiging gemaakt en verzonden voor een document dat moet worden ondertekend

Parameters

Name Sleutel Vereist Type Description
Document-id
 id True string

Document-id
E-mailen
 email string

E-mailadres van geadresseerde
E-mailgroep
 email_group string

Een groep gebruikers die de uitnodiging moeten ontvangen. Wanneer een van de gebruikers het document ondertekent, wordt het beschouwd als voltooid. Moet worden gebruikt met de geavanceerde parameter 'e-mailgroepen'. Vereist als 'E-mail' of 'Telefoonnodiging' niet wordt toegevoegd, maar niet tegelijkertijd kan worden gebruikt met een van deze parameters
Telefoon uitnodigen
 phone_invite string

Telefoonnummer van geadresseerde. Vereist voor uitnodiging via sms
Rol
 role True string

Naam van geadresseerderol. bijvoorbeeld Ondertekenaar 1, Ondertekenaar 2
Bestelling
 order True integer

Volgorde van ondertekening. De ondertekeningsvolgorde definieert de volgorde waarin geadresseerden een document moeten ondertekenen of vullen. Zodra alle geadresseerden in een orderstap klaar zijn met ondertekenen, gaat het document verder met de volgende orderstap (bijvoorbeeld 2, 3). Meerdere geadresseerden kunnen dezelfde ondertekeningsorder delen
Rol
 role True string

Naam van geadresseerderol, gebruikt voor het toewijzen van geavanceerde parameters
Naam van handtekening vooraf doorvoeren
 prefill_signature_name string

Vooraf ingevulde tekst in het handtekeningveld, beschikbaar voor bewerking door ondertekenaar
Vereiste vooraf ingestelde handtekeningnaam
 required_preset_signature_name string

Vooraf ingevulde tekst voor het handtekeningveld, vergrendeld voor bewerking door de ontvanger. Kan niet worden gebruikt met de naam van de handtekening vooraf invullen of 'Nieuwe handtekening vereisen'
Nieuwe handtekening vereisen
 force_new_signature boolean

Hiermee definieert u of de ondertekenaar een opgeslagen handtekening kan gebruiken. False – ondertekenaar kan een opgeslagen handtekening gebruiken; Waar: ondertekenaar moet een nieuwe handtekening maken
Doorsturen toestaan
 reassign boolean

Hiermee definieert u of de ontvanger de uitnodiging kan doorsturen naar een ander e-mailadres. 'true': ontvanger kan de uitnodiging doorsturen; 'false': geadresseerde kan de uitnodiging niet doorsturen
Weigeren per handtekening toestaan
 decline_by_signature boolean

Hiermee definieert u of de optie Weigeren voor ondertekenen op handtekeningvelden moet worden weergegeven. Waar – toon de optie weigeren; false – de optie weigeren verbergen
Herinnering verzenden in X Dagen
 remind_after integer

X dagen na de uitnodiging ontvangt een recepient een herinnerings-e-mail (van 1 tot 179 dagen). Moet kleiner zijn dan 'Dagen tot vervaldatum'
Herinnering verzenden in x dagen vóór verloop
 remind_before integer

X dagen voor de vervaldatum ontvangt een recepient een herinnerings-e-mail (van 1 tot 179 dagen). Moet kleiner zijn dan 'Dagen tot vervaldatum'
Herinnering elke x dagen verzenden
 remind_repeat integer

Een recepient ontvangt elke x dagen een herinneringsmail nadat de uitnodiging is verzonden (van 1 tot 7 dagen)
Dagen tot verloop
 expiration_days integer

In X dagen verloopt de uitnodiging (van 3 tot 180 dagen)
Verificatietype
 authentication_type string

Verificatietype dat wordt gebruikt voor verificatie van geadresseerden tijdens de ondertekeningssessie. Toegestane waarden: 'Wachtwoord', 'Telefoongesprek' en 'Sms'
Verificatiewachtwoord
 password string

Wachtwoord ingesteld voor de ondertekenaarverificatie. Vereist voor het verificatietype Wachtwoord
Telefoon voor verificatie
 phone string

Telefoonnummer dat wordt gebruikt om de ondertekenaar te verifiëren. Vereist voor het verificatietype Telefoongesprek en Sms. Voorbeeld: +1XXXXXXXXXXX
Sms-bericht voor verificatie
 authentication_sms_message string

Aangepast sms-bericht dat naar de ondertekenaar wordt verzonden, met de tijdelijke aanduiding {password}. Wordt gebruikt met het verificatietype Sms. Zonder deze parameter ontvangt de ondertekenaar een standaard-sms met een automatisch gegenereerd wachtwoord (ontgrendelingscode) - 'Ontgrendelingscode voor SignNow-document uitnodigen: 123456'. Voorbeeld: Voer het wachtwoord {password} in om uw document te ontgrendelen
Onderwerp
 subject string

Aangepast e-mailonderwerp voor de geadresseerde
Message
 message string

Aangepast e-mailbericht voor de geadresseerde
Omleidings-URI
 redirect_uri string

Wanneer alle aangevraagde velden zijn voltooid en ondertekend, wordt de ondertekenaar omgeleid naar deze URI
Omleidingsdoel
 redirect_target string

Bepaalt of de omleidings-URI moet worden geopend op een nieuw tabblad in de browser of op hetzelfde tabblad na de ondertekeningssessie. Mogelijke waarden: 'In het nieuwe tabblad': hiermee opent u de koppeling op een nieuw tabblad, 'Op hetzelfde tabblad'. Hiermee opent u de koppeling op hetzelfde tabblad
Omleidings-URI weigeren
 decline_redirect_uri string

De koppeling die wordt geopend nadat het document is geweigerd door de geadresseerde
Omleidings-URI sluiten
 close_redirect_uri string

De koppeling die wordt geopend wanneer de geadresseerde op Voortgang opslaan klikt en Later voltooien tijdens een ondertekeningssessie of sluiten in de weergavemodus
Is omleiding geannuleerd
 is_finish_redirect_canceled boolean

Hiermee geeft u op of de instelling voor voltooiingsomleiding wordt geannuleerd voor de organisatie. Waar: de omleiding wordt geannuleerd; Onwaar: de omleiding blijft actief
Wordt omleiding geannuleerd
 is_close_redirect_canceled boolean

Hiermee geeft u op of de instelling voor het omleiden van de voortgang van het opslaan wordt geannuleerd voor de organisatie. Waar: de omleiding wordt geannuleerd; Onwaar: de omleiding blijft actief
Wordt omleiding geannuleerd
 is_decline_redirect_canceled boolean

Hiermee geeft u op of de omleidingsinstelling voor weigeren wordt geannuleerd voor de organisatie. Waar: de omleiding wordt geannuleerd; Onwaar: de omleiding blijft actief
Language
 language string

Hiermee geeft u de taal van de ondertekeningssessie en e-mailberichten voor meldingen voor de ondertekenaar. Mogelijke waarden: En voor Engels, Es voor Spaans en Fr voor Frans. Als deze niet is ingesteld, wordt de taal bepaald door de taal van uw SignNow-account
E-mailen
 email True string

E-mailadres van viewer
Rol
 role True string

Rolnaam van viewer
Bestelling
 order True integer

Geheel getal: de volgorde van verzenden, beginnend vanaf 1
Rol
 role True string

Rolnaam van viewer. Wordt gebruikt voor het toewijzen van geavanceerde parameters
Onderwerp
 subject string

Aangepast e-mailonderwerp voor de viewer
Message
 message string

Aangepast e-mailbericht voor de viewer
E-mailen
 email True string

E-mailadres van fiatteur
Rol
 role True string

Naam van fiatteurrol
Bestelling
 order True integer

De volgorde van ontvangst van de goedkeuringsaanvraag
Rol
 role True string

Naam van fiatteurrol. Wordt gebruikt voor het toewijzen van geavanceerde parameters
Verloopdagen
 expiration_days integer

Aantal dagen voordat de uitnodiging verloopt
Message
 message string

Aangepast e-mailbericht voor de fiatteur
Onderwerp
 subject string

Aangepast e-mailonderwerp voor de fiatteur
Verificatietype
 authentication_type string

Verificatietype dat wordt gebruikt voor verificatie van geadresseerden tijdens de ondertekeningssessie. Toegestane waarden: 'Wachtwoord', 'Telefoongesprek' en 'Sms'
Wachtwoord
 password string

Wachtwoord ingesteld voor de ondertekenaarverificatie. Vereist voor het verificatietype Wachtwoord
Telefoon
 phone string

Telefoonnummer dat wordt gebruikt om de ondertekenaar te verifiëren. Vereist voor het verificatietype Telefoongesprek en Sms. Voorbeeld: +1XXXXXXXXXXX
Sms-bericht voor verificatie
 authentication_sms_message string

Aangepast sms-bericht dat naar de ondertekenaar wordt verzonden, met de tijdelijke aanduiding {password}. Wordt gebruikt met het verificatietype Sms. Zonder deze parameter ontvangt de ondertekenaar een standaard-sms met een automatisch gegenereerd wachtwoord (ontgrendelingscode) - 'Ontgrendelingscode voor SignNow-document uitnodigen: 123456'. Voorbeeld: Voer het wachtwoord {password} in om uw document te ontgrendelen
Omleidings-URI
 redirect_uri string

De URL die wordt geopend nadat de fiatteur het document goedkeurt
Omleidingsdoel
 redirect_target string

Bepaalt of de omleidings-URI moet worden geopend op een nieuw tabblad in de browser of op hetzelfde tabblad na de ondertekeningssessie. Mogelijke waarden: 'In het nieuwe tabblad': hiermee opent u de koppeling op een nieuw tabblad, 'Op hetzelfde tabblad'. Hiermee opent u de koppeling op hetzelfde tabblad
Van
 from string

E-mailadres van afzender. Alleen het e-mailadres dat is gekoppeld aan uw SignNow-account (aanmeldings-e-mailadres) kan worden gebruikt. Als deze leeg blijft, wordt deze automatisch ingesteld
ID-kaart
 id string

Id van een e-mailgroep. Een unieke id van 40 tekens die vooraf moet worden gemaakt
Naam
 name string

Een naam van de groep. Gebruik dit in het veld E-mailgroep ondertekenaars >
E-mailen
 email string

E-mailadres dat een uitnodiging moet ontvangen
E-mailen
 email string

E-mailadres dat een uitnodiging moet ontvangen
Naam
 name string

Naam van de stap
E-mailen
 email string

E-mailadres van CC-geadresseerde
Step
 step integer

De volgorde van verzending, beginnend vanaf 1
Onderwerp
 subject string

E-mailonderwerp voor alle geadresseerden
Message
 message string

E-mailbericht voor alle geadresseerden
CC-onderwerp
 cc_subject string

Cc-e-mailonderwerp voor alle CC-geadresseerden
CC-bericht
 cc_message string

CC-e-mailbericht voor alle CC-geadresseerden
QES-handtekening
 signature string

Type of QES. Mogelijke waarden: 'Eideasy', 'Nom151'. Wordt gebruikt voor het aanvragen van QES-handtekeningen van ondertekenaars. Alle ondertekenaars in de uitnodiging moeten hetzelfde handtekeningtype gebruiken. Als u een uitnodiging wilt maken met QES, moet de gebruiker deel uitmaken van een organisatie waarvoor QES is ingeschakeld

Retouren

Name Pad Type Description
Toestand
 status string

Toestand

Uitnodigen om documentgroep te ondertekenen

Bewerkings-id:
InviteToSignDocGroupAllOptions

Met deze actie maakt u een uitnodiging voor het ondertekenen van een documentgroep. U kunt een werkstroom met meerdere stappen configureren, waarbij verschillende geadresseerden in verschillende fasen op de documentgroep reageren

Parameters

Name Sleutel Vereist Type Description
Documentgroep-id
 id True string

Documentgroep-id
Bestelling
 order True integer

Volgorde van ondertekeningsstap: 1 - de geadresseerde(s) ondertekent eerst de documentgroep, vervolgens wordt de documentgroep verzonden naar 2,3 enzovoort. Verschillende geadresseerden kunnen dezelfde volgorde van ondertekening hebben
E-mailen
 email string

E-mailadres van geadresseerde
E-mailgroep
 email_group string

Een groep geadresseerden voor contactpersonen
Rolnaam
 role_name True string

De rolnaam van de geadresseerde in het document (kan worden gebruikt om velden in het document te identificeren die aan deze specifieke geadresseerde zijn toegewezen)
Handeling
 action True string

Toegestane actie met een document. Mogelijke waarden: Weergeven, Ondertekenen, Goedkeuren
Document-id
 document_id True string

Id van het document waarvoor acties vereist zijn van deze geadresseerde
Vereiste vooraf ingestelde handtekeningnaam
 required_preset_signature_name string

Vooraf ingevulde tekst voor het handtekeningveld, vergrendeld voor bewerking door de geadresseerde
Doorsturen toestaan
 allow_reassign boolean

Hiermee definieert u of de ontvanger de uitnodiging kan doorsturen naar een ander e-mailadres. 'true': ontvanger kan de uitnodiging doorsturen; 'false': geadresseerde kan de uitnodiging niet doorsturen
Weigeren per handtekening toestaan
 decline_by_signature boolean

Hiermee definieert u of de optie Weigeren voor ondertekenen op handtekeningvelden moet worden weergegeven. Waar: de optie weigeren weergeven; Onwaar: de optie weigeren verbergen
Verificatietype
 type string

Verificatietype dat wordt gebruikt voor verificatie van geadresseerden tijdens de ondertekeningssessie. Toegestane waarden: 'Wachtwoord', 'Telefoongesprek' en 'Sms'
Wachtwoord
 value string

Wachtwoord ingesteld voor de ondertekenaarverificatie. Vereist voor het verificatietype Wachtwoord
Telefoon
 phone string

Telefoonnummer dat wordt gebruikt om de ondertekenaar te verifiëren. Vereist voor het verificatietype Telefoongesprek en Sms. Voorbeeld: +1XXXXXXXXXXX
Message
 message string

Aangepast sms-bericht dat naar de ondertekenaar wordt verzonden, met de tijdelijke aanduiding {password}. Wordt gebruikt met het verificatietype Sms. Zonder deze parameter ontvangt de ondertekenaar een standaard-sms met een automatisch gegenereerd wachtwoord (ontgrendelingscode) - 'SignNow-document nodig ontgrendelingscode uit: 123456'
MerchantId
 merchant_id string

De id van het merchant-account dat is toegevoegd aan uw organisatie
Valuta
 currency string

De aangevraagde betalingsvaluta
Aantal
 amount string

Het gevraagde betalingsbedrag
Uri
 redirect_uri string

Wanneer alle aangevraagde velden zijn voltooid en ondertekend, wordt de ondertekenaar omgeleid naar deze URI
Omleidingsdoel
 redirect_target string

Bepaalt of de omleidings-URI moet worden geopend op een nieuw tabblad in de browser of op hetzelfde tabblad na de ondertekeningssessie. Mogelijke waarden: 'In het nieuwe tabblad': hiermee opent u de koppeling op een nieuw tabblad, 'Op hetzelfde tabblad'. Hiermee opent u de koppeling op hetzelfde tabblad
Omleidings-URI weigeren
 decline_redirect_uri string

De koppeling die wordt geopend nadat het document is geweigerd door de geadresseerde
Omleidings-URI sluiten
 close_redirect_uri string

De koppeling die wordt geopend wanneer een ondertekenaar op Voortgang opslaan en Later voltooien klikt tijdens een ondertekeningssessie of sluiten in de weergavemodus
Is omleiding geannuleerd
 is_finish_redirect_canceled boolean

Hiermee geeft u op of de instelling voor voltooiingsomleiding wordt geannuleerd voor de organisatie. Waar: de omleiding wordt geannuleerd; Onwaar: de omleiding blijft actief
Wordt omleiding geannuleerd
 is_close_redirect_canceled boolean

Hiermee geeft u op of de instelling voor het omleiden van de voortgang van het opslaan wordt geannuleerd voor de organisatie. Waar: de omleiding wordt geannuleerd; Onwaar: de omleiding blijft actief
Wordt omleiding geannuleerd
 is_decline_redirect_canceled boolean

Hiermee geeft u op of de omleidingsinstelling voor weigeren wordt geannuleerd voor de organisatie. Waar: de omleiding wordt geannuleerd; Onwaar: de omleiding blijft actief
Language
 language string

Hiermee geeft u de taal van de ondertekeningssessie en e-mailberichten voor meldingen voor de ondertekenaar. Mogelijke waarden: En voor Engels, Es voor Spaans en Fr voor Frans. Als deze niet is ingesteld, wordt de taal bepaald door de taal van uw SignNow-account
Bestelling
 order True integer

Volgorde van ondertekeningsstap: 1 - de geadresseerde(s) ondertekent eerst de documentgroep, vervolgens wordt de documentgroep verzonden naar 2,3 enzovoort. Verschillende geadresseerden kunnen dezelfde volgorde van ondertekening hebben
E-mailen
 email True string

E-mailadres van geadresseerde
E-mailgroep
 email_group string

Een groep geadresseerden voor contactpersonen
Onderwerp
 subject string

Aangepast e-mailonderwerp voor de geadresseerde
Message
 message string

Aangepast e-mailbericht voor de geadresseerde
Dagen tot verloop
 expiration_days integer

In x dagen verloopt de uitnodiging (van 3 tot 180 dagen)
Herinnering verzenden in X Dagen
 remind_after integer

X dagen na de uitnodiging ontvangt een recepient een herinnerings-e-mail (van 1 tot 179 dagen). Moet korter zijn dan verloopdagen
Herinnering verzenden in X dagen vóór verloop
 remind_before integer

X dagen voor de vervaldatum ontvangt een recepient een herinnerings-e-mail (van 1 tot 179 dagen). Moet korter zijn dan verloopdagen
Herinnering elke x dagen verzenden
 remind_repeat integer

Een recepient ontvangt elke x dagen een herinneringsmail nadat de uitnodiging is verzonden (van 1 tot 7 dagen)
Identiteitsbewijs
 id string

Id van een e-mailgroep. Een unieke id van 40 tekens die vooraf moet worden gemaakt
Naam
 name string

Een naam van de groep. Gebruik deze in de e-mailgroep Uitnodigingsstappen >
E-mailen
 email string

E-mailadres dat een uitnodiging moet ontvangen
E-mailen
 email string

E-mailadres van de geadresseerde die de voltooiingsmail ontvangt
Documentbijlage uitschakelen
 disable_document_attachment boolean

Hiermee wordt aangegeven of het verzenden van documentbijlagen met de voltooiingsmail moet worden uitgeschakeld. Mogelijke waarden: Onwaar - documentbijlage inschakelen, Waar - documentbijlage uitschakelen
Onderwerp
 subject string

Aangepast onderwerp voor de voltooiings-e-mail
Message
 message string

Aangepast bericht voor de voltooiings-e-mail
Aanmelden als samengevoegd
 sign_as_merged boolean

Indien waar, kan api-gebruiker een uitnodiging verzenden die wordt geopend als samengevoegde documentgroep in één document
Tijdstempel van client
 client_timestamp integer

De tijdstempel van de uitnodiging voor de documentgroep
E-mailen
 email string

E-mailadres dat een uitnodiging moet ontvangen
QES-handtekening
 signature string

Type of QES. Mogelijke waarden: 'Eideasy', 'Nom151'. Wordt gebruikt voor het aanvragen van QES-handtekeningen van ondertekenaars. Alle ondertekenaars in de uitnodiging moeten hetzelfde handtekeningtype gebruiken. Als u een uitnodiging wilt maken met QES, moet de gebruiker deel uitmaken van een organisatie waarvoor QES is ingeschakeld

Retouren

Name Pad Type Description
Identiteitsbewijs
 id string

Uitnodigings-id van documentgroep
Uitnodigingskoppeling in behandeling
 pending_invite_link string

Koppeling uitnodiging in behandeling

Uitnodiging annuleren

Bewerkings-id:
CancelInvite

Annulering van handtekeningnodiging

Parameters

Name Sleutel Vereist Type Description
Document-id
 doc_id True string

Document-id opgeven voor annulering van handtekeningnodiging

Retouren

response
object

Uitnodigingsstatus voor documentgroep ophalen

Bewerkings-id:
GetDocumentGroupInviteStatus

Met deze actie wordt informatie opgehaald over een uitnodiging voor een documentgroep, inclusief de status van elke stap en actie

Parameters

Name Sleutel Vereist Type Description
Documentgroep-id
 id True string

Documentgroep-id

Retouren

Name Pad Type Description
Uitnodigings-id van documentgroep
 document_group_invite_id string

Uitnodigings-id van de documentgroep
Status van documentgroep
 status string

Ondertekeningsstatus van documentgroep. Mogelijke waarden: 'created', 'pending', 'fulfilled', 'canceled'
E-mailadres van eigenaar
 owner_email string

E-mailadres van de eigenaar van de documentgroep
Documentgroep geweigerd
 is_document_declined boolean

Retourneert 'true' als een document in de groep wordt geweigerd door een ondertekenaar of fiatteur; retourneert anders 'false'
steps
 steps array of object

Steps
Stap-id
 steps.step_id string

Stap-id van de uitnodiging voor de documentgroep
Ondertekeningsorder
 steps.signing_order integer

Volgorde van ondertekening
Document-id
 steps.document_id string

Document-id
Documentnaam
 steps.document_name string

Documentnaam
E-mailadres van ondertekenaar
 steps.signer_email string

E-mailadres van geadresseerde
Rolnaam
 steps.role_name string

Naam van de rol van geadresseerde
Actietype
 steps.action_type string

De actie die is vereist voor de geadresseerde in het document. Mogelijke waarden: 'Sign', 'View', 'Approve' of 'FreeFormSign'
Stap uitnodigings-id
 steps.invite_id string

Id van de uitnodigingsstap
Toestand
 steps.status string

De ondertekeningsstatus van de stap
Geweigerd
 steps.declined boolean

Waar als de ontvanger in deze stap het document heeft geweigerd
Reden voor weigeren
 steps.decline_reason string

Bericht van de geadresseerde bij het weigeren van het document
Gecreëerd
 steps.created integer

Datum waarop de stap is gemaakt
Updated
 steps.updated integer

Datum waarop de stapstatus voor het laatst is bijgewerkt

Veldwaarden voor documentgroep vooraf invullen

Bewerkings-id:
UpdateGroupFieldValues

Vulbare velden in de documenten automatisch in met specifieke waarden

Parameters

Name Sleutel Vereist Type Description
Template
 template_group_id True string

Een documentgroepsjabloon opgeven voor het ophalen van velden uit
Documentgroep-id
 doc_group_id True string

Een unieke documentgroep-id opgeven
velden
 fields dynamic

Retouren

Name Pad Type Description
Documentgroep-id
 id DocumentGroupId

Unieke documentgroep-id

Veldwaarden vooraf doorvoeren

Bewerkings-id:
UpdateFieldValues_V2

Vulbare velden in het document automatisch in met specifieke waarden

Parameters

Name Sleutel Vereist Type Description
Template
 template_id True string

Een documentsjabloon opgeven waaruit velden moeten worden opgehaald
Document-id
 doc_id True string

Een unieke document-id opgeven
velden
 fields dynamic

Retouren

Name Pad Type Description
Document-id
 id DocumentId

Unieke document-id

Veldwaarden vooraf invullen [AFGESCHAFT]

Bewerkings-id:
UpdateFieldValues

Deze actie is afgeschaft. Gebruik in plaats daarvan vooraf invulwaarden voor documentvelden .

Vooraf invullen van veldwaarden en eigenschappen.

Parameters

Name Sleutel Vereist Type Description
Template
 template_id True string

Een documentsjabloon opgeven waaruit velden moeten worden opgehaald
Document-id
 doc_id True string

Een unieke document-id opgeven
velden
 fields dynamic

Retouren

Name Pad Type Description
Document-id
 id DocumentId

Unieke document-id

Waarden voor slim veld vooraf doorvoeren

Bewerkings-id:
PrefillSmartFields

Smart Field-waarden vooraf invullen voor het opgegeven document

Parameters

Name Sleutel Vereist Type Description
Template
 template_id True string

Een documentsjabloon opgeven waaruit velden moeten worden opgehaald
Document-id
 doc_id True string

Een unieke document-id opgeven
velden
 fields dynamic

Triggers

Stroom starten bij documentgebeurtenis

Selecteer de gebeurtenis waarop u wilt activeren: de nieuwe of bijgewerkte handtekeningnodiging; wanneer iemand een document maakt, bijwerkt, voltooit of verwijdert
Stroom starten op documentgebeurtenis [AFGESCHAFT]

Deze actie is afgeschaft. Gebruik in plaats daarvan de startstroom voor documentgebeurtenis .

U kunt een trigger maken voor een van deze gebeurtenissen: document maken, document bijwerken, document verwijderen, document voltooid, maken van uitnodiging, update uitnodigen

Stroom starten bij documentgebeurtenis

Bewerkings-id:
Triggers_V2

Selecteer de gebeurtenis waarop u wilt activeren: de nieuwe of bijgewerkte handtekeningnodiging; wanneer iemand een document maakt, bijwerkt, voltooit of verwijdert

Parameters

Name Sleutel Vereist Type Description
Event
 event True string

Gebeurtenis selecteren die de stroom moet activeren

Retouren

Name Pad Type Description
Event
 meta.event string

Document gebeurtenis die de trigger heeft veroorzaakt.
Document-id
 content.document_id string

Unieke id van het doeldocument waardoor de gebeurtenis is veroorzaakt.
Documentnaam
 content.document_name string

Bestandsnaam van doeldocument zonder extensie

Stroom starten op documentgebeurtenis [AFGESCHAFT]

Bewerkings-id:
Triggers

Deze actie is afgeschaft. Gebruik in plaats daarvan de startstroom voor documentgebeurtenis .

U kunt een trigger maken voor een van deze gebeurtenissen: document maken, document bijwerken, document verwijderen, document voltooid, maken van uitnodiging, update uitnodigen

Parameters

Name Sleutel Vereist Type Description
Event
 event True string

Selecteer de gebeurtenis die de stroom moet activeren.

Retouren

Name Pad Type Description
Tijdstempel
 meta.timestamp integer

Datum en tijd waarop de gebeurtenis heeft plaatsgevonden (Unix-tijdstempelindeling).
Event
 meta.event string

Document gebeurtenis die de trigger heeft veroorzaakt.
Document-id
 content.document_id string

Unieke id van het doeldocument waardoor de gebeurtenis is veroorzaakt.
Documentnaam
 content.document_name string

Bestandsnaam van doeldocument zonder extensie

Definities

DocumentProperties

Name Pad Type Description
Document-id
 id DocumentId

Unieke document-id
Documentnaam
 document_name string

Bestandsnaam van document zonder extensie
Aantal pagina's
 page_count integer

Aantal pagina's in het document
Gecreëerd
 created integer

Datum en tijd waarop het document is gemaakt in Unix Timestamp-indeling
Updated
 updated integer

De datum en tijd waarop het document is bijgewerkt in unix-tijdstempelindeling
Sjabloonnaam
 original_filename string

Bestandsnaam van sjabloon met extensie (indien aanwezig)
Sjabloon-ID
 origin_document_id string

Sjabloondocument-id (indien aanwezig)
Is sjabloon
 template boolean

waar als het document een sjabloon is.
Documentstatus
 status string

Documentstatus

DocumentGroupsResponse

Name Pad Type Description
document_groups
 document_groups array of DocumentGroupProperties
Totaalaantal documentgroepen
 document_group_total_count integer

Het totale aantal documentgroepen in het SignNow-account

DocumentGroupProperties

Name Pad Type Description
Documentgroep-id
 group_id DocumentGroupId

Unieke documentgroep-id
Naam van documentgroep
 group_name string

Naam van documentgroep
Documents
 documents array of DocumentGroupDocumentProperties

Documents

DocumentGroupDocumentProperties

Name Pad Type Description
Document-id
 id DocumentId

Unieke document-id
Documentnaam
 document_name string

Bestandsnaam van document zonder extensie
Sjabloon-ID
 origin_document_id string

Sjabloondocument-id (indien aanwezig)

CreateDocumentGroupFromFilesResponse

Name Pad Type Description
Naam van documentgroep
 group_name string

Naam van documentgroep
Documentgroep-id
 group_id string

Documentgroep-id
Documenten
 documents array of object
Document-id
 documents.id DocumentId

Unieke document-id
Documentnaam
 documents.name string

Documentnaam

DocumentId

Unieke document-id

Unieke document-id

Document-id
string

DocumentGroupId

Unieke documentgroep-id

Unieke documentgroep-id

Documentgroep-id
string

Voorwerp

Dit is het type 'object'.

binair

Dit is het basisgegevenstype 'binair'.