Skip to main content

Create a Document

POST 
/v3/applications/:appId/envs/:appEnv/init-documents

This endpoint allow to initialize a document.
A document is linked to a signature request.
Before providing the content of the document, each document need to be initialized.
This create a document object that will be used to link document.
This method is a part of the Signature Request Creation Api Life Cycle.

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.

Body

The document initialization information.

    signatureRequestId stringrequired

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

    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.

Responses​

A simple container including the id of the document initializad.

Schema

    documentId string

    The id of the document initialized.

Loading...