home
Release NotesRelease ResourcesGeneralDeveloper Hub

General

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
search
search
Conga Advantage Platform
Advantage Platform Administration
CPQ
Billing for Advantage PlatformBilling for SalesforceCPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceTurboEngines
CLM
Adobe Sign ServicesCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceContractsConga for Google DocsContract Intelligence (Standalone)Discovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformSmart SearchX-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 Manager
Document Automation
Approvals for Advantage PlatformApprovals for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceGridInvoice GenerationMix FormsOrchestrateQuote GenerationSign for Advantage PlatformSign for Salesforce

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

search

General

chevron_left

General Contents

close

  • Features by Release

  • Conga Upgrade Program

  • chevron_right

    System Requirements and Supported Platforms Matrix

  • Managed Packages Dependency Matrix

  • Conga Applications in Salesforce Lightning

  • Salesforce Multi-Factor Authentication Support for Conga Commerce

  • chevron_right

    Conga Product Glossary

  • chevron_right

    Conga Upgrade Assistant

  • chevron_right

    Product Retirement Schedule

  • expand_more

    Developer Center

    • chevron_right

      Approvals for Salesforce REST APIs

    • chevron_right

      Billing for Salesforce REST APIs

    • chevron_right

      CLM for Salesforce REST APIs

    • chevron_right

      CPQ for Salesforce REST APIs

    • chevron_right

      Digital Commerce for Salesforce REST APIs

    • expand_more

      Discovery AI for Salesforce REST APIs

      • chevron_right

        Admin Config

      • chevron_right

        Conga APIs

      • chevron_right

        Documents

      • chevron_right

        Tenant Administration

      • chevron_right

        Config Discovery and Management

      • expand_more

        Document Analysis

        • Get information for an upload request

          get

        • Send information for upload

          post

        • Get job status

          get

        • Update job status

          post

        • Get document status

          get

        • Show document status

          post

        • Get extracted provisions

          get

        • Extract data from natural language

          get

        • Extract date and time from natural language

          get

        • Log feedback event

          post

        • Export a document

          post

        • Retrieve info to download a document

          get

        • Download an exported document to a named location

          post

        • Delete a document

          delete
      • chevron_right

        Insight Analysis and Management

    • chevron_right

      Orchestrate REST APIs

    • chevron_right

      Partner Commerce for Salesforce REST APIs

    • chevron_right

      TurboEngines REST APIs

  1. General
  2. arrow_right
  3. Developer Center
  4. arrow_right
  5. Discovery AI for Salesforce REST APIs

list_altShow Contents

chevron_left

General

Document Analysis

chevron_right
download

Show document status

post
https://IDD_URL/idd/api/{version}
/{tenantId}/analyze/docstatus

Returns the status information for the document provided. For requests with automatic notification enabled (that is, the notificationInfo object is included in the request), the notification in the response body resembles: 

status: complete,
responseBody:
  is_extracted: true,
  language: English,
  scan_quality: A,
  is_scanned: true,
  page_count: 10,
  error_code: 0,
  job_id: 412455,
  document_id: 86453,
  projectId: 625

Request

Security: API Key
Security: Bearer Auth

Path Parameters

tenantId
string
required

Tenant name

Query Parameters

context
string
required

Stringified form of JSON representing the context from IDD

Examples:
{"recordType":"NDA","projectId":"557","instanceUrl":"https://www.conga.com"}
documentid
string
required

Document ID

userid
string
required

User ID

Example:
a56392269d970c
username
string
required

User name

Example:
dummyuser

Body

Webhook information

notificationInfo
object

Including this webhook information enables automatic polling by IDD.

url
string<string>

URL

Example:
https://www.conga.com/maxupload/notify
method
string<string>

Request method

Example:
POST

Responses

200
403
404
500

Status of document

Body

responses
/
200
status
string<string>

Status

Example:
"in progress" or "complete"
responseBody
object

Response from provider

is_extracted
boolean
Example:
true
language
string
Example:
English
scan_quality
string
Example:
A
is_scanned
boolean
Example:
true
page_count
integer
Example:
4
error_code
integer
Example:
0
jobId
integer
Example:
625
document_id
string
Example:
82839
job_id
string
Example:
1920
Auth
:
Server Variables
:
Parameters
:
:
:
:
:
Body
1
{
2
  "notificationInfo": {
3
    "url": "https://www.conga.com/maxupload/notify",
4
    "method": "POST"
5
  }
6
}
curl --request POST \
  --url 'https://idd_url/idd/api/v2/tenantId/analyze/docstatus?context=%7B%22recordType%22%3A%22NDA%22%2C%22projectId%22%3A%22557%22%2C%22instanceUrl%22%3A%22https%3A%2F%2Fwww.conga.com%22%7D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: 123' \
  --data '{
  "notificationInfo": {
    "url": "https://www.conga.com/maxupload/notify",
    "method": "POST"
  }
}'
Response Example
1
{
2
  "status": "\"in progress\" or \"complete\"",
3
  "responseBody": {
4
    "is_extracted": true,
5
    "language": "English",
6
    "scan_quality": "A",
7
    "is_scanned": true,
8
    "page_count": 4,
9
    "error_code": 0,
10
    "jobId": 625,
11
    "document_id": "82839",
12
    "job_id": "1920"
13
  }
14
}
chevron_leftchevron_right
chevron_right

Footer Section

Explore


Conga.com
Legal
Feedback
Contact Support

Copyright © 2025 Conga Corporation • All Rights Reserved

Cookie Notice

We use cookies to improve your experience on our site. To find out more, read our cookie policy.