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
The unique identifier of the document.
- application/json
Body
The private content for the document.
the SHA-256 hash of the document that will be signed.
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 500
The updated document with provided private content.
- application/json
- Schema
- Example (from schema)
Schema
A unique string identifier for the document.
The application identifier which is used to identify the application used.
Possible values: [DEVELOPMENT
, STAGING
, PRODUCTION
]
The execution environment of the application where request are executed.
An optional external identifier that can be used to reference the document from external systems.
Possible values: [PDF
, FILE
, DATA_JSON
, PRIVATE_FILE
]
The type of document
The name of the file associated with the document.
The size of the file associated with the document, in bytes.
A user-friendly label to identify the document.
A detailed, human-readable description of the document.
The MIME type of the file associated with the document, such as 'application/pdf' for PDF files.
The hash of the document
Possible values: [CREATED
, DOCUMENT_REQUEST
, PROVIDED
, ARCHIVED
]
The current status of the document.
The unique identifier of the document request associated with this document.
The unique identifier of the signature request associated with the document.
The JSON content stringify of the document
If the document have been generated from an other the unique identifier of the related document.
Possible values: [PDF
, FILE
, DATA_JSON
, PRIVATE_FILE
]
If the document have been generated from an other the type of the related document.
The date and time when the document was created, formatted as a string in ISO 8601 format.
{
"_id": "string",
"appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
"appEnv": "DEVELOPMENT",
"externalId": "string",
"documentNature": "PDF",
"fileName": "string",
"fileSize": 0,
"label": "string",
"description": "string",
"mimeType": "string",
"documentHash": "string",
"status": "CREATED",
"documentRequestId": "string",
"signatureRequestId": "string",
"dataJsonContent": "string",
"relatedDocumentId": "string",
"relatedDocumentType": "PDF",
"_createdAt": "2024-06-14T12:34:38.111Z"
}
Bad request error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-06-14T12:34:38.111Z",
"status": 0,
"code": "string",
"context": {}
}
Unauthorized error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-06-14T12:34:38.111Z",
"status": 0,
"code": "string",
"context": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-06-14T12:34:38.111Z",
"status": 0,
"code": "string",
"context": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-06-14T12:34:38.112Z",
"status": 0,
"code": "string",
"context": {}
}
Timeout
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-06-14T12:34:38.112Z",
"status": 0,
"code": "string",
"context": {}
}
Internal Error
- application/json
- Schema
- Example (from schema)
Schema
The main message related to the error. It should provide an explanation or additional information about the error.
The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.
The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.
The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).
Additional contextual information related to the error. This object can contain any relevant properties.
{
"message": "string",
"timestamp": "2024-06-14T12:34:38.112Z",
"status": 0,
"code": "string",
"context": {}
}