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
Send information for upload
post
https://IDD_URL/idd/api/{version}
/{tenantId}/analyze/uploadinfo
Sends the provider's upload information (job ID/document ID) or file information for IDD to upload.
Collects job/document information for a manual upload or uploads internally (see the input types in the request body description.)
For requests with automatic notification enabled (with the notificationInfo object included in the request), the request body in the notification will resemble:
status: complete,
responseBody:
is_extracted: true,
language: English,
scan_quality: A,
is_scanned: true,
page_count: 10,
error_code: 0,
jobId: 412455,
documentId: 86453,
projectId: 625
tenantId
stringTenant name
resumable
stringSet to true to upload documents using the resumable API.
Example:
false
userid
stringUser ID
Example:
a56392269d970c
username
stringUser name
Example:
dummyuser
Request to:
- uploadJobInfo: Post job/document information to IDD,
- uploadJobInfoWithNotification: Post job/document information to IDD and receive notification on completion, or
- uploadDocumentInfo: Give IDD a link to the file to upload. If notificationInfo is provided, notify on completion.
object
(any of)
jobId
string<string>Job ID
Example:
80291
documentId
string<string>Document ID
Example:
394201
context
objectrecordType
string<string>Record type
Example:
NDA
projectId
string<string>Project ID
Example:
880
instanceUrl
string<string>Instance URL
Example:
https://www.conga.com
notificationInfo
objectIncluding 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
500
OK
- The information was received (if the request body was of the uploadJobInfo or uploadJobInfoWithNotification type).
- The file was downloaded successfully and automatic polling has begun (if the request body was of the uploadDocumentInfo type).
:
:
::::
curl --request POST \--url https://idd_url/idd/api/v2/tenantId/analyze/uploadinfo \--header 'Content-Type: application/json' \--header 'X-API-Key: 123' \--data '{"jobId": "40289","documentId": "89000","context": {"recordType": "NDA","projectId": "342","instanceUrl": "https://www.conga.com"}}'
chevron_right