Skip to main content
API docs by Redocly

Retrieval-API V3 (v0)

Download OpenAPI specification:Download

Retrieval requests let you determine the status of workflow execution. After workflow completion, you can make requests to fetch the results of workflow execution, including risk scores, decisions, and details about the services executed.

To check workflow status, you can poll the end-points periodically or set up a callback and Jumio will send a webhook to your specified URL when a workflow execution completes.

Retrieval

Endpoints for the account retrieval

Returns the binary of the credential part specified in the classifier. JPEG or PNG image (max. size 5 MB and max resolution of 8000 x 8000)

Authorizations:
Oauth2-EUOauth2-USOauth2-SGP
path Parameters
accountId
required
string <uuid>

Account UUID.

credentialId
required
string <uuid>

Credential UUID.

classifier
required
string
Example: FRONT, BACK, FACE

The credential part to return.

Responses

Response samples

Content type
application/json
{}

Returns the detailed results of workflow execution as a transaction record.

Authorizations:
Oauth2-EUOauth2-USOauth2-SGP
path Parameters
accountId
required
string <uuid>

Account UUID.

workflowExecutionId
required
string <uuid>

Workflow UUID. Returns the detailed results of workflow execution as a transaction record. Includes drop-off details such as the last credential captured by the user before abandoning the journey. In addition, this section includes details on the ID and Selfie capture such as auto_capture or manual_capture. Use the captureClient field to inspect these details.

Responses

Response samples

Content type
application/json
{
  • "workflow": {
    },
  • "account": {
    },
  • "createdAt": "2022-09-08T18:22:23.782Z",
  • "startedAt": "2022-09-08T18:26:50.550Z",
  • "completedAt": "2022-09-08T18:28:44.684Z",
  • "wipedOutAt": "2022-09-08T18:30:29.326Z",
  • "credentials": [],
  • "decision": {
    },
  • "steps": {},
  • "feedback": {
    },
  • "capabilities": {
    },
  • "rules": {
    },
  • "consent": {
    },
  • "captureClient": {
    }
}

Deletes all the PII data for the executed workflow.

Authorizations:
Oauth2-EUOauth2-USOauth2-SGP
path Parameters
accountId
required
string <uuid>

Account UUID.

workflowExecutionId
required
string <uuid>

Workflow UUID. Returns the detailed results of workflow execution as a transaction record. Includes drop-off details such as the last credential captured by the user before abandoning the journey. In addition, this section includes details on the ID and Selfie capture such as auto_capture or manual_capture. Use the captureClient field to inspect these details.

Responses

Response samples

Content type
application/json
{}

Returns the status of the executed workflow. The response is the same as the one being sent by the callback.

Authorizations:
Oauth2-EUOauth2-USOauth2-SGP
path Parameters
accountId
required
string <uuid>

Account UUID.

workflowExecutionId
required
string <uuid>

Workflow UUID. Returns the detailed results of workflow execution as a transaction record. Includes drop-off details such as the last credential captured by the user before abandoning the journey. In addition, this section includes details on the ID and Selfie capture such as auto_capture or manual_capture. Use the captureClient field to inspect these details.

Responses

Response samples

Content type
application/json
{
  • "account": {},
  • "workflowExecution": {
    }
}

Returns the presigned s3 URL of the executed workflow. S3 url can be used to download the transaction PDF

Authorizations:
Oauth2-EUOauth2-USOauth2-SGP
path Parameters
accountId
required
string <uuid>

Account UUID.

workflowExecutionId
required
string <uuid>

Workflow UUID. Returns the detailed results of workflow execution as a transaction record. Includes drop-off details such as the last credential captured by the user before abandoning the journey. In addition, this section includes details on the ID and Selfie capture such as auto_capture or manual_capture. Use the captureClient field to inspect these details.

Responses

Response samples

Content type
application/json
{}

Returns the steps in the executed workflow. Each step is a single service that executes one or more capabilities.

Authorizations:
Oauth2-EUOauth2-USOauth2-SGP
path Parameters
accountId
required
string <uuid>

Account UUID.

workflowExecutionId
required
string <uuid>

Workflow UUID. Returns the detailed results of workflow execution as a transaction record. Includes drop-off details such as the last credential captured by the user before abandoning the journey. In addition, this section includes details on the ID and Selfie capture such as auto_capture or manual_capture. Use the captureClient field to inspect these details.

Responses

Response samples

Content type
application/json
{
  • "steps": [
    ]
}

Returns the rules in the executed workflow.

Authorizations:
Oauth2-EUOauth2-USOauth2-SGP
path Parameters
accountId
required
string <uuid>

Account UUID.

workflowExecutionId
required
string <uuid>

Workflow UUID. Returns the detailed results of workflow execution as a transaction record. Includes drop-off details such as the last credential captured by the user before abandoning the journey. In addition, this section includes details on the ID and Selfie capture such as auto_capture or manual_capture. Use the captureClient field to inspect these details.

Responses

Response samples

Content type
application/json
{
  • "executions": [
    ]
}

Deletes all the PII data for every workflow-execution.

Authorizations:
Oauth2-EUOauth2-USOauth2-SGP
path Parameters
accountId
required
string <uuid>

Account UUID.

Responses

Response samples

Content type
application/json
{}

Provides feedback on whether or not the transaction was fraudulent.

Authorizations:
Oauth2-EUOauth2-USOauth2-SGP
path Parameters
accountId
required
string <uuid>

Account UUID.

workflowExecutionId
required
string <uuid>

Workflow UUID. Returns the detailed results of workflow execution as a transaction record. Includes drop-off details such as the last credential captured by the user before abandoning the journey. In addition, this section includes details on the ID and Selfie capture such as auto_capture or manual_capture. Use the captureClient field to inspect these details.

Request Body schema: application/json
required
status
required
string
Enum: "NA" "FRAUD" "NOT_FRAUD"
reason
string
Enum: "NA" "ACCOUNT_TAKEOVER" "COMPANY_POLICY" "FIRST_PARTY_FRAUD" "GOVERNMENT_REGULATIONS" "IDENTITY_FRAUD" "INSIDER_FRAUD" "MONEY_LAUNDERING" "PAYMENT_FRAUD" "PHISHING" "SYNTHETIC_ID_FRAUD" "THIRD_PARTY_FRAUD"

Reason for altering the status.

Responses

Request samples

Content type
application/json
{
  • "status": "FRAUD",
  • "reason": "FIRST_PARTY_FRAUD"
}

Response samples

Content type
application/json
{}

Returns a list of the last processed workflow executions.

Authorizations:
Oauth2-EUOauth2-USOauth2-SGP
query Parameters
size
integer [ 1 .. 100 ]
Default: 50

number of workflow executions to return.

page
integer >= 1
Default: 1

page number to return.

Responses

Response samples

Content type
application/json
{
  • "workflowExecutions": [
    ]
}