Skip to main content

Update Document Information

PUT 
/v4/documents/:documentId

This endpoint allows to update information about a specific document.

Request​

Path Parameters

    documentId stringrequired

    The unique identifier of the document.

Body

The document details for update.

    label string

    A user-friendly label to identify the document.

    description string

    A detailed, human-readable description of the document.

    externalId string

    An optional external identifier that can be used to reference the document from external systems. It's a free text. Ignisign's system do not interprete it.

    templateDisplayerId string
    templateDisplayerVersion number

Responses​

The updated document.

Schema

    _id string

    A unique string identifier for the document.

    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.

    externalId string

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

    documentNature IGNISIGN_DOCUMENT_TYPE (string)required

    Possible values: [PDF, PDF_ENCRYPTED, FILE, DATA_JSON, DATA_XML, PRIVATE_FILE]

    Represents the type of document that can be signed to the Ignisign application.

    fileName string

    The name of the file associated with the document.

    fileSize number

    The size of the file associated with the document, in bytes.

    label string

    A user-friendly label to identify the document.

    description string

    A detailed, human-readable description of the document.

    mimeType string

    The MIME type of the file associated with the document, such as 'application/pdf' for PDF files.

    documentHash stringrequired

    The hash of the document

    status IGNISIGN_DOCUMENT_STATUS (string)required

    Possible values: [CREATED, PROVIDED, ARCHIVED]

    The current status of the document.

    signatureRequestId stringrequired

    The unique identifier of the signature request associated with the document.

    dataJsonContent string

    The JSON content stringify of the document

    relatedDocumentId string

    If the document have been generated from an other the unique identifier of the related document.

    relatedDocumentType IGNISIGN_DOCUMENT_TYPE (string)

    Possible values: [PDF, PDF_ENCRYPTED, FILE, DATA_JSON, DATA_XML, PRIVATE_FILE]

    Represents the type of document that can be signed to the Ignisign application.

    _createdAt date-time

    The date and time when the document was created, formatted as a string in ISO 8601 format.

Loading...