Change Updates

Do not miss any Authentisign API changes, ever again

Subscribe to the Authentisign API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
1.0
47 structure changes including:
1 Breaking change
2 Additions
44 Modifications
1 Removal
Modified 44 Breaking
PUT /api/v1/signings/{signingId}/recover-deleted
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/{signingId}/documents/s/url
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/{signingId}/documents/sc
  • Response
  • 200, 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/{signingId}/history
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/{signingId}/participants
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/sso/signing/{signingId}
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
PATCH /api/v1/signings/{id}
  • Query
  • CallbackUrl query parameter Modified
    • Type is no longer string
      Breaking
PATCH /api/v1/signings/{signingId}/documents/{documentId}
  • Query
  • LayoutId query parameter Modified
    • Type is no longer string
      Breaking
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/accounts/email-signature
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/ccs/batch
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/layouts
  • Query
  • Name query parameter Modified
    • Type is no longer string
      Breaking
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/layouts/{id}/copy
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/participants/batch
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/signings
  • Body
  • multipart/form-data content type Modified
    • Files property Modified
      • Type went from array to array[string(binary)]
    • FilesWithStrikeoutsDisabled property Modified
      • Type went from array to array[string]
    • Fields property Modified
      • * property Added
    • Participants property Modified
      • Property is now required
        Breaking
      • Type went from array to array[object]
      • Authentisign.Services.Dtos.ParticipantDto property Added
    • Name property Modified
      • Property is now required
        Breaking
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/signings/{id}/copy
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/signings/{id}/resend-invitation
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/signings/{id}/reset
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/signings/{signingId}/force-complete
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/signings/{signingId}/link-transaction
  • Query
  • TransactionId, Documents query parameters Modified
    • Type is no longer string
      Breaking
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/signings/{signingId}/reject
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/signings/{signingId}/send-final-documents
  • Query
  • Emails query parameter Modified
    • Type is no longer string
      Breaking
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
POST /api/v1/signings/{signingId}/send-signing
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
PUT /api/v1/participants/{participantId}/email
  • Query
  • Email query parameter Modified
    • Type is no longer string
      Breaking
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
DELETE /api/v1/layouts/{id}
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
DELETE /api/v1/signings/{id}
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/documents/{documentId}/d/url
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/documents/{documentId}/dc/url
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/documents/{documentId}/o/url
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/documents/{encryptedDocumentId}/d
  • Response
  • 200, 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/documents/{encryptedDocumentId}/dc
  • Response
  • 200, 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/documents/{encryptedDocumentId}/o
  • Response
  • 200, 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/layouts
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/deleted
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/documents/{signingId}/certificates
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/documents/{signingId}/completed
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/documents/{signingId}/originals
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/participants/{signingId}/invitations
  • Response
  • 500 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/{id}
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/{signingId}/ccs
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/{signingId}/documents
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/{signingId}/documents/ls
  • Response
  • 200, 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/{signingId}/documents/ls/url
  • Response
  • 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
GET /api/v1/signings/{signingId}/documents/s
  • Response
  • 200, 400, 500 responses Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • default response Added
Removed 1 Breaking
GET /api/v1/sso/main
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
POST /api/v1/sso/layout/{layoutId}
GET /api/v1/sso/layout/{layoutId}
47 structure changes including:
2 Breaking changes
45 Modifications
2 Removals
Modified 45 Breaking
DELETE /api/v1/layouts/{id}
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
DELETE /api/v1/signings/{id}
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/documents/{documentId}/d/url
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/documents/{documentId}/dc/url
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/documents/{documentId}/o/url
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/documents/{encryptedDocumentId}/d
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/documents/{encryptedDocumentId}/dc
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/documents/{encryptedDocumentId}/o
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/layouts
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/deleted
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/documents/{signingId}/certificates
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/documents/{signingId}/completed
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/documents/{signingId}/originals
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/participants/{signingId}/invitations
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/{id}
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/{signingId}/ccs
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/{signingId}/documents
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/{signingId}/documents/ls
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/{signingId}/documents/ls/url
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/{signingId}/documents/s
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/{signingId}/documents/s/url
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/{signingId}/documents/sc
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/{signingId}/history
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/signings/{signingId}/participants
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/sso/main
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /api/v1/sso/signing/{signingId}
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /api/v1/signings/{id}
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PATCH /api/v1/signings/{signingId}/documents/{documentId}
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/accounts/email-signature
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/ccs/batch
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/layouts
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/layouts/{id}/copy
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/participants/batch
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/signings
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/signings/{id}/copy
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/signings/{id}/resend-invitation
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/signings/{id}/reset
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/signings/{signingId}/force-complete
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/signings/{signingId}/link-transaction
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/signings/{signingId}/reject
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/signings/{signingId}/send-final-documents
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
POST /api/v1/signings/{signingId}/send-signing
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /api/v1/participants/{participantId}/email
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
PUT /api/v1/signings/{signingId}/recover-deleted
  • Authentication
  • Api key header, Api key query authentication methods Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
Removed 2 Breaking
Api key headerauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Api key queryauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking