Skip to main content

Get Signer Summary

GET 
/v3/applications/:appId/envs/:appEnv/signers/:signerId

This endpoint a summary of information for a specific signer.

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.

    signerId stringrequired

    The unique identifier of the signer to be revoked.

Responses​

The signer summary.

Schema

    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]

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

Loading...