Skip to main content

Update a Signature Request

PUT 
/v3/signature-requests/:signatureRequestId

This endpoint updates a signature request identified by the signature request ID.

This methos is a partial update, that means that you can update only the fields you want to update.

The signature request must be in DRAFT state to be able to be updated.

documentIds and signerIds are optional but must be globally provided to be able to PUBLISH the signature request.
That means that you need to provide them at least one time
This method is a part of the Signature Request Creation Api Life Cycle.

Request​

Path Parameters

    signatureRequestId stringrequired

    The unique identifier of the signature request to be closed.

Body

The signature request details.

    title string
    description string
    expirationDate date-time
    expirationDateIsActivated boolean
    language IGNISIGN_SIGNATURE_LANGUAGES (string)

    Possible values: [EN, FR, DE]

    Represents the languages for signatures supported by a signature profile.

    documentIds string[]
    externalId string
    diffusionMode IGNISIGN_SIGNATURE_REQUEST_DIFFUSION_MODE (string)

    Possible values: [WHEN_READY, SCHEDULED]

    Represents the diffusion mode of a signature request.

    • WHEN_READY : The signature request will be sent to the signer as soon it is ready to be signed. This is the default value.
      I.E: If there are no document request, the signature request will be sent to the signer as soon as the signature request is PUBLISHED.
      If there are document request, the signature request will be sent to the signer as soon as all the document request are have been completed.
    • SCHEDULED : The signature request will be sent to the signer at a specific date. This date is specified in the diffusionDate field
    diffusionDate date-time

    statements

    object[]

  • Array [

    • _id string

    A unique string identifier for the signature request statement.

    appId appId (string)required

    The application identifier which is used to identify the application used.

    appEnv IGNISIGN_APPLICATION_ENV (string)required

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

    signatureRequestId stringrequired

    The unique identifier of the signature request associated with this statement.

    documentId string

    If target value is 'DOCUMENT', this value is unique identifier of the document associated with this statement.

    target IGNISIGN_SIGNATURE_REQUEST_STATEMENT_TARGET (string)required

    Possible values: [SIGNATURE_REQUEST, DOCUMENT]

    The target of the signature request statement. This can be 'SIGNATURE_REQUEST' or 'DOCUMENT'.

    labelMd string

    The label of the statement represented in MD format.

  • ]

    • signerIds string[]
    extendedAuthSessionEnabled boolean

    Indicates whether extended authentication sessions are enabled in this signature request. This allow signers to authenticate once and sign signature session during 30 minutes with the same device/browser.

    initialSignatureRequestId string

    If the signature request has been created from a signature profile with the individualizeRequests option activated, this field will contain the identifier of the initial signature request which it has been generated.

    signersAsApprover string[]

    the ids of signers that will be approvers

    recipients string[]

    the emails of signers that will receive a copy of the signed document

Responses​

The context of the updated signature request.

Schema

    _id string
    appId appId (string)required

    The application identifier which is used to identify the application used.

    appEnv IGNISIGN_APPLICATION_ENV (string)required

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

    signatureProfileId stringrequired
    title string
    description string
    expirationDate date-time
    expirationDateIsActivated boolean
    status IGNISIGN_SIGNATURE_REQUEST_STATUS (string)required

    Possible values: [DRAFT, WAITING_DOCUMENTS, WAITING_DOCUMENTS_GENERATION, READY, IN_PROGRESS, COMPLETED, EXPIRED, FAILED, CANCELLED, PROCESSING]

    Represents the current status of a signature request in the Ignisign application.

    language IGNISIGN_SIGNATURE_LANGUAGES (string)

    Possible values: [EN, FR, DE]

    Represents the languages for signatures supported by a signature profile.

    documentIds string[]
    externalId string
    diffusionMode IGNISIGN_SIGNATURE_REQUEST_DIFFUSION_MODE (string)

    Possible values: [WHEN_READY, SCHEDULED]

    Represents the diffusion mode of a signature request.

    • WHEN_READY : The signature request will be sent to the signer as soon it is ready to be signed. This is the default value.
      I.E: If there are no document request, the signature request will be sent to the signer as soon as the signature request is PUBLISHED.
      If there are document request, the signature request will be sent to the signer as soon as all the document request are have been completed.
    • SCHEDULED : The signature request will be sent to the signer at a specific date. This date is specified in the diffusionDate field
    diffusionDate date-time
    signerIds string[]
    signedBy string[]
    _createdAt date-time
    creatorId string
    templateDisplayerId string
    templateDisplayerVersion number

    signers

    object[]

    required

  • Array [

    • signerId string

    The unique identifier of the signer.

    externalId string

    The external identifier of the signer - A reference that you can set to match with your internal systems.

    firstName string

    The first name of the signer.

    lastName string

    The last name of the signer.

    email string

    The email of the signer.

    status IGNISIGN_SIGNER_STATUS (string)

    Possible values: [CREATED, PENDING, BLOCKED, ACTIVE]

    The status of the signer.

    alreadyProvidedInputs IGNISIGN_SIGNER_CREATION_INPUT_REF (string)[]

    Possible values: [firstName, lastName, email, phoneNumber, nationality, birthDate, birthPlace, birthCountry]

    isRecurrent boolean

    Indicates whether the signer is recurrent or not (one-off).

  • ]

    • documents

    object[]

    required

  • Array [

    • _id string

    A unique string identifier for the document context.

    appId appId (string)required

    The application identifier which is used to identify the application used.

    appEnv IGNISIGN_APPLICATION_ENV (string)required

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

    externalId string

    An optional external identifier that can be used to reference the document context from external systems.

    documentNature IGNISIGN_DOCUMENT_TYPE (string)required

    Possible values: [PDF, FILE, DATA_JSON, PRIVATE_FILE]

    fileName string

    The name of the file associated with the document.

    fileSize number

    The size of the file associated with the document, typically in bytes.

    label string

    A user-friendly label to identify the document.

    description string

    A detailed, human-readable description of the document.

    mimeType string

    The MIME type of the file associated with the document, such as 'application/pdf' for PDF files.

    documentHash stringrequired

    The hash of the document.

    status IGNISIGN_DOCUMENT_STATUS (string)required

    Possible values: [CREATED, DOCUMENT_REQUEST, PROVIDED, ARCHIVED]

    Represents the current status of a document in the Ignisign application.

    documentRequestId string

    The unique identifier of the document request associated with this document.

    signatureRequestId stringrequired

    The unique identifier of the signature request associated with the document.

    _createdAt date-time

    The date and time when the document context was created, formatted as a string in ISO 8601 format.

    statements

    object[]

    The statements related to the document.

  • Array [

    • _id string

    A unique string identifier for the signature request statement.

    appId appId (string)required

    The application identifier which is used to identify the application used.

    appEnv IGNISIGN_APPLICATION_ENV (string)required

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

    signatureRequestId stringrequired

    The unique identifier of the signature request associated with this statement.

    documentId string

    If target value is 'DOCUMENT', this value is unique identifier of the document associated with this statement.

    target IGNISIGN_SIGNATURE_REQUEST_STATEMENT_TARGET (string)required

    Possible values: [SIGNATURE_REQUEST, DOCUMENT]

    The target of the signature request statement. This can be 'SIGNATURE_REQUEST' or 'DOCUMENT'.

    labelMd string

    The label of the statement represented in MD format.

  • ]

    • documentRequest

    object

    The document request associated with the document context.

    _id string

    A unique string identifier for the document request.

    appId appId (string)required

    The application identifier which is used to identify the application used.

    appEnv IGNISIGN_APPLICATION_ENV (string)required

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

    signatureRequestId stringrequired

    The unique identifier of the signature request associated with this document request.

    documentId stringrequired

    The unique identifier of the document associated with this request.

    target IGNISIGN_DOCUMENT_REQUEST_TARGET (string)required

    Possible values: [APPLICATION, USER]

    The target of the document request. If the value is 'USER' an email is sent to this USER to be able to complete the document request. If the value is 'APPLICATION' a webhook is sent to the APPLICATION with the elements that allow it to provide the document.

    status IGNISIGN_DOCUMENT_REQUEST_STATUS (string)required

    Possible values: [CREATED, IN_PROGRESS, PROVIDED, WAITING_CONFIRMATION, CANCELLED, VALIDATED, REJECTED]

    The current status of the document request.

    externalId string

    An optional external identifier that can be used to reference the document request from external systems.

    user

    object

    The user associated with the document request. required if target value is 'USER'

    firstName string

    The first name of the user associated with the document request.

    lastName string

    The last name of the user associated with the document request.

    email stringrequired

    The email address of the user associated with the document request.

    signatureSummaries

    object[]

    required

    The signatures associated with the document context.

  • Array [

    • signatureId stringrequired

    The unique identifier of the signature.

    signerId stringrequired

    The unique identifier of the signer who provided the signature.

    date date-timerequired

    The date and time when the signature was realized, formatted as a string in ISO 8601 format.

  • ]

  • ]

    • statements

    object[]

  • Array [

    • _id string

    A unique string identifier for the signature request statement.

    appId appId (string)required

    The application identifier which is used to identify the application used.

    appEnv IGNISIGN_APPLICATION_ENV (string)required

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

    signatureRequestId stringrequired

    The unique identifier of the signature request associated with this statement.

    documentId string

    If target value is 'DOCUMENT', this value is unique identifier of the document associated with this statement.

    target IGNISIGN_SIGNATURE_REQUEST_STATEMENT_TARGET (string)required

    Possible values: [SIGNATURE_REQUEST, DOCUMENT]

    The target of the signature request statement. This can be 'SIGNATURE_REQUEST' or 'DOCUMENT'.

    labelMd string

    The label of the statement represented in MD format.

  • ]

    • signatureProfile

    object

    required

    _id string

    A unique string identifier for the signature profile.

    appId appId (string)required

    The application identifier which is used to identify the application used.

    appEnv appEnv (string)required

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

    orgId stringrequired

    The unique identifier of the organization associated with this signature profile.

    name stringrequired

    The name of the signature profile.

    status IGNISIGN_SIGNATURE_PROFILE_STATUS (string)required

    Possible values: [PUBLISHED, ARCHIVED]

    Represents the current status of a signature profile in the Ignisign application.

    integrationMode IGNISIGN_INTEGRATION_MODE (string)required

    Possible values: [BY_SIDE, EMBEDDED]

    Represents the integration mode of a signature profile.

    signatureMethodRef IGNISIGN_SIGNATURE_METHOD_REF (string)required

    Possible values: [SIMPLE_STD, ADVANCED_STD, QUALIFIED_STD]

    Represents the method used for signatures in a signature profile in the Ignisign application.

    signatureRequestType IGNISIGN_SIGNATURE_REQUEST_TYPE (string)

    Possible values: [STANDARD, SIGNER_SETUP]

    The type of signature request. This parameter is used to define the type of signature request to be created. This will determine the type of signature request that will be created and the steps that will be required to complete the signature request.

    idProofings IGNISIGN_ID_PROOFING_METHOD_REF (string)[]required

    Possible values: [VIDEO_ROBOT_AES, VIDEO_ROBOT_QES, BANK_ACCOUNT_CHECK, E_ID_AES, E_ID_QES, RA_NATURAL_QES, RA_NATURAL_AES, SOCIAL_SECURITY_NUMBER, BIND_ADDITIONAL_AUTH_METHOD]

    The identity proofing methods used in this signature profile.

    authMethods IGNISIGN_AUTH_FULL_MECHANISM_REF (string)[]required

    Possible values: [SIMPLE, PHONE_SMS, PHONE_CALL, TOTP, PASS_KEY_POSSESSION, AES_EID, QES_EID]

    The authentication methods used in this signature profile.

    documentTypes IGNISIGN_DOCUMENT_TYPE (string)[]required

    Possible values: [PDF, FILE, DATA_JSON, PRIVATE_FILE]

    The types of documents supported by this signature profile.

    documentRequestActivated booleanrequired

    Indicates whether document requests are activated in this signature profile.

    defaultLanguage IGNISIGN_SIGNATURE_LANGUAGES (string)required

    Possible values: [EN, FR, DE]

    Represents the languages for signatures supported by a signature profile.

    languageCanBeChanged booleanrequired

    Indicates whether the language can be changed during the signature request creation.

    statementsEnabled booleanrequired

    Indicates whether statements are enabled in this signature profile.

    templateDisplayerId string

    The unique identifier of the template displayer associated with this signature profile in case of document type is DATA_JSON.

    createdByDefault boolean

    Indicates whether the signature profile has been created has a by default signature profile.

    extendedAuthSessionEnabled booleanrequired

    Indicates whether extended authentication sessions are enabled in this signature profile. This allow signers to authenticate once and sign signature session during 30 minutes with the same device/browser.

    approverEnabled boolean

    Indicates whether the approver is enabled for signature request created from this signature profile.

    recipientEnabled boolean

    Indicates whether the recipient is enabled for signature request created from this signature profile.

    individualizeRequests boolean

    Indicates whether the signature request created from this signature profile are individualized. I.E all the signers will receive a separate signature request. Approvers will be included in each signature request.

    sharingRestricted boolean

    Indicates whether the access to signature proof page is restricted. If true, the signature proof page will be accessible only by the signers, approvers recipient and platform users that are allowed to view the page if no, anyone with the link can access the page and view its content.

    applicationMetadata

    object

    appName stringrequired
    logoB64 string

    colors

    object

    primary

    object

    required

    50 stringrequired
    100 stringrequired
    200 stringrequired
    300 stringrequired
    400 stringrequired
    500 stringrequired
    600 stringrequired
    700 stringrequired
    800 stringrequired
    900 stringrequired
    A100 stringrequired
    A200 stringrequired
    A400 stringrequired
    A700 stringrequired

    secondary

    object

    required

    50 stringrequired
    100 stringrequired
    200 stringrequired
    300 stringrequired
    400 stringrequired
    500 stringrequired
    600 stringrequired
    700 stringrequired
    800 stringrequired
    900 stringrequired
    A100 stringrequired
    A200 stringrequired
    A400 stringrequired
    A700 stringrequired
    signatureProofsUrl string
    signatureProofStatus IGNISIGN_DOCUMENT_GENERATED_STATUS (string)

    Possible values: [NOT_INITIALIZED, IN_PROGRESS, WAITING_IMAGES, ON_ERROR, CREATED]

    initialSignatureRequestId string

    If the signature request has been created from a signature profile with the individualizeRequests option activated, this field will contain the identifier of the initial signature request which it has been generated.

    signersAsApprover string[]

    the ids of signers that will be approvers

    recipients string[]

    the emails of signers that will receive a copy of the signed document

Loading...