Get Signer Profile

GET 
/v4/applications/:appId/envs/:appEnv/signer-profiles/:signerProfileId

This endpoint retrieves a signer profile by its ID.

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.

signerProfileId stringrequired

The unique identifier of the related signer profile.

Responses

200

The signer profile details.

application/json

Schema

Schema

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

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]

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

emailDomains string[]
signerIds string[]

Example (from schema)

{
  "_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"
  ]
}

400

Bad request error

application/json

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.

Example (from schema)

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

401

Unauthorized error

application/json

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.

Example (from schema)

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

403

Forbidden

application/json

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.

Example (from schema)

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

404

Not Found

application/json

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.

Example (from schema)

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

500

Internal Error

application/json

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.

Example (from schema)

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

Loading...