Get Bare Signature Proofs

GET 
/v4/envs/:appEnv/bare-signatures/proofs

This endpoint retrieves proofs for a bare signature.

Request

Path Parameters

appEnv stringrequired

Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

The execution environment of the application where request are executed.

Header Parameters

Authorization stringrequired

Bearer token for authorization

Responses

200

List of bare signature proofs.

application/json

Schema

Schema

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
externalId string
signerId stringrequired

proofs

object[]

required

Array [

documentId stringrequired

type IGNISIGN_SIGNATURE_PROOF_TYPE (string)required

Possible values: [PDF_WITH_SIGNATURES, PROOF_WEB_PAGE, C2PA, ADVANCED_LEGAL_KIT, XADES, CADES, PKCS7, JWS]

documentHash stringrequired

proofB64 stringrequired

timestampSequence string

signingTime date-time

]

signerInformation

object

required

fullName stringrequired

lastName string

firstName string

Example (from schema)

{
  "appId": "appId_XXXX-XXXX-XXXX-XXXX-XXXX",
  "appEnv": "DEVELOPMENT",
  "signatureRequestId": "string",
  "externalId": "string",
  "signerId": "string",
  "proofs": [
    {
      "documentId": "string",
      "type": "PDF_WITH_SIGNATURES",
      "documentHash": "string",
      "proofB64": "string",
      "timestampSequence": "string",
      "signingTime": "2024-07-29T15:51:28.071Z"
    }
  ],
  "signerInformation": {
    "fullName": "string",
    "lastName": "string",
    "firstName": "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...