Skip to main content

Ignisign v3 to v4 - API Migration Guide

This guide outlines the significant changes made in version 4 of the Ignisign platform, with a detailed comparison of the API changes from version 3. It will help you smoothly transition to the new version by understanding the modifications across main Ignisign areas such as Documents, Applications, Signature Requests, Signers, and Signer Profiles.

Main Changes

  • Document Management: Deletion of the IgnisignDocumentRequest principle and the introduction of the DATA_XML document type.
  • Application Settings: Addition of appType and isDefaultApplication fields, and migration from signatureProfile to signerProfile.
  • Signature Requests: The move of templateDisplayerId and templateDisplayerVersion to documents and various about new features.
  • Signers: Migration from signatureProfile to signerProfile with new fields for Seal, LogCapsule, M2M, and BareSignature.
  • New Features: Support for Seal, LogCapsule, M2M, and BareSignature.

Summary:

The document-related changes involve a shift of focus from Signature Profiles to Documents, along with the addition of a new document type, DATA_XML, and the removal of several classes related to document requests.

Main Changes:

  • Deletion of the IgnisignDocumentRequest principle.
  • Templates shifted from signature profiles.
  • New document type: DATA_XML.

Changes in Classes:

ClassAdded FieldsRemoved Fields
IgnisignDocumenttemplateDisplayerId, templateDisplayerVersiondocumentRequestId
IgnisignDocument_Context-documentRequest
IgnisignDocument_InitializationDtotemplateDisplayerId, templateDisplayerVersion-
IgnisignDocument_UpdateDtotemplateDisplayerId, templateDisplayerVersion-

Changes in Enums:

EnumAdded FieldsRemoved Fields
IGNISIGN_DOCUMENT_TYPEDATA_XML-
IGNISIGN_DOCUMENT_STATUS-DOCUMENT_REQUEST
IGNISIGN_WEBHOOK_TOPICS-DOCUMENT_REQUEST

Changes in Constants:

Added Constant
IMAGE_MIMETYPE_INSERABLE_IN_PDF

Summary:

Changes in applications include the addition of new fields to IgnisignApplication, the restructuring of EnvSettings, and the addition of new classes related to features like SSO and API Keys.

Main Changes:

  • New fields: appType, isDefaultApplication.
  • Migration: Signature profile fields replaced by signer profile fields.
  • New structures: EnvSettings updated with new fields.

Changes in Classes:

ClassAdded FieldsRemoved Fields
IgnisignApplicationappType, isDefaultApplication-
IgnisignApplication_ContextsignerProfiles-
IgnisignApplication_EnvSettingsNew API, language, session, and retention fieldsappRootUrl, authorizedRedirectionUrls, defaultSignatureProfileId, oAuth2, saml

Changes in Enums:

Enum Added
IGNISIGN_APPLICATION_TYPE
IGNISIGN_APPLICATION_ENV_API_KEYS_STATUS
IGNISIGN_SSO_CONFIG_TYPES
IGNISIGN_SSO_CONFIG_STATUS

Changes in Constants:

Constants Added
IGNISIGN_SIGNATURE_LANGUAGES_AVAILABLE
IGNISIGN_APPLICATION_TYPES_ACTIVATED
IGNISIGN_APPLICATION_TYPES_HIDDEN

Summary:

In the signature requests, template-related fields have been removed from the signature request object and moved to documents. Several new fields were added to support new features like Seal, M2M, and BareSignature. Signature profiles have been replaced by signer profiles.

Main Changes:

  • Field relocation: templateDisplayerId and templateDisplayerVersion moved to documents.
  • Migration: From signatureProfile to signerProfile.
  • New fields: Added fields for Seal, M2M, and BareSignature.

Changes in Classes:

Classes Renamed:

Class RenamedNew Name
IgnisignSignatureRequest_PublishBySideIgnisignWebhookDto_SignatureRequestSignerBySide
IgnisignSignatureRequest_PublishEmbeddedIgnisignWebhookDto_SignatureRequestSignerEmbedded
IgnisignWebhookDto_SignatureRequestSignerIgnisignWebhookDto_SignatureRequestSigners

Classes Added:

Maonly related to the migration from signatureProfile to signerProfile.

Class AddedDescription
IgnisignSignatureRequest_SignerProfile-
IgnisignSignatureRequest_Publish_ResponseDTO-
IgnisignSignatureRequest_SignerProfile-

Changes in Existing Classes:

ClassAdded FieldsRemoved FieldsRenamed Fields
IgnisignSignatureRequestappEnvSettingVersion, defaultSignatureMethod, signerProfilesUsed, individualizeRequests, m2mIdsignatureProfileId, templateDisplayerId, templateDisplayerVersionsignersAsApprover -> signerIdsAsApprover
IgnisignSignatureRequest_UpdateDtodefaultSignatureMethod, signerProfilesSignatureMethod, individualizeRequests-signersAsApprover -> signerIdsAsApprover
IgnisignSignatureRequest_ContextsignerProfilessignersAsApprover, signatureProfile-
IgnisignApplication_SignatureMetadataappTyperootUrl-

New Enums:

Enum Added
IGNISIGN_SIGNATURE_PROOF_TYPE

Changes in Enums:

EnumAdded FieldsRemoved Fields
IGNISIGN_SIGNATURE_LANGUAGESNew languages added-
IGNISIGN_ID_PROOFING_METHOD_REFORG_SSO_AES, ORG_SSO_QESORG_SSO, AUTOMATE_ONBOARDING
IGNISIGN_AUTH_FULL_MECHANISM_REF-AUTOMATE
IGNISIGN_SIGNATURE_METHOD_REF-AUTOMATE_AVANCED
IGNISIGN_SIGNATURE_REQUEST_STATUS-WAITING_DOCUMENTS
IGNISIGN_SIGNATURE_REQUEST_TYPESEAL, SEAL_M2M, BARE_SIGNATURE-

Summary:

The signerProfile migration is a major update here, along with new fields added to support Seal, LogCapsule, M2M, and BareSignature features.

Main Changes:

  • Migration: From signatureProfile to signerProfile.
  • New fields: Support for Seal, LogCapsule, and M2M features.

Changes in Classes:

ClassAdded FieldsRemoved Fields
IgnisignSignersignerProfileIdsignatureProfileId
IgnisignSigner_CreationRequestDtosignerProfileIdsignatureProfileId, isRecurrent
IgnisignSigner_UpdateRequestDtosignerProfileIdsignatureProfileId, isRecurrent
IgnisignSigner_CreationResponseDtosuccess, alreadyExists-
IgnisignSigner_SummarysignerProfileId, sealClaims, fromUserId-

Changes in Enums:

EnumAdded FieldsRemoved Fields
IGNISIGN_SIGNER_CLAIM_REFCAN_APPROVE_SEAL_SES, CAN_APPROVE_SEAL_AES, CAN_APPROVE_SEAL_QESAUTOMATE_SECRET_POSSESSION
IGNISIGN_SIGNER_ENTITY_TYPESEALLEGAL, VIRTUAL
IGNISIGN_SIGNER_STATUSCORRUPTED-

Summary:

The migration to signerProfile has resulted in several new classes and enums related to managing signature methods and profiles.

Main Changes:

  • New classes: Signer profile classes added.

Changes in Classes:

Class added
IgnisignSignerProfileSignatureMethod
IgnisignSignerProfile
IgnisignSignerProfileDto
IgnisignSigner_To_SignerProfile
IgnisignSignerProfile_SignatureAuthMethods
SignerProfileBulkDto
Class removed
IgnisignSignatureProfile_IdContainerDto

Enums Added:

Enum Added
IGNISIGN_SIGNER_PROFILE_STATUS