Adobe Acrobat Sign Sandbox
Adobe is de meest vertrouwde digitale documenttekenservice ter wereld. Met Adobe Acrobat Sign kunt u handmatige processen transformeren in alle digitale ervaringen. Adobe Acrobat Sign-functionaliteit opnemen in uw favoriete toepassingen om de status van overeenkomsten te maken, verzenden en bewaken.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Standaard | 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 | Standaard | 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 | Standaard | 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 | Ondersteuning voor Adobe Acrobat Sign |
| URL | https://helpx.adobe.com/contact/enterprise-support.dc.html#sign |
| E-mailen | support@echosign.zendesk.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Adobe Inc. |
| Webpagina | https://acrobat.adobe.com/us/en/sign.html |
| Privacybeleid | https://www.adobe.com/privacy/policy.html |
| Categorieën | Webpagina |
Adobe Acrobat Sign Sandbox
De Adobe Acrobat Sign Sandbox is een gewijzigd enterprise-tier-account in een omgeving die afzonderlijk is van de productieomgeving. Het doel van de sandbox is dat beheerders configuraties, API-aanroepen, bibliotheeksjablonen, aangepaste werkstromen en nieuwe functies kunnen testen die de release naderen.
Uitgever: Adobe, Inc.
Vereiste voorwaarden
Adobe Acrobat Sign-account is vereist.
Referenties ophalen
N/A
Aan de slag met uw connector
N/A
Bekende problemen en beperkingen
N/A
Veelvoorkomende fouten en oplossingen
N/A
Veelgestelde vragen
Gebruikershandleiding voor connectors https://helpx.adobe.com/sign/using/adobesign-sandbox.html
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 250 | 60 seconden |
Acties
| De gedetailleerde informatie van de werkstroom ophalen |
Met deze bewerking worden gedetailleerde stukjes informatie over de werkstroom opgehaald. |
| De ondertekenings-URL ophalen |
Met deze bewerking wordt de URL voor de e-sign-pagina opgehaald voor de huidige ondertekenaar(en) van een overeenkomst. |
| De status van een overeenkomst ophalen |
Met deze bewerking worden alle huidige gegevens van een overeenkomst opgehaald, zoals de status. |
| De status van een overeenkomst ophalen [AFGESCHAFT] |
Deze actie is afgeschaft. Gebruik in plaats daarvan de status van een overeenkomst ophalen .
|
| Een bibliotheeksjabloon maken op basis van een document-URL |
Met deze bewerking maakt u een sjabloon in de Adobe Acrobat Sign-bibliotheek op basis van een document-URL. Gebruik deze sjabloon voor het verzenden van overeenkomsten |
| Een bibliotheeksjabloon maken op basis van een document-URL (oud) [AFGESCHAFT] |
Met deze bewerking maakt u een sjabloon in de Adobe Acrobat Sign-bibliotheek op basis van een document-URL. Gebruik deze sjabloon voor het verzenden van overeenkomsten |
| Een bibliotheeksjabloon maken op basis van een geüpload document |
Met deze bewerking maakt u een sjabloon in de Adobe Acrobat Sign-bibliotheek op basis van een geüpload document. Gebruik deze sjabloon voor het verzenden van overeenkomsten. |
| Een bibliotheeksjabloon maken op basis van een geüpload document (oud) [AFGESCHAFT] |
Met deze bewerking maakt u een sjabloon in de Adobe Acrobat Sign-bibliotheek op basis van een geüpload document. Gebruik deze sjabloon voor het verzenden van overeenkomsten. |
| Een document ophalen uit een overeenkomst |
Met deze bewerking wordt de bestandsstroom van een specifiek document van de overeenkomst opgehaald. |
| Een document ophalen uit een overeenkomst [AFGESCHAFT] |
Deze actie is afgeschaft. Gebruik in plaats daarvan Een document ophalen uit een overeenkomst .
|
| Een document uploaden en een document-id ophalen |
Met deze bewerking wordt een document geüpload in uw Adobe Acrobat Sign-account en wordt er een document-id voor geretourneerd. Dit document wordt tijdelijk opgeslagen in Adobe Acrobat Sign en de document-id kan worden gebruikt voor verdere bewerkingen, zoals het maken van een overeenkomst. |
| Een document uploaden en een document-id ophalen (oud) [AFGESCHAFT] |
Met deze bewerking wordt een document geüpload in uw Adobe Acrobat Sign-account en wordt er een document-id voor geretourneerd. Dit document wordt tijdelijk opgeslagen in Adobe Acrobat Sign en de document-id kan worden gebruikt voor verdere bewerkingen, zoals het maken van een overeenkomst. |
| Een lijst met alle bibliotheeksjablonen ophalen |
Met deze bewerking wordt de lijst opgehaald met alle documenten die zijn opgeslagen als sjablonen in de Adobe Acrobat Sign-bibliotheek van de gebruiker. |
| Een lijst met alle bibliotheeksjablonen ophalen (oud) [AFGESCHAFT] |
Met deze bewerking wordt de lijst opgehaald met alle documenten die zijn opgeslagen als sjablonen in de Adobe Acrobat Sign-bibliotheek van de gebruiker. |
| Een lijst met alle document-id's ophalen uit een overeenkomst |
Met deze bewerking worden de id's van alle documenten en ondersteunende documenten van een overeenkomst opgehaald. |
| Een lijst met alle document-id's ophalen uit een overeenkomst [AFGESCHAFT] |
Deze actie is afgeschaft. Gebruik in plaats daarvan een lijst met alle document-id's uit een overeenkomst ophalen.
|
| Een lijst met alle overeenkomsten ophalen |
Met deze bewerking wordt de lijst met alle overeenkomsten van de gebruiker opgehaald. |
| Een lijst met alle overeenkomsten ophalen (oud) [AFGESCHAFT] |
Met deze bewerking wordt de lijst met alle overeenkomsten van de gebruiker opgehaald. |
| Een lijst met alle overeenkomsten ophalen op basis van zoekcriteria |
Met deze bewerking worden overeenkomsten doorzocht op criteria zoals werkstroom-id, enzovoort. |
| Een lijst met alle webformulieren ophalen |
Met deze bewerking wordt de lijst met alle webformulieren van de gebruiker opgehaald. |
| Een lijst met alle werkstromen ophalen |
Met deze bewerking wordt de lijst met alle werkstromen van de gebruiker opgehaald. |
| Een lijst ophalen van alle groepen waartoe de gebruiker behoort |
Met deze bewerking wordt de lijst opgehaald van alle groepen waartoe de gebruiker behoort. |
| Een overeenkomst annuleren |
Annuleert de overeenkomst die is geïdentificeerd door agreementId in het pad. |
| Een overeenkomst maken op basis van bestandsinhoud en verzenden voor handtekening |
Met deze bewerking maakt u een overeenkomst op basis van een bestand in Adobe Acrobat Sign en verzendt u deze voor ondertekening. |
| Een overeenkomst maken op basis van een bibliotheeksjabloon en verzenden voor handtekening |
Met deze bewerking maakt u een overeenkomst op basis van een sjabloon die is opgeslagen in de Adobe Acrobat Sign-bibliotheek van de gebruiker en verzendt deze voor handtekening. |
| Een overeenkomst maken op basis van een bibliotheeksjabloon en verzenden voor handtekening (oud) [AFGESCHAFT] |
Met deze bewerking maakt u een overeenkomst op basis van een sjabloon die is opgeslagen in de Adobe Acrobat Sign-bibliotheek van de gebruiker en verzendt deze voor handtekening. |
| Een overeenkomst maken op basis van een document-URL en verzenden voor handtekening |
Met deze bewerking maakt u een overeenkomst op basis van een document dat is geüpload in Adobe Acrobat Sign en verzendt u deze voor handtekening. |
| Een overeenkomst maken op basis van een document-URL en verzenden voor handtekening (oud) [AFGESCHAFT] |
Met deze bewerking maakt u een overeenkomst op basis van een document dat is geüpload in Adobe Acrobat Sign en verzendt u deze voor handtekening. |
| Een overeenkomst maken op basis van een werkstroom en verzenden voor handtekening |
Met deze bewerking wordt een overeenkomst gemaakt op basis van een werkstroom in Adobe Acrobat Sign en wordt deze verzonden voor ondertekening. |
| Een overeenkomst maken op een geüpload document en verzenden voor handtekening |
Met deze bewerking maakt u een overeenkomst op basis van een document dat is geüpload in Adobe Acrobat Sign en verzendt u deze voor handtekening. |
| Een overeenkomst maken van een geüpload document en verzenden voor handtekening (oud) [AFGESCHAFT] |
Met deze bewerking maakt u een overeenkomst op basis van een document dat is geüpload in Adobe Acrobat Sign en verzendt u deze voor handtekening. |
| Een PDF van de audittrail van de overeenkomst ophalen |
Met deze bewerking wordt de PDF-bestandsstroom van het audittrail van de overeenkomst opgehaald. Houd er rekening mee dat de bestandsstroom moet worden opgeslagen met een bestandsnaam die eindigt op .pdf bestandsextensie. |
| Een PDF van een ondertekende overeenkomst ophalen |
Met deze bewerking wordt de PDF-bestandsstroom van de gecombineerde of ondertekende overeenkomst opgehaald. Houd er rekening mee dat de bestandsstroom moet worden opgeslagen met een bestandsnaam die eindigt op .pdf bestandsextensie. |
| Een PDF van een ondertekende overeenkomst ophalen [AFGESCHAFT] |
Deze actie is afgeschaft. Gebruik in plaats daarvan Een PDF van een ondertekende overeenkomst ophalen.
|
| Formulierveldgegevens van overeenkomst ophalen (oud) [AFGESCHAFT] |
Hiermee worden gegevens opgehaald die zijn ingevoerd in de interactieve formuliervelden van de overeenkomst. |
| Formulierveldgegevens van overeenkomst ophalen in CSV-indeling |
Hiermee worden gegevens opgehaald die zijn ingevoerd in de interactieve formuliervelden van de overeenkomst. |
| Formulierveldgegevens van overeenkomst ophalen in JSON-indeling |
Hiermee worden gegevens opgehaald die zijn ingevoerd in de interactieve formuliervelden van de overeenkomst. |
De gedetailleerde informatie van de werkstroom ophalen
Met deze bewerking worden gedetailleerde stukjes informatie over de werkstroom opgehaald.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Werkstroom-id
|
workflowId | True | string |
De werkstroom-id van de werkstroom waarvan de gegevens nodig zijn |
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
Retouren
Een JSON met gedetailleerde informatie over de werkstroom
De ondertekenings-URL ophalen
Met deze bewerking wordt de URL voor de e-sign-pagina opgehaald voor de huidige ondertekenaar(en) van een overeenkomst.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id zoals opgegeven door de actie waarmee de overeenkomst wordt gemaakt |
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
Retouren
- Body
- SigningUrlResponse
De status van een overeenkomst ophalen
Met deze bewerking worden alle huidige gegevens van een overeenkomst opgehaald, zoals de status.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst waarvan de informatie nodig is |
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
Retouren
Details van overeenkomst voltooien
- Body
- AgreementInfoV6
De status van een overeenkomst ophalen [AFGESCHAFT]
Deze actie is afgeschaft. Gebruik in plaats daarvan de status van een overeenkomst ophalen .
Met deze bewerking worden alle huidige gegevens van een overeenkomst opgehaald, zoals de status.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst waarvan de informatie nodig is |
Retouren
De volledige details over de overeenkomst
- Body
- AgreementInfo
Een bibliotheeksjabloon maken op basis van een document-URL
Met deze bewerking maakt u een sjabloon in de Adobe Acrobat Sign-bibliotheek op basis van een document-URL. Gebruik deze sjabloon voor het verzenden van overeenkomsten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Sjabloonnaam
|
name | True | string |
Overeenkomstnaam die wordt gebruikt om de sjabloon te identificeren |
|
Sjabloontype
|
templateTypes | True | array of string |
Een lijst met een of meer bibliotheeksjabloontypen |
|
Deelmodus
|
sharingMode | True | string |
Hiermee geeft u op wie toegang moet hebben tot dit bibliotheekdocument |
|
URL
|
url | True | string |
Een openbaar toegankelijke URL voor het ophalen van de onbewerkte bestandsinhoud |
|
Naam
|
name | True | string |
De oorspronkelijke bestandssysteembestandsnaam van het document dat wordt verzonden |
|
Typologie
|
mimeType | True | string |
Het mime-type van het bestand waarnaar wordt verwezen, bijvoorbeeld application/pdf |
|
Sjabloonstatus
|
state | True | string |
Status van het bibliotheekdocument. |
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
Retouren
Een JSON-object met een beschrijving van de bibliotheeksjabloon
Een bibliotheeksjabloon maken op basis van een document-URL (oud) [AFGESCHAFT]
Met deze bewerking maakt u een sjabloon in de Adobe Acrobat Sign-bibliotheek op basis van een document-URL. Gebruik deze sjabloon voor het verzenden van overeenkomsten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sjabloonnaam
|
name | True | string |
Overeenkomstnaam die wordt gebruikt om de sjabloon te identificeren |
|
Sjabloontype
|
libraryTemplateTypes | True | string |
Een lijst met een of meer bibliotheeksjabloontypen |
|
Delen met
|
librarySharingMode | True | string |
Hiermee geeft u op wie toegang moet hebben tot dit bibliotheekdocument |
|
URL
|
url | True | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
Naam
|
name | True | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
URL (2)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (2)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (3)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (3)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (4)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (4)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (5)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (5)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (6)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (6)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (7)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (7)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (8)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (8)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (9)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (9)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (10)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (10)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
Retouren
Een JSON-object met een beschrijving van de bibliotheeksjabloon
Een bibliotheeksjabloon maken op basis van een geüpload document
Met deze bewerking maakt u een sjabloon in de Adobe Acrobat Sign-bibliotheek op basis van een geüpload document. Gebruik deze sjabloon voor het verzenden van overeenkomsten.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Sjabloonnaam
|
name | True | string |
Overeenkomstnaam die wordt gebruikt om de sjabloon te identificeren |
|
Sjabloontype
|
templateTypes | True | array of string |
Een lijst met een of meer bibliotheeksjabloontypen |
|
Deelmodus
|
sharingMode | True | string |
Hiermee geeft u op wie toegang moet hebben tot dit bibliotheekdocument |
|
ID-kaart
|
transientDocumentId | True | string |
De document-id die is ontvangen door een tijdelijk document te uploaden |
|
Sjabloonstatus
|
state | True | string |
Status van het bibliotheekdocument. |
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
Retouren
Een JSON-object met een beschrijving van de bibliotheeksjabloon
Een bibliotheeksjabloon maken op basis van een geüpload document (oud) [AFGESCHAFT]
Met deze bewerking maakt u een sjabloon in de Adobe Acrobat Sign-bibliotheek op basis van een geüpload document. Gebruik deze sjabloon voor het verzenden van overeenkomsten.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sjabloonnaam
|
name | True | string |
Overeenkomstnaam die wordt gebruikt om de sjabloon te identificeren |
|
Sjabloontype
|
libraryTemplateTypes | True | string |
Een lijst met een of meer bibliotheeksjabloontypen |
|
Delen met
|
librarySharingMode | True | string |
Hiermee geeft u op wie toegang moet hebben tot dit bibliotheekdocument |
|
Document-id
|
transientDocumentId | True | string |
De document-id die is ontvangen door een document te uploaden |
|
Document-id (2)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (3)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (4)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (5)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (6)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (7)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (8)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (9)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (10)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
Retouren
Een JSON-object met een beschrijving van de bibliotheeksjabloon
Een document ophalen uit een overeenkomst
Met deze bewerking wordt de bestandsstroom van een specifiek document van de overeenkomst opgehaald.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst waarvan het document nodig is |
|
Document-id
|
documentId | True | string |
De document-id van het specifieke document van de overeenkomst |
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
Retouren
De bestandsstroom van het document
- response
- DocumentResponse
Een document ophalen uit een overeenkomst [AFGESCHAFT]
Deze actie is afgeschaft. Gebruik in plaats daarvan Een document ophalen uit een overeenkomst .
Met deze bewerking wordt de bestandsstroom van een specifiek document van de overeenkomst opgehaald.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst waarvan het document nodig is |
|
Document-id
|
documentId | True | string |
De document-id van het specifieke document van de overeenkomst |
Retouren
De bestandsstroom van het document
- response
- DocumentResponse
Een document uploaden en een document-id ophalen
Met deze bewerking wordt een document geüpload in uw Adobe Acrobat Sign-account en wordt er een document-id voor geretourneerd. Dit document wordt tijdelijk opgeslagen in Adobe Acrobat Sign en de document-id kan worden gebruikt voor verdere bewerkingen, zoals het maken van een overeenkomst.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestandsnaam
|
File-Name | True | string |
De naam van het te uploaden document met extensie |
|
Bestandsinhoud
|
File | True | contentOnly |
De bestandsstroom van het document dat moet worden geüpload |
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
Retouren
Een JSON die de id van het geüploade document bevat
Een document uploaden en een document-id ophalen (oud) [AFGESCHAFT]
Met deze bewerking wordt een document geüpload in uw Adobe Acrobat Sign-account en wordt er een document-id voor geretourneerd. Dit document wordt tijdelijk opgeslagen in Adobe Acrobat Sign en de document-id kan worden gebruikt voor verdere bewerkingen, zoals het maken van een overeenkomst.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bestandsnaam
|
File-Name | True | string |
De naam van het te uploaden document met extensie |
|
Bestandsinhoud
|
File | True | contentOnly |
De bestandsstroom van het document dat moet worden geüpload |
Retouren
Een JSON die de id van het geüploade document bevat
Een lijst met alle bibliotheeksjablonen ophalen
Met deze bewerking wordt de lijst opgehaald met alle documenten die zijn opgeslagen als sjablonen in de Adobe Acrobat Sign-bibliotheek van de gebruiker.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Wordt gebruikt om door de pagina's te navigeren. Als deze niet is opgegeven, wordt de eerste pagina geretourneerd. |
|
|
Paginaformaat
|
pageSize | integer |
Aantal items op de antwoordpagina. Standaard: 100; Max: 10000 |
|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
Retouren
Een JSON die het matrixobject van de bibliotheeksjabloon bevat
- Body
- LibraryDocuments
Een lijst met alle bibliotheeksjablonen ophalen (oud) [AFGESCHAFT]
Met deze bewerking wordt de lijst opgehaald met alle documenten die zijn opgeslagen als sjablonen in de Adobe Acrobat Sign-bibliotheek van de gebruiker.
Retouren
Een JSON die het matrixobject van de bibliotheeksjabloon bevat
- Body
- DocumentLibraryItems
Een lijst met alle document-id's ophalen uit een overeenkomst
Met deze bewerking worden de id's van alle documenten en ondersteunende documenten van een overeenkomst opgehaald.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst waarvan de documenten nodig zijn |
|
Ondersteunende documenten - Inhoudstype
|
supportingDocumentContentFormat | string |
Inhoudstype van de ondersteunende documenten van de overeenkomst |
|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
Retouren
Een JSON die zowel de documenten als ondersteunende documentmatrixobjecten bevat
- Body
- AgreementDocumentsV6
Een lijst met alle document-id's ophalen uit een overeenkomst [AFGESCHAFT]
Deze actie is afgeschaft. Gebruik in plaats daarvan een lijst met alle document-id's uit een overeenkomst ophalen.
Met deze bewerking worden de id's van alle documenten en ondersteunende documenten van een overeenkomst opgehaald.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst waarvan de documenten nodig zijn |
|
Ondersteunende documenten - Inhoudstype
|
supportingDocumentContentFormat | string |
Inhoudstype van de ondersteunende documenten van de overeenkomst |
Retouren
Een JSON die zowel de documenten als ondersteunende documentmatrixobjecten bevat
- Body
- AgreementDocuments
Een lijst met alle overeenkomsten ophalen
Met deze bewerking wordt de lijst met alle overeenkomsten van de gebruiker opgehaald.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Wordt gebruikt om door de pagina's te navigeren. Als deze niet is opgegeven, wordt de eerste pagina geretourneerd. |
|
|
Paginaformaat
|
pageSize | integer |
Aantal items op de antwoordpagina. Standaard: 100; Max: 10000 |
|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
Retouren
Een JSON die het matrixobject van de gebruikersovereenkomst bevat
- Body
- userAgreementListV6
Een lijst met alle overeenkomsten ophalen (oud) [AFGESCHAFT]
Met deze bewerking wordt de lijst met alle overeenkomsten van de gebruiker opgehaald.
Retouren
Een JSON die het matrixobject van de gebruikersovereenkomst bevat
- Body
- UserAgreements
Een lijst met alle overeenkomsten ophalen op basis van zoekcriteria
Met deze bewerking worden overeenkomsten doorzocht op criteria zoals werkstroom-id, enzovoort.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
|
|
Naam/id van werkstroom
|
workflowId | string |
Selecteer een aangepaste werkstroom in de lijst of voer de aangepaste werkstroom-id in. |
|
|
Gemaakt na
|
gt | string |
De minimaal toegestane datum/tijd. Voorbeeld: 2020-12-31T23:59:00Z |
|
|
Gemaakt vóór
|
lt | string |
De maximaal toegestane datum/tijd. Voorbeeld: 2023-12-31T23:59:00Z |
|
|
Paginaformaat
|
pageSize | integer |
Aantal items op de antwoordpagina. Standaard: 50; Max: 500 |
|
|
Startindex
|
startIndex | integer |
Op 0 gebaseerde eerste rij (offset) van de zoekresultaten die moeten worden geretourneerd. |
Retouren
Een JSON die het matrixobject van de gebruikersovereenkomst bevat
- Body
- userAgreementListV6
Een lijst met alle webformulieren ophalen
Met deze bewerking wordt de lijst met alle webformulieren van de gebruiker opgehaald.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Cursor
|
cursor | string |
Wordt gebruikt om door de pagina's te navigeren. Als deze niet is opgegeven, wordt de eerste pagina geretourneerd. |
|
|
Paginaformaat
|
pageSize | integer |
Aantal items op de antwoordpagina. Standaard: 100; Max: 10000 |
|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
Retouren
Een JSON die het matrixobject van het webformulier van de gebruiker bevat
- Body
- userWidgetListV6
Een lijst met alle werkstromen ophalen
Met deze bewerking wordt de lijst met alle werkstromen van de gebruiker opgehaald.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Conceptwerkstromen opnemen
|
includeDraftWorkflows | boolean |
Conceptwerkstromen opnemen |
|
|
Inactieve werkstromen opnemen
|
includeInactiveWorkflows | boolean |
Inactieve werkstromen opnemen |
|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
Retouren
Een JSON die het matrixobject van de gebruikerswerkstroom bevat
- Body
- userWorkflowListV6
Een lijst ophalen van alle groepen waartoe de gebruiker behoort
Met deze bewerking wordt de lijst opgehaald van alle groepen waartoe de gebruiker behoort.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Gebruikers-ID
|
userId | True | string |
Als u het resultaat voor geautoriseerde gebruiker wilt ophalen, kan de gebruikers-id worden vervangen door 'ik' zonder aanhalingstekens. |
Retouren
Een JSON die de lijst met groepen voor een bepaalde gebruiker bevat
- Body
- UserGroupsInfoV6
Een overeenkomst annuleren
Annuleert de overeenkomst die is geïdentificeerd door agreementId in het pad.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst die moet worden geannuleerd. |
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Agrementstatus
|
state | string |
De staat waarin de overeenkomst moet landen. |
|
|
Comment
|
comment | string |
Een optionele opmerking waarin de reden van annulering aan de geadresseerden wordt beschreven. |
|
|
Overige
|
notifyOthers | boolean |
Of u de geadresseerden al dan niet op de hoogte wilt stellen. |
Een overeenkomst maken op basis van bestandsinhoud en verzenden voor handtekening
Met deze bewerking maakt u een overeenkomst op basis van een bestand in Adobe Acrobat Sign en verzendt u deze voor ondertekening.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Naam overeenkomst
|
name | True | string |
De naam van de overeenkomst |
|
Naam
|
fileName | True | string |
De naam van het te uploaden document met extensie |
|
Content
|
formData | True | byte |
De bestandsstroom van het document dat moet worden geüpload |
|
Handtekeningtype
|
signatureType | True | string |
Het type handtekening dat u wilt aanvragen - e-handtekening of geschreven |
|
E-mailadres van deelnemer
|
True | string |
Het e-mailadres van de deelnemer |
|
|
Authenticatie
|
authenticationMethod | string |
Standaardverificatie: e-mail (geen) |
|
|
Wachtwoord
|
password | string |
Het wachtwoord dat vereist is voor de deelnemer |
|
|
Landcode
|
countryCode | string |
De landcode van de ontvanger die is vereist om het document weer te geven en te ondertekenen |
|
|
Telefoon nee.
|
phone | string |
Het telefoonnummer van de geadresseerde dat is vereist om de overeenkomst te bekijken en te ondertekenen |
|
|
Bestelling
|
order | True | integer |
Index beginnend met 1, die de positie aangeeft waarop de ondertekeningsgroep moet ondertekenen. |
|
Rol
|
role | True | string |
De huidige rollen van de deelnemersset (ondertekenaar, fiatteur, enz.). |
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
|
|
Message
|
message | string |
Een optioneel bericht aan de geadresseerden die hun actie aanvragen |
|
|
E-mailen
|
string |
Het e-mailadres van de CC van de overeenkomst |
||
|
Verlooptijd
|
expirationTime | string |
Tijd waarna de overeenkomst verloopt. Voorbeeld: 2020-12-31T23:59:00Z |
|
|
Herinneringsfrequentie
|
reminderFrequency | string |
Hoe vaak wilt u herinneringen verzenden? |
|
|
Documentwachtwoord
|
openPassword | string |
Het wachtwoord dat moet worden gebruikt om de ondertekende overeenkomst PDF te versleutelen |
|
|
Naam
|
fieldName | string |
De naam van het veld |
|
|
Waarde
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Omleidingsvertraging
|
redirectDelay | string |
De vertraging (in seconden) voordat de gebruiker naar de pagina geslaagd wordt gebracht. |
|
|
Omleidings-URL
|
redirectUrl | string |
URL om om te leiden na het voltooien van het ondertekeningsproces, bijvoorbeeld https://adobe.com |
|
|
Eerste e-mailberichten
|
initEmails | string |
E-mailberichten voor meldingen voor initiëren van overeenkomsten beheren. |
Retouren
Een JSON die de id van de zojuist gemaakte overeenkomst bevat
Een overeenkomst maken op basis van een bibliotheeksjabloon en verzenden voor handtekening
Met deze bewerking maakt u een overeenkomst op basis van een sjabloon die is opgeslagen in de Adobe Acrobat Sign-bibliotheek van de gebruiker en verzendt deze voor handtekening.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Naam overeenkomst
|
name | True | string |
De naam van de overeenkomst |
|
Template
|
libraryDocumentId | True | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
Handtekeningtype
|
signatureType | True | string |
Het type handtekening dat u wilt aanvragen - e-handtekening of geschreven |
|
E-mailadres van deelnemer
|
True | string |
Het e-mailadres van de deelnemer |
|
|
Authenticatie
|
authenticationMethod | string |
Standaardverificatie: e-mail (geen) |
|
|
Wachtwoord
|
password | string |
Het wachtwoord dat vereist is voor de deelnemer |
|
|
Landcode
|
countryCode | string |
De landcode van de ontvanger die is vereist om het document weer te geven en te ondertekenen |
|
|
Telefoon nee.
|
phone | string |
Het telefoonnummer van de geadresseerde dat is vereist om de overeenkomst te bekijken en te ondertekenen |
|
|
Bestelling
|
order | True | integer |
Index beginnend met 1, die de positie aangeeft waarop de ondertekeningsgroep moet ondertekenen. |
|
Rol
|
role | True | string |
De huidige rollen van de deelnemersset (ondertekenaar, fiatteur, enz.). |
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
|
|
Message
|
message | string |
Een optioneel bericht aan de geadresseerden die hun actie aanvragen |
|
|
E-mailen
|
string |
Het e-mailadres van de CC van de overeenkomst |
||
|
Verlooptijd
|
expirationTime | string |
Tijd waarna de overeenkomst verloopt. Voorbeeld: 2020-12-31T23:59:00Z |
|
|
Herinneringsfrequentie
|
reminderFrequency | string |
Hoe vaak wilt u herinneringen verzenden? |
|
|
Documentwachtwoord
|
openPassword | string |
Het wachtwoord dat moet worden gebruikt om de ondertekende overeenkomst PDF te versleutelen |
|
|
Naam
|
fieldName | string |
De naam van het veld |
|
|
Waarde
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Omleidingsvertraging
|
redirectDelay | string |
De vertraging (in seconden) voordat de gebruiker naar de pagina geslaagd wordt gebracht. |
|
|
Omleidings-URL
|
redirectUrl | string |
URL om om te leiden na het voltooien van het ondertekeningsproces, bijvoorbeeld https://adobe.com |
|
|
Eerste e-mailberichten
|
initEmails | string |
E-mailberichten voor meldingen voor initiëren van overeenkomsten beheren. |
Retouren
Een JSON die de id van de zojuist gemaakte overeenkomst bevat
Een overeenkomst maken op basis van een bibliotheeksjabloon en verzenden voor handtekening (oud) [AFGESCHAFT]
Met deze bewerking maakt u een overeenkomst op basis van een sjabloon die is opgeslagen in de Adobe Acrobat Sign-bibliotheek van de gebruiker en verzendt deze voor handtekening.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam overeenkomst
|
name | True | string |
De naam van de overeenkomst |
|
Documentbibliotheeksjabloon
|
libraryDocumentId | True | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
Handtekeningtype
|
signatureType | True | string |
Het type handtekening dat u wilt aanvragen - E-handtekening of Geschreven |
|
E-mailadres van geadresseerde
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
Message
|
message | string |
Een optioneel bericht aan de geadresseerden die hun actie aanvragen |
|
|
Dagen tot deadline
|
daysUntilSigningDeadline | integer |
Het aantal dagen dat overblijft voordat het document verloopt |
|
|
Herinneringsfrequentie
|
reminderFrequency | string |
Hoe vaak wilt u herinneringen verzenden? |
|
|
Documentwachtwoord
|
openPassword | string |
Het wachtwoord dat moet worden gebruikt om de ondertekende overeenkomst PDF te versleutelen |
|
|
Documentbibliotheeksjabloon (2)
|
libraryDocumentId | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
|
Documentbibliotheeksjabloon (3)
|
libraryDocumentId | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
|
Documentbibliotheeksjabloon (4)
|
libraryDocumentId | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
|
Documentbibliotheeksjabloon (5)
|
libraryDocumentId | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
|
Documentbibliotheeksjabloon (6)
|
libraryDocumentId | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
|
Documentbibliotheeksjabloon (7)
|
libraryDocumentId | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
|
Documentbibliotheeksjabloon (8)
|
libraryDocumentId | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
|
Documentbibliotheeksjabloon (9)
|
libraryDocumentId | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
|
Documentbibliotheeksjabloon (10)
|
libraryDocumentId | string |
Een document kiezen uit de sjablonen die zijn opgeslagen in uw bibliotheek |
|
|
E-mailadres van geadresseerde (2)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (2)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (2)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (3)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (3)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (3)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (4)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (4)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (4)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (5)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (5)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (5)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (6)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (6)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (6)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (7)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (7)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (7)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (8)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (8)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (8)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (9)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder voor geadresseerden (9)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (9)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (10)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (10)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (10)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (11)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (11)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (11)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (12)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (12)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (12)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (13)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (13)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (13)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (14)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder voor geadresseerden (14)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (14)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (15)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (15)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (15)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (16)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (16)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (16)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (17)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (17)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (17)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (18)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (18)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (18)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (19)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (19)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (19)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (20)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (20)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (20)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (21)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (21)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (21)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (22)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (22)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (22)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (23)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (23)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (23)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (24)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder voor geadresseerden (24)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (24)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (25)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (25)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (25)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
Formulierveldnaam (1)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (1)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (2)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (2)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (3)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (3)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (4)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (4)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (5)
|
fieldName | string |
De naam van het veld |
|
|
Waarde formulierveld (5)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (6)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (6)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (7)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (7)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (8)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (8)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (9)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (9)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (10)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (10)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (11)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (11)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (12)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (12)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (13)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (13)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (14)
|
fieldName | string |
De naam van het veld |
|
|
Waarde formulierveld (14)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (15)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (15)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (16)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (16)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (17)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (17)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (18)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (18)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (19)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (19)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (20)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (20)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (21)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (21)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (22)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (22)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (23)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (23)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (24)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (24)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (25)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (25)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (26)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (26)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (27)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (27)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (28)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (28)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (29)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (29)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (30)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (30)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (31)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (31)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (32)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (32)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (33)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (33)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (34)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (34)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (35)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (35)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (36)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (36)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (37)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (37)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (38)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (38)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (39)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (39)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (40)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (40)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (41)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (41)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (42)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (42)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (43)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (43)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (44)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (44)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (45)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (45)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (46)
|
fieldName | string |
De naam van het veld |
|
|
Waarde formulierveld (46)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (47)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (47)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (48)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (48)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (49)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (49)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (50)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (50)
|
defaultValue | string |
De standaardwaarde van het veld |
Retouren
Een JSON die de id van de zojuist gemaakte overeenkomst bevat
Een overeenkomst maken op basis van een document-URL en verzenden voor handtekening
Met deze bewerking maakt u een overeenkomst op basis van een document dat is geüpload in Adobe Acrobat Sign en verzendt u deze voor handtekening.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Naam overeenkomst
|
name | True | string |
De naam van de overeenkomst |
|
URL
|
url | True | string |
Een openbaar toegankelijke URL voor het ophalen van de onbewerkte bestandsinhoud |
|
Naam
|
name | True | string |
De oorspronkelijke bestandssysteembestandsnaam van het document dat wordt verzonden |
|
Typologie
|
mimeType | True | string |
Het mime-type van het bestand waarnaar wordt verwezen, bijvoorbeeld application/pdf |
|
Handtekeningtype
|
signatureType | True | string |
Hiermee geeft u het handtekeningtype op dat is aangevraagd - E-handtekening of geschreven |
|
E-mailadres van deelnemer
|
True | string |
Het e-mailadres van de deelnemer |
|
|
Authenticatie
|
authenticationMethod | string |
Standaardverificatie: e-mail (geen) |
|
|
Wachtwoord
|
password | string |
Het wachtwoord dat vereist is voor de deelnemer |
|
|
Landcode
|
countryCode | string |
De landcode van de ontvanger die is vereist om het document weer te geven en te ondertekenen |
|
|
Telefoon nee.
|
phone | string |
Het telefoonnummer van de geadresseerde dat is vereist om de overeenkomst te bekijken en te ondertekenen |
|
|
Bestelling
|
order | True | integer |
Index beginnend met 1, die de positie aangeeft waarop de ondertekeningsgroep moet ondertekenen. |
|
Rol
|
role | True | string |
De huidige rollen van de deelnemersset (ondertekenaar, fiatteur, enz.). |
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
|
|
Message
|
message | string |
Een optioneel bericht aan de geadresseerden die hun actie aanvragen |
|
|
E-mailen
|
string |
Het e-mailadres van de CC van de overeenkomst |
||
|
Verlooptijd
|
expirationTime | string |
Tijd waarna de overeenkomst verloopt. Voorbeeld: 2020-12-31T23:59:00Z |
|
|
Herinneringsfrequentie
|
reminderFrequency | string |
Hoe vaak wilt u herinneringen verzenden? |
|
|
Documentwachtwoord
|
openPassword | string |
Het wachtwoord dat moet worden gebruikt om de ondertekende overeenkomst PDF te versleutelen |
|
|
Naam
|
fieldName | string |
De naam van het veld |
|
|
Waarde
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Omleidingsvertraging
|
redirectDelay | string |
De vertraging (in seconden) voordat de gebruiker naar de pagina geslaagd wordt gebracht. |
|
|
Omleidings-URL
|
redirectUrl | string |
URL om om te leiden na het voltooien van het ondertekeningsproces, bijvoorbeeld https://adobe.com |
|
|
Eerste e-mailberichten
|
initEmails | string |
E-mailberichten voor meldingen voor initiëren van overeenkomsten beheren. |
Retouren
Een JSON die de id van de zojuist gemaakte overeenkomst bevat
Een overeenkomst maken op basis van een document-URL en verzenden voor handtekening (oud) [AFGESCHAFT]
Met deze bewerking maakt u een overeenkomst op basis van een document dat is geüpload in Adobe Acrobat Sign en verzendt u deze voor handtekening.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam overeenkomst
|
name | True | string |
De naam van de overeenkomst |
|
URL
|
url | True | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
Naam
|
name | True | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
Handtekeningtype
|
signatureType | True | string |
Het type handtekening dat u wilt aanvragen - E-handtekening of Geschreven |
|
E-mailadres van geadresseerde
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
Message
|
message | string |
Een optioneel bericht aan de geadresseerden die hun actie aanvragen |
|
|
Dagen tot deadline
|
daysUntilSigningDeadline | integer |
Het aantal dagen dat overblijft voordat het document verloopt |
|
|
Herinneringsfrequentie
|
reminderFrequency | string |
Hoe vaak wilt u herinneringen verzenden? |
|
|
Documentwachtwoord
|
openPassword | string |
Het wachtwoord dat moet worden gebruikt om de ondertekende overeenkomst PDF te versleutelen |
|
|
URL (2)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (2)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (3)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (3)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (4)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (4)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (5)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (5)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (6)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (6)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (7)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (7)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (8)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (8)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (9)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (9)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
URL (10)
|
url | string |
Een openbaar toegankelijke URL voor het ophalen van het document |
|
|
Naam (10)
|
name | string |
De naam van het document waarnaar wordt verwezen, met extensie |
|
|
E-mailadres van geadresseerde (2)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (2)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (2)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (3)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (3)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (3)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (4)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (4)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (4)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (5)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (5)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (5)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (6)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (6)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (6)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (7)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (7)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (7)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (8)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (8)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (8)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (9)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder voor geadresseerden (9)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (9)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (10)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (10)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (10)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (11)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (11)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (11)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (12)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (12)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (12)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (13)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (13)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (13)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (14)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder voor geadresseerden (14)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (14)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (15)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (15)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (15)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (16)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (16)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (16)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (17)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (17)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (17)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (18)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (18)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (18)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (19)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (19)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (19)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (20)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (20)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (20)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (21)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (21)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (21)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (22)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (22)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (22)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (23)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (23)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (23)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (24)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder voor geadresseerden (24)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (24)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (25)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (25)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (25)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
Formulierveldnaam (1)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (1)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (2)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (2)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (3)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (3)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (4)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (4)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (5)
|
fieldName | string |
De naam van het veld |
|
|
Waarde formulierveld (5)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (6)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (6)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (7)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (7)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (8)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (8)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (9)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (9)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (10)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (10)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (11)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (11)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (12)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (12)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (13)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (13)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (14)
|
fieldName | string |
De naam van het veld |
|
|
Waarde formulierveld (14)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (15)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (15)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (16)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (16)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (17)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (17)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (18)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (18)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (19)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (19)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (20)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (20)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (21)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (21)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (22)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (22)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (23)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (23)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (24)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (24)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (25)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (25)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (26)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (26)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (27)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (27)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (28)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (28)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (29)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (29)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (30)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (30)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (31)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (31)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (32)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (32)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (33)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (33)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (34)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (34)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (35)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (35)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (36)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (36)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (37)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (37)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (38)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (38)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (39)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (39)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (40)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (40)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (41)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (41)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (42)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (42)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (43)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (43)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (44)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (44)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (45)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (45)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (46)
|
fieldName | string |
De naam van het veld |
|
|
Waarde formulierveld (46)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (47)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (47)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (48)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (48)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (49)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (49)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (50)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (50)
|
defaultValue | string |
De standaardwaarde van het veld |
Retouren
Een JSON die de id van de zojuist gemaakte overeenkomst bevat
Een overeenkomst maken op basis van een werkstroom en verzenden voor handtekening
Met deze bewerking wordt een overeenkomst gemaakt op basis van een werkstroom in Adobe Acrobat Sign en wordt deze verzonden voor ondertekening.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
In de naam van
|
x-api-user | True | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
Groepsnaam/id
|
groupId | True | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
|
Naam/id van werkstroom
|
workflowIdParam | True | string |
Selecteer een aangepaste werkstroom in de lijst of voer de aangepaste werkstroom-id in. |
|
agreementWorkflowSchema
|
agreementWorkflowSchema | True | dynamic |
Details voor de geselecteerde gebeurtenis. |
Retouren
Een JSON die de id van de zojuist gemaakte overeenkomst bevat
Een overeenkomst maken op een geüpload document en verzenden voor handtekening
Met deze bewerking maakt u een overeenkomst op basis van een document dat is geüpload in Adobe Acrobat Sign en verzendt u deze voor handtekening.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Naam overeenkomst
|
name | True | string |
De naam van de overeenkomst |
|
ID-kaart
|
transientDocumentId | True | string |
De document-id die is ontvangen door een tijdelijk document te uploaden |
|
Handtekeningtype
|
signatureType | True | string |
Het type handtekening dat u wilt aanvragen - e-handtekening of geschreven |
|
E-mailadres van deelnemer
|
True | string |
Het e-mailadres van de deelnemer |
|
|
Authenticatie
|
authenticationMethod | string |
Standaardverificatie: e-mail (geen) |
|
|
Wachtwoord
|
password | string |
Het wachtwoord dat vereist is voor de deelnemer |
|
|
Landcode
|
countryCode | string |
De landcode van de ontvanger die is vereist om het document weer te geven en te ondertekenen |
|
|
Telefoon nee.
|
phone | string |
Het telefoonnummer van de geadresseerde dat is vereist om de overeenkomst te bekijken en te ondertekenen |
|
|
Bestelling
|
order | True | integer |
Index beginnend met 1, die de positie aangeeft waarop de ondertekeningsgroep moet ondertekenen. |
|
Rol
|
role | True | string |
De huidige rollen van de deelnemersset (ondertekenaar, fiatteur, enz.). |
|
Groepsnaam/id
|
groupId | string |
Id van de groep. Als u dit wilt gebruiken, moet het veld 'In de naam van' zijn geselecteerd |
|
|
Message
|
message | string |
Een optioneel bericht aan de geadresseerden die hun actie aanvragen |
|
|
E-mailen
|
string |
Het e-mailadres van de CC van de overeenkomst |
||
|
Verlooptijd
|
expirationTime | string |
Tijd waarna de overeenkomst verloopt. Voorbeeld: 2020-12-31T23:59:00Z |
|
|
Herinneringsfrequentie
|
reminderFrequency | string |
Hoe vaak wilt u herinneringen verzenden? |
|
|
Documentwachtwoord
|
openPassword | string |
Het wachtwoord dat moet worden gebruikt om de ondertekende overeenkomst PDF te versleutelen |
|
|
Naam
|
fieldName | string |
De naam van het veld |
|
|
Waarde
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Omleidingsvertraging
|
redirectDelay | string |
De vertraging (in seconden) voordat de gebruiker naar de pagina geslaagd wordt gebracht. |
|
|
Omleidings-URL
|
redirectUrl | string |
URL om om te leiden na het voltooien van het ondertekeningsproces, bijvoorbeeld https://adobe.com |
|
|
Eerste e-mailberichten
|
initEmails | string |
E-mailberichten voor meldingen voor initiëren van overeenkomsten beheren. |
Retouren
Een JSON die de id van de zojuist gemaakte overeenkomst bevat
Een overeenkomst maken van een geüpload document en verzenden voor handtekening (oud) [AFGESCHAFT]
Met deze bewerking maakt u een overeenkomst op basis van een document dat is geüpload in Adobe Acrobat Sign en verzendt u deze voor handtekening.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam overeenkomst
|
name | True | string |
De naam van de overeenkomst |
|
Document-id
|
transientDocumentId | True | string |
De document-id die is ontvangen door een document te uploaden |
|
Handtekeningtype
|
signatureType | True | string |
Het type handtekening dat u wilt aanvragen - E-handtekening of Geschreven |
|
E-mailadres van geadresseerde
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
Message
|
message | string |
Een optioneel bericht aan de geadresseerden die hun actie aanvragen |
|
|
Dagen tot deadline
|
daysUntilSigningDeadline | integer |
Het aantal dagen dat overblijft voordat het document verloopt |
|
|
Herinneringsfrequentie
|
reminderFrequency | string |
Hoe vaak wilt u herinneringen verzenden? |
|
|
Documentwachtwoord
|
openPassword | string |
Het wachtwoord dat moet worden gebruikt om de ondertekende overeenkomst PDF te versleutelen |
|
|
Document-id (2)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (3)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (4)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (5)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (6)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (7)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (8)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (9)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
Document-id (10)
|
transientDocumentId | string |
De document-id die is ontvangen door een document te uploaden |
|
|
E-mailadres van geadresseerde (2)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (2)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (2)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (3)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (3)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (3)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (4)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (4)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (4)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (5)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (5)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (5)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (6)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (6)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (6)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (7)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (7)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (7)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (8)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (8)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (8)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (9)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder voor geadresseerden (9)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (9)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (10)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (10)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (10)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (11)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (11)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (11)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (12)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (12)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (12)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (13)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (13)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (13)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (14)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder voor geadresseerden (14)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (14)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (15)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (15)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (15)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (16)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (16)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (16)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (17)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (17)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (17)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (18)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (18)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (18)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (19)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (19)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (19)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (20)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder van geadresseerde (20)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (20)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (21)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (21)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (21)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (22)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (22)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (22)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (23)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (23)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (23)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (24)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder voor geadresseerden (24)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van ontvanger (24)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
E-mailadres van geadresseerde (25)
|
True | string |
E-mail van de geadresseerde |
|
|
Handtekeningorder geadresseerde (25)
|
signingOrder | True | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Rol van geadresseerde (25)
|
recipientSetRole | True | string |
De rol van ontvanger opgeven |
|
Formulierveldnaam (1)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (1)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (2)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (2)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (3)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (3)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (4)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (4)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (5)
|
fieldName | string |
De naam van het veld |
|
|
Waarde formulierveld (5)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (6)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (6)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (7)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (7)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (8)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (8)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (9)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (9)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (10)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (10)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (11)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (11)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (12)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (12)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (13)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (13)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (14)
|
fieldName | string |
De naam van het veld |
|
|
Waarde formulierveld (14)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (15)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (15)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (16)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (16)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (17)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (17)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (18)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (18)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (19)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (19)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (20)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (20)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (21)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (21)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (22)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (22)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (23)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (23)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (24)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (24)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (25)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (25)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (26)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (26)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (27)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (27)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (28)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (28)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (29)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (29)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (30)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (30)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (31)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (31)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (32)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (32)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (33)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (33)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (34)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (34)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (35)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (35)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (36)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (36)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (37)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (37)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (38)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (38)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (39)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (39)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (40)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (40)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (41)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (41)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (42)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (42)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (43)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (43)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (44)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (44)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (45)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (45)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (46)
|
fieldName | string |
De naam van het veld |
|
|
Waarde formulierveld (46)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (47)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (47)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (48)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (48)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (49)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (49)
|
defaultValue | string |
De standaardwaarde van het veld |
|
|
Formulierveldnaam (50)
|
fieldName | string |
De naam van het veld |
|
|
Formulierveldwaarde (50)
|
defaultValue | string |
De standaardwaarde van het veld |
Retouren
Een JSON die de id van de zojuist gemaakte overeenkomst bevat
Een PDF van de audittrail van de overeenkomst ophalen
Met deze bewerking wordt de PDF-bestandsstroom van het audittrail van de overeenkomst opgehaald. Houd er rekening mee dat de bestandsstroom moet worden opgeslagen met een bestandsnaam die eindigt op .pdf bestandsextensie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst waarvan de informatie nodig is |
Retouren
De bestandsstroom van het audittrail voor de overeenkomst
- response
- AgreementAuditTrailResponse
Een PDF van een ondertekende overeenkomst ophalen
Met deze bewerking wordt de PDF-bestandsstroom van de gecombineerde of ondertekende overeenkomst opgehaald. Houd er rekening mee dat de bestandsstroom moet worden opgeslagen met een bestandsnaam die eindigt op .pdf bestandsextensie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id zoals opgegeven door de actie waarmee de overeenkomst wordt gemaakt |
|
Ondersteunende documenten bijvoegen?
|
attachSupportingDocuments | boolean |
Indien waar, voegt u ondersteunende documenten toe aan de ondertekende overeenkomst PDF |
|
|
Auditrapport bijvoegen?
|
attachAuditReport | boolean |
Voeg indien waar een auditrapport toe aan de ondertekende overeenkomst PDF |
|
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
Retouren
De bestandsstroom van het document
- response
- CombinedDocumentResponse
Een PDF van een ondertekende overeenkomst ophalen [AFGESCHAFT]
Deze actie is afgeschaft. Gebruik in plaats daarvan Een PDF van een ondertekende overeenkomst ophalen.
Met deze bewerking wordt de PDF-bestandsstroom van de gecombineerde of ondertekende overeenkomst opgehaald. Houd er rekening mee dat de bestandsstroom moet worden opgeslagen met een bestandsnaam die eindigt op .pdf bestandsextensie.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id zoals opgegeven door de actie waarmee de overeenkomst wordt gemaakt |
|
Ondersteunende documenten bijvoegen?
|
attachSupportingDocuments | boolean |
Indien waar, voegt u ondersteunende documenten toe aan de ondertekende overeenkomst PDF |
|
|
Auditrapport bijvoegen?
|
auditReport | boolean |
Voeg indien waar een auditrapport toe aan de ondertekende overeenkomst PDF |
Retouren
De bestandsstroom van het document
- response
- CombinedDocumentResponse
Formulierveldgegevens van overeenkomst ophalen (oud) [AFGESCHAFT]
Hiermee worden gegevens opgehaald die zijn ingevoerd in de interactieve formuliervelden van de overeenkomst.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst waarvan de informatie nodig is |
Retouren
- response
- file
Formulierveldgegevens van overeenkomst ophalen in CSV-indeling
Hiermee worden gegevens opgehaald die zijn ingevoerd in de interactieve formuliervelden van de overeenkomst.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst waarvan de informatie nodig is |
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
Retouren
De inhoud van de formuliergegevens
- Inhoud van formuliergegevens
- binary
Formulierveldgegevens van overeenkomst ophalen in JSON-indeling
Hiermee worden gegevens opgehaald die zijn ingevoerd in de interactieve formuliervelden van de overeenkomst.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Overeenkomst-id
|
agreementId | True | string |
De overeenkomst-id van de overeenkomst waarvan de informatie nodig is |
|
In de naam van
|
x-api-user | string |
Het e-mailadres van de API-aanroeper in de indeling: e-mail:adobesignuser@domain.com |
Retouren
De inhoud van de formuliergegevens
- Inhoud van formuliergegevens
- object
Triggers
| Wanneer de status van een overeenkomst verandert |
Hiermee wordt een nieuwe stroom geactiveerd wanneer de status van een overeenkomst verandert. Behandelt de meest voorkomende overeenkomst-gebeurtenissen, zoals het maken, voltooien, enzovoort. |
| Wanneer een gebeurtenis plaatsvindt |
Hiermee wordt een nieuwe stroom geactiveerd wanneer een gebeurtenis plaatsvindt. Behandelt alle overeenkomsten, Mega Sign en Web Form-gebeurtenissen. |
| Wanneer een gebeurtenis van een webformulierovereenkomst plaatsvindt |
Hiermee wordt een nieuwe stroom geactiveerd wanneer de gebeurtenis webformulierovereenkomst plaatsvindt. Behandelt de meest voorkomende overeenkomst-gebeurtenissen, zoals het maken, voltooien, enzovoort. |
| Wanneer een groepsevenement plaatsvindt |
Hiermee wordt een nieuwe stroom geactiveerd wanneer een groepsgebeurtenis plaatsvindt. Behandelt alle overeenkomsten, Mega Sign en Web Form-gebeurtenissen. |
| Wanneer een overeenkomst naar een deelnemer wordt verzonden |
Hiermee wordt een nieuwe stroom geactiveerd wanneer een overeenkomst naar een deelnemer wordt verzonden. |
| Wanneer een werkstroom voor een overeenkomst is voltooid |
Hiermee wordt een nieuwe stroom geactiveerd wanneer een werkstroom voor een overeenkomst is voltooid |
| Wanneer er een nieuwe overeenkomst wordt gemaakt |
Hiermee wordt een nieuwe stroom geactiveerd wanneer er een nieuwe overeenkomst wordt gemaakt. |
Wanneer de status van een overeenkomst verandert
Hiermee wordt een nieuwe stroom geactiveerd wanneer de status van een overeenkomst verandert. Behandelt de meest voorkomende overeenkomst-gebeurtenissen, zoals het maken, voltooien, enzovoort.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam
|
name | True | string |
De naam van de trigger |
|
Scope
|
scope | True | string |
Het bereik van de trigger |
|
Naam/id van overeenkomst
|
resourceId | string |
Geef alleen op wanneer 'Bereik' een specifieke overeenkomst is. Selecteer een overeenkomst in de lijst of voer de overeenkomst-id in. |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
De gebeurtenissen waarvoor de stroom moet worden geactiveerd |
|
Informatie over overeenkomst opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde overeenkomstgegevens worden verzonden in een melding? |
|
|
Informatie over deelnemers aan de overeenkomst opnemen?
|
includeParticipantsInfo | boolean |
Moeten de gegevens van de deelnemer aan de overeenkomst in een melding worden verzonden? |
|
|
Informatie over overeenkomstdocument opnemen?
|
includeDocumentsInfo | boolean |
Moeten de gegevens van het overeenkomstdocument worden verzonden in een melding? |
|
|
Ondertekende documentgegevens van de overeenkomst opnemen?
|
includeSignedDocuments | boolean |
Moet er een definitieve kopie van het ondertekende document worden verzonden wanneer de overeenkomst is voltooid? |
Retouren
Wanneer een gebeurtenis plaatsvindt
Hiermee wordt een nieuwe stroom geactiveerd wanneer een gebeurtenis plaatsvindt. Behandelt alle overeenkomsten, Mega Sign en Web Form-gebeurtenissen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam
|
name | True | string |
De naam van de trigger |
|
Scope
|
scope | True | string |
Het bereik van de trigger |
|
Type bron
|
resourceType | string |
Geef alleen op wanneer 'Bereik' een specifieke resource is. Selecteer het resourcetype waarvoor de stroom moet worden geactiveerd. |
|
|
Resource-ID
|
resourceId | string |
Geef alleen op wanneer 'Bereik' een specifieke resource is. Voer de overeenkomst of megateken of webformulier of groeps-id in waarvoor de stroom moet worden geactiveerd. |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
De gebeurtenissen waarvoor de stroom moet worden geactiveerd |
|
Informatie over overeenkomst opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde overeenkomstgegevens worden verzonden in een melding? |
|
|
Informatie over deelnemers aan de overeenkomst opnemen?
|
includeParticipantsInfo | boolean |
Moeten de gegevens van de deelnemer aan de overeenkomst in een melding worden verzonden? |
|
|
Informatie over overeenkomstdocument opnemen?
|
includeDocumentsInfo | boolean |
Moeten de gegevens van het overeenkomstdocument worden verzonden in een melding? |
|
|
Ondertekende documentgegevens van de overeenkomst opnemen?
|
includeSignedDocuments | boolean |
Moet een definitieve kopie van het ondertekende document bij voltooiing van de overeenkomst worden verzonden in een melding? |
|
|
MegaSign-info opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde megatekengegevens worden verzonden in een melding? |
|
|
Informatie over webformulieren opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde webformuliergegevens worden verzonden in een melding? |
|
|
Gegevens van deelnemers aan het webformulier opnemen?
|
includeParticipantsInfo | boolean |
Moeten gegevens van deelnemers aan het webformulier worden verzonden in een melding? |
|
|
Informatie over webformulierdocumenten opnemen?
|
includeDocumentsInfo | boolean |
Moeten documentgegevens van het webformulier worden verzonden in een melding? |
Retouren
Wanneer een gebeurtenis van een webformulierovereenkomst plaatsvindt
Hiermee wordt een nieuwe stroom geactiveerd wanneer de gebeurtenis webformulierovereenkomst plaatsvindt. Behandelt de meest voorkomende overeenkomst-gebeurtenissen, zoals het maken, voltooien, enzovoort.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam
|
name | True | string |
De naam van de trigger |
|
Paginaformaat webformulieren
|
pageSize | integer |
Selecteer het aantal webformulieren dat u wilt weergeven in de vervolgkeuzelijst |
|
|
Naam/id van webformulier
|
resourceId | True | string |
Selecteer een webformulier in de lijst of voer de webformulier-id in. |
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
De gebeurtenissen waarvoor de stroom moet worden geactiveerd |
|
Informatie over overeenkomst opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde overeenkomstgegevens worden verzonden in een melding? |
|
|
Informatie over deelnemers aan de overeenkomst opnemen?
|
includeParticipantsInfo | boolean |
Moeten de gegevens van de deelnemer aan de overeenkomst in een melding worden verzonden? |
|
|
Informatie over overeenkomstdocument opnemen?
|
includeDocumentsInfo | boolean |
Moeten de gegevens van het overeenkomstdocument worden verzonden in een melding? |
|
|
Ondertekende documentgegevens van de overeenkomst opnemen?
|
includeSignedDocuments | boolean |
Moet er een definitieve kopie van het ondertekende document worden verzonden wanneer de overeenkomst is voltooid? |
Retouren
Wanneer een groepsevenement plaatsvindt
Hiermee wordt een nieuwe stroom geactiveerd wanneer een groepsgebeurtenis plaatsvindt. Behandelt alle overeenkomsten, Mega Sign en Web Form-gebeurtenissen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam
|
name | True | string |
De naam van de trigger |
|
Groepsnaam/id
|
resourceId | string |
Id van de groep |
|
|
webhookSubscriptionEvents
|
webhookSubscriptionEvents | True | array of string |
De gebeurtenissen waarvoor de stroom moet worden geactiveerd |
|
Informatie over overeenkomst opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde overeenkomstgegevens worden verzonden in een melding? |
|
|
Informatie over deelnemers aan de overeenkomst opnemen?
|
includeParticipantsInfo | boolean |
Moeten de gegevens van de deelnemer aan de overeenkomst in een melding worden verzonden? |
|
|
Informatie over overeenkomstdocument opnemen?
|
includeDocumentsInfo | boolean |
Moeten de gegevens van het overeenkomstdocument worden verzonden in een melding? |
|
|
Ondertekende documentgegevens van de overeenkomst opnemen?
|
includeSignedDocuments | boolean |
Moet een definitieve kopie van het ondertekende document bij voltooiing van de overeenkomst worden verzonden in een melding? |
|
|
MegaSign-info opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde megatekengegevens worden verzonden in een melding? |
|
|
Informatie over webformulieren opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde webformuliergegevens worden verzonden in een melding? |
|
|
Gegevens van deelnemers aan het webformulier opnemen?
|
includeParticipantsInfo | boolean |
Moeten gegevens van deelnemers aan het webformulier worden verzonden in een melding? |
|
|
Informatie over webformulierdocumenten opnemen?
|
includeDocumentsInfo | boolean |
Moeten documentgegevens van het webformulier worden verzonden in een melding? |
Retouren
Wanneer een overeenkomst naar een deelnemer wordt verzonden
Hiermee wordt een nieuwe stroom geactiveerd wanneer een overeenkomst naar een deelnemer wordt verzonden.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam
|
name | True | string |
De naam van de trigger |
|
Scope
|
scope | True | string |
Het bereik van de trigger |
|
Naam/id van overeenkomst
|
resourceId | string |
Geef alleen op wanneer 'Bereik' een specifieke overeenkomst is. Selecteer een overeenkomst in de lijst of voer de overeenkomst-id in. |
|
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
De gebeurtenissen waarvoor de stroom moet worden geactiveerd |
|
Informatie over overeenkomst opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde overeenkomstgegevens worden verzonden in een melding? |
|
|
Informatie over deelnemers aan de overeenkomst opnemen?
|
includeParticipantsInfo | boolean |
Moeten de gegevens van de deelnemer aan de overeenkomst in een melding worden verzonden? |
|
|
Informatie over overeenkomstdocument opnemen?
|
includeDocumentsInfo | boolean |
Moeten de gegevens van het overeenkomstdocument worden verzonden in een melding? |
Retouren
- Body
- WebhookPayload
Wanneer een werkstroom voor een overeenkomst is voltooid
Hiermee wordt een nieuwe stroom geactiveerd wanneer een werkstroom voor een overeenkomst is voltooid
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam
|
name | True | string |
De naam van de trigger |
|
Scope
|
scope | True | string |
Het bereik van de trigger |
|
Naam/id van overeenkomst
|
resourceId | string |
Geef alleen op wanneer 'Bereik' een specifieke overeenkomst is. Selecteer een overeenkomst in de lijst of voer de overeenkomst-id in. |
|
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
De gebeurtenissen waarvoor de stroom moet worden geactiveerd |
|
Informatie over overeenkomst opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde overeenkomstgegevens worden verzonden in een melding? |
|
|
Informatie over deelnemers aan de overeenkomst opnemen?
|
includeParticipantsInfo | boolean |
Moeten de gegevens van de deelnemer aan de overeenkomst in een melding worden verzonden? |
|
|
Informatie over overeenkomstdocument opnemen?
|
includeDocumentsInfo | boolean |
Moeten de gegevens van het overeenkomstdocument worden verzonden in een melding? |
|
|
Ondertekende documentgegevens van de overeenkomst opnemen?
|
includeSignedDocuments | boolean |
Moet een definitieve kopie van het ondertekende document bij voltooiing van de overeenkomst worden verzonden in een melding? |
Retouren
Wanneer er een nieuwe overeenkomst wordt gemaakt
Hiermee wordt een nieuwe stroom geactiveerd wanneer er een nieuwe overeenkomst wordt gemaakt.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam
|
name | True | string |
De naam van de trigger |
|
Scope
|
scope | True | string |
Het bereik van de trigger |
|
Subscription
|
webhookSubscriptionEvents | True | array of string |
De gebeurtenissen waarvoor de stroom moet worden geactiveerd |
|
Informatie over overeenkomst opnemen?
|
includeDetailedInfo | boolean |
Moeten gedetailleerde overeenkomstgegevens worden verzonden in een melding? |
|
|
Informatie over deelnemers aan de overeenkomst opnemen?
|
includeParticipantsInfo | boolean |
Moeten de gegevens van de deelnemer aan de overeenkomst in een melding worden verzonden? |
Retouren
Definities
AgreementCreationResponse
Een JSON die de id van de zojuist gemaakte overeenkomst bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Overeenkomst-id
|
agreementId | string |
De unieke id van de overeenkomst die kan worden gebruikt om de status op te vragen en ondertekende documenten te downloaden |
AgreementCreationResponseV6
Een JSON die de id van de zojuist gemaakte overeenkomst bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Overeenkomst-id
|
id | string |
De unieke id van de overeenkomst die kan worden gebruikt om de status op te vragen en ondertekende documenten te downloaden |
AgreementDocuments
Een JSON die zowel de documenten als ondersteunende documentmatrixobjecten bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Documents
|
documents | array of Document |
Een lijst met objecten die de documenten vertegenwoordigen |
|
Bewijsstukken
|
supportingDocuments | array of SupportingDocument |
Een lijst met ondersteunende documenten. Dit wordt alleen geretourneerd als er een ondersteunend document in de overeenkomst staat |
AgreementDocumentsV6
Een JSON die zowel de documenten als ondersteunende documentmatrixobjecten bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Documents
|
documents | array of DocumentV6 |
Een lijst met objecten die de documenten vertegenwoordigen |
|
Bewijsstukken
|
supportingDocuments | array of SupportingDocumentV6 |
Een lijst met ondersteunende documenten. Dit wordt alleen geretourneerd als er een ondersteunend document in de overeenkomst staat |
AgreementInfo
De volledige details over de overeenkomst
| Name | Pad | Type | Description |
|---|---|---|---|
|
Overeenkomst-id
|
agreementId | string |
Een unieke id die kan worden gebruikt om de overeenkomst uniek te identificeren |
|
Evenementen
|
events | array of DocumentHistoryEvent |
Een geordende lijst met de gebeurtenissen in het audittrail van dit document |
|
Vervaldatum
|
expiration | date |
De datum waarna de overeenkomst niet meer kan worden ondertekend |
|
Meest recente versie-id
|
latestVersionId | string |
Een unieke id die de huidige versie van de overeenkomst uniek identificeert |
|
Message
|
message | string |
Het bericht dat is gekoppeld aan de overeenkomst die de afzender heeft verstrekt |
|
Naam overeenkomst
|
name | string |
De naam van de overeenkomst, opgegeven door de afzender |
|
Volgende deelnemerssets
|
nextParticipantSetInfos | array of NextParticipantSetInfo |
Informatie over wie hierna moet handelen voor deze overeenkomst |
|
Deelnemerssets
|
participantSetInfos | array of ParticipantSetInfo |
Informatie over alle deelnemerssets van dit document |
|
Handtekeningtype
|
signatureType | string |
Hiermee geeft u het handtekeningtype op dat is aangevraagd - E-handtekening of geschreven |
|
Documentbeveiliging
|
securityOptions | string |
Beveiligingsinformatie over het document dat aangeeft of een wachtwoord vereist is om het te bekijken en te ondertekenen |
|
Toestand
|
status | string |
De huidige status van de overeenkomst |
AgreementInfoV6
Details van overeenkomst voltooien
| Name | Pad | Type | Description |
|---|---|---|---|
|
Overeenkomst-id
|
id | string |
Een unieke id die kan worden gebruikt om de overeenkomst uniek te identificeren |
|
Aanmaakdatum
|
createdDate | date |
Datum waarop een overeenkomst is gemaakt |
|
Vertraging van eerste herinnering
|
firstReminderDelay | integer |
Geheel getal dat de vertraging in uren aangeeft voordat de eerste herinnering wordt verzonden. |
|
Herinneringsfrequentie
|
reminderFrequency | string |
Hoe vaak wilt u herinneringen verzenden? |
|
Vervaldatum
|
expiration | date |
De datum waarna de overeenkomst niet meer kan worden ondertekend |
|
Lokatie
|
locale | string |
De landinstelling die is gekoppeld aan deze overeenkomst, bijvoorbeeld en_US of fr_FR |
|
Message
|
message | string |
Het bericht dat is gekoppeld aan de overeenkomst die de afzender heeft verstrekt |
|
Naam overeenkomst
|
name | string |
De naam van de overeenkomst, opgegeven door de afzender |
|
Zichtbaarheid van documenten?
|
documentVisibilityEnabled | boolean |
Is zichtbaarheid van documenten ingeschakeld? |
|
Deelnemerssets
|
participantSetsInfo | array of ParticipantSetInfoV6 |
Informatie over alle deelnemerssets van dit document |
|
Handtekeningtype
|
signatureType | string |
Hiermee geeft u het handtekeningtype op dat is aangevraagd - E-handtekening of geschreven |
|
Beveiligingsopties
|
securityOptions | string |
Beveiligingsinformatie over het document dat aangeeft of een wachtwoord vereist is om het te bekijken en te ondertekenen |
|
Toestand
|
status | string |
De huidige status van de overeenkomst |
|
E-mail van afzender
|
senderEmail | string |
Het e-mailbericht van de afzender |
|
Werkstroom-id
|
workflowId | string |
De id van een aangepaste werkstroom die het routeringspad van een overeenkomst definieert. |
|
Ccs
|
ccs | array of CcInfo |
Een lijst met een of meer CCs die worden gekopieerd in de overeenkomsttransactie. |
|
Groeps-id
|
groupId | string |
De unieke id van de groep waartoe de overeenkomst behoort. |
CombinedDocumentResponse
AgreementAuditTrailResponse
De bestandsstroom van het audittrail voor de overeenkomst
De bestandsstroom van het audittrail voor de overeenkomst
- Inhoud van audittrail overeenkomst
- binary
DisplayUserInfo
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bedrijf
|
company | string |
Geeft de naam weer van het bedrijf van de gebruiker, indien beschikbaar |
|
E-mailen
|
string |
Hiermee wordt het e-mailadres van de gebruiker weergegeven |
|
|
Volledige naam
|
fullName | string |
Geeft de volledige naam van de gebruiker weer, indien beschikbaar. |
DisplayUserSetInfo
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gegevens van gebruikersset weergeven
|
displayUserSetMemberInfos | array of DisplayUserInfo |
Geeft de informatie over de gebruikersset weer |
|
Naam van gebruikersset weergeven
|
displayUserSetName | string |
Document
De informatie over het document
| Name | Pad | Type | Description |
|---|---|---|---|
|
Document-id
|
documentId | string |
De unieke id van het document |
|
Mime-type
|
mimeType | string |
Het Mime-type van het document |
|
Naam
|
name | string |
De naam van het document |
|
Aantal pagina's
|
numPages | integer |
Aantal pagina's in het document |
DocumentV6
De informatie over het document
| Name | Pad | Type | Description |
|---|---|---|---|
|
Document-id
|
id | string |
De unieke id van het document |
|
Mime-type
|
mimeType | string |
Het Mime-type van het document |
|
Naam
|
name | string |
De naam van het document |
|
Aantal pagina's
|
numPages | integer |
Aantal pagina's in het document |
DocumentHistoryEvent
| Name | Pad | Type | Description |
|---|---|---|---|
|
Gebeurtenisinitiator
|
actingUserEmail | string |
E-mailadres van de gebruiker die de gebeurtenis heeft gestart |
|
Gebeurtenisdatum
|
date | date |
De datum van de controlegebeurtenis |
|
Beschrijving van evenement
|
description | string |
Een beschrijving van de controlegebeurtenis |
|
E-mailadres van deelnemer
|
participantEmail | string |
E-mailadres van de gebruiker die de gebeurtenis heeft gestart |
|
Gebeurtenistype
|
type | string |
Type overeenkomst-gebeurtenis |
DocumentLibraryItem
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bibliotheeksjabloon-id
|
libraryDocumentId | string |
De unieke id van het bibliotheekdocument dat wordt gebruikt bij het verzenden van het document dat moet worden ondertekend |
|
Bibliotheeksjabloontypen
|
libraryTemplateTypes | array of string |
Een lijst met een of meer bibliotheeksjabloontypen |
|
Gewijzigd op
|
modifiedDate | date |
De dag waarop de bibliotheeksjabloon voor het laatst is gewijzigd |
|
Naam van bibliotheeksjabloon
|
name | string |
De naam van de bibliotheeksjabloon |
|
Modus Voor delen van sjablonen
|
scope | string |
Het bereik van zichtbaarheid van de bibliotheeksjabloon |
DocumentLibraryItems
Een JSON die het matrixobject van de bibliotheeksjabloon bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Lijst met bibliotheeksjablonen
|
libraryDocumentList | array of DocumentLibraryItem |
Een lijst met bibliotheeksjabloonitems |
DocumentResponse
LibraryDocumentCreationResponse
Een JSON-object met een beschrijving van de bibliotheeksjabloon
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bibliotheeksjabloon-id
|
libraryDocumentId | string |
De unieke id die kan worden gebruikt om te verwijzen naar de bibliotheeksjabloon |
NextParticipantInfo
| Name | Pad | Type | Description |
|---|---|---|---|
|
E-mailen
|
string |
Het e-mailadres van de volgende deelnemer |
|
|
Naam
|
name | string |
De naam van de volgende deelnemer, indien beschikbaar |
|
Wachten sinds
|
waitingSince | date |
De datum waarop het document wacht totdat de deelnemer actie onderneemt |
NextParticipantSetInfo
| Name | Pad | Type | Description |
|---|---|---|---|
|
Volgende deelnemer ledengegevens instellen
|
nextParticipantSetMemberInfos | array of NextParticipantInfo |
Informatie over de leden van de volgende deelnemersset |
ParticipantInfo
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bedrijf
|
company | string |
Het bedrijf van de deelnemer, indien beschikbaar |
|
E-mailen
|
string |
Het e-mailadres van de deelnemer |
|
|
Naam
|
name | string |
De naam van de deelnemer, indien beschikbaar |
|
Deelnemers-ID
|
participantId | string |
De unieke id van de deelnemer |
|
Beveiligingsopties
|
securityOptions | array of string |
Beveiligingsopties die van toepassing zijn op de deelnemer |
|
Title
|
title | string |
De titel van de deelnemer, indien beschikbaar |
ParticipantSetInfo
| Name | Pad | Type | Description |
|---|---|---|---|
|
Id van deelnemersset
|
participantSetId | string |
De unieke id van de deelnemersset |
|
Ledengegevens van deelnemer instellen
|
participantSetMemberInfos | array of ParticipantInfo |
Informatie over de leden van de set geadresseerden |
|
Privébericht
|
privateMessage | string |
Privébericht voor de deelnemers in de set |
|
Rol
|
roles | array of string |
De huidige rollen van de deelnemersset. Een deelnemersset kan een of meer rollen hebben |
|
securityOptions
|
securityOptions | array of string |
Beveiligingsopties die van toepassing zijn op de deelnemer |
|
Ondertekeningsorder
|
signingOrder | integer |
Index beginnend met 1, die de volgorde aangeeft waarin deze geadresseerde zich ondertekent |
|
Status van deelnemersset
|
status | string |
De deelnemer heeft de status ingesteld met betrekking tot het document |
ParticipantSetInfoV6
| Name | Pad | Type | Description |
|---|---|---|---|
|
Ledengegevens van deelnemer instellen
|
memberInfos | array of MemberInfosV6 |
Informatie over de leden van de set geadresseerden |
|
Bestelling
|
order | integer |
Index die de positie aangeeft waarop de ondertekeningsgroep moet ondertekenen. |
|
Rol
|
role | string |
De huidige rollen van de deelnemersset (ondertekenaar, fiatteur, enz.). |
|
Naam van deelnemersset
|
name | string |
De naam van de deelnemersset |
|
Deelnemer Persoonlijke Messsage instellen
|
privateMessage | string |
Privébericht voor de deelnemers in de set |
|
Deelnemer zichtbare pagina's instellen
|
visiblePages | array of string |
De pagina's die zichtbaar zijn voor de deelnemersset |
MemberInfosV6
| Name | Pad | Type | Description |
|---|---|---|---|
|
E-mailadres van deelnemer
|
string |
Het e-mailadres van de deelnemer |
|
|
Authenticatie
|
securityOption.authenticationMethod | string |
Standaardverificatie: e-mail (geen) |
|
Wachtwoord
|
securityOption.password | string |
Het wachtwoord dat vereist is voor de deelnemer |
|
Landcode
|
securityOption.phoneInfo.countryCode | string |
De landcode van de ontvanger die is vereist om het document weer te geven en te ondertekenen |
|
Telefoon nee.
|
securityOption.phoneInfo.phone | string |
Het telefoonnummer van de geadresseerde dat is vereist om de overeenkomst te bekijken en te ondertekenen |
SigningUrl
| Name | Pad | Type | Description |
|---|---|---|---|
|
E-mail voor aanmeldings-URL
|
string |
Het e-mailadres van de ondertekenaar die is gekoppeld aan deze ondertekenings-URL |
|
|
Aanmeldings-URL
|
esignUrl | string |
Het URL-adres van de ondertekenaar die is gekoppeld aan deze ondertekenings-URL |
SigningUrlResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Matrix van URL's voor ondertekenaarsets
|
signingUrlSetInfos | array of SigningUrlSetInfo |
Een matrix met URL's voor ondertekenaarsets die betrokken zijn bij deze overeenkomst |
SigningUrlSetInfo
| Name | Pad | Type | Description |
|---|---|---|---|
|
- Url-matrix ondertekenen
|
signingUrls | array of SigningUrl |
Een matrix met URL's voor de huidige ondertekenaarset |
|
- Naam van url-set ondertekenen
|
signingUrlSetName | string |
De naam van de huidige ondertekenaarset |
Ondersteunende documenten
De informatie over het ondersteunende document
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naam van ondersteunend document
|
displayLabel | string |
Weergavenaam van het ondersteunende document |
|
Naam van ondersteunende documentveld
|
fieldName | string |
De naam van het ondersteunende documentveld |
|
Mime-type ondersteunend document
|
mimeType | string |
Het Mime-type van het ondersteunende document |
|
Ondersteunende documentpagina's
|
numPages | integer |
Aantal pagina's in het ondersteunende document |
|
Ondersteunende document-id
|
supportingDocumentId | string |
Unieke id die het ondersteunende document vertegenwoordigt |
SupportingDocumentV6
De informatie over het ondersteunende document
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naam van ondersteunend document
|
displayLabel | string |
Weergavenaam van het ondersteunende document |
|
Naam van ondersteunende documentveld
|
fieldName | string |
De naam van het ondersteunende documentveld |
|
Mime-type ondersteunend document
|
mimeType | string |
Het Mime-type van het ondersteunende document |
|
Ondersteunende documentpagina's
|
numPages | integer |
Aantal pagina's in het ondersteunende document |
|
Ondersteunende document-id
|
id | string |
Unieke id die het ondersteunende document vertegenwoordigt |
TransientDocumentResponse
Een JSON die de id van het geüploade document bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Document-id
|
transientDocumentId | string |
De document-id van het geüploade document |
UserAgreement
| Name | Pad | Type | Description |
|---|---|---|---|
|
Overeenkomst-id
|
agreementId | string |
Een unieke id die kan worden gebruikt om de overeenkomst uniek te identificeren |
|
Informatie over gebruikerssets weergeven
|
displayUserSetInfos | array of DisplayUserSetInfo |
De meest relevante huidige gebruiker die voor de overeenkomst is ingesteld. Dit is doorgaans de volgende ondertekenaar als de overeenkomst afkomstig is van de huidige gebruiker of de afzender als deze van een andere gebruiker wordt ontvangen |
|
Datum weergeven
|
displayDate | date |
De weergavedatum voor de overeenkomst |
|
Esign
|
esign | boolean |
Waar als dit een e-ondertekendocument is |
|
Meest recente versie-id
|
latestVersionId | string |
Een versie-id die de huidige versie van de overeenkomst uniek identificeert |
|
Naam
|
name | string |
Naam van de overeenkomst |
|
Toestand
|
status | string |
De huidige status van de overeenkomst |
UserAgreements
Een JSON die het matrixobject van de gebruikersovereenkomst bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Lijst met overeenkomsten
|
userAgreementList | array of UserAgreement |
Een matrix met overeenkomstitems |
UserAgreementV6
| Name | Pad | Type | Description |
|---|---|---|---|
|
Informatie over gebruikerssets weergeven
|
displayParticipantSetInfos | array of DisplayUserSetInfo |
De meest relevante huidige gebruiker die voor de overeenkomst is ingesteld. Dit is doorgaans de volgende ondertekenaar als de overeenkomst afkomstig is van de huidige gebruiker of de afzender als deze van een andere gebruiker wordt ontvangen |
|
Datum weergeven
|
displayDate | string |
De weergavedatum voor de overeenkomst |
|
Esign
|
esign | boolean |
Waar als dit een e-ondertekendocument is |
|
Verborgen
|
hidden | boolean |
Waar als de overeenkomst verborgen is voor de gebruiker |
|
Groeps-id
|
groupId | string |
Unieke id van de groep |
|
Meest recente versie-id
|
latestVersionId | string |
Een versie-id die de huidige versie van de overeenkomst uniek identificeert |
|
Naam
|
name | string |
Naam van de overeenkomst |
|
Bovenliggende id
|
parentId | string |
De bovenliggende id van een megaSign-kind OF de oorspronkelijke id van een exemplaar van een webformulierovereenkomst |
|
Overeenkomst-id
|
id | string |
De unieke id van de overeenkomst |
|
Toestand
|
status | string |
De huidige status van de overeenkomst |
|
Typologie
|
type | string |
Het soort overeenkomst |
userAgreementListV6
Een JSON die het matrixobject van de gebruikersovereenkomst bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
page
|
page | page |
Informatie over paginering om door het antwoord te navigeren |
|
Lijst met overeenkomsten
|
userAgreementList | array of UserAgreementV6 |
Een matrix met overeenkomstitems |
page
Informatie over paginering om door het antwoord te navigeren
| Name | Pad | Type | Description |
|---|---|---|---|
|
nextCursor
|
nextCursor | string |
Wordt gebruikt om naar de volgende pagina te navigeren. Als deze niet wordt geretourneerd, zijn er geen verdere pagina's. |
WebhookPayload
| Name | Pad | Type | Description |
|---|---|---|---|
|
Event
|
event | string |
De gebeurtenis die op de resource is opgetreden. |
|
Gebeurtenisdatum
|
eventDate | date |
De datum van de gebeurtenis. De notatie is jjjj-MM-dd'T'UU:mm:ssZ. Bijvoorbeeld: 2016-02-25T18:46:19Z vertegenwoordigt UTC-tijd |
|
Resourcetype gebeurtenis
|
eventResourceType | string |
De resource waarop de gebeurtenis is opgetreden. |
|
Bovenliggend type overeenkomst
|
eventResourceParentType | string |
Informatie over de resource van waaruit een overeenkomst wordt gemaakt. Mogelijke waarden: webformulier of megateken |
|
Bovenliggende id van overeenkomst
|
eventResourceParentId | string |
Een unieke id van de resource waaruit deze overeenkomst wordt gemaakt |
|
Rol gebeurtenisdeelnemer
|
participantRole | string |
De rol van de deelnemer voor het evenement. |
|
Gebeurtenisdeelnemer-id
|
participantUserId | string |
De id van de deelnemer voor het evenement. |
|
E-mailadres gebeurtenisdeelnemer
|
participantUserEmail | string |
Het e-mailadres van de deelnemer voor het evenement. |
|
Gebeurtenis die gebruikers-id optreedt
|
actingUserId | string |
De id van de gebruiker die de gebeurtenis heeft gemaakt. |
|
E-mailadres van actieve gebruiker
|
actingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gemaakt. |
|
Ip-adres van gebruiker die optreedt voor gebeurtenis
|
actingUserIpAddress | string |
Het IP-adres van de gebruiker die de gebeurtenis heeft gemaakt |
|
Gebeurtenis die gebruikers-id start
|
initiatingUserId | string |
De id van de gebruiker die de gebeurtenis heeft geïnitieerd namens de actieve gebruiker. |
|
Gebeurtenis voor het initiëren van gebruikers-e-mail
|
initiatingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gestart namens de actieve gebruiker. |
|
Toepasselijke gebruikers voor meldingen
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Een lijst met gebruikers voor wie deze melding van toepassing is |
|
Agreement
|
agreement | WebhookAgreementInfo |
De volledige informatie van de overeenkomst |
ApplicableUsers
De informatie over de gebruikers voor wie deze melding van toepassing is
| Name | Pad | Type | Description |
|---|---|---|---|
|
Melding toepasselijke gebruikers-id
|
id | string |
De unieke id van de gebruiker waarvoor deze melding van toepassing is |
|
Melding van toepasselijke gebruikers-e-mail
|
string |
Het e-mailadres van de gebruiker waarvoor deze melding van toepassing is |
|
|
Melding van toepassingsgebruikersrol
|
role | string |
De rol van de gebruiker in de werkstroom waarvoor deze melding wordt gegenereerd |
|
Is de gebruiker die van toepassing is op nettolading
|
payloadApplicable | boolean |
Of de gegevens in deze melding van toepassing zijn op deze gebruiker of niet |
WebhookPayloadWithoutNextParticipantSet
| Name | Pad | Type | Description |
|---|---|---|---|
|
Event
|
event | string |
De gebeurtenis die op de resource is opgetreden. |
|
Gebeurtenisdatum
|
eventDate | date |
De datum van de gebeurtenis. De notatie is jjjj-MM-dd'T'UU:mm:ssZ. Bijvoorbeeld: 2016-02-25T18:46:19Z vertegenwoordigt UTC-tijd |
|
Resourcetype gebeurtenis
|
eventResourceType | string |
De resource waarop de gebeurtenis is opgetreden. |
|
Bovenliggend type overeenkomst
|
eventResourceParentType | string |
Informatie over de resource van waaruit een overeenkomst wordt gemaakt. Mogelijke waarden: webformulier of megateken |
|
Bovenliggende id van overeenkomst
|
eventResourceParentId | string |
Een unieke id van de resource waaruit deze overeenkomst wordt gemaakt |
|
Gebeurtenisdeelnemer-id
|
participantUserId | string |
De id van de deelnemer voor het evenement. |
|
E-mailadres gebeurtenisdeelnemer
|
participantUserEmail | string |
Het e-mailadres van de deelnemer voor het evenement. |
|
Gebeurtenis die gebruikers-id optreedt
|
actingUserId | string |
De id van de gebruiker die de gebeurtenis heeft gemaakt. |
|
E-mailadres van actieve gebruiker
|
actingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gemaakt. |
|
Ip-adres van gebruiker die optreedt voor gebeurtenis
|
actingUserIpAddress | string |
Het IP-adres van de gebruiker die de gebeurtenis heeft gemaakt |
|
Gebeurtenis die gebruikers-id start
|
initiatingUserId | string |
De id van de gebruiker die de gebeurtenis heeft geïnitieerd namens een actieve gebruiker |
|
Gebeurtenis voor het initiëren van gebruikers-e-mail
|
initiatingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gestart namens de actieve gebruiker. |
|
Toepasselijke gebruikers voor meldingen
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Een lijst met gebruikers voor wie deze melding van toepassing is |
|
Agreement
|
agreement | WebhookAgreementInfoWithoutNextParticipantSet |
De volledige informatie van de overeenkomst |
WebhookPayloadWithSignedDocumentForStatusChange
| Name | Pad | Type | Description |
|---|---|---|---|
|
Event
|
event | string |
De gebeurtenis die op de resource is opgetreden. |
|
Gebeurtenisdatum
|
eventDate | date |
De datum van de gebeurtenis. De notatie is jjjj-MM-dd'T'UU:mm:ssZ. Bijvoorbeeld: 2016-02-25T18:46:19Z vertegenwoordigt UTC-tijd |
|
Sub gebeurtenis
|
subEvent | string |
De subgebeurtenis die op een resource is opgetreden. |
|
Bovenliggend type overeenkomst
|
eventResourceParentType | string |
Informatie over de resource van waaruit een overeenkomst wordt gemaakt. Mogelijke waarden: webformulier of megateken |
|
Bovenliggende id van overeenkomst
|
eventResourceParentId | string |
Een unieke id van de resource waaruit deze overeenkomst wordt gemaakt |
|
Gebeurtenisdeelnemer-id
|
participantUserId | string |
De id van de deelnemer voor het evenement. |
|
E-mailadres gebeurtenisdeelnemer
|
participantUserEmail | string |
Het e-mailadres van de deelnemer voor het evenement. |
|
Gebeurtenis die gebruikers-id optreedt
|
actingUserId | string |
De id van de gebruiker die de gebeurtenis heeft gemaakt. |
|
E-mailadres van actieve gebruiker
|
actingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gemaakt. |
|
Ip-adres van gebruiker die optreedt voor gebeurtenis
|
actingUserIpAddress | string |
Het IP-adres van de gebruiker die de gebeurtenis heeft gemaakt |
|
Actietype
|
actionType | string |
De actie waarvoor de gebeurtenis is opgetreden. |
|
Gebeurtenis die gebruikers-id start
|
initiatingUserId | string |
De id van de gebruiker die de gebeurtenis heeft geïnitieerd namens een actieve gebruiker |
|
Gebeurtenis voor het initiëren van gebruikers-e-mail
|
initiatingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gestart namens de actieve gebruiker. |
|
Resourcetype gebeurtenis
|
eventResourceType | string |
De resource waarop de gebeurtenis is opgetreden. |
|
Rol gebeurtenisdeelnemer
|
participantRole | string |
De rol van de deelnemer voor het evenement. |
|
Toepasselijke gebruikers voor meldingen
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Een lijst met gebruikers voor wie deze melding van toepassing is |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocument |
De volledige informatie van de overeenkomst |
WebhookPayloadWithSignedDocument
| Name | Pad | Type | Description |
|---|---|---|---|
|
Event
|
event | string |
De gebeurtenis die op de resource is opgetreden. |
|
Gebeurtenisdatum
|
eventDate | date |
De datum van de gebeurtenis. De notatie is jjjj-MM-dd'T'UU:mm:ssZ. Bijvoorbeeld: 2016-02-25T18:46:19Z vertegenwoordigt UTC-tijd |
|
Bovenliggend type overeenkomst
|
eventResourceParentType | string |
Informatie over de resource van waaruit een overeenkomst wordt gemaakt. Mogelijke waarden: webformulier of megateken |
|
Bovenliggende id van overeenkomst
|
eventResourceParentId | string |
Een unieke id van de resource waaruit deze overeenkomst wordt gemaakt |
|
Resourcetype gebeurtenis
|
eventResourceType | string |
De resource waarop de gebeurtenis is opgetreden. |
|
Rol gebeurtenisdeelnemer
|
participantRole | string |
De rol van de deelnemer voor het evenement. |
|
Gebeurtenisdeelnemer-id
|
participantUserId | string |
De id van de deelnemer voor het evenement. |
|
E-mailadres gebeurtenisdeelnemer
|
participantUserEmail | string |
Het e-mailadres van de deelnemer voor het evenement. |
|
Gebeurtenis die gebruikers-id optreedt
|
actingUserId | string |
De id van de gebruiker die de gebeurtenis heeft gemaakt. |
|
E-mailadres van actieve gebruiker
|
actingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gemaakt. |
|
Ip-adres van gebruiker die optreedt voor gebeurtenis
|
actingUserIpAddress | string |
Het IP-adres van de gebruiker die de gebeurtenis heeft gemaakt |
|
Gebeurtenis die gebruikers-id start
|
initiatingUserId | string |
De id van de gebruiker die de gebeurtenis heeft geïnitieerd namens een actieve gebruiker |
|
Gebeurtenis voor het initiëren van gebruikers-e-mail
|
initiatingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gestart namens de actieve gebruiker. |
|
Toepasselijke gebruikers voor meldingen
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Een lijst met gebruikers voor wie deze melding van toepassing is |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocument |
De volledige informatie van de overeenkomst |
WebhookPayloadGeneric
| Name | Pad | Type | Description |
|---|---|---|---|
|
Event
|
event | string |
De gebeurtenis die op de resource is opgetreden. |
|
Gebeurtenisdatum
|
eventDate | date |
De datum van de gebeurtenis. De notatie is jjjj-MM-dd'T'UU:mm:ssZ. Bijvoorbeeld: 2016-02-25T18:46:19Z vertegenwoordigt UTC-tijd |
|
Sub gebeurtenis
|
subEvent | string |
De subgebeurtenis die op een resource is opgetreden. |
|
Bovenliggend type overeenkomst
|
eventResourceParentType | string |
Informatie over de resource van waaruit een overeenkomst wordt gemaakt. Mogelijke waarden: webformulier of megateken |
|
Bovenliggende id van overeenkomst
|
eventResourceParentId | string |
Een unieke id van de resource waaruit deze overeenkomst wordt gemaakt |
|
Resourcetype gebeurtenis
|
eventResourceType | string |
De resource waarop de gebeurtenis is opgetreden. |
|
Rol gebeurtenisdeelnemer
|
participantRole | string |
De rol van de deelnemer voor het evenement. |
|
Gebeurtenisdeelnemer-id
|
participantUserId | string |
De id van de deelnemer voor het evenement. |
|
E-mailadres gebeurtenisdeelnemer
|
participantUserEmail | string |
Het e-mailadres van de deelnemer voor het evenement. |
|
Gebeurtenis die gebruikers-id optreedt
|
actingUserId | string |
De id van de gebruiker die de gebeurtenis heeft gemaakt. |
|
E-mailadres van actieve gebruiker
|
actingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gemaakt. |
|
Gebeurtenis die gebruikers-id start
|
initiatingUserId | string |
De id van de gebruiker die de gebeurtenis heeft geïnitieerd namens een actieve gebruiker |
|
Gebeurtenis voor het initiëren van gebruikers-e-mail
|
initiatingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gestart namens de actieve gebruiker. |
|
Actietype
|
actionType | string |
De actie waarvoor de gebeurtenis is opgetreden. |
|
Ip-adres van gebruiker die optreedt voor gebeurtenis
|
actingUserIpAddress | string |
Het IP-adres van de gebruiker die de gebeurtenis heeft gemaakt |
|
Toepasselijke gebruikers voor meldingen
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Een lijst met gebruikers voor wie deze melding van toepassing is |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
De volledige informatie van de overeenkomst |
|
Megateken
|
megaSign | WebhookMegaSignInfo |
De volledige informatie van het megateken |
|
Webformulier
|
widget | WebhookWidgetInfo |
De volledige informatie van het webformulier |
WebFormWebhookAgreementEventPayload
| Name | Pad | Type | Description |
|---|---|---|---|
|
Event
|
event | string |
De overeenkomstgebeurtenis die op het webformulier is opgetreden. |
|
Gebeurtenisdatum
|
eventDate | date |
De datum van de gebeurtenis. De notatie is jjjj-MM-dd'T'UU:mm:ssZ. Bijvoorbeeld: 2016-02-25T18:46:19Z vertegenwoordigt UTC-tijd |
|
Sub gebeurtenis
|
subEvent | string |
De subgebeurtenis die op een webformulier is opgetreden. |
|
Bovenliggend type overeenkomst - webformulier
|
eventResourceParentType | string |
Waarde die aangeeft dat er een overeenkomst wordt gemaakt op basis van het webformulier. |
|
Webformulier-id
|
eventResourceParentId | string |
Een unieke id van het webformulier waaruit deze overeenkomst wordt gemaakt |
|
Resourcetype gebeurtenis - overeenkomst
|
eventResourceType | string |
De resource waarop de gebeurtenis is opgetreden. |
|
Rol gebeurtenisdeelnemer
|
participantRole | string |
De rol van de deelnemer voor het evenement. |
|
Gebeurtenisdeelnemer-id
|
participantUserId | string |
De id van de deelnemer voor het evenement. |
|
E-mailadres gebeurtenisdeelnemer
|
participantUserEmail | string |
Het e-mailadres van de deelnemer voor het evenement. |
|
Gebeurtenis die gebruikers-id optreedt
|
actingUserId | string |
De id van de gebruiker die de gebeurtenis heeft gemaakt. |
|
E-mailadres van actieve gebruiker
|
actingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gemaakt. |
|
Gebeurtenis die gebruikers-id start
|
initiatingUserId | string |
De id van de gebruiker die de gebeurtenis heeft geïnitieerd namens een actieve gebruiker |
|
Gebeurtenis voor het initiëren van gebruikers-e-mail
|
initiatingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gestart namens de actieve gebruiker. |
|
Actietype
|
actionType | string |
De actie waarvoor de gebeurtenis is opgetreden. |
|
Ip-adres van gebruiker die optreedt voor gebeurtenis
|
actingUserIpAddress | string |
Het IP-adres van de gebruiker die de gebeurtenis heeft gemaakt |
|
Toepasselijke gebruikers voor meldingen
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Een lijst met gebruikers voor wie deze melding van toepassing is |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
De volledige informatie van de overeenkomst |
GroupWebhookEventPayload
| Name | Pad | Type | Description |
|---|---|---|---|
|
Event
|
event | string |
De gebeurtenis die is opgetreden voor een groep. |
|
Gebeurtenisdatum
|
eventDate | date |
De datum van de gebeurtenis. De notatie is jjjj-MM-dd'T'UU:mm:ssZ. Bijvoorbeeld: 2016-02-25T18:46:19Z vertegenwoordigt UTC-tijd |
|
Sub gebeurtenis
|
subEvent | string |
De subgebeurtenis die is opgetreden voor een groep. |
|
Bovenliggend type overeenkomst - webformulier
|
eventResourceParentType | string |
Informatie over de groep waaruit een overeenkomst wordt gemaakt. |
|
Webformulier-id
|
eventResourceParentId | string |
Een unieke id van de groep waaruit deze overeenkomst wordt gemaakt |
|
Resourcetype gebeurtenis - overeenkomst
|
eventResourceType | string |
De groep waarvoor de gebeurtenis heeft plaatsgevonden. |
|
Rol gebeurtenisdeelnemer
|
participantRole | string |
De rol van de deelnemer voor het evenement. |
|
Gebeurtenisdeelnemer-id
|
participantUserId | string |
De id van de deelnemer voor het evenement. |
|
E-mailadres gebeurtenisdeelnemer
|
participantUserEmail | string |
Het e-mailadres van de deelnemer voor het evenement. |
|
Gebeurtenis die gebruikers-id optreedt
|
actingUserId | string |
De id van de gebruiker die de gebeurtenis heeft gemaakt. |
|
E-mailadres van actieve gebruiker
|
actingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gemaakt. |
|
Gebeurtenis die gebruikers-id start
|
initiatingUserId | string |
De id van de gebruiker die de gebeurtenis heeft geïnitieerd namens een actieve gebruiker |
|
Gebeurtenis voor het initiëren van gebruikers-e-mail
|
initiatingUserEmail | string |
Het e-mailadres van de gebruiker die de gebeurtenis heeft gestart namens de actieve gebruiker. |
|
Actietype
|
actionType | string |
De actie waarvoor de gebeurtenis is opgetreden. |
|
Ip-adres van gebruiker die optreedt voor gebeurtenis
|
actingUserIpAddress | string |
Het IP-adres van de gebruiker die de gebeurtenis heeft gemaakt |
|
Toepasselijke gebruikers voor meldingen
|
webhookNotificationApplicableUsers | array of ApplicableUsers |
Een lijst met gebruikers voor wie deze melding van toepassing is |
|
Agreement
|
agreement | WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo |
De volledige informatie van de overeenkomst |
|
Megateken
|
megaSign | WebhookMegaSignInfo |
De volledige informatie van het megateken |
|
Webformulier
|
widget | WebhookWidgetInfo |
De volledige informatie van het webformulier |
WebhookAgreementInfo
De volledige informatie van de overeenkomst
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De unieke id van de overeenkomst |
|
Naam
|
name | string |
De naam van de overeenkomst |
|
Handtekeningtype
|
signatureType | string |
Hiermee geeft u het handtekeningtype op dat is aangevraagd - E-handtekening of geschreven |
|
Toestand
|
status | string |
De huidige status van de overeenkomst |
|
Ccs
|
ccs | array of CcInfo |
Een lijst met een of meer CCs die worden gekopieerd in de overeenkomsttransactie. |
|
Aanmaakdatum
|
createdDate | date |
Datum waarop een overeenkomst is gemaakt |
|
Verlooptijd
|
expirationTime | string |
Tijd waarna de overeenkomst verloopt en moet worden ondertekend voordat deze is ondertekend |
|
Externe ID
|
externalId.id | string |
Een willekeurige waarde van uw systeem, die kan worden opgegeven tijdens het verzenden en vervolgens later geretourneerd of opgevraagd |
|
Externe groep
|
externalId.group | string |
Een willekeurige waarde van uw systeem, die kan worden opgegeven tijdens het verzenden en vervolgens later geretourneerd of opgevraagd |
|
Vertraging van eerste herinnering
|
firstReminderDelay | integer |
Geheel getal dat de vertraging in uren aangeeft voordat de eerste herinnering wordt verzonden. |
|
Lokatie
|
locale | string |
De landinstelling die aan deze overeenkomst is gekoppeld |
|
Message
|
message | string |
Een optioneel bericht aan de deelnemers, waarin wordt beschreven wat er wordt verzonden of waarom hun handtekening is vereist |
|
Herinneringsfrequentie
|
reminderFrequency | string |
Optionele parameter waarmee wordt ingesteld hoe vaak u herinneringen naar de deelnemers wilt verzenden. Als deze niet is opgegeven, wordt de standaardfrequentie gebruikt die voor het account is ingesteld |
|
E-mail van afzender
|
senderEmail | string |
E-mail van afzender van overeenkomst |
|
Kluis ingeschakeld?
|
vaultingInfo.enabled | boolean |
Voor accounts die zijn ingesteld voor documentkluizen en de optie om per overeenkomst in te schakelen, bepaalt dit of het document moet worden gekluisd |
|
Zichtbaarheid van documenten?
|
documentVisibilityEnabled | boolean |
Is zichtbaarheid van documenten ingeschakeld |
|
Werkstroom-id
|
workflowId | string |
De id van een aangepaste werkstroom die het routeringspad van een overeenkomst definieert. |
|
Omleidings-URL na ondertekening
|
postSignOption.redirectUrl | string |
Een openbaar toegankelijke URL waarnaar de gebruiker wordt verzonden nadat het ondertekeningsproces is voltooid |
|
Deelnemerssets
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
De deelnemer stelt gegevens in |
|
Volgende deelnemerssets
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
De volgende deelnemer stelt informatie in |
|
Documents
|
documentsInfo.documents | array of WebhookDocument |
Een lijst met objecten die de documenten vertegenwoordigen |
|
Bewijsstukken
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Een lijst met ondersteunende documenten |
WebhookAgreementInfoWithoutNextParticipantSet
De volledige informatie van de overeenkomst
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De unieke id van de overeenkomst |
|
Naam
|
name | string |
De naam van de overeenkomst |
|
Handtekeningtype
|
signatureType | string |
Hiermee geeft u het handtekeningtype op dat is aangevraagd - E-handtekening of geschreven |
|
Toestand
|
status | string |
De huidige status van de overeenkomst |
|
Ccs
|
ccs | array of CcInfo |
Een lijst met een of meer CCs die worden gekopieerd in de overeenkomsttransactie. |
|
Aanmaakdatum
|
createdDate | date |
Datum waarop een overeenkomst is gemaakt |
|
Zichtbaarheid van documenten?
|
documentVisibilityEnabled | boolean |
Is zichtbaarheid van documenten ingeschakeld |
|
Verlooptijd
|
expirationTime | string |
Tijd waarna de overeenkomst verloopt en moet worden ondertekend voordat deze is ondertekend |
|
Externe ID
|
externalId.id | string |
Een willekeurige waarde van uw systeem, die kan worden opgegeven tijdens het verzenden en vervolgens later geretourneerd of opgevraagd |
|
Externe groep
|
externalId.group | string |
Een willekeurige waarde van uw systeem, die kan worden opgegeven tijdens het verzenden en vervolgens later geretourneerd of opgevraagd |
|
Vertraging van eerste herinnering
|
firstReminderDelay | integer |
Geheel getal dat de vertraging in uren aangeeft voordat de eerste herinnering wordt verzonden. |
|
Lokatie
|
locale | string |
De landinstelling die aan deze overeenkomst is gekoppeld |
|
Message
|
message | string |
Een optioneel bericht aan de deelnemers, waarin wordt beschreven wat er wordt verzonden of waarom hun handtekening is vereist |
|
Herinneringsfrequentie
|
reminderFrequency | string |
Optionele parameter waarmee wordt ingesteld hoe vaak u herinneringen naar de deelnemers wilt verzenden. Als deze niet is opgegeven, wordt de standaardfrequentie gebruikt die voor het account is ingesteld |
|
E-mail van afzender
|
senderEmail | string |
E-mail van afzender van overeenkomst |
|
Kluis ingeschakeld?
|
vaultingInfo.enabled | boolean |
Voor accounts die zijn ingesteld voor documentkluizen en de optie om per overeenkomst in te schakelen, bepaalt dit of het document moet worden gekluisd |
|
Omleidings-URL na ondertekening
|
postSignOption.redirectUrl | string |
Een openbaar toegankelijke URL waarnaar de gebruiker wordt verzonden nadat het ondertekeningsproces is voltooid |
|
Werkstroom-id
|
workflowId | string |
De id van een aangepaste werkstroom die het routeringspad van een overeenkomst definieert. |
|
Deelnemerssets
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
De deelnemer stelt gegevens in |
WebhookAgreementInfoWithSignedDocumentAndNextParticipantInfo
De volledige informatie van de overeenkomst
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De unieke id van de overeenkomst |
|
Naam
|
name | string |
De naam van de overeenkomst |
|
Handtekeningtype
|
signatureType | string |
Hiermee geeft u het handtekeningtype op dat is aangevraagd - E-handtekening of geschreven |
|
Toestand
|
status | string |
De huidige status van de overeenkomst |
|
Ccs
|
ccs | array of CcInfo |
Een lijst met een of meer CCs die worden gekopieerd in de overeenkomsttransactie. |
|
Aanmaakdatum
|
createdDate | date |
Datum waarop een overeenkomst is gemaakt |
|
Verlooptijd
|
expirationTime | string |
Tijd waarna de overeenkomst verloopt en moet worden ondertekend voordat deze is ondertekend |
|
Externe ID
|
externalId.id | string |
Een willekeurige waarde van uw systeem, die kan worden opgegeven tijdens het verzenden en vervolgens later geretourneerd of opgevraagd |
|
Externe groep
|
externalId.group | string |
Een willekeurige waarde van uw systeem, die kan worden opgegeven tijdens het verzenden en vervolgens later geretourneerd of opgevraagd |
|
Vertraging van eerste herinnering
|
firstReminderDelay | integer |
Geheel getal dat de vertraging in uren aangeeft voordat de eerste herinnering wordt verzonden. |
|
Lokatie
|
locale | string |
De landinstelling die aan deze overeenkomst is gekoppeld |
|
Message
|
message | string |
Een optioneel bericht aan de deelnemers, waarin wordt beschreven wat er wordt verzonden of waarom hun handtekening is vereist |
|
Herinneringsfrequentie
|
reminderFrequency | string |
Optionele parameter waarmee wordt ingesteld hoe vaak u herinneringen naar de deelnemers wilt verzenden. Als deze niet is opgegeven, wordt de standaardfrequentie gebruikt die voor het account is ingesteld |
|
Omleidings-URL na ondertekening
|
postSignOption.redirectUrl | string |
Een openbaar toegankelijke URL waarnaar de gebruiker wordt verzonden nadat het ondertekeningsproces is voltooid |
|
Werkstroom-id
|
workflowId | string |
De id van een aangepaste werkstroom die het routeringspad van een overeenkomst definieert. |
|
E-mail van afzender
|
senderEmail | string |
E-mail van afzender van overeenkomst |
|
Zichtbaarheid van documenten?
|
documentVisibilityEnabled | boolean |
Is zichtbaarheid van documenten ingeschakeld |
|
Kluis ingeschakeld?
|
vaultingInfo.enabled | boolean |
Voor accounts die zijn ingesteld voor documentkluizen en de optie om per overeenkomst in te schakelen, bepaalt dit of het document moet worden gekluisd |
|
Deelnemerssets
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
De deelnemer stelt gegevens in |
|
Volgende deelnemerssets
|
participantSetsInfo.nextParticipantSets | array of WebhookParticipantSets |
De volgende deelnemer stelt informatie in |
|
Documents
|
documentsInfo.documents | array of WebhookDocument |
Een lijst met objecten die de documenten vertegenwoordigen |
|
Bewijsstukken
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Een lijst met ondersteunende documenten Dit wordt alleen geretourneerd als er een ondersteunend document in de overeenkomst staat |
|
Ondertekende documentgegevens
|
signedDocumentInfo.document | string |
Een met base64 gecodeerde tekenreeks van het ondertekende document |
WebhookAgreementInfoWithSignedDocument
De volledige informatie van de overeenkomst
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De unieke id van de overeenkomst |
|
Naam
|
name | string |
De naam van de overeenkomst |
|
Handtekeningtype
|
signatureType | string |
Hiermee geeft u het handtekeningtype op dat is aangevraagd - E-handtekening of geschreven |
|
Toestand
|
status | string |
De huidige status van de overeenkomst |
|
Ccs
|
ccs | array of CcInfo |
Een lijst met een of meer CCs die worden gekopieerd in de overeenkomsttransactie |
|
Aanmaakdatum
|
createdDate | date |
Datum waarop een overeenkomst is gemaakt |
|
Zichtbaarheid van documenten?
|
documentVisibilityEnabled | boolean |
Is zichtbaarheid van documenten ingeschakeld |
|
Verlooptijd
|
expirationTime | string |
Tijd waarna de overeenkomst verloopt en moet worden ondertekend voordat deze is ondertekend |
|
Externe ID
|
externalId.id | string |
Een willekeurige waarde van uw systeem, die kan worden opgegeven tijdens het verzenden en vervolgens later geretourneerd of opgevraagd |
|
Externe groep
|
externalId.group | string |
Een willekeurige waarde van uw systeem, die kan worden opgegeven tijdens het verzenden en vervolgens later geretourneerd of opgevraagd |
|
Vertraging van eerste herinnering
|
firstReminderDelay | integer |
Geheel getal dat de vertraging in uren aangeeft voordat de eerste herinnering wordt verzonden. |
|
Lokatie
|
locale | string |
De landinstelling die aan deze overeenkomst is gekoppeld |
|
Message
|
message | string |
Een optioneel bericht aan de deelnemers, waarin wordt beschreven wat er wordt verzonden of waarom hun handtekening is vereist |
|
Herinneringsfrequentie
|
reminderFrequency | string |
Optionele parameter waarmee wordt ingesteld hoe vaak u herinneringen naar de deelnemers wilt verzenden. Als deze niet is opgegeven, wordt de standaardfrequentie gebruikt die voor het account is ingesteld |
|
E-mail van afzender
|
senderEmail | string |
E-mail van afzender van overeenkomst |
|
Kluis ingeschakeld?
|
vaultingInfo.enabled | boolean |
Voor accounts die zijn ingesteld voor documentkluizen en de optie om per overeenkomst in te schakelen, bepaalt dit of het document moet worden gekluisd |
|
Omleidings-URL na ondertekening
|
postSignOption.redirectUrl | string |
Een openbaar toegankelijke URL waarnaar de gebruiker wordt verzonden nadat het ondertekeningsproces is voltooid |
|
Werkstroom-id
|
workflowId | string |
De id van een aangepaste werkstroom die het routeringspad van een overeenkomst definieert. |
|
Deelnemerssets
|
participantSetsInfo.participantSets | array of WebhookParticipantSets |
De deelnemer stelt gegevens in |
|
Documents
|
documentsInfo.documents | array of WebhookDocument |
Een lijst met objecten die de documenten vertegenwoordigen |
|
Bewijsstukken
|
documentsInfo.supportingDocuments | array of WebhookSupportingDocument |
Een lijst met ondersteunende documenten Dit wordt alleen geretourneerd als er een ondersteunend document in de overeenkomst staat |
|
Ondertekende documentgegevens
|
signedDocumentInfo.document | string |
Een met base64 gecodeerde tekenreeks van het ondertekende document |
WebhookMegaSignInfo
De volledige informatie van het megateken
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De unieke id van de megasign |
|
Naam
|
name | string |
De naam van de megasign |
|
Toestand
|
status | string |
De status van de megasign |
|
Ccs
|
ccs | array of MegaSignCcInfo |
Een lijst met een of meer e-mailadressen die u wilt kopiëren op deze megasign. |
|
Externe ID
|
externalId.id | string |
Een willekeurige waarde van uw systeem, die kan worden opgegeven tijdens het verzenden en vervolgens later geretourneerd of opgevraagd |
|
Vertraging van eerste herinnering
|
firstReminderDelay | integer |
Geheel getal dat de vertraging in uren aangeeft voordat de eerste herinnering wordt verzonden. |
|
Lokatie
|
locale | string |
De landinstelling die aan deze overeenkomst is gekoppeld |
|
Message
|
message | string |
Een optioneel bericht aan de deelnemers, waarin wordt beschreven wat er wordt verzonden of waarom hun handtekening is vereist |
|
Omleidings-URL na ondertekening
|
postSignOption.redirectUrl | string |
Een openbaar toegankelijke URL waarnaar de gebruiker wordt verzonden nadat het ondertekeningsproces is voltooid |
|
E-mail van afzender
|
senderEmail | string |
E-mail van megasign creator |
|
Handtekeningtype
|
signatureType | string |
Hiermee geeft u het handtekeningtype op dat is aangevraagd - E-handtekening of geschreven |
|
Kluis ingeschakeld?
|
vaultingInfo.enabled | boolean |
Voor accounts die zijn ingesteld voor documentkluizen en de optie om per overeenkomst in te schakelen, bepaalt dit of het document moet worden gekluisd |
|
Bestandsgegevens van onderliggende overeenkomsten
|
childAgreementsInfo.fileInfo | MegaSignChildAgreementsFileInfo |
Bestandsgegevens met informatie over de onderliggende overeenkomst van megaSign. |
WebhookWidgetInfo
De volledige informatie van het webformulier
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De unieke id van het webformulier |
|
Naam
|
name | string |
De naam van het webformulier |
|
Toestand
|
status | string |
De status van het webformulier |
|
Informatie over verificatiefouten
|
authFailureInfo | AuthFailureWidgetRedirectionInfo |
URL en bijbehorende eigenschappen voor de foutpagina worden gebruikt nadat de ondertekenaar van het webformulier niet kan worden geverifieerd |
|
Ccs
|
ccs | array of WidgetCcInfo |
Een lijst met een of meer e-mailadressen die u op dit webformulier wilt kopiëren. |
|
Aanmaakdatum
|
createdDate | date |
Datum waarop het webformulier is gemaakt |
|
Voltooiingsgegevens
|
completionInfo | WidgetCompletionRedirectionInfo |
URL en bijbehorende eigenschappen voor de geslaagde pagina waar de ondertekenaar van het webformulier naar wordt geleid na het uitvoeren van de gewenste actie op het webformulier |
|
E-mail maker
|
creatorEmail | string |
Het e-mailadres van de maker van het webformulier |
|
Kluis ingeschakeld?
|
vaultingInfo.enabled | boolean |
Voor accounts die zijn ingesteld voor documentkluizen en de optie om per overeenkomst in te schakelen, bepaalt dit of het document moet worden gekluisd |
|
Aanvullende informatie over deelnemerssets
|
participantSetsInfo.additionalParticipantSets | array of WidgetParticipantSetInfo |
Lijst met alle deelnemers aan het webformulier, met uitzondering van de ondertekenaar van het webformulier |
|
Rol eerste deelnemerset
|
participantSetsInfo.widgetParticipantSet.role | string |
Rol die wordt aangenomen door alle deelnemers in de set (ondertekenaar, fiatteur, enz.) |
|
Eerste ingestelde volgorde van deelnemer
|
participantSetsInfo.widgetParticipantSet.order | integer |
Index die de sequentiële ondertekeningsgroep aangeeft (opgegeven voor hybride routering) |
|
Documents
|
documentsInfo.documents | array of WidgetWebhookDocument |
Een lijst met objecten die de documenten vertegenwoordigen |
AuthFailureWidgetRedirectionInfo
URL en bijbehorende eigenschappen voor de foutpagina worden gebruikt nadat de ondertekenaar van het webformulier niet kan worden geverifieerd
| Name | Pad | Type | Description |
|---|---|---|---|
|
Vertraging bij omleiding van verificatiefout
|
delay | integer |
De vertraging (in seconden) voordat de gebruiker naar de resulterende pagina wordt geleid |
|
Omleidingsframe voor verificatiefouten
|
deframe | boolean |
Als deframe onwaar is, wordt de resulterende pagina weergegeven in het webformulierframe |
|
Omleidings-URL voor verificatiefouten
|
url | string |
Een openbaar toegankelijke URL waarnaar de gebruiker wordt verzonden nadat het webformulier is voltooid |
WidgetCompletionRedirectionInfo
URL en bijbehorende eigenschappen voor de geslaagde pagina waar de ondertekenaar van het webformulier naar wordt geleid na het uitvoeren van de gewenste actie op het webformulier
| Name | Pad | Type | Description |
|---|---|---|---|
|
Vertraging van voltooiingsomleiding
|
delay | integer |
De vertraging (in seconden) voordat de gebruiker naar de resulterende pagina wordt geleid |
|
Omleidingsdeframe voor voltooiing
|
deframe | boolean |
Als deframe onwaar is, wordt de resulterende pagina weergegeven in het webformulierframe |
|
Omleidings-URL voor voltooiing
|
url | string |
Een openbaar toegankelijke URL waarnaar de gebruiker wordt verzonden nadat het webformulier is voltooid |
WebhookParticipantSets
| Name | Pad | Type | Description |
|---|---|---|---|
|
Ledengegevens
|
memberInfos | array of MemberInfos |
De informatie over deelnemers |
|
Bestelling
|
order | integer |
Index die de positie aangeeft waarop de ondertekeningsgroep moet ondertekenen. |
|
Rol
|
role | string |
Rol die wordt aangenomen door alle deelnemers in de set (ondertekenaar, fiatteur, enz.) |
|
Toestand
|
status | string |
Huidige status van de overeenkomst vanuit het perspectief van de gebruiker |
|
ID-kaart
|
id | string |
De id van de deelnemersset |
|
Naam
|
name | string |
De naam van de deelnemersset |
|
Privébericht
|
privateMessage | string |
Privébericht voor de deelnemers in de set |
MegaSignChildAgreementsFileInfo
Bestandsgegevens met informatie over de onderliggende overeenkomst van megaSign.
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bestands-id van onderliggende overeenkomsten
|
childAgreementsInfoFileId | string |
De id van het bestand met informatie over de bestaande childAgreementsInfo van de megaSign. |
WidgetWebhookDocument
De informatie over het document van het webformulier
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De unieke id van het document |
|
Naam
|
name | string |
De naam van het document |
WebhookDocument
De informatie over het document van de overeenkomst
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De unieke id van het document |
|
Naam
|
name | string |
De naam van het document |
WebhookSupportingDocument
De informatie over het ondersteunende document
| Name | Pad | Type | Description |
|---|---|---|---|
|
Naam
|
displayLabel | string |
Weergavenaam van het ondersteunende document |
|
Veldnaam
|
fieldName | string |
De naam van het ondersteunende documentveld |
|
ID-kaart
|
id | string |
De unieke id die het ondersteunende document vertegenwoordigt |
WidgetCcInfo
De informatie over de CC van het webformulier
| Name | Pad | Type | Description |
|---|---|---|---|
|
E-mailen
|
string |
E-mail van de CC-deelnemer van het webformulier |
MegaSignCcInfo
De informatie over de CC van het megateken
| Name | Pad | Type | Description |
|---|---|---|---|
|
E-mailen
|
string |
E-mail van de CC-deelnemer van de megasign |
CCInfo
De informatie over de CC van de overeenkomst
| Name | Pad | Type | Description |
|---|---|---|---|
|
E-mailen
|
string |
Het e-mailadres van de CC van de overeenkomst |
|
|
Etiket
|
label | string |
Het label van de CC-lijst zoals geretourneerd in de beschrijving van de werkstroom |
|
Zichtbare pagina's
|
visiblePages | array of string |
De pagina's die zichtbaar zijn voor de CC |
WidgetParticipantSetInfo
| Name | Pad | Type | Description |
|---|---|---|---|
|
Rol
|
role | string |
Rol die wordt aangenomen door alle deelnemers in de set (ondertekenaar, fiatteur, enz.) |
|
ID-kaart
|
id | string |
De unieke id van de deelnemersset |
|
Ledengegevens
|
memberInfos | array of MemberInfos |
De informatie over de deelnemers |
|
Bestelling
|
order | integer |
Index die de sequentiële ondertekeningsgroep aangeeft (opgegeven voor hybride routering) |
MemberInfos
| Name | Pad | Type | Description |
|---|---|---|---|
|
ID-kaart
|
id | string |
De unieke id van de deelnemer |
|
E-mailen
|
string |
Het e-mailadres van de deelnemer |
|
|
Bedrijf
|
company | string |
Het bedrijf van de deelnemer |
|
Naam
|
name | string |
De naam van de deelnemer |
|
Privébericht
|
privateMessage | string |
Het privébericht van de deelnemer |
|
Toestand
|
status | string |
De status van de deelnemer |
LibraryDocumentCreationResponseV6
Een JSON-object met een beschrijving van de bibliotheeksjabloon
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bibliotheeksjabloon-id
|
id | string |
De unieke id die kan worden gebruikt om te verwijzen naar de bibliotheeksjabloon |
LibraryDocument
| Name | Pad | Type | Description |
|---|---|---|---|
|
Bibliotheeksjabloon-id
|
id | string |
De unieke id die wordt gebruikt om te verwijzen naar de bibliotheeksjabloon |
|
Verborgen
|
hidden | boolean |
Waar als bibliotheekdocument is verborgen |
|
Sjabloontype(en)
|
templateTypes | array of string |
Een lijst met een of meer bibliotheeksjabloontypen |
|
Gewijzigd op
|
modifiedDate | date |
De dag waarop de bibliotheeksjabloon voor het laatst is gewijzigd |
|
Naam van bibliotheeksjabloon
|
name | string |
De naam van de bibliotheeksjabloon |
|
Modus Voor delen van sjablonen
|
sharingMode | string |
Het bereik van zichtbaarheid van de bibliotheeksjabloon |
|
E-mail maker
|
creatorEmail | string |
E-mailadres van de maker van het bibliotheekdocument. |
|
Groeps-id
|
groupId | string |
De unieke id van de groep waartoe de bibliotheeksjabloon behoort. |
|
Toestand
|
status | string |
Status van het bibliotheekdocument |
LibraryDocuments
Een JSON die het matrixobject van de bibliotheeksjabloon bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
page
|
page | page |
Informatie over paginering om door het antwoord te navigeren |
|
Lijst met bibliotheeksjablonen
|
libraryDocumentList | array of LibraryDocument |
Een lijst met bibliotheeksjabloonitems |
UserWidgetV6
| Name | Pad | Type | Description |
|---|---|---|---|
|
Webformulier-id
|
id | string |
De unieke id van een webformulier |
|
Gewijzigd op
|
modifiedDate | string |
De datum waarop het webformulier het laatst is gewijzigd |
|
Verborgen
|
hidden | boolean |
Waar als de overeenkomst verborgen is voor de gebruiker |
|
Groeps-id
|
groupId | string |
Unieke id van de groep |
|
Naam
|
name | string |
De naam van het webformulier |
|
Toestand
|
status | string |
De status van het webformulier |
|
URL
|
url | string |
De gehoste URL van het webformulier |
|
Javascript
|
javascript | string |
De ingesloten Javascript-code van het webformulier |
userWidgetListV6
Een JSON die het matrixobject van het webformulier van de gebruiker bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
page
|
page | page |
Informatie over paginering om door het antwoord te navigeren |
|
Lijst met webformulieren
|
userWidgetList | array of UserWidgetV6 |
Een matrix met webformulieritems |
UserWorkflowV6
| Name | Pad | Type | Description |
|---|---|---|---|
|
Werkstroom-id
|
id | string |
De unieke id van een werkstroom |
|
Description
|
description | string |
Beschrijving die is opgegeven voor deze werkstroom op het moment dat deze is gemaakt |
|
Aanmaakdatum
|
created | string |
De datum waarop de werkstroom is gemaakt. Indeling is jjjj-MM-dd'T'UU:mm:ssZ |
|
Gewijzigd op
|
modified | string |
De datum waarop de werkstroom is gewijzigd. Indeling is jjjj-MM-dd'T'UU:mm:ssZ |
|
Naam
|
name | string |
De naam van de werkstroom |
|
Weergavenaam
|
displayName | string |
De weergavenaam van de werkstroom |
|
Toestand
|
status | string |
De werkstroomstatus |
|
Scope
|
scope | string |
Het werkstroombereik |
|
Originator-id
|
originatorId | string |
Initiële oorsprong van de werkstroom |
|
Bereik-id
|
scopeId | string |
Id van bereik. Momenteel is deze alleen van toepassing op bereikGROEP en de waarde is groupId. |
userWorkflowListV6
Een JSON die het matrixobject van de gebruikerswerkstroom bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Werkstroomlijst
|
userWorkflowList | array of UserWorkflowV6 |
Een matrix met werkstroomitems |
WorkflowDefaultParamsV6
Een JSON die het standaardparametersobject van de werkstroom bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Standaardwaarde
|
defaultValue | string |
Standaardwaarde van het veld als er geen invoer voor dit veld is opgegeven en dit veld is vereist |
|
Bewerkbaar
|
editable | boolean |
Of het huidige veld kan worden bewerkt. Als het bewerkbare kenmerk voor dit veld onwaar is, mag dit veld niet worden opgegeven in de aanvraag voor het maken van de overeenkomst en wordt de standaardwaarde van dit veld gebruikt bij het maken van een overeenkomst |
|
Verplicht
|
required | boolean |
Of dit veld vereist of optioneel is |
|
Zichtbaar
|
visible | boolean |
Of het huidige veld wel of niet zichtbaar is. Als het zichtbare kenmerk voor dit veld onwaar is, mag dit veld niet zichtbaar zijn in de gebruikersinterface voor het maken van overeenkomsten met behulp van deze werkstroom voor de gebruiker |
CCsListInfoDescriptionV6
Een JSON met gedetailleerde informatie over de werkstroom
| Name | Pad | Type | Description |
|---|---|---|---|
|
Standaardwaarden
|
defaultValues | array of string |
Een matrix met standaard-e-mailberichten die worden gebruikt als er geen invoer wordt opgegeven voor dit lijstelement |
|
Bewerkbaar
|
editable | boolean |
Of het huidige veld kan worden bewerkt. Als het bewerkbare kenmerk voor dit veld onwaar is, mag dit veld niet worden opgegeven in de aanvraag voor het maken van de overeenkomst en wordt de standaardwaarde van dit veld gebruikt bij het maken van een overeenkomst |
|
Etiket
|
label | string |
Een weergavetekst voor de werkstroomgebruiker die kan worden gebruikt voor de huidige CC-lijst |
|
Maximum aantal CC-vermeldingen
|
maxListCount | integer |
Maximum aantal toegestane vermeldingen in de huidige CC-lijst |
|
Minimale CC-vermeldingen
|
minListCount | integer |
Minimum aantal toegestane vermeldingen in de huidige CC-lijst |
|
CC-lijstnaam
|
name | string |
Naam van de huidige CC-lijst |
|
Verplicht
|
required | boolean |
Of dit veld vereist of optioneel is |
|
Zichtbaar
|
visible | boolean |
Of het huidige veld wel of niet zichtbaar is. Als het zichtbare kenmerk voor dit veld onwaar is, mag dit veld niet worden weergegeven op de pagina voor het maken van overeenkomsten met behulp van deze werkstroom |
ExpirationFieldInfoDescriptionV6
Een JSON die informatie over vervaldatum bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Standaardwaarde
|
defaultValue | string |
Standaardwaarde van het veld als er geen invoer voor dit veld is opgegeven en dit veld is vereist |
|
Bewerkbaar
|
editable | boolean |
Of het huidige veld kan worden bewerkt. Als het bewerkbare kenmerk voor dit veld onwaar is, mag dit veld niet worden opgegeven in de aanvraag voor het maken van de overeenkomst en wordt de standaardwaarde van dit veld gebruikt bij het maken van een overeenkomst |
|
Verlooptijd overeenkomst max. dagen
|
maxDays | integer |
Maximum aantal dagen voor het verlopen van de overeenkomst |
|
Verplicht
|
required | boolean |
Of dit veld vereist of optioneel is |
|
Zichtbaar
|
visible | boolean |
Of het huidige veld wel of niet zichtbaar is. Als het zichtbare kenmerk voor dit veld onwaar is, mag dit veld niet worden weergegeven op de pagina voor het maken van overeenkomsten met behulp van deze werkstroom |
FileInfosDescriptionV6
Een JSON die informatie over bestanden bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Etiket
|
label | string |
Label van dit veld weergeven voor externe gebruikers |
|
Naam
|
name | string |
Naam van het element fileInfo |
|
Verplicht
|
required | boolean |
Of dit veld vereist of optioneel is |
|
Werkstroombibliotheekdocumenten
|
workflowLibraryDocumentSelectorList | array of WorkflowLibraryDocumentV6 |
Een lijst met werkstroombibliotheekdocumenten waarvan één werkstroombibliotheekdocument kan worden geselecteerd met dit fileInfo-object |
WorkflowLibraryDocumentV6
Een JSON met informatie over werkstroombibliotheekdocument
| Name | Pad | Type | Description |
|---|---|---|---|
|
Etiket
|
label | string |
Een weergavetekst voor dit formulier voor werkstroomgebruikers |
|
Datum gewijzigd
|
modifiedDate | string |
De datum waarop het bibliotheekdocument voor het laatst is gewijzigd. De notatie is jjjj-MM-dd'T'UU:mm:ssZ. Bijvoorbeeld: 2016-02-25T18:46:19Z vertegenwoordigt UTC-tijd |
|
Deelmodus
|
sharingMode | string |
Hiermee geeft u op wie toegang moet hebben tot dit bibliotheekdocument. GLOBAL sharing is een beperkte bewerking |
|
Sjabloontypen
|
templateTypes | array of |
Een lijst met een of meer bibliotheeksjabloontypen |
|
Document-id van werkstroombibliotheek
|
workflowLibDoc | string |
Een id van het werkstroombibliotheekdocument dat kan worden opgegeven als invoerbestand in de aanvraag voor het maken van een aangepaste werkstroomovereenkomst |
LocaleFieldInfoDescriptionV6
Een JSON met gedetailleerde informatie over de landinstelling van de werkstroom
| Name | Pad | Type | Description |
|---|---|---|---|
|
Beschikbare landinstellingen
|
availableLocales | array of string |
Welke landinstellingen kunnen worden gekozen voor deze werkstroom |
|
Standaardwaarde
|
defaultValue | string |
Standaardwaarde van het veld als er geen invoer voor dit veld is opgegeven en dit veld is vereist |
|
Bewerkbaar
|
editable | boolean |
Of het huidige veld kan worden bewerkt. Als het bewerkbare kenmerk voor dit veld onwaar is, mag dit veld niet worden opgegeven in de aanvraag voor het maken van de overeenkomst en wordt de standaardwaarde van dit veld gebruikt bij het maken van een overeenkomst |
|
Verplicht
|
required | boolean |
Of dit veld vereist of optioneel is |
|
Zichtbaar
|
visible | boolean |
Of het huidige veld wel of niet zichtbaar is. Als het zichtbare kenmerk voor dit veld onwaar is, mag dit veld niet zichtbaar zijn in de gebruikersinterface voor het maken van overeenkomsten met behulp van deze werkstroom voor de gebruiker |
MergeFieldInfoDescriptionV6
Een JSON met gedetailleerde informatie over het samenvoegveld
| Name | Pad | Type | Description |
|---|---|---|---|
|
Standaardwaarde
|
defaultValue | string |
Standaardwaarde van het veld als er geen invoer voor dit veld is opgegeven en dit veld is vereist |
|
Weergavenaam
|
displayName | string |
De weergavetekst die voor dit aangepaste veld kan worden weergegeven |
|
Bewerkbaar
|
editable | boolean |
Of het huidige veld kan worden bewerkt. Als het bewerkbare kenmerk voor dit veld onwaar is, mag dit veld niet worden opgegeven in de aanvraag voor het maken van de overeenkomst en wordt de standaardwaarde van dit veld gebruikt bij het maken van een overeenkomst |
|
Naam van aangepast veld
|
fieldName | string |
Naam van het aangepaste veld in deze werkstroom |
|
Verplicht
|
required | boolean |
Of dit veld vereist of optioneel is |
|
Zichtbaar
|
visible | boolean |
Of het huidige veld zichtbaar moet zijn op de pagina voor het maken van overeenkomsten. Als het zichtbare kenmerk voor dit veld onwaar is, mag dit veld niet worden weergegeven op de pagina voor het maken van de overeenkomst met deze werkstroom |
PasswordFieldInfoDescriptionV6
Een JSON met gedetailleerde informatie over het wachtwoord
| Name | Pad | Type | Description |
|---|---|---|---|
|
Wachtwoord
|
defaultValue | string |
Standaardwaarde van het veld wachtwoordgegevens |
|
Bewerkbaar
|
editable | boolean |
Of het huidige veld kan worden bewerkt. Als het bewerkbare kenmerk voor dit veld onwaar is, mag dit veld niet worden opgegeven in de aanvraag voor het maken van de overeenkomst en wordt de standaardwaarde van dit veld gebruikt bij het maken van een overeenkomst |
|
Etiket
|
label | string |
Label van wachtwoordveld |
|
Naam
|
name | string |
Naam van wachtwoordveld |
|
Verplicht
|
required | boolean |
Of dit veld vereist of optioneel is |
|
Zichtbaar
|
visible | boolean |
Of het veld wachtwoordgegevens zichtbaar is op de pagina voor het maken van overeenkomsten |
RecipientsListInfoDescriptionV6
Een JSON met gedetailleerde informatie over de lijst met geadresseerden
| Name | Pad | Type | Description |
|---|---|---|---|
|
Afzender toestaan
|
allowSender | boolean |
Of afzender is toegestaan als geadresseerde |
|
Afzender toestaan
|
allowfax | boolean |
Of fax wel of niet is toegestaan |
|
Verificatiemethode
|
authenticationMethod | string |
Verificatiemethode voor de huidige adressenlijst om het document te bekijken en te ondertekenen, |
|
Standaardwaarde voor e-mail/fax
|
defaultValue | string |
Een standaard-e-mail of faxnummer |
|
Bewerkbaar
|
editable | boolean |
Of het huidige veld kan worden bewerkt. Als het bewerkbare kenmerk voor dit veld onwaar is, mag dit veld niet worden opgegeven in de aanvraag voor het maken van de overeenkomst en wordt de standaardwaarde van dit veld gebruikt bij het maken van een overeenkomst |
|
Etiket
|
label | string |
Een weergavetekst voor de werkstroomgebruiker die kan worden gebruikt voor de huidige lijst met geadresseerden |
|
Maximum aantal geadresseerden
|
maxListCount | integer |
Maximum aantal toegestane vermeldingen in de huidige lijst met geadresseerden |
|
Minimumaantal geadresseerden
|
minListCount | integer |
Minimum aantal toegestane vermeldingen in de huidige lijst met geadresseerden |
|
Naam van adressenlijst
|
name | string |
Naam van de huidige lijst met geadresseerden |
|
Rol van deelnemer
|
role | string |
De huidige rol van de deelnemer |
|
Zichtbaar
|
visible | boolean |
Of het huidige veld zichtbaar is. Als het zichtbare kenmerk voor dit veld onwaar is, mag dit veld niet worden weergegeven in de gebruikersinterface voor het maken van overeenkomsten met behulp van deze werkstroom voor de gebruiker |
WorkflowDescriptionV6
Een JSON met gedetailleerde informatie over de werkstroom
| Name | Pad | Type | Description |
|---|---|---|---|
|
agreementNameInfo
|
agreementNameInfo | WorkflowDefaultParamsV6 |
Een JSON die het standaardparametersobject van de werkstroom bevat |
|
authoringInfo
|
authoringInfo | WorkflowDefaultParamsV6 |
Een JSON die het standaardparametersobject van de werkstroom bevat |
|
CC-lijstgegevens
|
ccsListInfo | array of CCsListInfoDescriptionV6 |
Informatie over het invoerveld van de CC-lijst in de aanvraag voor het maken van een overeenkomst |
|
Datum voor het maken van werkstromen
|
created | string |
De dag waarop de werkstroom is gemaakt |
|
Beschrijving van werkstroom
|
description | string |
Beschrijving die is opgegeven voor deze werkstroom op het moment dat deze is gemaakt |
|
Weergavenaam van werkstroom
|
displayName | string |
De weergavenaam van de werkstroom |
|
expirationInfo
|
expirationInfo | ExpirationFieldInfoDescriptionV6 |
Een JSON die informatie over vervaldatum bevat |
|
Gegevens van bestanden
|
fileInfos | array of FileInfosDescriptionV6 |
Informatie over het invoerveld voor bestandsgegevens in de aanvraag voor het maken van een overeenkomst |
|
localeInfo
|
localeInfo | LocaleFieldInfoDescriptionV6 |
Een JSON met gedetailleerde informatie over de landinstelling van de werkstroom |
|
Gegevens van samenvoegvelden
|
mergeFieldsInfo | array of MergeFieldInfoDescriptionV6 |
Informatie over het invoerveld voor aangepaste gegevens in de aanvraag voor het maken van een overeenkomst |
|
messageInfo
|
messageInfo | WorkflowDefaultParamsV6 |
Een JSON die het standaardparametersobject van de werkstroom bevat |
|
Gewijzigd op
|
modified | string |
De dag waarop de werkstroom voor het laatst is gewijzigd |
|
Werkstroomnaam
|
name | string |
De naam van de werkstroom |
|
passwordInfo
|
passwordInfo | PasswordFieldInfoDescriptionV6 |
Een JSON met gedetailleerde informatie over het wachtwoord |
|
Informatie over lijst met geadresseerden
|
recipientsListInfo | array of RecipientsListInfoDescriptionV6 |
Informatie over het invoerveld voor recepientsgegevens in de aanvraag voor het maken van een overeenkomst |
|
Werkstroombereik
|
scope | string |
Het werkstroombereik |
|
Werkstroomstatus
|
status | string |
De werkstroomstatus |
|
Id van werkstroom-originator
|
originatorId | string |
Initiële oorsprong van de werkstroom |
|
Werkstroombereik-id
|
scopeId | string |
Id van bereik. Deze is momenteel alleen van toepassing op bereikGROEP en de waarde is groupId |
BooleanSettingInfoV6
| Name | Pad | Type | Description |
|---|---|---|---|
|
Waarde
|
value | boolean |
Waarde van de instelling |
|
Overgenomen
|
inherited | boolean |
Waar als de instelling wordt overgenomen van de groeps- of accountwaarde |
SettingsInfoV6
| Name | Pad | Type | Description |
|---|---|---|---|
|
libaryDocumentCreationVisible
|
libaryDocumentCreationVisible | BooleanSettingInfoV6 | |
|
sendRestrictedToWorkflows
|
sendRestrictedToWorkflows | BooleanSettingInfoV6 | |
|
userCanSend
|
userCanSend | BooleanSettingInfoV6 | |
|
widgetCreationVisible
|
widgetCreationVisible | BooleanSettingInfoV6 |
UserGroupInfoV6
| Name | Pad | Type | Description |
|---|---|---|---|
|
Groeps-id
|
id | string |
Unieke id van de groep |
|
Is groepsbeheerder
|
isGroupAdmin | boolean |
Waar als de gebruiker groepsbeheerder is |
|
Is primaire groep
|
isPrimaryGroup | boolean |
Waar als de groep de primaire groep van de gebruiker is |
|
Toestand
|
status | string |
Status van het groepslidmaatschap |
|
Aanmaakdatum
|
createdDate | date |
Datumgroep is gemaakt |
|
Groepsnaam
|
name | string |
Naam van de groep |
|
settings
|
settings | SettingsInfoV6 |
UserGroupsInfoV6
Een JSON die de lijst met groepen voor een bepaalde gebruiker bevat
| Name | Pad | Type | Description |
|---|---|---|---|
|
Lijst met gebruikersgroepen
|
groupInfoList | array of UserGroupInfoV6 |
Een matrix met gegevensitems voor gebruikersgroepen |
binair
Dit is het basisgegevenstype 'binair'.
Voorwerp
Dit is het type 'object'.
bestand
Dit is het basisgegevenstype 'bestand'.