Skip to main content

Get a Signer with details

GET 
/v3/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]

    The status of the signer.

    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, BIRTH_INFO]

    A reference that determinates the claim type.

    • EID_POSSESSION : The signer's claim is related to the possession of an eID.
    • 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.
    • BIRTH_INFO: The signer's claim is related to the birth information of the signer.
    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

    The unique identifier of the signature request.

    appId appId (string)required

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

    appEnv IGNISIGN_APPLICATION_ENV (string)required

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

    signatureProfileId stringrequired

    The identifier of the signature profile associated with the signature request.

    title string

    The title of the signature request.

    description string

    The description or details about the signature request.

    expirationDate date-time

    The expiration date of the signature request.

    expirationDateIsActivated boolean

    Indicates whether the expiration date is activated for the signature request.

    status IGNISIGN_SIGNATURE_REQUEST_STATUS (string)required

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

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

    language IGNISIGN_SIGNATURE_LANGUAGES (string)

    Possible values: [EN, FR, DE]

    Represents the languages for signatures supported by a signature profile.

    documentIds string[]

    An array of document identifiers associated with the signature request.

    externalId string

    An optional external identifier that can be used to reference the signature request from external systems.

    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 date when the signature request is to be diffused.

    signerIds string[]

    An array of signer identifiers associated with the signature request.

    signedBy string[]

    An array of identifiers of the signers who have signed the signature request.

    _createdAt date-time

    The date and time when the signature request was created.

    creatorId string

    The unique identifier of the user who created the signature request.

    docFileName string

    The name of the document associated with the signature request.

    docLabel string

    The label or title of the document associated with the signature request.

    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.

    signersAsApprover string[]

    the ids of signers that will be approvers

    recipients string[]

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

  • ]

Loading...