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}/analyze/docinfo
Retrieves the extracted information from the provider, along with mapped fields and templates.
tenantId
stringTenant name
documentid
stringDocument ID
instanceurl
stringInstance URL
recordtype
stringRecord type
userid
stringUser ID
Example:
a56392269d970c
username
stringUser name
Example:
dummyuser
Responses
200
500
OK
responses
/
200
projectId
string<string>Project ID
Example:
625
documentId
string<string>Document ID
Example:
82736
jobId
string<string>Job ID
Example:
43325
recordType
string<string>Record type
Example:
NDA
foundProvisionMap
booleanBoolean indicating if a provision map was found
Example:
true
extractedProvisions
array[object]tags
array[string]A possibly empty array of strings with tags that were assigned to the field instances
flag_user_id
integer<int64>Integer identifier of user who red-flagged the field instance
>= -9007199254740991<= 9007199254740991
field_name
string<string>Name of the field
field_instance_url
string<string>URL for viewing the field instance in the AI engine's UI
page_range
array[integer<int64>]A two-integer array indicating the document pages the field instance starts and ends on (inclusive).
is_flagged
booleanBoolean indicating if a field instance is red-flagged
text_ranges
array[array]An array of text ranges where this field instance text occurs in the document. Each element consists of two integers representing the start (inclusive) and end (exclusive) of the range, in characters from the start of the file.
field_instance_id
integer<int64>Integer identifier of the field instance
>= -9007199254740991<= 9007199254740991
field_id
integer<int64>Integer identifier of the field
>= -9007199254740991<= 9007199254740991
text
string<string>Text of the field instance
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
:
:
::::::
curl --request GET \--url https://idd_url/idd/api/v2/tenantId/analyze/docinfo \--header 'Accept: application/json' \--header 'X-API-Key: 123'
1{2"projectId": "625",3"documentId": "82736",4"jobId": "43325",5"recordType": "NDA",6"foundProvisionMap": true,7"extractedProvisions": [8{9"tags": [10"string"11],12"flag_user_id": 0,13"field_name": "string",14"field_instance_url": "string",15"page_range": [16017],18"is_flagged": true,19"text_ranges": [20[21022]23],24"field_instance_id": 0,25"field_id": 0,26"text": "string",27"mappedFields": [28{29"objectName": "string",30"congaField": "string"31}32],33"mappedClauses": [34{35"congaTemplateId": "string"36}37]38}39]40}
chevron_right