Skip to main content

Get Signature Requests - Paginated

GET 
/v4/applications/:appId/envs/:appEnv/signature-requests

This endpoint retrieves all signature requests for a given application and environment.

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.

Query Parameters

    page integer

    The page number to return.

Responses​

Paginated signature requests.

Schema

    signatureRequests

    object[]

    required

    An array of signature requests, each represented by an IgnisignSignatureRequest_WithDocName object.

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

  • ]

    • paginationData

    object

    required

    The pagination data for the list of signature requests.

    total numberrequired

    The total number of signature requests.

    page numberrequired

    The current page number in the pagination.

    nbEventsPerPage numberrequired

    The number of signature request events per page.

Loading...