Consumables APIs

Tip

Your feedback is valuable and is vital in improving our product and documentation. Send suggestions to acrobatsignembed@adobe.com.

Adobe Acrobat Sign supports a variety of authentication methods to ensure the security and integrity of electronic signatures. These methods range from simple, single-factor authentication to more complex, multi-factor authentication options - ensuring that organizations can manage and budget their use according to their security needs and compliance requirements, while also providing flexibility to choose the appropriate level of authentication for different types of transactions.

• Phone Authentication: A six-digit code is sent to the recipient’s phone via SMS or voice call, which must be entered to view the agreement. For details, check Phone authentication.

• Knowledge-Based Authentication (KBA): This high-level authentication method is used mainly in financial institutions. It involves answering personal questions derived from public databases and is only available for recipients in the US. For details, check Knowledge-based authentication .

• Government ID Authentication: This method requires the recipient to provide an image of a government-issued ID and a selfie for verification. For details, check Government ID .

Note

Add-ons and transactions are referred to as “consumables” because they are resources that are used up or consumed as they are utilized. Each time a transaction is initiated, such as sending an electronic document for signature, it is considered consumed and is deducted from the user’s available transaction quota. Similarly, authentication services like Knowledge-Based Authentication or Phone Authentication are also treated as consumables, as they are used up on a per-recipient basis when employed in the signing process. This means that each time a recipient uses one of these methods, it counts against the total number of transactions available to the sender, which must be replenished as needed.

Consumables summary on integration

	Value
HTTP Method	GET
Endpoint Operation	/v1/partners/me/consumableSummary
Authentication/ Authorization	Valid technical account token with ee.sign_group_oem
Audience	Partner will call this API to fetch count of consumables consumed within a given date range
Request Header	Partner APIs Common Headers
Query Params	FilterQueryParams
Response Object	ConsumableSummaryResponse
HTTP Status Code	200
Error Code	CommonErrorResponse

FilterRequestParams

Parameter Name	Type	Description	Required	Value Range
startDate	DateTime	DateTime in ISO-8601 format with UTC timezone	Yes	startDate should not be earlier than 2025-01-01T00:00:00Z
endDate	DateTime	DateTime in ISO-8601 format with UTC timezone	Yes	endDate should be greater than startDate but not more than 31 days from startDate. Ex: 2025-01-15T00:00:00Z

ConsumableSummaryResponse

Type	Description	Default Value
List<ConsumableSummary>	List of ConsumableSummary	[]

ConsumableSummary

Parameter Name	Type	Description	Sample Value
type	String	Type of consumables	Ex: TXN, PHONE_AUTH
count	Long	Count of consumable consumed within given range	Ex: 100

ConsumableSummaryResponse

{
  "consumableSummary": [
    {
     "type": "KBA",
     "count": 1
    },
    {
     "type": "PHONE_AUTH",
     "count": 2
    }
  ]
}

Get consumables summary on account level

	Value
HTTP Method	GET
Endpoint Operation	/v1/accounts/{account_id}/consumableSummary
Authentication/ Authorization	Valid Technical Account Token Mandatory Scopes in token - sign_account_read, agreement_read
Audience	Partner will call this API to fetch details of consumables (agreements, add-ons) consumed within a given date range for a given account
Request Header	Partner APIs Common Headers
Query Params	AccountFilterQueryParams
Response Object	ConsumableSummaryDetailsResponse
HTTP Status Code	200
Error Code	CommonErrorResponse

ConsumableSummaryResponse

{
  "consumableSummary": [
      {
        "type": "KBA",
        "count": 1
      },
      {
        "type": "PHONE_AUTH",
        "count": 2
      }
  ]
}

Get consumables summary details on account level

	Value
HTTP Method	GET
Endpoint Operation	/v1/accounts/{account_id}/consumableSummaryDetails
Authentication/ Authorization	Valid Technical Account Token Mandatory Scopes in token - sign_account_read, agreement_read
Audience	Partner will call this API to fetch details of consumables (agreements, add-ons) consumed within a given date range for a given account
Request Header	Partner APIs Common Headers
Query Params	AccountFilterQueryParams
Response Object	ConsumableSummaryDetailsResponse
HTTP Status Code	200
Error Code	CommonErrorResponse

AccountFilterQueryParams

Parameter Name	Type	Description	Required	Value Range
startDate	DateTime	DateTime in ISO-8601 format with UTC timezone	Yes	startDate should not be earlier than 2025-01-01T00:00:00Z
endDate	DateTime	DateTime in ISO-8601 format with UTC timezone	Yes	endDate should be greater than startDate but not more than 31 days from startDate. Ex: 2025-01-15T00:00:00Z
pageSize	Integer	Count of records to be returned per specific call	No
cursor	String	Reference to get next set of records with given pageSize. This is used to navigate through the pages. If not provided, returns the first page.	No

ConsumableSummaryDetailsResponse

Type	Description	Default Value
List<ConsumableSummaryDetails>	List of ConsumableSummaryDetails	[ ]

ConsumableSummaryDetails

Parameter Name	Type	Description	Sample Value
agreementId	String	Secure agreement identifier	Ex: CBJCHBCAABAA-N0tAR3aLID-u4R5RO
createdDate	DateTime	Agreement created time recorded in the system in UTC format
addonDetails	List<AddonDetails>	List of secondary consumables like add-ons with their count

AddonDetails

Parameter Name	Type	Description	Sample Value
type	String	Name of consumable	Ex: PHONE_AUTH, KBA
count	Long	Count of consumable consumed with an agreement	Ex: 100

ConsumptionResponseReportResponseItemDetail

{
  "page": {
    "nextCursor": "xyzjbjdbjb"
  },
  "agreements": [
    {
      "id": "CBJCHBCAABAA-N0tAR3aLID-u4R5RO",
      "createdDate": 2025-01-10T00:00:15Z,
      "addonDetails": [
        {
          "type": "KBA",
          "count": 1
        },
        {
          "type": "PHONE_AUTH",
          "count": 2
        }
      ]
    }
  ]
}

CommonErrorResponse

HTTP Code	Error Code	Message
400	BAD_REQUEST	The request provided is invalid
403	PERMISSION_DENIED	The API caller does not have the permission to execute this operation
429	TOO_MANY_REQUESTS	The request rate limit has reached
500	MISC_SERVER_ERROR	Some miscellaneous error has occurred.

Partner APIs Common Headers

Header Name	Values	Description
Authorization	Bearer <Technical Account Token>	Technical account token that is generated by the partner
content-type	application/json	Media type of the resource
x-request-id	String	A unique string value needed to track a given request