get SignatureRequest

ApiScope: payment.signaturerequest.fetch
API Scope Level: ServiceSubscriberScope

Query Parameters

signatureRequestDTO object required

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

Schema

Example (from schema)

---

Schema

error object
errorCode string
errorDescription string
warnings object[]
Array [
warningCode string
warningDescription string
]
id int64
uuid string
signatureCaptureUrl string
signedDocumentUrl string
spiRequestID int64
spiRequestUUID string
documents object[]
Array [
id int64
signatureRequestID int64
name string
documentUrl string
insertTs date-time
updateTs date-time
]
signers object[]
Array [
id int64
signatureRequestID int64
firstName string
lastName string
email string
phone string
insertTs date-time
updateTs date-time
]
isSigned boolean
successCallbackUrl string
renewCount int32
signedInvoiceEmailed boolean

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string"
  },
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ],
  "id": 0,
  "uuid": "string",
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestID": 0,
  "spiRequestUUID": "string",
  "documents": [
    {
      "id": 0,
      "signatureRequestID": 0,
      "name": "string",
      "documentUrl": "string",
      "insertTs": "2025-10-30T17:04:38.688Z",
      "updateTs": "2025-10-30T17:04:38.688Z"
    }
  ],
  "signers": [
    {
      "id": 0,
      "signatureRequestID": 0,
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string",
      "insertTs": "2025-10-30T17:04:38.688Z",
      "updateTs": "2025-10-30T17:04:38.688Z"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}

Bad Request

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Unauthorized

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Internal Server Error

*/*

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
errorDescription string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
warningDescription string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string",
      "errorDescription": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string",
      "warningDescription": "string"
    }
  ]
}

Loading...