Sign M2M

POST 
/v4/applications/:appId/envs/:appEnv/m2m/:m2mId/sign

This endpoint allows signing a document using the M2M (Machine-to-Machine) process.

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.

m2mId stringrequired

The unique identifier of the M2M to use.

application/json

Body

m2mId stringrequired
title string

document

object

required

anyOf

IgniSign_SignM2MDocumentHashRequestDto

documentType 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.

documentHash stringrequired

label string

IgniSign_SignM2MDocumentContentRequestDto

documentType 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.

documentHash stringrequired

label string

contentB64 stringrequired

mimeType string

IgniSign_SignM2MDocumentXMLRequestDto

documentType 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.

documentHash stringrequired

label string

xmlContent stringrequired

IgniSign_SignM2MDocumentJSONRequestDto

documentType 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.

documentHash stringrequired

label string

jsonContent required

templateDisplayerId string

templateDisplayerVersion number
externalId string
documentHashSignedByM2MPrivateKey stringrequired

Responses

200

The M2M signature response.

application/json

Schema

Schema

signatureRequestId stringrequired
documentId stringrequired
documentHash stringrequired

Example (from schema)

{
  "signatureRequestId": "string",
  "documentId": "string",
  "documentHash": "string"
}

400

Bad request error

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

401

Unauthorized error

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

403

Forbidden

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

500

Internal Error

application/json

Schema

Schema

message stringrequired

The main message related to the error. It should provide an explanation or additional information about the error.

timestamp date-timerequired

The timestamp when the error occurred, represented in UTC. It follows the format 'YYYY-MM-DD HH:mm:ss ZZ'.

status integerrequired

The HTTP status code associated with the error. It indicates the status of the corresponding HTTP response.

code stringrequired

The error code. It should be one of the IGNISIGN_ERROR_CODES (not linked here due to the high number of possible codes).

context object

Additional contextual information related to the error. This object can contain any relevant properties.

Example (from schema)

{
  "message": "string",
  "timestamp": "2024-07-29T15:51:28.071Z",
  "status": 0,
  "code": "string",
  "context": {}
}

Loading...