Update a Signature Request

PUT /v4/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.

application/json

Body

The signature request details.

title string

The title of the signature request.

description string

The description of the signature request.

expirationDate date-time

The expiration date if the expirationDateIsActivated parameter is true The action linked to this date is performed every 5 minutes, at 5, 10, 15... 55.

expirationDateIsActivated boolean

Indicates whether the expiration date is activated.

language IGNISIGN_SIGNATURE_LANGUAGES (string)

Possible values: [EN, FR, DE, ES, IT, PT, NL, PL, JA, KO, AR, HE]

Represents the languages for signatures supported by a signature profile.

documentIds string[]

The ids of the documents that are linked to the signature request.

externalId string

a free field to store an identifier that can be used to link the signature request to an external system.

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

the diffusion date if diffusionModeparameter is SCHEDULED The action linked to this date is performed every 5 minutes, at 5, 10, 15... 55.

statements

object[]

The list of statements that have been added to the signature request.

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 appEnv (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[]

The ids of the signers that have been invited to sign the signature request.

extendedAuthSessionEnabled boolean

Indicates whether the extended authentication session is enabled. by default took the value of the app setting.

signerIdsAsApprover string[]

the ids of signers that will be approvers

recipients string[]

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

defaultSignatureMethod IGNISIGN_SIGNATURE_METHOD_REF (string)

Possible values: [SIMPLE_STD, ADVANCED_STD, QUALIFIED_STD]

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

signerProfilesSignatureMethod

object[]

The signature method used for each signer profile. This is optional and could be used to override the default signature method for a specific signer profile.

Array [

signerProfileId stringrequired

signatureMethodRef IGNISIGN_SIGNATURE_METHOD_REF (string)required

Possible values: [SIMPLE_STD, ADVANCED_STD, QUALIFIED_STD]

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

]

individualizeRequests boolean

Indicates whether the signature request has been created with the individualizeRequests option activated. If activated, each signer will receive a separate signature request. Approvers will be included in each signature requests.

Responses

The context of the updated signature request.

application/json

Schema
Example (from schema)

Schema

_id string

_createdAt date-time

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.

signatureRequestType IGNISIGN_SIGNATURE_REQUEST_TYPE (string)required

Possible values: [STANDARD, SIGNER_SETUP, SEAL, SEAL_M2M, BARE_SIGNATURE]

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.

title string

The title of the signature request.

description string

The description of the signature request.

language IGNISIGN_SIGNATURE_LANGUAGES (string)

Possible values: [EN, FR, DE, ES, IT, PT, NL, PL, JA, KO, AR, HE]

Represents the languages for signatures supported by a signature profile.

status IGNISIGN_SIGNATURE_REQUEST_STATUS (string)required

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

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

externalId string

a free field to store an identifier that can be used to link the signature request to an external system.

creatorId string

The id of the user who created the signature request if this has been made into the IgniSign User interface.

documentIds string[]

The ids of the documents that are linked to the signature request.

signerIds string[]

The ids of the signers that have been invited to sign the signature request.

signedBy string[]

The ids of the signers that have already signed the signature request.

expirationDate date-time

The expiration date if the expirationDateIsActivated parameter is true The action linked to this date is performed every 5 minutes, at 5, 10, 15... 55.

expirationDateIsActivated boolean

Indicates whether the expiration date is activated.

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

the diffusion date if diffusionModeparameter is SCHEDULED The action linked to this date is performed every 5 minutes, at 5, 10, 15... 55.

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.

signerIdsAsApprover string[]

the ids of signers that will be approvers

recipients string[]

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

appEnvSettingVersion number

The version of the application environment settings used to create this signature request.

defaultSignatureMethod IGNISIGN_SIGNATURE_METHOD_REF (string)required

Possible values: [SIMPLE_STD, ADVANCED_STD, QUALIFIED_STD]

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

signerProfilesUsed

object[]

Array [

signerProfileId stringrequired

signatureMethodRef IGNISIGN_SIGNATURE_METHOD_REF (string)required

Possible values: [SIMPLE_STD, ADVANCED_STD, QUALIFIED_STD]

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

version numberrequired

signerIds string[]required

]

individualizeRequests boolean

m2mId string

Used only for M2M signature requests. The identifier of the M2M signature request. du not update directly this field.

signers

object[]

required

The list of signers' summaries that have been invited to sign the signature request.

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, CORRUPTED]

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).

signerProfileId string

sealClaims IGNISIGN_SIGNER_CLAIM_REF (string)[]

Possible values: [EID_POSSESSION_AES, EID_POSSESSION_QES, PHONE_NUMBER_POSSESSION, PRIVATE_KEY_POSSESSION, DAPP_WALLET_POSSESSION, APP_SIGNER_SECRET_POSSESSION, TOTP_POSSESSION, EMAIL_POSSESSION, ID_DOC_POSSESSION_QES, ID_DOC_POSSESSION_AES, SOCIAL_SECURITY_NUMBER_POSSESSION, RA_PROCESS_VALIDATED_AES, RA_PROCESS_VALIDATED_QES, BANK_ACCOUNT_POSSESSION, NATURAL_PERSON_NAME, LEGAL_PERSON_NAME, PASS_KEY_POSSESSION, NATIONALITY, CORPORATE_SSO_ACCOUNT_POSSESSION, GOOGLE_ACCOUNT_POSSESSION, GITHUB_ACCOUNT_POSSESSION, BIRTH_COUNTRY, BIRTH_DATE, BIRTH_PLACE, CAN_APPROVE_SEAL_SES, CAN_APPROVE_SEAL_AES, CAN_APPROVE_SEAL_QES]

fromUserId string

The id of the user that have the same email as the signer and that is a user of the application or organization (into IgniSign)

]

documents

object[]

required

The list of documents that are linked to the signature request.

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 appEnv (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, PDF_ENCRYPTED, FILE, DATA_JSON, DATA_XML, PRIVATE_FILE]

Represents the type of document that can be signed to the Ignisign application.

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, 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 appEnv (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.

]

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[]

The list of statements that have been added to the signature request.

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 appEnv (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.

]

applicationMetadata

object

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.

appName stringrequired

appType IGNISIGN_APPLICATION_TYPE (string)required

Possible values: [SIGNATURE, SEAL, LOG_CAPSULE, BARE_SIGNATURE, WEB3_PROOF, IGNISIGN_RIGHT_DELEGATION]

Represents the type of an Ignisign application. - SIGNATURE: Represents a managed signature application. - SEAL: Represents a seal application. - LOG_CAPSULE: Represents a log capsule application (generation of logs certified by a Qualified Timestamp). - BARE_SIGNATURE: Represents a bare signature application (Signature though oAuth2 mechanism). - WEB3_PROOF: Not yet implemented. - IGNISIGN_RIGHT_DELEGATION: Internal Application used to validate rights between users and signers (mainly used for eSeal right management).

logoB64 string

logoDarkB64 string

colors

object

Custom color palette for the application applied in the end-user signature interface. The primary color is the main color of the application, and the secondary color is the secondary color of the application.

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

The URL to retrieve the signature proofs associated with the signature request if activated.

signatureProofStatus IGNISIGN_DOCUMENT_GENERATED_STATUS (string)

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

The current state of the signature proofs generation.

signerProfiles

object[]

a List of signer profiles linked to signers that have been invited to sign the signature request.

Array [

_id string

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.

name stringrequired

description string

status IGNISIGN_SIGNER_PROFILE_STATUS (string)required

Possible values: [ACTIVE, ARCHIVED]

Represents the status of a signer profile.

version numberrequired

isEmailProofSentByIgnisign booleanrequired

isRecurrent booleanrequired

integrationMode IGNISIGN_INTEGRATION_MODE (string)required

Possible values: [BY_SIDE, EMBEDDED]

Represents the integration mode of a signer profile.

ssoConfigId string

signatureAuthMethodsConfiguration

object

required

SIMPLE_STD

object

idProofings IGNISIGN_ID_PROOFING_METHOD_REF (string)[]

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, ORG_SSO_AES, ORG_SSO_QES]

authMethods IGNISIGN_AUTH_FULL_MECHANISM_REF (string)[]

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

ADVANCED_STD

object

idProofings IGNISIGN_ID_PROOFING_METHOD_REF (string)[]

authMethods IGNISIGN_AUTH_FULL_MECHANISM_REF (string)[]

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

QUALIFIED_STD

object

idProofings IGNISIGN_ID_PROOFING_METHOD_REF (string)[]

authMethods IGNISIGN_AUTH_FULL_MECHANISM_REF (string)[]

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

emailDomains string[]

signerIds string[]

]

{
  "_id": "string",
  "_createdAt": "2024-07-29T15:51:28.071Z",
  "appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
  "appEnv": "DEVELOPMENT",
  "signatureRequestType": "STANDARD",
  "title": "string",
  "description": "string",
  "language": "EN",
  "status": "DRAFT",
  "externalId": "string",
  "creatorId": "string",
  "documentIds": [
    "string"
  ],
  "signerIds": [
    "string"
  ],
  "signedBy": [
    "string"
  ],
  "expirationDate": "2024-07-29T15:51:28.071Z",
  "expirationDateIsActivated": true,
  "diffusionMode": "WHEN_READY",
  "diffusionDate": "2024-07-29T15:51:28.071Z",
  "initialSignatureRequestId": "string",
  "signerIdsAsApprover": [
    "string"
  ],
  "recipients": [
    "string"
  ],
  "appEnvSettingVersion": 0,
  "defaultSignatureMethod": "SIMPLE_STD",
  "signerProfilesUsed": [
    {
      "signerProfileId": "string",
      "signatureMethodRef": "SIMPLE_STD",
      "version": 0,
      "signerIds": [
        "string"
      ]
    }
  ],
  "individualizeRequests": true,
  "m2mId": "string",
  "signers": [
    {
      "signerId": "string",
      "externalId": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "status": "CREATED",
      "alreadyProvidedInputs": [
        "firstName"
      ],
      "isRecurrent": true,
      "signerProfileId": "string",
      "sealClaims": [
        "EID_POSSESSION_AES"
      ],
      "fromUserId": "string"
    }
  ],
  "documents": [
    {
      "_id": "string",
      "appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
      "appEnv": "DEVELOPMENT",
      "externalId": "string",
      "documentNature": "PDF",
      "fileName": "string",
      "fileSize": 0,
      "label": "string",
      "description": "string",
      "mimeType": "string",
      "documentHash": "string",
      "status": "CREATED",
      "documentRequestId": "string",
      "signatureRequestId": "string",
      "_createdAt": "2024-07-29T15:51:28.071Z",
      "statements": [
        {
          "_id": "string",
          "appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
          "appEnv": "DEVELOPMENT",
          "signatureRequestId": "string",
          "documentId": "string",
          "target": "SIGNATURE_REQUEST",
          "labelMd": "string"
        }
      ],
      "signatureSummaries": [
        {
          "signatureId": "string",
          "signerId": "string",
          "date": "2024-07-29T15:51:28.071Z"
        }
      ]
    }
  ],
  "statements": [
    {
      "_id": "string",
      "appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
      "appEnv": "DEVELOPMENT",
      "signatureRequestId": "string",
      "documentId": "string",
      "target": "SIGNATURE_REQUEST",
      "labelMd": "string"
    }
  ],
  "applicationMetadata": {
    "appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
    "appEnv": "DEVELOPMENT",
    "appName": "string",
    "appType": "SIGNATURE",
    "logoB64": "string",
    "logoDarkB64": "string",
    "colors": {
      "primary": {
        "50": "string",
        "100": "string",
        "200": "string",
        "300": "string",
        "400": "string",
        "500": "string",
        "600": "string",
        "700": "string",
        "800": "string",
        "900": "string",
        "A100": "string",
        "A200": "string",
        "A400": "string",
        "A700": "string"
      },
      "secondary": {
        "50": "string",
        "100": "string",
        "200": "string",
        "300": "string",
        "400": "string",
        "500": "string",
        "600": "string",
        "700": "string",
        "800": "string",
        "900": "string",
        "A100": "string",
        "A200": "string",
        "A400": "string",
        "A700": "string"
      }
    }
  },
  "signatureProofsUrl": "string",
  "signatureProofStatus": "NOT_INITIALIZED",
  "signerProfiles": [
    {
      "_id": "string",
      "appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
      "appEnv": "DEVELOPMENT",
      "name": "string",
      "description": "string",
      "status": "ACTIVE",
      "version": 0,
      "isEmailProofSentByIgnisign": true,
      "isRecurrent": true,
      "integrationMode": "BY_SIDE",
      "ssoConfigId": "string",
      "signatureAuthMethodsConfiguration": {
        "SIMPLE_STD": {
          "idProofings": [
            "VIDEO_ROBOT_AES"
          ],
          "authMethods": [
            "SIMPLE"
          ]
        },
        "ADVANCED_STD": {
          "idProofings": [
            "VIDEO_ROBOT_AES"
          ],
          "authMethods": [
            "SIMPLE"
          ]
        },
        "QUALIFIED_STD": {
          "idProofings": [
            "VIDEO_ROBOT_AES"
          ],
          "authMethods": [
            "SIMPLE"
          ]
        }
      },
      "emailDomains": [
        "string"
      ],
      "signerIds": [
        "string"
      ]
    }
  ]
}

Bad request error

application/json

Schema
Example (from schema)

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

Unauthorized error

application/json

Schema
Example (from schema)

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

Forbidden

application/json

Schema
Example (from schema)

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

Not Found

application/json

Schema
Example (from schema)

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

Timeout

application/json

Schema
Example (from schema)

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

Internal Error

application/json

Schema
Example (from schema)

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

Update a Signature Request

/v4/signature-requests/:signatureRequestId

Request​

Path Parameters

Body

Responses​

Request

Responses