Skip to main content

Get a Signer with details

GET 
/v4/applications/:appId/envs/:appEnv/signers/:signerId/details

This endpoint retrieves details 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.

Responses​

The signer details.

Schema

    signerId string

    Unique identifier for the signer

    externalId string

    External identifier for the signer

    firstName string

    First name of the signer

    lastName string

    Last name of the signer

    email string

    Email of the signer

    status IGNISIGN_SIGNER_STATUS (string)

    Possible values: [CREATED, PENDING, BLOCKED, ACTIVE, CORRUPTED]

    The status of the signer.

    alreadyProvidedInputs IGNISIGN_SIGNER_CREATION_INPUT_REF (string)[]

    Possible values: [firstName, lastName, email, phoneNumber, nationality, birthDate, birthPlace, birthCountry]

    isRecurrent boolean
    signerProfileId string
    sealClaims IGNISIGN_SIGNER_CLAIM_REF (string)[]

    Possible values: [EID_POSSESSION_AES, EID_POSSESSION_QES, PHONE_NUMBER_POSSESSION, PRIVATE_KEY_POSSESSION, DAPP_WALLET_POSSESSION, APP_SIGNER_SECRET_POSSESSION, TOTP_POSSESSION, EMAIL_POSSESSION, ID_DOC_POSSESSION_QES, ID_DOC_POSSESSION_AES, SOCIAL_SECURITY_NUMBER_POSSESSION, RA_PROCESS_VALIDATED_AES, RA_PROCESS_VALIDATED_QES, BANK_ACCOUNT_POSSESSION, NATURAL_PERSON_NAME, LEGAL_PERSON_NAME, PASS_KEY_POSSESSION, NATIONALITY, CORPORATE_SSO_ACCOUNT_POSSESSION, GOOGLE_ACCOUNT_POSSESSION, GITHUB_ACCOUNT_POSSESSION, BIRTH_COUNTRY, BIRTH_DATE, BIRTH_PLACE, CAN_APPROVE_SEAL_SES, CAN_APPROVE_SEAL_AES, CAN_APPROVE_SEAL_QES]

    fromUserId string

    The id of the user that have the same email as the signer and that is a user of the application or organization (into IgniSign)

    claims

    object[]

    required

  • Array [

    • claimRef IGNISIGN_SIGNER_CLAIM_REF (string)required

    Possible values: [EID_POSSESSION_AES, EID_POSSESSION_QES, PHONE_NUMBER_POSSESSION, PRIVATE_KEY_POSSESSION, DAPP_WALLET_POSSESSION, APP_SIGNER_SECRET_POSSESSION, TOTP_POSSESSION, EMAIL_POSSESSION, ID_DOC_POSSESSION_QES, ID_DOC_POSSESSION_AES, SOCIAL_SECURITY_NUMBER_POSSESSION, RA_PROCESS_VALIDATED_AES, RA_PROCESS_VALIDATED_QES, BANK_ACCOUNT_POSSESSION, NATURAL_PERSON_NAME, LEGAL_PERSON_NAME, PASS_KEY_POSSESSION, NATIONALITY, CORPORATE_SSO_ACCOUNT_POSSESSION, GOOGLE_ACCOUNT_POSSESSION, GITHUB_ACCOUNT_POSSESSION, BIRTH_COUNTRY, BIRTH_DATE, BIRTH_PLACE, CAN_APPROVE_SEAL_SES, CAN_APPROVE_SEAL_AES, CAN_APPROVE_SEAL_QES]

    A reference that determinates the claim type.

    • EID_POSSESSION_AES : The signer's claim is related to the possession of an eID (valid for Advanced Electronic Signature only).
    • EID_POSSESSION_QES : The signer's claim is related to the possession of an eID (valid for Qualified Electronic Signature and Advanced Electronic Signature).
    • PHONE_NUMBER_POSSESSION : The signer's claim is related to the possession of a phone number.
    • PRIVATE_KEY_POSSESSION : The signer 's claim is related to the possession of a private key.
    • DAPP_WALLET_POSSESSION : The signer 's claim is related to the possession of a dApp wallet.
    • APP_SIGNER_SECRET_POSSESSION : this claim means that the signer have been initialized to be able to sign in the embedded mode. Ignisign has provide the client application with a secret that need to be provided when thesigner want to initialize a signature in the embedded mode.
      more info: https://ignisign.io/docs/core-concepts/Embeded_or_By-Side_Integration
    • TOTP_POSSESSION : claim related to the associatiation of it's account with a TOPT (Google Authenticator like application).
    • EMAIL_POSSESSION : The signer's claim is related to the possession of an email.
    • ID_DOC_POSSESSION_QES : The signer's claim is related to the possession of an ID document (valid for Qualified Electronic Signature and Advanced Electronic Signature).
    • ID_DOC_POSSESSION_AES : The signer's claim is related to the possession of an ID document (valid for Advanced Electronic Signature only).
    • RA_PROCESS_VALIDATED_AES : The signer's claim is related to the identification throw a delegation of the registration authority to the organization that owns the application linked to the signer (valid for Advanced Electronic Signature only).
    • RA_PROCESS_VALIDATED_QES : The signer's claim is related to the identification throw delegation of the registration authority to the organization that owns the application linked to the signer (valid for Qualified Electronic Signature and Advanced Electronic Signature).
    • BANK_ACCOUNT_POSSESSION : The signer 's claim is related to a the bank account.
    • NATURAL_PERSON_NAME : The signer's claim is related to natural name of the signer.
    • LEGAL_PERSON_NAME : The signer's claim is related to legal name of the signer.
    • PASS_KEY_POSSESSION : The signer's claim is related to the possession of a passKey. More Info: https://fidoalliance.org/passkeys/
    • NATIONALITY: The signer's claim is related to the nationality of the signer.
    • CORPORATE_SSO_ACCOUNT_POSSESSION : The signer's claim is related to the possession of a corporate SSO account.
    • GOOGLE_ACCOUNT_POSSESSION : The signer's claim is related to the possession of a Google account.
    • GITHUB_ACCOUNT_POSSESSION : The signer's claim is related to the possession of a GitHub account.
    • BIRTH_COUNTRY : The signer's claim is related to the birth country of the signer.
    • BIRTH_DATE : The signer's claim is related to the birth date of the signer.
    • BIRTH_PLACE : The signer's claim is related to the birth place of the signer.
    • CAN_APPROVE_SEAL_SES : The signer's claim is related to the ability to approve a seal with a Simple Electronic Signature.
    • CAN_APPROVE_SEAL_AES : The signer's claim is related to the ability to approve a seal with an Advanced Electronic Signature.
    • CAN_APPROVE_SEAL_QES : The signer's claim is related to the ability to approve a seal with a Qualified Electronic Signature.
    status IGNISIGN_SIGNER_CLAIM_STATUS (string)required

    Possible values: [DECLARED, VERIFIED, REJECTED, DEPRECATED]

    The status of the claim.

    • DECLARED : The claim as been declared by an application operator
    • VERIFIED : The claim has been verified
    • REJECTED : The claim has been rejected during a verification process
    • DEPRECATED : The claim has been deprecated.
      https://ignisign.io/docs/core-concepts/Signers_and_Claims

  • ]

    • latestSignatureRequests

    object[]

    required

  • Array [

    • _id string
    _createdAt date-time
    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.

    signatureRequestType IGNISIGN_SIGNATURE_REQUEST_TYPE (string)required

    Possible values: [STANDARD, SIGNER_SETUP, SEAL, SEAL_M2M, BARE_SIGNATURE]

    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.

    title string

    The title of the signature request.

    description string

    The description of the signature request.

    language IGNISIGN_SIGNATURE_LANGUAGES (string)

    Possible values: [EN, FR, DE, ES, IT, PT, NL, PL, JA, KO, AR, HE]

    Represents the languages for signatures supported by a signature profile.

    status IGNISIGN_SIGNATURE_REQUEST_STATUS (string)required

    Possible values: [DRAFT, WAITING_DOCUMENTS_GENERATION, READY, IN_PROGRESS, COMPLETED, EXPIRED, FAILED, CANCELLED, PROCESSING, CHILDREN_GENERATED]

    Represents the current status of a signature request in the Ignisign application.

    externalId string

    a free field to store an identifier that can be used to link the signature request to an external system.

    creatorId string

    The id of the user who created the signature request if this has been made into the IgniSign User interface.

    documentIds string[]

    The ids of the documents that are linked to the signature request.

    signerIds string[]

    The ids of the signers that have been invited to sign the signature request.

    signedBy string[]

    The ids of the signers that have already signed the signature request.

    expirationDate date-time

    The expiration date if the expirationDateIsActivated parameter is true The action linked to this date is performed every 5 minutes, at 5, 10, 15... 55.

    expirationDateIsActivated boolean

    Indicates whether the expiration date is activated.

    diffusionMode IGNISIGN_SIGNATURE_REQUEST_DIFFUSION_MODE (string)

    Possible values: [WHEN_READY, SCHEDULED]

    Represents the diffusion mode of a signature request.

    • WHEN_READY : The signature request will be sent to the signer as soon it is ready to be signed. This is the default value.
      I.E: If there are no document request, the signature request will be sent to the signer as soon as the signature request is PUBLISHED.
      If there are document request, the signature request will be sent to the signer as soon as all the document request are have been completed.
    • SCHEDULED : The signature request will be sent to the signer at a specific date. This date is specified in the diffusionDate field
    diffusionDate date-time

    the diffusion date if diffusionModeparameter is SCHEDULED The action linked to this date is performed every 5 minutes, at 5, 10, 15... 55.

    initialSignatureRequestId string

    If the signature request has been created from a signature profile with the individualizeRequests option activated, this field will contain the identifier of the initial signature request which it has been generated.

    signerIdsAsApprover string[]

    the ids of signers that will be approvers

    recipients string[]

    the emails of signers that will receive a copy of the signed document

    appEnvSettingVersion number

    The version of the application environment settings used to create this signature request.

    defaultSignatureMethod IGNISIGN_SIGNATURE_METHOD_REF (string)required

    Possible values: [SIMPLE_STD, ADVANCED_STD, QUALIFIED_STD]

    Represents the method used for signatures in a signature requests in an Ignisign application.

    signerProfilesUsed

    object[]

  • Array [

    • signerProfileId stringrequired
    signatureMethodRef IGNISIGN_SIGNATURE_METHOD_REF (string)required

    Possible values: [SIMPLE_STD, ADVANCED_STD, QUALIFIED_STD]

    Represents the method used for signatures in a signature requests in an Ignisign application.

    version numberrequired
    signerIds string[]required

  • ]

    • individualizeRequests boolean

    Indicates whether the signature request has been created with the individualizeRequests option activated. If activated, each signer will receive a separate signature request. Approvers will be included in each signature requests.

    m2mId string

    Used only for M2M signature requests. The identifier of the M2M signature request. du not update directly this field.

    docFileName string

    The name of the first document that is linked to the signature request.

    docLabel string

    The label ( title ) of the first document that is linked to the signature request.

  • ]

Loading...