Annature (onafhankelijke uitgever) (preview)
Annature is de toonaangevende eSigning-oplossing in Australisch eigendom met een geïntegreerde digitale handtekeningprovider. Met deze connector kunnen bedrijven enveloppen maken en annature-werkstroom voor documentondertekening integreren met behulp van Annature API (v1).
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Dr Adrian Colquhoun (Strategik) |
| URL | https://www.linkedin.com/in/adriancolquhoun/ |
| E-mailen | adrian@strategik.com.au |
| Connectormetagegevens | |
|---|---|
| Uitgever | Dr Adrian Colquhoun (Strategik) |
| Webpagina | https://annature.com.au |
| Privacybeleid | https://www.annature.com.au/privacy-policy |
| Categorieën | Productiviteit |
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| standaard | Parameters voor het maken van verbinding. | Alle regio's | Niet deelbaar |
Verstek
Van toepassing: Alle regio's
Parameters voor het maken van verbinding.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Annature-id | touw | Annature-id | Klopt |
| Annature Key | beveiligde string | Annature Key | Klopt |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Accounts ophalen |
Alle accounts weergeven |
| Alle bijlagen voor een veld ophalen |
Veldbijlagen ophalen |
| Documenten ophalen |
Alle documenten voor een envelop weergeven |
| Envelop maken |
Envelop maken |
| Envelop maken op sjabloon |
Sjabloon gebruiken |
| Envelop ophalen |
Envelop ophalen |
| Envelop verwijderen |
Envelop verwijderen |
| Envelop verzenden |
Envelop verzenden |
| Enveloppen ophalen |
Alle enveloppen weergeven |
| Geadresseerde ophalen |
Eén geadresseerde ophalen die is gemaakt voor een envelop met behulp van de id-eigenschap die is geretourneerd in de hoofdtekst van het antwoord voor een envelop maken |
| Leegte envelop |
Envelop verzenden |
| Organisatie ophalen |
Organisatie ophalen |
| Sjablonen ophalen |
Alle sjablonen weergeven |
| Sjabloon ophalen |
Sjabloon ophalen |
| Veld ophalen |
Veld ophalen |
| Velden ophalen |
Alle velden weergeven |
Accounts ophalen
Alle accounts weergeven
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
identiteitskaart
|
id | string | |
|
Naam
|
name | string |
Naam |
|
E-mailen
|
string |
E-mailen |
|
|
nummer
|
number | string | |
|
timezone
|
timezone | string | |
|
rol
|
role | string | |
|
active
|
active | boolean | |
|
group_id
|
group_id | string | |
|
geschapen
|
created | string | |
|
Geverifieerd
|
verified | string |
Alle bijlagen voor een veld ophalen
Veldbijlagen ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Envelop-id
|
envelope_id | True | string |
Envelop-id |
|
Veld-id
|
id | True | string |
Veld-id |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
identiteitskaart
|
id | string | |
|
Origineel
|
original | string | |
|
naam
|
name | string | |
|
type
|
type | string | |
|
size
|
size | integer | |
|
geschapen
|
created | string |
Documenten ophalen
Alle documenten voor een envelop weergeven
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Envelop-id
|
envelope_id | True | string |
Envelop-id |
|
Duur van eindpunt
|
endpoint_duration | integer |
Hiermee stelt u het aantal minuten in waarvoor het oorspronkelijke eindpunt en de hoofdeindpunten toegankelijk zijn. Getal kan variëren tussen 1 en 10080, waarbij de standaardwaarde 60 is |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
Identiteitsbewijs
|
id | string |
Identiteitsbewijs |
|
Naam
|
name | string |
Naam |
|
pages
|
pages | integer | |
|
Origineel
|
original | string |
Origineel |
|
Meester
|
master | string |
Meester |
|
Gecreëerd
|
created | string |
Gecreëerd |
Envelop maken
Envelop maken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam
|
name | True | string |
De naam van de envelop, weergegeven in het onderwerp van e-mailberichten die naar geadresseerden worden verzonden en bij het weergeven van de envelop |
|
Message
|
message | string |
Message |
|
|
Shared
|
shared | boolean |
Shared |
|
|
Conceptversie
|
draft | boolean |
Conceptversie |
|
|
Account-ID
|
account_id | True | string |
Account-ID |
|
Groeps-id
|
group_id | string |
Groeps-id |
|
|
Groeps-id
|
id | string |
Groeps-id |
|
|
Naam
|
name | string |
Naam |
|
|
Typologie
|
type | string |
Typologie |
|
|
Bestandsinhoud
|
base | byte |
Bestandsinhoud |
|
|
Naam
|
name | string |
Naam |
|
|
E-mail-id
|
string |
E-mail-id |
||
|
Mobiel
|
mobile | string |
Mobiel |
|
|
Type geadresseerde
|
type | string |
Het type geadresseerde, wordt standaard ingesteld op ondertekenaar wanneer deze niet is opgegeven |
|
|
Message
|
message | string |
Message |
|
|
wachtwoord
|
password | string | ||
|
Gedempt?
|
muted | boolean |
Hierdoor wordt voorkomen dat Annature correspondentie naar de geadresseerde verzendt |
|
|
Ondertekeningsorder
|
order | integer |
Ondertekeningsorder |
|
|
Sessie voltooid
|
session_completed | string |
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid |
|
|
Sessie geweigerd
|
session_declined | string |
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen |
|
|
identiteitskaart
|
id | string | ||
|
recipient_id
|
recipient_id | string | ||
|
type
|
type | string |
Het veldtype |
|
|
page
|
page | integer | ||
|
x_coordinate
|
x_coordinate | integer | ||
|
y_coordinate
|
y_coordinate | integer | ||
|
Verplicht
|
required | boolean |
Verplicht |
|
|
Alleen lezen
|
read_only | boolean |
Alleen lezen |
|
|
Collaborative
|
collaborative | boolean |
Collaborative |
|
|
width
|
width | integer | ||
|
font_size
|
font_size | integer | ||
|
font_type
|
font_type | string |
Mogelijke waarden zijn koerier en helvetica |
|
|
geschapen
|
created | string |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
Identiteitsbewijs |
|
naam
|
name | string |
Naam |
|
message
|
message | string |
Message |
|
status
|
status | string |
Toestand |
|
Shared
|
shared | boolean |
Shared |
|
Gemaakt op
|
created | string |
Gemaakt op |
|
Verzonden op
|
sent | string |
Verzonden op |
|
ongeldig
|
voided | ||
|
Daalde
|
declined | ||
|
voltooid
|
completed | ||
|
Account-ID
|
account_id | string |
Account_id |
|
Groeps-id
|
group_id | string |
Groeps-id |
|
recipients
|
recipients | array of object | |
|
identiteitskaart
|
recipients.id | string | |
|
naam
|
recipients.name | string | |
|
e-mailadres
|
recipients.email | string | |
|
mobile
|
recipients.mobile | string | |
|
type
|
recipients.type | string | |
|
status
|
recipients.status | string | |
|
message
|
recipients.message | string | |
|
Wachtwoord
|
recipients.password |
Wachtwoord |
|
|
Gedempt
|
recipients.muted | boolean |
Gedempt |
|
order
|
recipients.order | integer | |
|
declined_reason
|
recipients.declined_reason | ||
|
geschapen
|
recipients.created | string | |
|
gezonden
|
recipients.sent | string | |
|
Daalde
|
recipients.declined | ||
|
voltooid
|
recipients.completed | ||
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Envelop maken op sjabloon
Sjabloon gebruiken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sjabloon-ID
|
id | True | string |
Sjabloon-ID |
|
Naam
|
name | string |
De naam van de envelop, weergegeven in het onderwerp van e-mailberichten die naar geadresseerden worden verzonden en bij het weergeven van de envelop |
|
|
Conceptversie
|
draft | boolean |
Conceptversie |
|
|
Message
|
message | string |
Message |
|
|
Shared
|
shared | boolean |
Shared |
|
|
Account-ID
|
account_id | True | string |
Account-ID |
|
Groeps-id
|
group_id | string |
Groeps-id |
|
|
Groeps-id
|
id | string |
Groeps-id |
|
|
Naam
|
name | string |
Naam |
|
|
Groeps-id
|
type | string |
Groeps-id |
|
|
Bestandsinhoud
|
base | byte |
Bestandsinhoud |
|
|
Rol-id
|
role_id | string |
Rol-id |
|
|
Naam
|
name | string |
Naam |
|
|
E-mail-id
|
string |
E-mail-id |
||
|
Mobiel
|
mobile | string |
Mobiel |
|
|
SMS-verificatie
|
sms_auth | string |
SMS-verificatie |
|
|
Type geadresseerde
|
type | string |
Het type geadresseerde, wordt standaard ingesteld op ondertekenaar wanneer deze niet is opgegeven |
|
|
Message
|
message | string |
Message |
|
|
wachtwoord
|
password | string | ||
|
Gedempt?
|
muted | boolean |
Hierdoor wordt voorkomen dat Annature correspondentie naar de geadresseerde verzendt |
|
|
Ondertekeningsorder
|
order | integer |
Ondertekeningsorder |
|
|
Veld-id (van sjabloon)
|
id | True | string |
Id van het sjabloonveld |
|
Waarde
|
value | True | string |
Waarde voor dit veld |
|
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid
|
session_completed | string |
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid |
|
|
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen
|
session_declined | string |
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
Identiteitsbewijs |
|
naam
|
name | string |
Naam |
|
message
|
message | string |
Message |
|
gedeeld
|
shared | boolean |
Wordt gedeeld? |
|
draft
|
draft | boolean | |
|
account_id
|
account_id | string |
Account-ID |
|
group_id
|
group_id | string |
Groeps-id |
|
Documenten
|
documents | array of object | |
|
Identiteitsbewijs
|
documents.id | string |
Identiteitsbewijs |
|
Naam
|
documents.name | string |
Naam |
|
pages
|
documents.pages | integer | |
|
Origineel
|
documents.original | string |
Origineel |
|
Meester
|
documents.master | string |
Meester |
|
Gecreëerd
|
documents.created | string |
Gecreëerd |
|
recipients
|
recipients | array of object | |
|
role_id
|
recipients.role_id | string | |
|
naam
|
recipients.name | string | |
|
e-mailadres
|
recipients.email | string | |
|
mobile
|
recipients.mobile | string | |
|
message
|
recipients.message | string | |
|
wachtwoord
|
recipients.password | boolean | |
|
Gedempt
|
recipients.muted | boolean | |
|
session_completed
|
recipients.redirects.session_completed | string | |
|
session_declined
|
recipients.redirects.session_declined | string |
Envelop ophalen
Envelop ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Envelop-id
|
id | True | string |
Envelop-id |
|
Duur van eindpunt
|
endpoint_duration | integer |
Hiermee stelt u het aantal minuten in waarvoor het oorspronkelijke eindpunt en de hoofdeindpunten toegankelijk zijn. Getal kan variëren tussen 1 en 10080, waarbij de standaardwaarde 60 is |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
Identiteitsbewijs |
|
naam
|
name | string |
Naam |
|
message
|
message | string |
Message |
|
status
|
status | string |
Toestand |
|
gedeeld
|
shared | boolean |
Shared |
|
geschapen
|
created | string |
Gecreëerd |
|
gezonden
|
sent | string |
Gezonden |
|
ongeldig
|
voided | string |
Ongeldig |
|
Daalde
|
declined | string |
Geweigerd |
|
voltooid
|
completed | string |
Volbracht |
|
master
|
master | string |
Meester |
|
Gecombineerd
|
combined | string |
Gecombineerd |
|
certificate
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
Account-ID |
|
group_id
|
group_id | string |
Groeps-id |
|
Ontvangers
|
recipients | array of object | |
|
Naam
|
recipients.name | string |
Naam |
|
E-mail-id
|
recipients.email | string |
E-mail-id |
|
Mobiel
|
recipients.mobile | string |
Mobiel |
|
Type geadresseerde
|
recipients.type | string |
Het type geadresseerde, wordt standaard ingesteld op ondertekenaar wanneer deze niet is opgegeven |
|
Message
|
recipients.message | string |
Message |
|
Wachtwoord
|
recipients.password | ||
|
Gedempt?
|
recipients.muted | boolean |
Hierdoor wordt voorkomen dat Annature correspondentie naar de geadresseerde verzendt |
|
Ondertekeningsorder
|
recipients.order | integer |
Ondertekeningsorder |
|
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid
|
recipients.redirects.session_completed | string |
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid |
|
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen
|
recipients.redirects.session_declined | string |
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen |
|
velden
|
recipients.fields | array of object | |
|
identiteitskaart
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
type
|
recipients.fields.type | string | |
|
page
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
Verplicht
|
recipients.fields.required | boolean |
Verplicht |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
Collaborative
|
recipients.fields.collaborative | boolean |
Collaborative |
|
width
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
geschapen
|
recipients.fields.created | string |
Envelop verwijderen
Envelop verwijderen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Envelop-id
|
id | True | string |
Envelop-id |
Envelop verzenden
Envelop verzenden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Envelop-id
|
id | True | string |
Envelop-id |
Enveloppen ophalen
Alle enveloppen weergeven
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Envelopnaam
|
name | string |
Een exact-matchfilter voor de lijst op basis van de naameigenschap van de envelop |
|
|
Envelopstatus
|
status | string |
Een exact-matchfilter voor de lijst op basis van de status van de envelop |
|
|
Naam van geadresseerde
|
recipient | string |
Een exacte overeenkomstfilter voor de lijst op basis van de naam of e-maileigenschap van een geadresseerde |
|
|
Gemaakt voor
|
created_before | date |
Retourneert resultaten waarbij de gemaakte datum vóór de opgegeven waarde valt |
|
|
Gemaakt na
|
created_after | date |
Retourneert resultaten waarbij de gemaakte datum zich na de opgegeven waarde bevindt |
|
|
Voltooid vóór
|
completed_before | date |
Retourneert resultaten waarbij de voltooide datum vóór de opgegeven waarde valt |
|
|
Voltooid na
|
completed_after | date |
Retourneert resultaten waarbij de voltooide datum zich na de opgegeven waarde bevindt |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
identiteitskaart
|
id | string |
Identiteitsbewijs |
|
naam
|
name | string |
Naam |
|
message
|
message | string |
Message |
|
status
|
status | string |
Toestand |
|
gedeeld
|
shared | boolean |
Shared |
|
geschapen
|
created | string |
Gecreëerd |
|
gezonden
|
sent | string |
Gezonden |
|
ongeldig
|
voided | string |
Ongeldig |
|
Daalde
|
declined | string |
Geweigerd |
|
voltooid
|
completed | string |
Volbracht |
|
Gecombineerd
|
combined | string |
Gecombineerd |
|
master
|
master | string |
Meester |
|
certificate
|
certificate | string |
Certificate |
|
account_id
|
account_id | string |
Account-ID |
|
group_id
|
group_id | string |
Groeps-id |
|
Ontvangers
|
recipients | array of object | |
|
Naam
|
recipients.name | string |
Naam |
|
E-mail-id
|
recipients.email | string |
E-mail-id |
|
Mobiel
|
recipients.mobile | string |
Mobiel |
|
Type geadresseerde
|
recipients.type | string |
Het type geadresseerde, wordt standaard ingesteld op ondertekenaar wanneer deze niet is opgegeven |
|
Message
|
recipients.message | string |
Message |
|
Wachtwoord
|
recipients.password | ||
|
Gedempt?
|
recipients.muted | boolean |
Hierdoor wordt voorkomen dat Annature correspondentie naar de geadresseerde verzendt |
|
Ondertekeningsorder
|
recipients.order | integer |
Ondertekeningsorder |
|
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid
|
recipients.redirects.session_completed | string |
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid |
|
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen
|
recipients.redirects.session_declined | string |
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen |
|
velden
|
recipients.fields | array of object | |
|
identiteitskaart
|
recipients.fields.id | string | |
|
recipient_id
|
recipients.fields.recipient_id | string | |
|
type
|
recipients.fields.type | string | |
|
page
|
recipients.fields.page | integer | |
|
x_coordinate
|
recipients.fields.x_coordinate | integer | |
|
y_coordinate
|
recipients.fields.y_coordinate | integer | |
|
Verplicht
|
recipients.fields.required | boolean |
Verplicht |
|
Read_only
|
recipients.fields.read_only | boolean |
Read_only |
|
Collaborative
|
recipients.fields.collaborative | boolean |
Collaborative |
|
width
|
recipients.fields.width | integer | |
|
font_size
|
recipients.fields.font_size | integer | |
|
font_type
|
recipients.fields.font_type | string | |
|
geschapen
|
recipients.fields.created | string |
Geadresseerde ophalen
Eén geadresseerde ophalen die is gemaakt voor een envelop met behulp van de id-eigenschap die is geretourneerd in de hoofdtekst van het antwoord voor een envelop maken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Recipient
|
id | True | string |
Geadresseerde-id |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
Identiteitsbewijs
|
id | string |
Identiteitsbewijs |
|
naam
|
name | string |
Naam |
|
e-mailadres
|
string |
E-mailen |
|
|
mobile
|
mobile | string |
Mobiel |
|
type
|
type | string |
Typologie |
|
status
|
status | string |
Toestand |
|
message
|
message | string |
Message |
|
Wachtwoord
|
password |
Wachtwoord |
|
|
Gedempt
|
muted | boolean |
Gedempt |
|
order
|
order | integer | |
|
declined_reason
|
declined_reason | string |
Declined_reason |
|
geschapen
|
created | string |
Gecreëerd |
|
gezonden
|
sent | string |
Gezonden |
|
Daalde
|
declined | string |
Geweigerd |
|
voltooid
|
completed | string |
Volbracht |
|
session_completed
|
redirects.session_completed | string |
Session_completed |
|
session_declined
|
redirects.session_declined | string |
Session_declined |
Leegte envelop
Envelop verzenden
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Envelop-id
|
id | True | string |
Envelop-id |
Organisatie ophalen
Organisatie ophalen
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
Identiteitsbewijs |
|
naam
|
name | string |
Naam |
|
zaak
|
business | string |
Bedrijf |
|
e-mailadres
|
string |
E-mailen |
|
|
nummer
|
number | string |
Number |
|
address
|
address | string |
Adres |
|
webpagina
|
website | string |
Webpagina |
|
logo
|
logo | string |
Logo |
|
kleur
|
colour | string |
Kleur |
|
geschapen
|
created | string |
Gecreëerd |
Sjablonen ophalen
Alle sjablonen weergeven
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Naam
|
name | string |
Een exact-matchfilter voor de lijst op basis van de sjablonen |
|
|
Gemaakt voor
|
created_before | date |
Retourneert resultaten waarbij de gemaakte datum vóór de opgegeven waarde valt |
|
|
Gemaakt na
|
created_after | date |
Retourneert resultaten waarbij de gemaakte datum zich na de opgegeven waarde bevindt |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
identiteitskaart
|
id | string | |
|
naam
|
name | string | |
|
Shared
|
shared | boolean |
Shared |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
geschapen
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
Documenten
|
documents | array of object | |
|
Identiteitsbewijs
|
documents.id | string |
Identiteitsbewijs |
|
Naam
|
documents.name | string |
Naam |
|
pages
|
documents.pages | integer | |
|
Origineel
|
documents.original | string |
Origineel |
|
Meester
|
documents.master | string |
Meester |
|
Gecreëerd
|
documents.created | string |
Gecreëerd |
|
roles
|
roles | array of object | |
|
Identiteitsbewijs
|
roles.id | string |
Identiteitsbewijs |
|
Naam
|
roles.name | string |
Naam |
|
Naam van geadresseerde
|
roles.recipient_name | string |
Naam van geadresseerde |
|
E-mailadres van geadresseerde
|
roles.recipient_email | string |
E-mailadres van geadresseerde |
|
Geadresseerde Mobile
|
roles.recipient_mobile | string |
Geadresseerde Mobile |
|
Type geadresseerde
|
roles.recipient_type | string |
Het type geadresseerde, wordt standaard ingesteld op ondertekenaar wanneer deze niet is opgegeven |
|
Wachtwoord
|
roles.recipient_password | string |
Wachtwoord |
|
Ondertekeningsorder
|
roles.order | integer |
Ondertekeningsorder |
|
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid
|
roles.recipient_redirects.session_completed | string |
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid |
|
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen
|
roles.recipient_redirects.session_declined | string |
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen |
Sjabloon ophalen
Sjabloon ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Sjabloon-ID
|
id | True | string |
Sjabloon-ID |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string | |
|
naam
|
name | string | |
|
Shared
|
shared | boolean |
Shared |
|
envelope_name
|
envelope_name | string | |
|
envelope_message
|
envelope_message | string | |
|
Envelope_shared
|
envelope_shared | boolean |
Envelope_shared |
|
geschapen
|
created | string | |
|
account_id
|
account_id | string | |
|
group_id
|
group_id | string | |
|
Documenten
|
documents | array of object | |
|
Identiteitsbewijs
|
documents.id | string |
Identiteitsbewijs |
|
Naam
|
documents.name | string |
Naam |
|
pages
|
documents.pages | integer | |
|
Origineel
|
documents.original | string |
Origineel |
|
Meester
|
documents.master | string |
Meester |
|
Gecreëerd
|
documents.created | string |
Gecreëerd |
|
roles
|
roles | array of object | |
|
Identiteitsbewijs
|
roles.id | string |
Identiteitsbewijs |
|
Naam
|
roles.name | string |
Naam |
|
Naam van geadresseerde
|
roles.recipient_name | string |
Naam van geadresseerde |
|
E-mailadres van geadresseerde
|
roles.recipient_email | string |
E-mailadres van geadresseerde |
|
Geadresseerde Mobile
|
roles.recipient_mobile | string |
Geadresseerde Mobile |
|
Type geadresseerde
|
roles.recipient_type | string |
Het type geadresseerde, wordt standaard ingesteld op ondertekenaar wanneer deze niet is opgegeven |
|
Wachtwoord
|
roles.recipient_password | string |
Wachtwoord |
|
Ondertekeningsorder
|
roles.order | integer |
Ondertekeningsorder |
|
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid
|
roles.recipient_redirects.session_completed | string |
Doeleindpunt nadat de geadresseerde de envelop heeft voltooid |
|
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen
|
roles.recipient_redirects.session_declined | string |
Doeleindpunt nadat de geadresseerde de envelop heeft geweigerd te ondertekenen |
Veld ophalen
Veld ophalen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Envelop-id
|
envelope_id | True | string |
Envelop-id |
|
Veld-id
|
id | True | string |
Veld-id |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
Identiteitsbewijs |
|
recipient_id
|
recipient_id | string |
Geadresseerde-id |
|
type
|
type | string |
Typologie |
|
page
|
page | integer | |
|
anchor
|
anchor | string |
Anchor |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
Verplicht
|
required | boolean |
Verplicht |
|
Read_only
|
read_only | boolean |
Read_only |
|
Collaborative
|
collaborative | boolean |
Hiermee kunnen andere geadresseerden op de envelop de waarden wijzigen |
|
waarde
|
value | string |
De waarde van het veld |
|
Gecontroleerd
|
checked | boolean |
Gecontroleerd |
|
height
|
height | integer | |
|
width
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string |
Mogelijke waarden zijn koerier en helvetica |
|
date_format
|
date_format | string |
Datumnotatie |
|
geschapen
|
created | string |
Gecreëerd |
Velden ophalen
Alle velden weergeven
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Envelop-id
|
envelope_id | True | string |
Envelop-id |
Retouren
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
identiteitskaart
|
id | string | |
|
recipient_id
|
recipient_id | string | |
|
type
|
type | string | |
|
page
|
page | integer | |
|
anchor
|
anchor | string | |
|
x_coordinate
|
x_coordinate | integer | |
|
y_coordinate
|
y_coordinate | integer | |
|
Verplicht
|
required | boolean |
Verplicht |
|
Read_only
|
read_only | boolean |
Read_only |
|
Collaborative
|
collaborative | boolean |
Collaborative |
|
waarde
|
value | string | |
|
Gecontroleerd
|
checked | boolean |
Gecontroleerd |
|
height
|
height | integer | |
|
width
|
width | integer | |
|
options
|
options | ||
|
font_size
|
font_size | integer | |
|
font_type
|
font_type | string | |
|
date_format
|
date_format | string | |
|
geschapen
|
created | string |
Triggers
| Gebeurtenistrigger - Envelop en ontvanger |
Triggers wanneer een gebeurtenis optreedt wanneer enveloppen zijn voltooid of geadresseerdeweergaven |
Gebeurtenistrigger - Envelop en ontvanger
Triggers wanneer een gebeurtenis optreedt wanneer enveloppen zijn voltooid of geadresseerdeweergaven
Retouren
- Body
- WebhookEventContent
Definities
WebhookEventContent
| Name | Pad | Type | Description |
|---|---|---|---|
|
gebeurtenis
|
event | string | |
|
envelope_id
|
envelope_id | string | |
|
ongeldig
|
voided | string | |
|
voltooid
|
completed | string | |
|
master
|
master | string | |
|
certificate
|
certificate | string | |
|
gezonden
|
sent | string | |
|
method
|
method | string | |
|
recipient_id
|
recipient_id | string | |
|
Bekeken
|
viewed | string | |
|
Daalde
|
declined | string | |
|
declined_reason
|
declined_reason | string | |
|
mislukt
|
failed | string | |
|
Diagnose
|
diagnosis | string |