Skip to main content

Provide Document Content - Private file

POST 
/v3/documents/:documentId/private-content

This endpoint provides private content for a document.
This method is a part of the Signature Request Creation Api Life Cycle.

Request​

Path Parameters

    documentId stringrequired

    The unique identifier of the document.

Body

The private content for the document.

    documentHash stringrequired

    the SHA-256 hash of the document that will be signed.

Responses​

The updated document with provided private content.

Schema

    _id string

    A unique string identifier for the document.

    appId appIdrequired

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

    appEnv IGNISIGN_APPLICATION_ENVrequired

    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_TYPErequired

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

    The type of document

    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_STATUSrequired

    Possible values: [CREATED, DOCUMENT_REQUEST, PROVIDED, ARCHIVED]

    The current status of the document.

    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.

    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

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

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

    _createdAt date-time

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

Loading...