Sign API endpoint reference
This page documents all Sign API endpoints. For authentication details and the response format, see the Sign API overview.
Certificates
List available certificates
Returns the list of certificates the authenticated user has access to.
GET /signapi/v1/certificate/list
| Parameter | Value |
|---|---|
| Authentication | Authorization: Bearer YOUR_ACCESS_TOKEN |
| Body | — |
Response
{
"message": "string",
"messageType": "SUCCESS",
"errorCode": "OK",
"data": [
{
"id": 0,
"alias": "string",
"thumbprint": "string",
"pinPolicy": "NoPIN",
"requireUsageReason": true
}
]
}
Signing
Sign a document
Signs a document and returns the signed file.
POST /signapi/v1/sign/document
| Parameter | Value |
|---|---|
| Authentication | Authorization: Bearer YOUR_ACCESS_TOKEN |
| Content-Type | multipart/form-data |
| Response | Signed file |
This request uses multipart/form-data with two fields:
jsonUploadData: A form field containing the serialized JSON (see example below).file: The document to be signed.
{
"certificateId": 11,
"pin": null,
"reason": null,
"visualSignature": {
"x": 316,
"y": 843,
"width": 385,
"height": 96,
"imageBase64": "[IMAGE_IN_B64]",
"pages": [1]
}
}
The visualSignature field is optional.
Sign a hash
Signs a data hash and returns the resulting signature.
POST /signapi/v1/sign/hash
| Parameter | Value |
|---|---|
| Authentication | Authorization: Bearer YOUR_ACCESS_TOKEN |
| Content-Type | application/json |
Body
{
"dataInBase64": "string",
"hashAlgorithm": "SHA256",
"padding": "PKCS1",
"certificate": "string",
"pin": "string",
"usageReason": "string"
}
| Field | Type | Description |
|---|---|---|
dataInBase64 | string | Data to sign, Base64-encoded. |
hashAlgorithm | string | Hash algorithm. Valid values: MD5, SHA1, SHA224, SHA256, SHA384, SHA512. |
padding | string | Padding type. Valid values: PKCS1, PSS, OAEP. |
certificate | string | Thumbprint of the certificate to use. |
pin | string | Certificate PIN, if required. |
usageReason | string | Usage reason, if the certificate requires it. |
Response
{
"message": "string",
"messageType": "SUCCESS",
"errorCode": "OK",
"data": "string"
}
The data field contains the resulting signature, Base64-encoded.
Signature profile
The profile endpoints let you manage the user's default signing configuration: the pre-selected certificate, whether a signature image or informational text is included, and which pages the signature is applied to. This configuration is used in the Signtrust signing flow.
These endpoints are available from version 4.42.0 and require an access token obtained through the centralized OAuth 2.0 flow.
Get signature profile
Returns the saved signing configuration for the authenticated user.
GET /signapi/v1/profile
| Parameter | Value |
|---|---|
| Authentication | Authorization: Bearer YOUR_ACCESS_TOKEN |
| Body | — |
Response
{
"message": "string",
"messageType": "SUCCESS",
"errorCode": "OK",
"data": {
"hasSelectedCert": true,
"selectedCertId": 0,
"includeImage": true,
"includeInfo": true,
"infoItems": ["CERTIFICATE"],
"pageType": "ALL",
"pageRange": "string"
}
}
| Field | Type | Description |
|---|---|---|
hasSelectedCert | boolean | Whether the user has a pre-selected certificate. |
selectedCertId | integer | null | ID of the pre-selected certificate. Present only if hasSelectedCert is true. |
includeImage | boolean | Whether a custom signature image is included. |
includeInfo | boolean | Whether informational text is included in the visual signature. |
infoItems | array | List of informational elements included. Valid values: CERTIFICATE, FRIENDLYNAME, DATE, THUMBPRINT. |
pageType | string | Pages where the signature is applied. Valid values: CURRENT, LAST, ALL, RANGE. |
pageRange | string | null | Page range in 1-3,5 format. Present only if pageType is RANGE. |
Save signature profile
Creates or replaces the authenticated user's signing configuration.
POST /signapi/v1/profile
| Parameter | Value |
|---|---|
| Authentication | Authorization: Bearer YOUR_ACCESS_TOKEN |
| Content-Type | application/json |
Body
{
"hasSelectedCert": true,
"selectedCertId": 0,
"includeImage": true,
"includeInfo": true,
"infoItems": ["CERTIFICATE"],
"pageType": "ALL",
"pageRange": null
}
| Field | Type | Required | Description |
|---|---|---|---|
hasSelectedCert | boolean | Yes | Whether a certificate is pre-selected. |
selectedCertId | integer | null | Conditional | Required if hasSelectedCert is true. |
includeImage | boolean | Yes | Whether to include a signature image. |
includeInfo | boolean | Yes | Whether to include informational text. |
infoItems | array | Conditional | Required if includeInfo is true. Must contain at least one item. Valid values: CERTIFICATE, FRIENDLYNAME, DATE, THUMBPRINT. |
pageType | string | Yes | Pages where the signature is applied. Valid values: CURRENT, LAST, ALL, RANGE. |
pageRange | string | null | Conditional | Required if pageType is RANGE. Format: 1-3,5. |
Response
{
"message": "string",
"messageType": "SUCCESS",
"errorCode": "OK",
"data": {}
}
Delete signature profile
Deletes the authenticated user's saved signing configuration.
DELETE /signapi/v1/profile
| Parameter | Value |
|---|---|
| Authentication | Authorization: Bearer YOUR_ACCESS_TOKEN |
| Body | — |
Response
{
"message": "string",
"messageType": "SUCCESS",
"errorCode": "OK",
"data": {}
}
Signature image
These endpoints let you manage the custom image overlaid on the document when signing (the visual representation of the signature).
These endpoints are available from version 4.42.0 and require an access token obtained through the centralized OAuth 2.0 flow.
Get signature image
Returns the signature image for the authenticated user.
GET /signapi/v1/profile/image
| Parameter | Value |
|---|---|
| Authentication | Authorization: Bearer YOUR_ACCESS_TOKEN |
| Body | — |
Response
{
"message": "string",
"messageType": "SUCCESS",
"errorCode": "OK",
"data": {
"imageInBase64": "string"
}
}
Upload signature image
Uploads or replaces the signature image for the authenticated user.
PUT /signapi/v1/profile/image
| Parameter | Value |
|---|---|
| Authentication | Authorization: Bearer YOUR_ACCESS_TOKEN |
| Content-Type | application/json |
Body
{
"imageInBase64": "string"
}
The imageInBase64 field must contain the image Base64-encoded.
Response
{
"message": "string",
"messageType": "SUCCESS",
"errorCode": "OK",
"data": {}
}
Delete signature image
Deletes the signature image for the authenticated user.
DELETE /signapi/v1/profile/image
| Parameter | Value |
|---|---|
| Authentication | Authorization: Bearer YOUR_ACCESS_TOKEN |
| Body | — |
Response
{
"message": "string",
"messageType": "SUCCESS",
"errorCode": "OK",
"data": {}
}
SharePoint configuration
Get SharePoint configuration
Returns the SharePoint configuration parameters associated with the Redtrust installation. These values are used for the Signtrust SharePoint integration.
GET /signapi/v1/sp-config
This endpoint is available from version 4.42.0 and requires an access token obtained through the centralized OAuth 2.0 flow.
| Parameter | Value |
|---|---|
| Authentication | Authorization: Bearer YOUR_ACCESS_TOKEN |
| Body | — |
Response
{
"message": "string",
"messageType": "SUCCESS",
"errorCode": "OK",
"data": {
"sharepoint_clientid": "string",
"sharepoint_tenantid": "string"
}
}
| Field | Description |
|---|---|
sharepoint_clientid | Client ID of the application registered in Azure for the SharePoint integration. |
sharepoint_tenantid | Azure tenant ID associated with the organization. |
Was this page helpful?