Update a Signature Profile Status
PUT/v3/applications/:appId/envs/:appEnv/signature-profiles/:signatureProfileId/status
This endpoint updates the status of a signature profile for a given application.
Request
Path Parameters
The application identifier which is used to identify the application used.
Possible values: [DEVELOPMENT
, STAGING
, PRODUCTION
]
The execution environment of the application where request are executed.
The unique identifier of the signature profile.
- application/json
Body
The status of the signature profile.
Possible values: [PUBLISHED
, ARCHIVED
]
Represents the current status of a signature profile in the Ignisign application.
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 500
The updated signature profile.
- application/json
- Schema
- Example (from schema)
Schema
A unique string identifier for the signature profile.
The application identifier which is used to identify the application used.
Possible values: [DEVELOPMENT
, STAGING
, PRODUCTION
]
The execution environment of the application where request are executed.
The unique identifier of the organization associated with this signature profile.
The name of the signature profile.
Possible values: [PUBLISHED
, ARCHIVED
]
Represents the current status of a signature profile in the Ignisign application.
Possible values: [BY_SIDE
, EMBEDDED
]
Represents the integration mode of a signature profile.
Possible values: [SIMPLE_STD
, ADVANCED_STD
, QUALIFIED_STD
]
Represents the method used for signatures in a signature profile in the Ignisign application.
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.
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.
Possible values: [SIMPLE
, PHONE_SMS
, PHONE_CALL
, TOTP
, PASS_KEY_POSSESSION
, AES_EID
, QES_EID
]
The authentication methods used in this signature profile.
Possible values: [PDF
, FILE
, DATA_JSON
, PRIVATE_FILE
]
The types of documents supported by this signature profile.
Indicates whether document requests are activated in this signature profile.
Possible values: [EN
, FR
, DE
]
Represents the languages for signatures supported by a signature profile.
Indicates whether the language can be changed during the signature request creation.
Indicates whether statements are enabled in this signature profile.
The unique identifier of the template displayer associated with this signature profile in case of document type is DATA_JSON.
Indicates whether the signature profile has been created has a by default signature profile.
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.
Indicates whether the approver is enabled for signature request created from this signature profile.
Indicates whether the recipient is enabled for signature request created from this signature profile.
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.
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.
{
"_id": "string",
"appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
"appEnv": "DEVELOPMENT",
"orgId": "string",
"name": "string",
"status": "PUBLISHED",
"integrationMode": "BY_SIDE",
"signatureMethodRef": "SIMPLE_STD",
"signatureRequestType": "STANDARD",
"idProofings": [
"VIDEO_ROBOT_AES"
],
"authMethods": [
"SIMPLE"
],
"documentTypes": [
"PDF"
],
"documentRequestActivated": true,
"defaultLanguage": "EN",
"languageCanBeChanged": true,
"statementsEnabled": true,
"templateDisplayerId": "string",
"createdByDefault": true,
"extendedAuthSessionEnabled": true,
"approverEnabled": true,
"recipientEnabled": true,
"individualizeRequests": true,
"sharingRestricted": true
}
Bad request error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
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
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
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
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
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
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
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
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
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
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
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": {}
}