Jump to Content
Product Documentation
Conga Community
Home
Guides
API Reference
Product Documentation
Conga Community
Log In
API Reference
Log In
Home
Guides
API Reference
Get Customer Onboarded
JUMP TO
Ingress
Documents
Generate a document from merge templates and data sources
post
Join documents from multiple sources
post
Change document protection
post
Change document protection
post
Convert documents' format
post
Convert a document's format
post
/v2/documents/process
post
/v2/documents/{documentId}/process
post
Jobs
Get job information
get
Status
Get merge process status
get
Salesforce
Search Salesforce Leads, Contacts and Users
get
Get Salesforce Object Name and Object Type by Record ID
get
MOCK: Fetch templates for a given customer
get
Fetch all managed package Salesforce templates (CET + CGT) for the current customer's org.
get
Retrieves recent attachments and files for a Salesforce record(objectId).
get
Fetch related contacts for a given Salesforce record.
get
MOCK: Fetch related contacts for a given Salesforce record
get
Merge
Get merge info
get
Accept merge
get
Reject merge
get
Initiate the merge workflow
post
Initiate the merge workflow after uploading JSON data
post
MOCK : Initiate the merge workflow after uploading JSON data
post
Returns the url list of merged and preview documents for a given correlationId.
get
Email
Send an email with attachments using providers such as SES, Salesforce (SF), or SendGrid
post
MOCK: Send an email with attachments (returns JSON string)
post
Merge an email template with SF info or JSON payload from original merge request
post
Generate sign package url
post
MOCK: Generate sign package url
post
Configuration
Retrieves environment and region details from configuration.
get
Preview
Merges the provided dataModel with the template to generate a preview.
post
PlatformComposerFeatureFlag
Evaluate PlatformComposer feature flag for the given Salesforce Org Id
get
Orchestrate
/v2/orchestrate/merge
post
/v2/orchestrate/merge
get
Migration
Runs the ComposerSolution status migration job. Finalized records using status "Draft" will be updated to "Complete".
post
Json
Get data Schema JSON
post
/v1/Json/datatranslateprocess
post
Draft
Saves a solution draft before it proceeds to the Deploy tab.
post
Retrieves a draft solution by its ID.
get
Solution
Retrieves all solutions with optional pagination and search filter.
get
Creates a new solution.
post
Retrieves the code snippet for a specific language and solution.
post
Retrieves a single solution by its ID.
get
Partially updates an existing solution by its ID (PATCH).
patch
Deletes a solution by its ID.
del
Get coding languages for the solution's deploy step
get
Search Saleforce contacts with the given search term.
get
CustomBranding
Uploads a logo file with a custom name.
post
Get all uploaded customBrandings
get
/v1/CustomBranding/{id}
del
Updates a logo's image and/or custom name by ID.
patch
Get logo file details by ID
get
/v1/CustomBranding/{id}/download
get
ComposerParameter
Retrieves all parameters with optional pagination and search filter.
get
/v1/Parameter/{id}
get
Approvals
Activities
Get approval activities for a context object
get
AdhocProcess
Define an ad hoc process
post
Get an ad hoc process
get
Delete the adhoc Approvals
del
Submit adhoc approval
post
Resubmit an ad hoc process
post
Get a submitted ad hoc process
get
AsyncOperationStatus
Get Async Operation Status by correlation id
get
BackupAdmin
Get the backup administrator
get
Save the backup administrator
post
Delete the backup administrator
del
BackupDelegates
Create or update backup or delegate approvers
post
List backup and delegate approvers
get
Get a backup or delegate approver
get
Delete a backup or delegate approver
del
Count backup and delegate approvers
get
Activate a backup or delegate
post
Deactivate a backup or delegate
post
BusinessObjects
List business object types
get
List all business objects' assignee type values
get
List a business object's assignee type values
get
List a business object's custom user fields
get
Validate a custom assignee
post
List a business object's fields
get
Get a business object's child types
get
List email templates for a business object
get
List email templates for a business object
get
List email templates for a business object
get
List email templates for a business object
get
List a business object's processes
get
Reorder an approval process list
post
Get a business object's rules
get
Count all of a business object's rules
get
Process
Create an approval process
post
Search approval processes
get
Get an approval process
get
Update an approval process
put
Delete an approval process
del
Activate an approval process
post
Deactivate an approval process
post
Clone an approval process
post
Reorder a list of approval processes
post
Get this step's dependencies
get
List all step dependencies
get
Update an approval process step by ID
put
Delete an approval process step
del
Reorder approval process steps
post
Get approval process steps
get
Activate an approval process step
post
Deactivate a process step
post
Check for a process
get
Count active and inactive processes
get
ProcessSteps
Create an approval process step
post
Update an approval process step
put
Get an approval process step
get
Check for a step
get
Requests
Submit for approval
post
Submit an approval asynchronously
post
Get an approval request status
get
Preview an approval
get
Approve a request
post
Approve requests
post
Reject an approval request
post
Reject approval requests
post
Reassign requests
post
Escalate an approval request
post
Reassign an approval request
post
Add an ad hoc approver
put
Delete an ad hoc approver
del
Add comment to approval request
put
Reqeust an information about approval request
put
Check for objects requiring approval
post
Check for objects requiring approval asynchronously
post
Process escalation reminder jobs
post
Get status for a context object
get
Get status for a context object's child object
get
Recall approval requests
post
Get approval request comments
get
Bulk business object operations
post
Get an approval request
get
Get the approval request attachments
post
Get all requests for an assignee and object
get
Take ownership of a queued request
put
RuleDimensions
Save an approval rule dimension
post
Get an approval rule dimension
get
Update an approval rule dimension
put
Delete an approval rule dimension
del
RuleEntries
Save an approval rule entry
post
Get an approval rule entry
get
Validate a rule entry label
get
Reorder rule entries
post
Rules
Save an approval rule
post
Search rules
get
Get an approval rule
get
Delete an approval rule
del
Activate an approval rule
post
Deactivate an approval rule
post
Clone an approval rule
post
Get rule entry dependencies
get
Activate an approval rule entry
post
Deactivate an approval rule entry
post
Delete an approval rule entry
del
Validate a rule name
get
SearchFilters
Create or update a search filter
post
Get all search filters
get
Get a search filter by ID
get
Delete a search filter by ID
del
Activate a search filter
post
Deactivate a search filter
post
Validate a search filter name
get
SystemProperties
Get system properties
get
Update system properties
post
Get a custom configuration
get
Delete a custom configuration
del
Create or update a custom configuration
post
Get custom configurations
get
Get Approvals product settings for all business objects
get
Get email configuration
get
Create email configuration
post
Update email configuration
patch
UserDashboard
Count user's approvals
get
Get Approval Count for BusinessObject
get
Get Dashboard count and BusinessObject data or Approval request related to the business object
post
Get user dashboard approval details
get
UserGroup
List user groups
get
Create a user group
post
Update a user group
put
Get a user group and its members by ID
get
Delete a user group by ID
del
List user group members
get
Add a member
post
Delete a member by ID
del
eSignature
AdobeSign
Get Adobe sign events by esign transaction
get
AgreementSigningCycle
Retrieves a list of agreement signing cycles based on the specified signing provider type and agreement ID.
get
Authorization
Get refresh token
post
Get access token
get
Configuration
Get sign configuration
get
Update the sign configuration
put
/api/esign/v1/esignatures/configuration/default
post
Activate a sign provider
post
CongaSign
Create and send a transaction
post
Sign
Create an envelope
post
Get transaction details by transaction
get
Get transaction details by object ID
get
List allowed signer types
get
List users
get
End wet-sign flow
post
Get sign provider templates
get
/api/esign/v1/esignatures/void/{objectId}
post
Get the latest sign provider
get
Conga Sign
AccountAttachmentsBlacklist
Retrieves a list of blacklisted attachment types.
get
AccountAttachmentsWhitelist
Retrieves your current attachments whitelist.
get
Updates your attachments whitelist.
put
Deletes and resets attachments whitelist.
del
AccountDesignerSettings
Retrieves your current Designer settings. Retrieved values include any customizations you may have made, as well as any current default values.
get
Updates your account Designer settings. This call can be used to implement either some of the settings that you wish to change, or to implement all of your changes.
patch
Deletes any Designer settings that you may have configured. Your Designer settings will be returned to their default values.
del
AccountEmailReminderSettings
Retrieves your current Email Reminder settings.
get
Updates your account email reminder settings.
patch
Deletes any customized Account Email Reminder settings.
del
AccountFeatureSettings
Retrieves a list of all your current Backoffice Feature settings.
get
Updates your Backoffice Feature settings with any or all changes. This call can be used to implement either some of the settings that you wish to change, or to implement all of your changes.
patch
Deletes and resets any customized Backoffice Feature settings.
del
AccountPackageSettings
Retrieves a list of all your current Backoffice Package Settings
get
Updates your Backoffice Package settings with any or all changes. This call can be used to implement either some of the settings that you wish to change, or to implement all of your changes
patch
Deletes and resets any customized Backoffice Package settings
del
AccountRoles
Retrieve account role information
get
Create a new account role
post
Update an account role
put
Retrieve an account role
get
Delete an account role
del
Retrieve user IDs assigned to a role
get
Get the user's account roles
get
Create a new account role
post
Accounts
Retrieve account usage information
get
AccountSettings
Retrieves a list of all your current Backoffice Account settings.
get
Updates your Backoffice Account settings with any or all changes. This call can be used to implement either some of the settings that you wish to change, or to implement all of your changes.
patch
Deletes and resets any customized Backoffice Account settings.
del
AccountSigningLogos
Add, update, or delete signing ceremony logos
get
Retrieve an account's signing ceremony logos
post
AccountSigningTheme
Retrieve a customized signing theme
get
Create a customized signing theme
post
Update a customized signing theme
put
Delete customized signing themes
del
AccountSigningUIOptions
Retrieve customized new signer experience settings
get
Patch custom signing UI options
patch
Delete customized new signer experience settings
del
AccountSupportedLanguages
Retrieves the list of supported languages that you can set for your signers.
get
Updates your supported signing languages.
patch
Deletes your personally configured supported signing language settings.
del
AccountSystemSettings
Retrieves your current system settings.
get
Update your system settings with new settings.
patch
Deletes and resets any customized system settings.
del
Approval
Create an approval
post
Update an approval
put
Retrieve an approval
get
Update an approval
put
Delete an existing approval
del
Create a new field with an autogenerated name related to an existing approval
post
Retrieve an approval field
get
Update a field related to an approval
put
Create a field related to an approval with a specific field ID
post
Delete a field from an approval.
del
Updates the conditions for a given approval field
put
Retrieve all signable approvals
get
Auth
CONGA-ONLY Retrieve Auth Session Token
get
AuthenticationTokens
Create a sender authentication token
post
Create a multi-use signer authentication token
post
Create a new single use signer authentication token
post
CONGA-ONLY Creates a User access token that is used to access package details for a signer of an existing package. This single-use token is restricted to a single package and expires after 30 minutes.
post
Callback
Retrieves a list of all callbacks.
get
Creates a new callback.
post
Retrieves a list of callbacks for a specified connector.
get
Creates a new callback for a specified connector.
post
ComprehensiveHealthCheck
Checks for comprehensive health
get
CustomerOnboarded
Get Customer Onboarded
get
CustomerRegistration
CONGA-ONLY Delete OneSpanCallback Customer Registration
del
CONGA-ONLY Register OneSpanCallback Customer Information
post
CONGA-ONLY Get OneSpanCallback Customer Information
get
CustomFields
Create a custom field
post
List all custom fields. Query parameters "to" and "from" are expected to navigate pages.
get
Update a custom field
put
Delete a custom account field by ID
del
Retrieve an account specified custom field
get
DataManagement
Retrieve the data management policy for the account
get
Update the account's data management policy
put
Retrieve the expiry configurations defined for the account
get
Update the expiry configurations defined for the account
put
Documents
Retrieve the specified document
get
Update a document
post
Update the specified document
put
Delete a document from a package
del
Retrieve zipped documents
get
Retrieve document visibility information
get
Update document visibility
post
Retrieve an original PDF document
get
Retrieve a specific document in PDF form
get
Retrieve a page
get
Add a new document to an existing package
post
Update documents
put
Delete multiple documents from a package
del
Create a signature confirmation
post
Sign all documents in a package
post
Apply a layout to a document
post
Retrieve zipped file containing all documents including supporting documents
get
Replace approvals and imprint fields for a document
put
Update document custom metadata
put
ExternalAuthentication
Retrieve external authentication options
get
FileAttachment
Download all attachments
get
Download all attachments for a specific role
get
Download an attachment
get
Add an attachment
post
Delete an attachment file
del
Download an attachment
get
Check for a specific attachment
get
Check for signer uploads
get
Check for attachments and uploads by role
get
IdvEvidenceSummary
Get IDV evidence summary
get
Get IDV evidence summary image URLs
get
Get IDV evidence summary signer image
get
IdvWorkflow
Retrieve the IDV authentication workflow
get
Create an IDV authentication workflow configuration
post
Update IDV workflow configuration
put
Delete IDV workflow configuration
del
IFWorkflowConfiguration
Retrieve IF workflow configuration information
get
ImprintFields
Creates new imprint field with an autogenerated id.
post
Deletes all imprint fields assigned to the document.
del
Replaces all imprint fields with those provided in the request.
put
Retrieves existing imprint field.
get
Deletes existing imprint field.
del
Update existing imprint field.
put
Copies the imprint field to the other documents in the package.
post
InAppReports
Retrieve reports by date and type
get
Delete the specified report files (csv)
del
Retrieve report summaries by date and report type
get
Retrieve a report file (csv)
get
Delete a report file by ID (csv)
del
Retrieve zipped csv reports
get
Layout
List available layouts
get
Create a new layout
post
Notification
Re-send a notification to a signer
post
Re-send a notification to a signer
post
Send an SMS notification to signers linked to a role
post
Send an SMS notification to signers linked to a role
post
Send mobile notification
post
OAuth2
List all OAuth2 clients
get
Create a new OAuth2 client
post
Delete an OAuth2 client
del
Regenerate OAuth2 client secret
post
Generate an OAuth2 access token
post
OneSpanPackage
List packages
get
OneSpanUrl
Retrieves OneSpan BaseURL for different regions
get
Package
List packages
get
Create a package
post
Get package information
get
Update a package
put
Delete a package
del
Get package readiness
get
Get package audit details
get
Summarize package evidence
get
List package fields
get
/v1/cs-packages/{packageId}/referencedConditions
get
Retrieve all approvals by signer
get
Get package signing status
get
Get package signature URL
get
Create packages
post
Re-create a package or template
post
PasswordPolicy
Retrieve password policy information
get
Update password policy configuration
put
Reminder
Retrieve a package's reminder schedule
get
Create a reminder schedule
post
Update a reminder schedule
put
Delete a reminder schedule
del
Reports
Report this sender's usage
get
Report completions by sender
get
Report senders' usage for this account
get
Retrieve a usage report of transactions
get
Report transaction details for transactionId
get
Report current sender's usage
get
Role
Retrieve all package roles
get
Add new role
post
Reorder package roles
put
Adds a new ad hoc group to a transaction
post
Updates a transaction's existing ad hoc group
put
Deletes a specified ad hoc group
del
Retrieve a role
get
Update roles in the package
put
Delete a role
del
Unlock a role
post
RolesVerification
Retrieve information on verification types being used
get
Update an advanced verification method
put
Create advanced verification
post
Delete an advanced verification method
del
Retrieve advanced verification types
get
Sender
List users in an account
get
Create a user
post
Retrieve a user's detailed account information
get
Update a sender's details
post
Delete a sender
del
Invites a user to join the account.
post
Updates a Sender's password.
post
Resets the password for a specified user.
post
Retrieve a user's signature
get
Upload a signature image
post
Delete a signature image
del
Session
Retrieve session object
get
SignatureImage
Retrieve signature image for a package role
get
SignatureLayout
Retrieve signature layout configuration
get
Update signature layout configuration
patch
SubAccounts
List sub-accounts
get
List API keys for the current sub-account user
get
List sub-accounts
get
Create a new sub-account
post
Update a sub-account
put
VirtualRoom
Retrieve a virtual room configuration
get
Update a virtual room configuration
put
List masked fields
get
Define fields to be masked
post
Add a masked field
put
Delete a masked field
del
List available virtual room recordings
get
Fetch a video file
get
Powered by
Get Customer Onboarded
get
https://rls.congacloud.com/api/sign/v1/customer/onboarded
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
Log in to use your API keys
Response
Click
Try It!
to start a request and see the response here!