Skip to main content
Complete the following prerequisites and configuration steps to deploy the Onfido Connector.

​
Prerequisites

Before you configure the connector, ensure you have the following credentials and connectivity in place:
  • Onfido contract and access: You need an active test and production account to use this integration.
  • Access to Onfido Studio: You need administrator access to Onfido Studio to create and configure workflows.
  • An active workflow: Create, configure, and publish one or more workflows in Onfido Studio before you launch any identity verification process.
  • Network connectivity: Confirm routing between the Onfido environments and the Grand Central iPaaS.
  • Environment details: Obtain the following environment variables from Onfido to configure the connector:
KeyDescription
onfido.baseUrlBase URL of the Onfido app
onfidoapitokenOnfido token for OAuth generation

​
Configuration guide

Follow these steps to initialize and authorize your Onfido Connector.

​
1. Establish connectivity

Share the following details with the Grand Central team to establish secure connectivity between Grand Central and Onfido:
  • Environment details: Base URL of the Onfido app
  • Authorization: Onfido API token for authentication

​
2. Configure environment variables

Define your environment variables in the party-lifecycle-v0.values.yaml file in the gc-ecos-applications-live repository. Set values for parameters that override the defaults in the application.properties file. Sample application.properties file: 
onfido.baseUrl= //ONFIDO environment base URL
Sample party-lifecycle-v0.values.yaml file: 
# Sample Onfido environment configuration
connector:
  traits:
    knativeservice:
      minScale: 0
    logging:
      level: INFO
Place the party-lifecycle-v0.values.yaml file in the following path: 
├── iPaaS
└── azure/runtimes
    ├── dev
    └── test
        └── values
            ├── gc-onfido
                └── party-lifecycle-v0.values.yaml

​
Test your integration

To access the Party Lifecycle Unified API, include your Grand Central subscription key in the request header. If you do not have a key, contact the Grand Central Support Team to request one.
KeyValue
api-key<your_subscription_key>
Test the API using the Postman Collection.

​
Troubleshooting

If your connector does not respond as expected, check these common scenarios.
Cause: The Grand Central gateway cannot establish a handshake with the Onfido endpoint. This typically indicates an upstream service outage at Onfido or a network routing failure.Solution: Verify the operational status of the Onfido environment with Onfido. If the service is operational, contact the GC Support team.
Cause: The request to Onfido exceeded the configured timeout threshold. This can occur during high load or network latency issues.Solution: Verify the operational status of the Onfido environment with Onfido. If the service is operational, contact the GC Support team to review timeout configurations.
Cause: You entered incorrect credentials during setup.Solution: Verify your credentials with Onfido and contact the GC team to update the connection.
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 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.