create a new SignatureRequest

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

application/json

Request Body required

signatureCaptureUrl string
signedDocumentUrl string
spiRequestUUID string
spiRequestID int64 deprecated
documents object[]
Array [
name string
fileUri string
spiRequestUuid string
]
signers object[]
Array [
firstName string
lastName string
email string
phone string
]
isSigned boolean
successCallbackUrl string
renewCount int32
signedInvoiceEmailed boolean

Responses

• 200
• 400
• 401
• 500

---

OK

application/json

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
]
uuid string
spiRequestUuid string
signatureCaptureUrl string
signedDocumentUrl string
spiRequestId int64 deprecated
paymentSignatureRequestId int64 deprecated

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

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"
    }
  ]
}

POST /kpayment/v1/esign/signature-requests

Request

Base URL

/payment

Body required

{
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestUUID": "string",
  "documents": [
    {
      "name": "string",
      "fileUri": "string",
      "spiRequestUuid": "string"
    }
  ],
  "signers": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}

curl / cURL

curl -L -X POST '/payment/kpayment/v1/esign/signature-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestUUID": "string",
  "documents": [
    {
      "name": "string",
      "fileUri": "string",
      "spiRequestUuid": "string"
    }
  ],
  "signers": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}'

python / requests

curl -L -X POST '/payment/kpayment/v1/esign/signature-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestUUID": "string",
  "documents": [
    {
      "name": "string",
      "fileUri": "string",
      "spiRequestUuid": "string"
    }
  ],
  "signers": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}'

go / native

curl -L -X POST '/payment/kpayment/v1/esign/signature-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestUUID": "string",
  "documents": [
    {
      "name": "string",
      "fileUri": "string",
      "spiRequestUuid": "string"
    }
  ],
  "signers": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}'

nodejs / axios

curl -L -X POST '/payment/kpayment/v1/esign/signature-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestUUID": "string",
  "documents": [
    {
      "name": "string",
      "fileUri": "string",
      "spiRequestUuid": "string"
    }
  ],
  "signers": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}'

ruby / Net::HTTP

curl -L -X POST '/payment/kpayment/v1/esign/signature-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestUUID": "string",
  "documents": [
    {
      "name": "string",
      "fileUri": "string",
      "spiRequestUuid": "string"
    }
  ],
  "signers": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}'

csharp / RestSharp

curl -L -X POST '/payment/kpayment/v1/esign/signature-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestUUID": "string",
  "documents": [
    {
      "name": "string",
      "fileUri": "string",
      "spiRequestUuid": "string"
    }
  ],
  "signers": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}'

php / cURL

curl -L -X POST '/payment/kpayment/v1/esign/signature-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestUUID": "string",
  "documents": [
    {
      "name": "string",
      "fileUri": "string",
      "spiRequestUuid": "string"
    }
  ],
  "signers": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}'

java / OkHttp

curl -L -X POST '/payment/kpayment/v1/esign/signature-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestUUID": "string",
  "documents": [
    {
      "name": "string",
      "fileUri": "string",
      "spiRequestUuid": "string"
    }
  ],
  "signers": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}'

powershell / RestMethod

curl -L -X POST '/payment/kpayment/v1/esign/signature-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "signatureCaptureUrl": "string",
  "signedDocumentUrl": "string",
  "spiRequestUUID": "string",
  "documents": [
    {
      "name": "string",
      "fileUri": "string",
      "spiRequestUuid": "string"
    }
  ],
  "signers": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phone": "string"
    }
  ],
  "isSigned": true,
  "successCallbackUrl": "string",
  "renewCount": 0,
  "signedInvoiceEmailed": true
}'