Prerequisites
Before you begin, confirm the following:- You have completed the steps in Get started.
- You have an active contract with DocuSign and your own accounts and credentials set for DocuSign services.
Configuration
To configure your connector, follow these steps:-
Set your API Management (APIM) subscription key in the header as follows:
- Key:
api-key - Value:
YOUR_SUBSCRIPTION_KEY
- Key:
-
Ask the Grand Central team to set up a connection with DocuSign, and provide the following details for JSON Web Token (JWT) generation:
docusign-client-iddocusign-user-iddocusign-account-base-urldocusign-cert-thumbprint
-
Configure the DocuSign
baseURLin thegc-applications-liverepository in the connector’svalues.yamlfile: -
Verify the connector’s
values.yamlfile location in the repository: -
Register your environment callback URL (
{CORRESPONDENCE_INBOUND_BASE_URL}/webhooks/documents-signature) in DocuSign Connect. -
Configure how Grand Central receives asynchronous updates from DocuSign for real-time signing status processing in the
correspondence-inbound-v0.values.yamlfile. The following table lists the ASB configuration properties:
| Property | Description | Example value |
|---|---|---|
asb.event.version | Version of the Async Service Bridge (ASB) schema. | 1.0.0 |
asb.event.type | The ASB event type for outgoing messages. | com.backbase.correspondence.event.spec.v1.DocumentSignatureEvent |
asb.event.source | The ASB source for outgoing messages. | com.backbase.correspondence |
asb.event.topic | The ASB topic for outgoing messages. | document-signature |
asb.producer.apiUri | The callback URI for receiving incoming events. | http://asb-producer-v0.synchub-producer.svc.cluster.local |
Test your integration
To access the Correspondence Unified API, include your Grand Central subscription key in the request header. If you don’t have a key, contact the Grand Central team to have one provisioned. The following table lists the header you must include on each request.| Key | Value |
|---|---|
api-key | YOUR_SUBSCRIPTION_KEY |
Troubleshooting
If your connector isn’t responding as expected, check these common scenarios.5xx: Internal server error or core system down
5xx: Internal server error or core system down
Cause: The Grand Central gateway can’t establish a handshake with the DocuSign endpoint. This typically indicates an upstream service outage at DocuSign or a network routing failure.Solution: Verify the operational status of the DocuSign environment with DocuSign. If the service is operational, contact the Grand Central team.
5xx: Timeout or SocketTimeoutException
5xx: Timeout or SocketTimeoutException
Cause: The request to DocuSign exceeded the configured timeout threshold. This can occur during high load or network latency issues.Solution: Verify the operational status of the DocuSign environment with DocuSign. If the service is operational, contact the Grand Central team to review timeout configurations.
Invalid authentication
Invalid authentication
Cause: The credentials provided during setup are incorrect.Solution: Verify your credentials with DocuSign and contact the Grand Central team to update the connection.
429: Rate limit exceeded
429: Rate limit exceeded
Cause: The number of incoming requests exceeded the defined threshold for your subscription tier. This response protects the stability of the Grand Central and partner infrastructure.Solution: Review your application’s request patterns to identify unexpected spikes. If you require higher throughput, contact the Grand Central team to request an adjustment to your APIM rate limit policy.
Need more help?
Contact support
Reach out to the Grand Central team for assistance with environment setup or rate limit increases.