Skip to main content

Get Signature Profiles

GET 
/v3/applications/:appId/envs/:appEnv/signature-profiles

This endpoint retrieves all signature profiles for a given application.

Request​

Path Parameters

    appId stringrequired

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

    Example: appId_XXXX-XXXX-XXXX-XXXX-XXXX
    appEnv stringrequired

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

Responses​

An array of signature profiles.

Schema

  • Array [

    • _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.

  • ]

Loading...