Aggregate API Overview
Jumio’s architecture is designed as an asynchronous system, where each integration typically follows these five steps:
- Initiate a workflow
- Acquire credentials
- Finalize the workflow
- Wait for a callback
- Retrieve the results
The Aggregate API simplifies this process by providing a synchronous experience, merging all five steps into a single API call.
This API is ideal when you want to:
- Upload prepared data credentials, or
- Use existing credentials already available in your account (via the Account Update endpoint).
If any internal service takes longer than the configured timeout, the Aggregate API returns an intermediate response. In that case, you can continue to wait for the callback and then retrieve the final results using the Retrieval API. This page contains the full Aggregate API specification.
note
Authentication for these APIs will remain same as current authentication for Account Initiate and Account Update API