Skip to main content

Get a Document Context

GET 
/v4/documents/:documentId/context

This endpoint retrieves the context of a specific document.

Request​

Path Parameters

    documentId stringrequired

    The unique identifier of the document.

Responses​

The retrieved document context.

Schema

    _id string

    A unique string identifier for the document context.

    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 context 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, typically 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]

    Represents the current status of a document in the Ignisign application.

    documentRequestId string

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

    signatureRequestId stringrequired

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

    _createdAt date-time

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

    statements

    object[]

    The statements related to the document.

  • Array [

    • _id string

    A unique string identifier for the signature request statement.

    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.

    signatureRequestId stringrequired

    The unique identifier of the signature request associated with this statement.

    documentId string

    If target value is 'DOCUMENT', this value is unique identifier of the document associated with this statement.

    target IGNISIGN_SIGNATURE_REQUEST_STATEMENT_TARGET (string)required

    Possible values: [SIGNATURE_REQUEST, DOCUMENT]

    The target of the signature request statement. This can be 'SIGNATURE_REQUEST' or 'DOCUMENT'.

    labelMd string

    The label of the statement represented in MD format.

  • ]

    • signatureSummaries

    object[]

    required

    The signatures associated with the document context.

  • Array [

    • signatureId stringrequired

    The unique identifier of the signature.

    signerId stringrequired

    The unique identifier of the signer who provided the signature.

    date date-timerequired

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

  • ]

Loading...