Calling Retrieval APIs

APIs are available for retrieving:

  • Workflow Status to obtain the processing status of the transaction. Depending on the workflow being executed the transaction may take up to several minutes to complete. The Status API provides a way to determine when the transaction details are actually available.

    Workflow Details including the workflow metadata, credentials (including URLs for accessing each credential part), and the capabilities that were executed.

  • Workflow Steps with information about each service that was called, and the capabilities that were executed for that service.

  • Individual Workflow Credentials.

  • A URL that allows you to download a PDF transaction report.

For the complete API specification see: Retrieval API Reference.

Retrieval Best Practices

Make sure the transaction is complete before retrieving the detail data:

  • lf you have implemented a Callback service, wait for the callback before requesting the transactions details.

  • Alternatively, call the Workflow Status API. If the transaction status is:

    • PROCESSED you can retrieve the details and images.

    • SESSION_EXPIRED or TOKEN_EXPIRED, the transaction was unsuccessful and details will not be available.

Recommended Retry Policy

To accommodate any brief interruptions to the retrieval service Jumio recommends you implement a retry policy with an initial retry after 40 seconds and a maximum of 10 consecutive unsuccessful retrieval attempts after receiving the callback. The recommended timings are 40, 60, 100, 160, 240, 340, 460, 600, 760, and 940 seconds.