Connective eSignatures

Status: Preview

Tier: Premium

Version: 0.1

Name

Summary

CreateInstantPackage ([Optional]CreateInstantPackageParameterBody body)

Create Instant Package

PackageList ([Optional]string ContinuationToken, [Optional]integer MaxQuantity, [Optional]string SortField, [Optional]string SortOrder, [Optional]string CreatedBeforeDate, [Optional]string Status, [Optional]string createdAfterDate)

Package List

CreatePackage (string Content-Type, [Optional]CreatePackageParameterBody body)

Create Package

AddDocumentToPackage (string PackageId, [Optional]AddDocumentToPackageParameterBody body)

Add document to package

GetSigningLocations (string Id)

Get Signing Locations

GetPackageStatus (string Id)

Get Package Status

SetPackageStatus (string Id, SetPackageStatusParameterBody body)

Set Package Status

SkipSigners (string PackageId)

Skip Signers

DownloadPackage (string id)

Download Package

ExpiryTimeStamp (string id, ExpiryTimeStampParameterBody body)

Expiry Time Stamp

SendPackageReminders (string PackageId)

Send Package Reminders

DeletePackage (string id)

Delete Package

SetProcessInformation (string id, [Optional]SetProcessInformationParameterBody body)

Set Process Information

PackageAuditProof (string packageId)

Package Audit Proof

PackageAuditProofDoc (string packageId, string documentId)

Package Audit Proof with document ID

PackageCorrelationAuditProof (string correlationId)

Package Correlation Audit Proof Download

DocumentCorrelationAuditProof (string correlationId)

Document Correlation Audit Proof Download

ProofExternalSource (string packageId, [Optional]ProofExternalSourceParameterBody body)

Add Proof from External Source

Name

Summary

Name

Summary

AddDocumentToPackageParameterBody

AddDocumentToPackageResponse

Content

CreateInstantPackageParameterBody

CreateInstantPackageResponse

CreatePackageParameterBody

CreatePackageResponse

ErrorHandlingResponse

ExpiryTimeStampParameterBody

GetSigningLocationsResponse

Package

PackageDocument

PackageListResponse

PackageStatus

ProofExternalSourceParameterBody

Request.Actor

SetPackageStatusParameterBody

SetProcessInformationParameterBody

SigningField

SigningType

Stakeholder

Name

Type

Summary

Required

Related Action

body

CreateInstantPackageParameterBody

False

Name

Type

Summary

Required

Related Action

ContinuationToken

string

(The continuation token / guid to know what page to return.)

The continuation token / guid to know what page to return. MUST BE EMPTY or the token returned from a PREVIOUS call.

False

MaxQuantity

integer(int32)

(Gets or sets the maximum quantity.)

Gets or sets the maximum quantity.

False

SortField

string

(Gets or sets the sort field.)

Gets or sets the sort field.

False

SortOrder

string

(Gets or sets the sort field.)

Gets or sets the sort field.

False

CreatedBeforeDate

string

(Gets or sets the created before date.)

Gets or sets the created before date.

False

Status

string

(Gets or sets the status.)

Gets or sets the status.

False

createdAfterDate

string

(Gets or sets the created after date.)

Gets or sets the created after date.

False

Name

Type

Summary

Required

Related Action

Content-Type

string

(Content-Type)

Content-Type

True

body

CreatePackageParameterBody

False

Name

Type

Summary

Required

Related Action

PackageId

string

(The package identifier.)

Package Unique Id

True

body

AddDocumentToPackageParameterBody

False

Name

Type

Summary

Required

Related Action

Id

string

(Id of the signing field)

Id of the signing field

True

Name

Type

Summary

Required

Related Action

Id

string

(Unique id for the signing package)

Unique id for the signing package

True

Name

Type

Summary

Required

Related Action

Id

string

(Unique id for the signing package)

Unique id for the signing package

True

body

SetPackageStatusParameterBody

True

Name

Type

Summary

Required

Related Action

PackageId

string

(Unique id of the Package)

Unique id of the Package

True

Name

Type

Summary

Required

Related Action

id

string

(Unique ID of the Package)

Unique ID of the Package

True

Name

Type

Summary

Required

Related Action

id

string

(Unique ID of the Package)

Unique ID of the Package

True

body

ExpiryTimeStampParameterBody

True

Name

Type

Summary

Required

Related Action

PackageId

string

(Unique ID of the Package)

Unique ID of the Package

True

Name

Type

Summary

Required

Related Action

id

string

(Unique ID of the Package)

Unique ID of the Package

True

Name

Type

Summary

Required

Related Action

id

string

(Unique ID of the Package)

Unique ID of the Package

True

body

SetProcessInformationParameterBody

False

Name

Type

Summary

Required

Related Action

packageId

string

(Unique ID of the Package)

Unique ID of the Package

True

Name

Type

Summary

Required

Related Action

packageId

string

(Unique ID of the Package)

Unique ID of the Package

True

documentId

string

(Unique ID of the Document)

Unique ID of the Document

True

Name

Type

Summary

Required

Related Action

correlationId

string

(The correlation identifier.)

The correlation identifier.

True

Name

Type

Summary

Required

Related Action

correlationId

string

(The correlation identifier.)

The correlation identifier.

True

Name

Type

Summary

Required

Related Action

packageId

string

(The unique ID of the Package)

The unique ID of the Package

True

body

ProofExternalSourceParameterBody

False

Name

Type

Summary

Document

string

Attached document in base64 encoded format.

DocumentLanguage

string

Language to use in signature texts.

DocumentName

string

Name of the document to be shown in the eSignatures Portal.

SigningFields

array of (SigningField)

One or more signing locations in the document.

CorrelationId

string

Id that indicates which documents within this package are correlated with documents that have been signed in the past in other packages.

DocumentType

string

Type of document that will be signed.

ExternalDocumentReference

string

Reference given by the calling application.

PdfErrorHandling

array of (ErrorHandlingResponse)

Representation

string

Attached representation document in base64 format. This must be PDF data.

RepresentationType

string

Type of the representation document.

TargetType

string

The TargetType defines if an extra conversion to PDF/A needs to be done before signing.

Name

Type

Summary

DocumentId

string

Unique id for the document

CreationTimestamp

string

Date and time the flow was created. Format: YYYY-MM-DDThh:mm:ss+zz:zz

Locations

array of (LocationsItem)

Represents a possible location for a signature

Name

Type

Summary

Id

string

Unique id for this location

Label

string

Detected or specified label

PageNumber

boolean

The page on which the location was found.

Name

Type

Summary

uploads

array of (UploadsItem)

Name

Type

Summary

upload

array of (UploadItem)

indexes

array of (IndexesItem)

packageCorrelationId

string

packageId

string

Name

Type

Summary

start

string(date-time)

end

string(date-time)

signatures

array of (SignaturesItem)

Name

Type

Summary

proofs

array of (ProofsItem)

locationId

string

Name

Type

Summary

proof

Proof

Name

Type

Summary

name

string

type

string

index

boolean

ipAddress

string

Name

Type

Summary

index

Index

Name

Type

Summary

identifier

boolean

content

string

Name

Type

Summary

Document

string(byte)

Attached document in base64 encoded format. Required unless Multipart format is used.

DocumentLanguage

string

Language to use in signature texts. Currently supported: en, nl, de, fr, es.  Values: [en, nl, de, fr, es]

DocumentName

string

Name of the document and package to be shown in the eSignatures Portal.

ExternalPackageData

string

ExternalPackageData

Initiator

string

Email address of a registered user

Stakeholders

array of (Stakeholder)

Information about the people who are involved in the process.

CallBackUrl

string

REST API URL that will be called each time an action has been completed for this package

CorrelationId

string

Id that indicates which packages or documents are correlated

DocumentGroupCode

string

The ‘Code’ which identifies a document group in which the document should be shown

ThemeCode

string

Theme that must be applied to the package

DownloadUnsignedFiles

boolean

This parameter determines whether packages can be downloaded from the WYSIWYS before signing

ExpiryTimestamp

string

Reference given by the calling application. This parameter will not be used by the eSignatures Portal

ExternalDocumentReference

string

Reference given by the calling application, this parameter will not be used by the eSignatures Portal

ExternalPackageReference

string

Reference given by the calling application, this parameter will not be used by the eSignatures Portal

F2FRedirectUrl

string

Url to which the end user is redirected after all fields have been signed with ‘face to face’ signing, or when all fields have been rejected.

NotificationCallBackUrl

string

REST API URL that will be called when an end user requests to be notified. If no URL is supplied no call back is performed

PdfErrorHandling

string

How to deal with PDFs containing minor flaws

Representation

string

Attached representation document in base64 format

RepresentationType

string

Type of the representation document, must be present when Representation is filled. Only “application/pdf” is supported.

SigningTemplateCode

string

The template configured in the portal will provide all necessary information

TargetType

string

The TargetType defines if an extra conversion to PDF/A needs to be done before signing

Name

Type

Summary

PackageId

string

Unique identifier of the package.

CreationTimestamp

string

Date and time when the package was created according to the server.

Name

Type

Summary

Initiator

string

Email address of a registered user.

PackageName

string

Package name, seen in the eSignatures Portal and when downloading as zip file.

CallBackUrl

string

REST API URL that will be called each time an action has been completed for this package.

CorrelationId

string

Id that indicates which packages are correlated.

DocumentGroupCode

string

The ‘Code’ which identifies a document group in which the package should be shown.

ThemeCode

string

Theme that must be applied to the package

DownloadUnsignedFiles

boolean

This parameter determines whether packages can be downloaded from the WYSIWYS before signing.

ExpiryTimestamp

string

The date and time when this package expires and can no longer be signed.

ExternalPackageReference

string

Reference given by the calling application. This parameter will not be used by the eSignatures Portal.

ExternalPackageData

string

This field is reserved for future use. It can be used for customer-specific extensions to integrate with third-party services, such as Debit Card signing.

F2FRedirectUrl

string

URL to which the end user is redirected after all fields have been signed with 'face to face' signing, or when all fields have been rejected.

NotificationCallBackUrl

string

REST API URL that will be called when an end user requests to be notified.

Name

Type

Summary

PackageId

string

Unique identifier of the package.

CreationTimestamp

string

Date and time when the package was created according to the server.

Name

Type

Summary

ErrorCode

string

Error code with variable information.

Message

string

Error message detail text, not localized

Name

Type

Summary

ExpiryTimestamp

string(date-time)

Name

Type

Summary

Documents

array of (DocumentsItem)

Name

Type

Summary

DocumentId

string

Unique id for the document

ExternalDocumentReference

string

External reference for identification. Make sure to use a unique value.

Locations

array of (LocationsItem)

Represents a possible location for a signature

Name

Type

Summary

Id

string

Unique id for this location.

Label

string

Value you entered as Request parameter.

PageNumber

integer(int32)

Number of the page on which the signature can be found.

Name

Type

Summary

Id

string

PackageStatus

string

ExternalPackageReference

string

Name

Type

Summary

DocumentId

string

Unique id of the document

ExternalDocumentReference

string

Returns the external reference of this document as it was passed in through the Add document to package call.

DocumentName

string

Name of the document

DocumentType

string

Type of document within the package.

Name

Type

Summary

ContinuationToken

string

ContinuationToken

MaxQuantity

integer(int32)

MaxQuantity

Total

integer(int32)

Total

Items

array of (Package)

Name

Type

Summary

PackageName

string

Description for the Package shown to the eSignatures Portal user as file name.

CreationTimestamp

string

Date and time when the package was created according to the server.

Initiator

string

Initiator field of the package as it was passed in at creation time.

ExpiryTimestamp

string

UTC formatted time at which the document expires. Can be null.

ExternalPackageReference

string

Returns the external reference id of the package as it was passed in at creation time.

F2FSigningUrl

string

Link to the package which allows to pick from all the signing session at once.

PackageStatus

string

Status of the package as a whole:

PackageDocuments

array of (PackageDocument)

Details for each of the documents in the package.

Stakeholders

array of (StakeholdersItem)

Details for each of the persons which will interact with the package.

Name

Type

Summary

Type

string

Type of stakeholder: Person, PersonGroup, or ContactGroup.

PersonGroupName

string

Name of the person group. Only returned if Type was set to PersonGroup in the request.

ContactGroupCode

string

Code of the contact group. Only returned if Type was set to ContactGroup in the request.

EmailAddress

string

Email address of the signer.

ExternalStakeholderReference

string

External reference identifying this person in the external system.

StakeholderId

string

Unique id.

Actors

array of (ActorsItem)

Details of all steps to take.

Name

Type

Summary

ActorId

string

Unique id for this combination of action, stakeholder and document.

ActionUrl

string

URL that this person can open to interact with the package.

ActionUrls

array of (ActionUrlsItem)

Array of URLs that the different persons of the PersonGroup or ContactGroup can open to interact with the package.

ActorStatus

string

Draft (package has status Draft)

Type

string

Signer / Receiver

CompletedBy

string

The name of the end user who completed the action.

CompletedTimestamp

string

Timestamp of the moment on which this action was completed.

Reason

string

Returns the text entered by the person who changed the status of a package to a final state (e.g. a reject).

Locations

array of (LocationsItem)

Represents a possible location for a signature.

Name

Type

Summary

EmailAddress

string

Email address of the person.

Url

string

URL that this person can open to interact with the package.

Name

Type

Summary

Id

string

Unique id for this location

UsedSigningType

string

Returns the signing type that was used to sign the document.

Name

Type

Summary

Content

string

The actual content of the proof.

LocationId

string

Location of the signature for which the proof content was generated.

Name

string

Name of the proof.

Type

string

A machine-readable “type” key. Can be freely chosen.

Description

string

Brief human-readable description of the proof.

IpAddress

string

IP address of the end user of the external source for which the proof was added.

Name

Type

Summary

Type

string

Signer / Receiver

OrderIndex

integer(int32)

This number specifies in which order actors need to execute their action.

SigningFields

array of (SigningField)

Define the locations where this actor should sign

SigningTypes

array of (SigningType)

One or more signing type info objects.

Phonenumber

string

Phone number to receive an SMS OTP.

RedirectUrl

string

Url to which the end user is redirected after signing.

SendNotifications

boolean

eSignatures can send e-mails to all the people who are allowed to sign.

UserRoles

array of (string)

Role or function of the signer.

LegalNoticeCode

string

Legal Notice

LegalNoticeText

string

Custom legal notice text in case none of the three predefined legal notices apply.

Name

Type

Summary

Status

string

Pending / Revoked

Name

Type

Summary

Stakeholders

array of (StakeholdersItem)

Name

Type

Summary

Actors

array of (ActorsItem)

Array with more information about what the stakeholder must do.

EmailAddress

string

Email Address

FirstName

string

First Name

Language

string

UI language of this stakeholder. Currently supported: en, nl, de, fr, es.

LastName

string

Last Name

BirthDate

string

Date of birth in format: YYYY-MM-DD

ExternalStakeholderReference

string

Reference given by the calling application. This parameter will not be used by the eSignatures Portal.

Name

Type

Summary

Type

string

Type  Values: [Signer, Receiver]

OrderIndex

string

This number specifies in which order actors need to execute their action.

LocationIds

array of (string)

The location ids where a signature must be placed by this person.

SigningTypes

array of (SigningType)

One or more signing type info objects.

Phonenumber

string

Phone number to receive an SMS OTP.

RedirectURL

string

Url to which the end user is redirected after signing, or rejecting. The redirect occurs immediately after signing or rejecting.

SendNotifications

boolean

eSignatures can send e-mails to the actors whose action is required, such as signing

UserRoles

array of (string)

The location ids where a signature must be placed by this person.

LegalNoticeCode

string

The 3 values will point to the 3 legal notices built into the application. These can be altered in the Configuration Index.

LegalNoticetext

string

Custom legal notice text in case none of the three predefined legal notices apply

Name

Type

Summary

PageNumber

integer

Number of the page on which to add a signing location

Width

string

Width

Height

string

Height

Left

string

Position from the left of the page

Top

string

Position from top of the page

MarkerOrFieldId

string

Unique reference to a signing field, text marker or textfield.

Name

Type

Summary

SigningType

string

The signing type used in this actor's session.

CommitmentTypes

array of (string)

One or more OIDs of commitment types. Can only be passed when signature policy is used.

MandatedSignerValidation

string

Type of validation to execute during eID other smart card, or itsme signing session.

MandatedSignerIds

array of (string)

Defines which eID or other smart cards are allowed to sign during this session.

SignaturePolicyId

string

Signing policy details for the signature.

Name

Type

Summary

Actors

array of (Request.Actor)

EmailAddress

string

EmailAddress

FirstName

string

FirstName

LastName

string

LastName

BirthDate

string

BirthDate

Language

string

Language

ExternalStakeholderReference

string

ExternalStakeholderReference