V2 API

Although the names implies otherwise, the PKIsigning V2 API is not a successor of the PKIsigning V1 API. The PKIsigning V1 API is an easy to use, one-stop-shop for easily sending requests for signing and downloading and retrieving the result afterwards.

The V2 API does the same but is more suitable for complex situations where data is not readily available.

The PKIsigning V2 API is a RESTful API to mimic almost all operations that are available in the PKIsigning front-end. It is also the source of our Microsoft PowerAutomate connector. For integrating with PKIsigning without deep diving into authentication and HTTP calls, please use Microsoft PowerAutomate.

PKIsigning is using Swagger for API documentation. Please look at the API documentation in our Swagger interface.

 

Below you find the available calls for this API.

 

Call

Description

Swagger

Call

Description

Swagger

Create actor

Creates a new actor and adds it to a document

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Actors/Actors_Create

Create document

Creates a new document and add it to a specific request

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Documents/Documents_Create

Create request

Create a new request

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Requests/Requests_Create

Delete a request

Permanently deletes a specific request

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Requests/Requests_Delete

Delete actor

Permanently deletes a specific actor

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Actors/Actors_Delete

Delete document

Permanently deletes a specific document

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Documents/Documents_Delete

Download request

Downloads a requests and its contents as a .zip file

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Requests/Requests_Download

Get actor data

Returns all data for a specific actor

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Actors/Actors_Get

Get actor data by document

Returns all data of all actors for a specific document

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Actors/Actors_List

Get actor data by request

Returns all data of all actors for a specific request

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Actors/Actors_RequestActors

Get document data

Returns all (meta)data for a specific document

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Documents/Documents_Get

Get request data

Returns all (meta)data for a specific request

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Requests/Requests_Get

Get workgroups for organisation

Returns a list of all workgroups for a specific organisation

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Organisations/Organisations_GetWorkgroups

Get my organisation ID

Returns the organisation ID for the authenticated user

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Organisations/Organisations_GetOrganisationOfCurrentUser

Get workgroups for user

Returns a list of all workgroups for a specific user of a specific organisation

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Organisations/Organisations_GetWorkgroupsByUser

Resend invite

Resends the invite for the current actor in line for a specific request

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Actors/Actors_ResendCurrentInvite

Send request

Starts the workflow and sends an invite to the first actor in line for a specific request

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Requests/Requests_Send

Update actor

Changes data for a specific actor

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Actors/Actors_Update

Update document

Changes data for a specific document

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Documents/Documents_Update

Update request

Changes data for a specific request

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Requests/Requests_Update

Withdraw invite

Withdraws the invite for the current actor in line for a specific request

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Actors/Actors_WithdrawCurrentInvite

 

 

Webhooks

When an event occurs on a request

https://accplatformapi.pkisigning.io/swagger/index.html?urls.primaryName=V2#/Webhooks/Webhooks_CreateWebhook



© 2020 PKIsigning, SBRS B.V.