eSign for Jira
eSign for Jira
Breadcrumbs

External Integration API


Overview

eSign supports an Integration API to allow external systems to integrate with eSign.

Security & Authentication

Authenticate to eSign API’s by providing the eSign API Token as a standard Bearer token header.

Authorization: Bearer <ESIGN_API_TOKEN_HERE>

Create and manage API Tokens in eSign App Settings within the Atlassian Jira environment.

API Locations

The API Base URL’s are listed below by location. The active location for a site is displayed in the eSign App Settings and Create Token pages.

https://digitalrose.atlassian.net/wiki/s/1397523071/6452/2b02b495225559de55daeff4b55d7bef79b68562/_/images/icons/emoticons/information.png API Tokens are linked to the pinned data residency region. If a site is migrated, new API Token(s) will need to be created.

Region

API Base URL

EU

https://japi.eu.esign-app.com/jira/api/external

USA

https://japi.us.esign-app.com/jira/api/external

API Endpoints

API Token [GET]

Description

Returns information about the eSign API token used to authenticate this request.

Can be used to verify API connection.

Method

GET

Endpoint

/jira/api/external/v1/token

Query

N/A

Body

N/A

Success Response

200

{
	"success": true,
	"code": 200,
	"data": {
		"name": "my api token",
		"created": "2025-09-10T05:00:45Z",
		"expires": "2026-09-10T00:00:00Z"
	}
}

Error
Response

401

{
	"success": false,
	"code": 401,
	"message": "Invalid API token"
}

Execute Signature [POST]

Description

Applies a signature to an existing Jira Work Item.

Method

POST

Endpoint

/v1/signature/execute

Query

N/A

Body

 
{
  "accountId": "{Signee Account ID}", 
  "issueKey": "{WorkItem/IssueKey}", 
  "pin": "XXXXXX", 
  "meaning": "{Signature Type Meaning}", 
  "title": "{user title (optional)}"
}

Success Response

200

{
	"success": true,
	"code": 200,
	"message": "Signature successfully applied to {WorkItem Key}."
}

Error
Response

403

{
	"success": false,
	"code": 403,
	"message": "Signature Type Invalid Meaning is not available for this work item due to type or status.  Contact your Jira administrator."
}

User Signature Profile [GET]

Description

Fetch information on a user’s signature profile, including their Signing Pin status and saved title

Method

GET

Endpoint

/v1/user/profile

Query

?accountId={accountId}

Body

N/A

Success Response

200

{
	"success": true,
	"code": 200,
	"data": {
		"accountId": "{user account ID}",
		"name": "{display name}",
		"title": "{eSign Title}",
		"pinStatus": "{OK|",
		"jiraBaseUrl": "https://{jira-site}.atlassian.net"
	}
}

Error
Response

400

{
	"success": false,
	"code": 400,
	"message": "Error retrieving user profile for account {accountId}"
}