The Destination Formats and APIs module governs how structured, validated data exits Docupath and enters downstream systems.
It has two primary functions: configuring the outbound data format (the file structure used for exports) and managing API credentials (the Client ID and Secret key pairs that external systems use to authenticate with Docupath). Together, these settings form the handoff layer - the point where clean, AI-extracted data is delivered to your ERP, EDI gateway, compliance tool, or data lake.
How It Works
Outbound Destination Format
The Destination Format setting determines the file format used when exporting approved documents to external platforms. Docupath supports standardised formats such as Simple XML, with the ability to extend to custom formats as integration needs evolve.
Configuration is straightforward:
Navigate to Settings → Destination Format & APIs
Select the preferred format (e.g., Docupath Simple XML Format)
Save the selection
The selected format applies to all future exports. Previously exported documents retain their original format and are not retroactively reformatted.
API Credentials
Docupath uses Client ID and Client Secret key pairs to authenticate external systems that connect to your tenant. Only authorised clients can access or retrieve data.
Generating Credentials
Navigate to Settings → Destination Format & APIs
Click Generate API Credentials
Enter a descriptive Key Name (e.g.,
ERP Prod,Tax Auth Key,Staging-EDI)Copy the Client ID and Client Secret - the Secret is displayed only once
Store credentials securely in a secrets manager or vault
Key Rotation Workflow
Generate a new API credential with a descriptive name
Update the external system to use the new credentials
Verify the integration is working with the new key
Delete the old credential from Docupath
Credential Security
The Client Secret is shown only once at generation. It cannot be retrieved after the modal is closed
If the Secret is lost, the credential must be deleted and a new one generated
Credential management is restricted to Admin users
Descriptive naming conventions (including environment identifiers) are recommended for multi-environment deployments
Supported Configurations and Options
Configuration | Detail |
Destination format | Docupath Simple XML Format (default); extensible to custom formats |
API credential fields | Key Name, Client ID, Client Secret |
Credential management | Generate, view (Client ID only), delete |
Key naming convention | Recommended: include environment and system identifiers (e.g., |
Format application | Applies to future exports only |
Other Technical Specifications
Parameter | Detail |
Authentication method | Client ID + Client Secret key pair |
Secret visibility | One-time display at generation |
Active credentials | Multiple keys can be active simultaneously |
Format selection scope | Tenant-wide — applies to all document exports |
Active export templates | One data export template per document type at a given time |
Notes
Client Secrets cannot be recovered once generated - lost keys require deletion and recreation
Format selection applies only to future deliveries; past exports remain in their original format
Only one data export template can be configured at a given time for all file types
Changing the destination format mid-stream without informing downstream teams can cause parsing failures in receiving systems
API credentials are tenant-scoped - they cannot be restricted to specific organisations or document types within the tenant
There is no built-in credential expiry mechanism - implement key rotation as part of your security operations calendar