Create

Eslatma

Hujjat imzolangandan so‘ng, oldingi sahifaga qaytish uchun webimzo ga quyidagi URL orqali so‘rov yuboring:
https://webimzo.uz/test/?requestId={RequestId}&secretKey={SecretKey}&redirect={RedirectUrl}

🔹 redirect - bu imzolash jarayonidan so‘ng foydalanuvchini qaytarish kerak bo‘lgan sahifaning havolasi.

POST /v1/SignRequest/Create

Authentication

• Type: Basic Authentication
• Credentials:
  • Username: <your_username>
  • Password: <your_password>

Request Headers

• Content-Type: application/json
• Accept: text/plain

Request Body example

Field	Type	Required	Description
apiKey	string	yes	API key to authenticate the request.
isAllowMultiple	boolean	yes	Indicates if multiple entries are allowed.
isForceCreate	boolean	yes	Forces the creation of the entry even if one already exists.
signatureMethodIds	integer[]	yes	List of signature method IDs to be used.
signData	string	yes	The data to be signed.
signRequestActionTypes	array	no	Array of sign request action types (see detailed structure below).
signRequestUsers	array	yes	Array of the document signers (see detailed structure below).
tableId	integer	yes	The ID of the table associated with the document.
title	string	no	The title of the document.
documentId	long	yes	The unique ID of the document.
documentIdAsString	string	no	Document ID as a string (optional).
documentType	string	no	The type of the document.
signDataTypeId	integer	no	The ID indicating the type of the sign data.
signDataFileExt	string	no	File extension of the sign data.
hashAlgorithmId	integer	no	The ID of the hash algorithm used for hashing sign data.
printableLink	string	yes	The link to the printable document.
printableLinkExt	string	no	The file extension of the printable link (optional).
templateId	integer	no	The ID of the template associated with the document signing.
organizationName	string	no	The name of the organization associated with the document.
organizationInn	string	no	The identifier of the organization associated with the document.
isVisibleToOthers	boolean	yes	Indicates whether the signers is visible to others.

signRequestUsers

Field	Type	Required	Description
docStatusId	integer	yes	The ID representing the document's status.
userInfo	string	yes	Information about the signer.
userKey	string	yes	The PINFL key associated with the signer.
userId	integer	no	The unique ID of the signer.
signPriority	integer	no	The priority level of signer for signing the document.
ipAddress	string	no	The IP address of the signer.
userAgent	string	no	The user agent string (browser info).
userPhoneNumber	string	no	The signer's phone number.
parentUserKey	string	no	The parent user key associated with the signer.

signRequestActionTypes

Field	Type	Required	Description
actionTypeId	integer	yes	The ID of the action type.
actionTypeName	string	yes	The name of the action type.
templateId	integer	no	The ID of the template associated with this action type.
translates	array	no	Array of translation (see detailed structure below).

translates

Field	Type	Required	Description
languageCode	string	yes	The language code for the translation.
name	string	yes	The translated name of the action type.

Response

200 OK - The request was successful (example)

Field	Type	Description
success	boolean	Indicates whether the request was successful. Always true for successful responses.
result	object	An object containing the result of the successful request.
result.requestId	uuid	A unique identifier for tracking the request.
result.secretKey	string	A unique key for tracking the request.
result.smsInformed	boolean	Indicates whether the signers were informed with a sms message.

Bad Request (example)

Field	Type	Description
success	boolean	Indicates whether the request was successful. Always false for bad requests.
error	object	An object containing detailed error information.
error.code	string	A code representing the specific error type.
error.message	string	A detailed error message explaining the issue. Typically localized if needed.

Curl

curl -X 'POST' \
  'https://webimzo.uz/test/api/v1/SignRequest/Create' \
  -H 'accept: text/plain' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
  "apiKey": "string",
  "title": "string",
  "isForceCreate": true,
  "tableId": 0,
  "documentId": 0,
  "documentIdAsString": "string",
  "documentType": "string",
  "signDataTypeId": 0,
  "isAllowMultiple": true,
  "signData": "string",
  "signDataFileExt": "string",
  "hashAlgorithmId": 0,
  "previewPrintableLink": "string",
  "printableLink": "string",
  "printableLinkExt": "string",
  "templateId": 0,
  "organizationName": "string",
  "organizationInn": "string",
  "isVisibleToOthers": true,
  "signRequestUsers": [
    {
      "userKey": "string",
      "userInfo": "string",
      "userId": 0,
      "docStatusId": 0,
      "signPriority": 0,
      "ipAddress": "string",
      "userAgent": "string",
      "userPhoneNumber": "string",
      "parentUserKey": "string"
    }
  ],
  "signRequestActionTypes": [
    {
      "actionTypeId": 0,
      "actionTypeName": "string",
      "templateId": 0,
      "translates": [
        {
          "languageCode": "string",
          "name": "string"
        }
      ]
    }
  ],
  "signatureMethodIds": [
    0
  ]
}'

POST /v1/SignRequest/Get

Authentication

• Type: Basic Authentication
• Credentials:
  • Username: <your_username>
  • Password: <your_password>

Request Body (example)

Field	Type	Required
apiKey	string	yes
requestId	uuid	yes
secretKey	string	yes

Response

200 OK - The request was successful (example)

Field	Type	Description
success	boolean	Indicates whether the request was successful. Always true for successful responses.
result	object	An object containing the result of the request.
result.id	uuid	The unique ID of the sign request.
result.secretKey	string	The secret key used to validate the sign request.
result.title	string	The title of the document.
result.tableId	integer	The ID of the table associated with the document.
result.documentId	long	The unique ID of the document.
result.documentIdAsString	string	The document ID as a string (may be null).
result.documentType	string	The type of the document.
result.signDataTypeId	integer	The ID indicating the type of the sign data.
result.signData	string	The data that was signed.
result.signerUserCount	integer	The total number of users required to sign the document.
result.signedUserCount	integer	The number of users who have already signed the document.
result.haveMoreSignUser	boolean	Indicates whether there are more users who need to sign the document.
result.previewPrintableLink	string	The link to preview the printable document (may be null).
result.printableLink	string	The link to the printable document.
result.printableLinkExt	string	The file extension of the printable link (may be null).
result.organizationName	string	The name of the organization associated with the document.
result.organizationInn	string	The identifier of the organization associated with the document.
result.isVisibleToOthers	boolean	Indicates whether the signers is visible to others.
result.smsInformed	boolean	Indicates whether the signers were informed with a sms message.
result.signRequestUsers	array	Array of the document signers (see detailed structure below).
result.signatureMethods	array	Array of signature methods (see detailed structure below).

signRequestUsers

Field	Type	Description
id	uuid	The unique identifier of the sign request user.
userKey	string	The PINFL key associated with the signer.
userInfo	string	Information about the signer.
userPhoneNumber	string	The phone number of the signer.
userId	integer	The unique ID of the signer.
isSigned	boolean	Indicates whether the user has signed the document.
signPriority	integer	The priority level of the signer for signing the document.
docStatusId	integer	The ID representing the document's status.
signedAt	dateTime	The date and time when the user signed the document.
actionTypeId	integer	The ID of the action type associated with this sign request.
signatureMethodId	integer	The ID of the signature method used by the user.
signDetails	string	Additional details about the signing process.
parentUserKey	string	The parent user key associated with the signer.

signatureMethods

Field	Type	Description
signRequestId	uuid	The unique identifier of the sign request.
signatureMethodId	integer	The ID of the signature method used in the sign request.
signatureMethodName	string	The name of the signature method used in the sign request.

Bad Request (example)

Field	Type	Description
success	boolean	Indicates whether the request was successful. Always false for bad requests.
error	object	An object containing detailed error information.
error.code	string	A code representing the specific error type.
error.message	string	A detailed error message explaining the issue. Typically localized if needed.

Curl

curl -X 'POST' \
  'https://webimzo.uz/test/api/v1/SignRequest/Get' \
  -H 'accept: text/plain' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
  "apiKey": "string",
  "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "secretKey": "string"
}'

POST /v1/SignRequest/UpdateState

Authentication

• Type: Basic Authentication
• Credentials:
  • Username: <your_username>
  • Password: <your_password>

Request Body

Field	Type	Required	Description
apiKey	string	yes	API key for authentication
tableId	integer	yes	ID of the associated table
documentId	long	no	Unique document identifier (optional)
documentIdAsString	string	no	Document ID as string (optional, may be null)
documentType	string	no	Type/category of document (optional)

Response

200 OK - Success

Field	Type	Description
success	boolean	Request success status. Always true for successful responses.
result	boolean	Update operation result (true indicates successful update)

400 Bad Request

Field	Type	Description
success	boolean	Always false for error responses
error	object	Error details object
error.code	string	Machine-readable error code
error.message	string	Human-readable error description
error.details	string	Additional error context (optional, may be null)

Notes

• Either documentId (numeric) or documentIdAsString (string format) must be provided

Curl

curl -X 'POST' \
  'https://webimzo.uz/test/api/v1/SignRequest/UpdateState' \
  -H 'accept: text/plain' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
  "apiKey": "string",
  "tableId": 0,
  "documentId": 0,
  "documentIdAsString": "string",
  "documentType": "string"
}'

POST /v1/SignRequest/GetCallbackLogs

Authentication

• Type: Basic Authentication
• Credentials:
  • Username: <your_username>
  • Password: <your_password>

Request Body

Field	Type	Required	Description
apiKey	string	yes	API key for authentication
isError	boolean	no	Filter logs by error status (true=errors only)
signRequestIds	array[uuid]	no	Specific sign request IDs to filter logs

Response

200 OK - Success

Field	Type	Description
success	boolean	Request success status. Always true when successful.
result	array	Array of callback log entries
result[]	object	Callback log entry details:
callbackUrl	string	The URL that was called
errorCode	string	Error code if callback failed (may be null)
errorMessage	string	Descriptive error message (may be null)
errorCount	integer	Number of consecutive failure attempts
errorAt	datetime	Timestamp of last error (UTC, may be null)
requestBody	string	Full request body sent in callback
comment	string	Additional debug information (may be null)
responseStatusCode	integer	HTTP status code received from callback endpoint
responseDetails	string	Raw response content from callback endpoint
successAt	datetime	Timestamp of last successful callback (UTC, may be null)

400 Bad Request

Field	Type	Description
success	boolean	Always false for error responses
error	object	Error details object
error.code	string	Machine-readable error code (e.g., "INVALID_REQUEST_IDS")
error.message	string	Human-readable error description
error.details	string	Additional error context (optional, may be null)

Curl

curl -X 'POST' \
  'https://webimzo.uz/test/api/v1/SignRequest/GetCallbackLogs' \
  -H 'accept: text/plain' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
  "apiKey": "string",
  "isError": true,
  "signRequestIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

Constants

The following constants are used in the request body to specify certain types, methods, or codes.

SignDataTypeIdConst

Constant Name	Value	Description
STRINGFILE_DOC_PDF	1	Represents a PDF document file for signing.
STRINGFILE_PRINTABLE	2	Represents a printable string file.
PRINTABLE_HASH	3	Represents a hash of a printable file.
STRINGFILE	4	Represents a general string file for signing.
BYTEFILE	5	Represents a byte array file for signing.

SignatureMethodIdConst

Constant Name	Value	Description
E_IMZO	1	Signature method using the E-Imzo service.
STYX_IMZO	2	Signature method using the Styx-Imzo service.
SMS_CODE	3	Signature method using an SMS code verification.

LanguageCodeConst

Constant Name	Value	Localize Value	Description
RU	"RU"	ru-RU	Russian language code.
UZ_CYRL	"UZ_CYRL"	uz-Cyrl	Uzbek language in Cyrillic script.
UZ_LATN	"UZ_LATN"	uz-Latn	Uzbek language in Latin script.
EN	"EN"	en-US	English language code.
QR	"QR"	kaa	Karakalpak language code.