Upgrading from v3

The Jumio Platform API is backward compatible with v3. Upgrading to the current Jumio Platform requires minimal changes to your integration. The most significant changes include:

• Retrieval Details

• Workflow Keys

What Stays the Same

• API Authentication (although you are strongly encouraged to migrate to using OAuth2 Bearer Tokens instead of Basic Authentication, if you have not already done so. See Authorization for additional information).

• API endpoints. The APIs you are used to using for account initialization, credential acquisition, transaction status, transaction detail retrieval, and credential deletion remain the same.

• Transactions available in the Jumio Portal. Your v3 transactions are accessible through the Portal along with new transactions.

Retrieval Details

The transaction details return two additional objects:

• A decision object with the overall dicision and risk score for the transaction. For example

     "decision": {
        "type": "PASSED",
        "details": {
           "label": "PASSED"
        },
        "risk": {
           "score": 0.0
        }
     },
     ...
  

  See also: Transaction Decisions and Risk Scores

• A steps object that provides the URL to the new API for retrieving Workflow Steps

Workflow Keys

The v3 workflows all have corresponding Jumio Platform workflows that return the new details, in addition to taking advantage of the underlying platform improvements. You can take advantage of the new workflows by simply entering the new key in your account request.

v3 Worklfow Key and Description	Jumio Platform Workflow Key and Description
Workflow 1: ID Capture and Storage	10031: ID Capture and Storage
Workflow 2: ID Verification	10015: Jumio ID Verification
Workflow 3: ID and Identity Verification	10011: Jumio Id Verification + Identity Verification
Workflow 5: Similarity to existing ID	10025: Similarity to existing ID
Workflow 6: Standalone Liveness	10016: Standalone Liveness
Workflow 9: Authentication	10014: Jumio Authentication
Workflow 16: Authentication on Premise	10071: Authentication On-Premises
Workflow 20: Similarity of Two Images	10024: Similarity of Two Images
Workflow 32: ID Verification, Identity Verification, Screening	10032: ID + IV + Screening