Footer Section
Explore
Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)Conga CopilotCPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTest AuthorTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration Manager for Advantage PlatformX-Author for Migration ManagerRelease NotesGeneral
Get extracted provisions
get
https://IDD_URL/idd/api/{version}
/{tenantId}/document/extractions
Gets extracted information along with mapped fields and clauses.
tenantId
stringTenant name
agreementid
stringAgreement ID
attachmentid
stringAttachment ID
documentid
stringList of document IDs
instanceurl
stringThe URL of the org instance
module
stringThe source module/application, such as "clm", "cc", or "cfs"
Example:
CLM
userid
stringUser ID of the logged-in user
Example:
a56392269d970c
username
stringFull name of the logged-in user
Example:
Gilad Turbahn
Responses
200
404
500
OK
responses
/
200
documentId
string<string>Document ID
Example:
82736
documentName
string<string>Document name
Example:
AcmeMSA.pdf
agreementId
string<string>Document ID
Example:
005a2382736
originalAttachmentId
string<string>Attachment ID for the original document
Example:
009dahr89
reviewAttachmentId
string<string>Attachment ID for the searchable PDF
Example:
009dahr90
recordType
string<string>Record type
Example:
NDA
extractedProvisions
array[object]provider
string<string>Name of the provider
Example:
congaai
name
string<string>Name of the field
Example:
Agreement Start Date
fieldId
string<string>ID of the provision
Example:
45894422-4875959
type
string<string>Provision type
Example:
standard
extractions
array[object]mappedFields
array[object]An array of objects and fields this provision maps to
mappedClauses
array[object]An array of template IDs this provision maps to
missingProvisions
array[object]provider
string<string>Name of the provider
Example:
congaai
name
string<string>Name of the field
fieldId
string<string>ID of the provision
type
string<string>Provision type
Example:
standard
:
:
::::::::
curl --request GET \--url https://idd_url/idd/api/v2/tenantId/document/extractions \--header 'Accept: application/json' \--header 'X-API-Key: 123'
1{2"documentId": "82736",3"documentName": "AcmeMSA.pdf",4"agreementId": "005a2382736",5"originalAttachmentId": "009dahr89",6"reviewAttachmentId": "009dahr90",7"recordType": "NDA",8"extractedProvisions": [9{10"provider": "congaai",11"name": "Agreement Start Date",12"fieldId": "45894422-4875959",13"type": "standard",14"extractions": [15{16"text": "5th day of June 2021",17"normalizedText": "06/05/2021",18"spans": [19{20"start": 0,21"end": 0,22"pages": {23"start": 0,24"end": 025},26"bounds": {27"top": 0,28"left": 0,29"bottom": 0,30"right": 031}32}33]34}35],36"mappedFields": [37{38"objectName": "string",39"congaField": "string",40"wordWildCard": "string",41"patternSimilarity": "string"42}43],44"mappedClauses": [45{46"congaTemplateId": "string",47"wordWildCard": "string",48"patternSimilarity": "string"49}50]51}52],53"missingProvisions": [54{55"provider": "congaai",56"name": "string",57"fieldId": "string",58"type": "standard"59}60]61}
chevron_right