Skip to main content

Update a Signer

PUT 
/v4/applications/:appId/envs/:appEnv/signers/:signerId

This endpoint update a signer ( only field additions are possible except externalId and isRecurrent). isRecurrent can be updated, but, if the signer is recurrent, it can't be changed to one-off.

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.

Body

The details to update a signer (IgnisignSigner_UpdateRequestDto).

    signerId string

    The unique identifier of the signer to be updated.

    signerProfileId string

    The unique identifier of the signer profile that the signer which the signer will be associated. the fields needed to initiate the signers will depends of the configuration of the signer profile. more info: https://ignisign.io/docs/core-concepts/Signers_and_Claims

    externalId string

    An external identifier that can be used to identify the signer. It's a reference that can be used to identify the signer in the external system. Ignisign does not use internally this field to identify the signer.

    firstName string

    The first name of the signer.

    lastName string

    The last name of the signer.

    email string

    The email address of the signer.

    phoneNumber E.164

    the phone number of the signer.

    nationality iso 3166-1 alpha-2

    The nationality of the signer.

    birthDate date

    the date of birth of the signer.

    birthPlace string

    the place of birth of the signer.

    birthCountry iso 3166-1 alpha-2

    the country of birth of the signer.

Responses​

The created or upgraded signer.

Schema

    signerId stringrequired
    entityType IGNISIGN_SIGNER_ENTITY_TYPE (string)required

    Possible values: [NATURAL, SEAL]

    the type of the signer entity - For the moment, only NATURAL is supported.

    authSecret string

    the secret that have to be used to authenticate the signer in an embedded integration mode

    success booleanrequired

    Indicates whether the signer has been created successfully

    alreadyExists booleanrequired

    Indicates whether the signer already exists

Loading...