Get Application Context
GET/v3/applications/:appId/context
This endpoint retrieves the global context of an application.
Request
Path Parameters
The application identifier which is used to identify the application used.
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 500
The context of the applications.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
Array [
]
The application identifier which is used to identify the application used.
Possible values: [ACTIVE
, BLOCKED
, ARCHIVED
, ORG_ARCHIVED
]
config
object
required
the configuration linked to the application - this configuration is not yet realy used.
The application identifier which is used to identify the application used.
envSettings
object
required
DEVELOPMENT
object
required
This object represents the environment settings for an application.
The application identifier which is used to identify the application used.
The unique identifier of the organization that owns the application.
Possible values: [DEVELOPMENT
, STAGING
, PRODUCTION
]
The execution environment of the application where request are executed.
webhooks
object[]
required
A list of webhook settings for the application.
A unique string identifier for the webhook endpoint.
The URL where the webhook endpoint will send data to.
A human-readable description of the webhook endpoint. This can be used for documentation or additional context.
The date and time when the webhook endpoint was created, formatted as a string in ISO 8601 format.
The root URL of the application.
A list of URLs that are authorized for redirection from the application.
A flag indicating whether an API key has been generated for the application into this environment.
STAGING
object
required
This object represents the environment settings for an application.
The application identifier which is used to identify the application used.
The unique identifier of the organization that owns the application.
Possible values: [DEVELOPMENT
, STAGING
, PRODUCTION
]
The execution environment of the application where request are executed.
webhooks
object[]
required
A list of webhook settings for the application.
A unique string identifier for the webhook endpoint.
The URL where the webhook endpoint will send data to.
A human-readable description of the webhook endpoint. This can be used for documentation or additional context.
The date and time when the webhook endpoint was created, formatted as a string in ISO 8601 format.
The root URL of the application.
A list of URLs that are authorized for redirection from the application.
A flag indicating whether an API key has been generated for the application into this environment.
PRODUCTION
object
required
This object represents the environment settings for an application.
The application identifier which is used to identify the application used.
The unique identifier of the organization that owns the application.
Possible values: [DEVELOPMENT
, STAGING
, PRODUCTION
]
The execution environment of the application where request are executed.
webhooks
object[]
required
A list of webhook settings for the application.
A unique string identifier for the webhook endpoint.
The URL where the webhook endpoint will send data to.
A human-readable description of the webhook endpoint. This can be used for documentation or additional context.
The date and time when the webhook endpoint was created, formatted as a string in ISO 8601 format.
The root URL of the application.
A list of URLs that are authorized for redirection from the application.
A flag indicating whether an API key has been generated for the application into this environment.
settings
object
required
****************** COMMON SETTINGS ******************
The application identifier which is used to identify the application used.
Possible values: [EN
, FR
, DE
]
Represents the languages for signatures supported by a signature profile.
primaryColor
object
secondaryColor
object
signatureProfiles
object
required
DEVELOPMENT
object[]
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.
STAGING
object[]
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.
PRODUCTION
object[]
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.
{
"appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
"appName": "string",
"status": "ACTIVE",
"orgId": "string",
"_createdAt": "2024-07-29T15:51:28.071Z",
"config": {
"appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
"orgId": "string"
},
"envSettings": {
"DEVELOPMENT": {
"appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
"orgId": "string",
"appEnv": "DEVELOPMENT",
"webhooks": [
{
"_id": "string",
"url": "string",
"description": "string",
"_createdAt": "2024-07-29T15:51:28.071Z"
}
],
"appRootUrl": "string",
"authorizedRedirectionUrls": [
"string"
],
"isApiKeyGenerated": true
},
"STAGING": {
"appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
"orgId": "string",
"appEnv": "DEVELOPMENT",
"webhooks": [
{
"_id": "string",
"url": "string",
"description": "string",
"_createdAt": "2024-07-29T15:51:28.071Z"
}
],
"appRootUrl": "string",
"authorizedRedirectionUrls": [
"string"
],
"isApiKeyGenerated": true
},
"PRODUCTION": {
"appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
"orgId": "string",
"appEnv": "DEVELOPMENT",
"webhooks": [
{
"_id": "string",
"url": "string",
"description": "string",
"_createdAt": "2024-07-29T15:51:28.071Z"
}
],
"appRootUrl": "string",
"authorizedRedirectionUrls": [
"string"
],
"isApiKeyGenerated": true
}
},
"settings": {
"appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
"orgId": "string",
"customerSupportEmail": "string",
"defaultLanguage": "EN",
"logoB64": "string",
"logoDarkB64": "string",
"primaryColor": {
"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"
},
"secondaryColor": {
"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"
}
},
"signatureProfiles": {
"DEVELOPMENT": [
{
"_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
}
],
"STAGING": [
{
"_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
}
],
"PRODUCTION": [
{
"_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": {}
}