Initiating a Transaction
Jumio Platform transactions are associated with an account ID, which allows multiple transactions to be associated with an end user
A person who is a customer, patient, constituent, or client of a Jumio customer, and who participates in the “customer journey” as part of their interaction with the Jumio customer.. A transaction is initated by either creating or updating an account. The set of Jumio services used to process the transaction is controlled by a
-
Integrating Jumio Services for an overview of accounts, credentials, workflows, and transactions on the Jumio Platform.
-
Creating or Updating Accounts for information on the relevant APIs for initiating a transaction.
-
Services and Workflows Reference for reference information on standard workflows and customization options.
Initiating a Transaction in V2
Jumio's Netverify API allowed new transactions to be instantiated without context. You could create a new transaction for any user at any time with the same API call. The services executed by a given transaction were determined either by the API endpoint itself, or by including/removing certain API body parameters. There was no way to associate multiple transactions with the same user.
How did user attribution work in V2?
By using the "customerId" field, you could associate a given scan to a user. However, Jumio provided no out-of-the-box management infrastructure for your user/customer objects. You had to track and manage your own users indexed by customer ID fields that you could define arbitrarily.
Example /initiate Request Body
{
"customerInternalReference" : "transaction_1234",
"userReference" : "user_1234",
"successUrl" : "https://www.abc.com/success",
"errorUrl" : "https://www.abc.com/error",
"callbackUrl" : "https://www.abc.com/callback",
"reportingCriteria" : "myReport1234",
"workflowId" : 200,
"presets" :
[
{
"index" : 1, "country" : "AUT",
"type" : "PASSPORT"
}
],
"locale" : "en-GB"
}
Example Response
{
"timestamp": "2018-07-03T08:23:12.494Z",
"transactionReference": "xxxxxxxx-...-xxxxxx",
"redirectUrl": "https://abc.netverify.com/..."
}
Example /performNetverify Request Body
{
"merchantIdScanReference":"",
"country":"",
"idType":"",
"frontsideImage":"/9j/4AA...AEB//2Q=="
"userConsent": {
"userIp": "226.80.211.232",
"userLocation": {
"country": "USA",
"state": "IL"
},
"consent": {
"obtained": "yes",
"obtainedAt": "2022-07-20T17:20:35.000Z"
}
}
"enabledFields":"idNumber,idFirstName,...",
"merchantReportingCriteria":"",
"customerId":"",
"firstName":"firstName",
"lastName":"lastName",
"expiry":"2015-01-01",
"number":"123456789",
"dob":"1970-01-01",
"personalNumber":"123",
"callbackGranularity":"onAllSteps",
"mrzCheck":true,
"frontsideImageMimeType":"image/jpeg",
"callbackUrl":"https://….",
[...]
}
Example Response
{
"timestamp": "2017-08-16T10:37:44.623Z",
"jumioIdScanReference": "xxxxxxxx-xxxx-..."
}
Initiating a Transaction in the Jumio Platform
The Jumio Platform enhances user-management by introducing new concepts for supporting multiple transactions for a single end user A person who is a customer, patient, constituent, or client of a Jumio customer, and who participates in the “customer journey” as part of their interaction with the Jumio customer., including accounts A grouping of credentials and transactions associated with an end user., and
Each of your end users who interacts with Jumio has their own account A grouping of credentials and transactions associated with an end user.. Think of each account as a container for the transactions and documents associated with the user.
Instead of calling an endpoint for a specific service you call an /accounts endpoint. To initiate the first transaction for a new end user you use a POST request to initiate the transaction and create a new account. To initiate a subsequent transaction for the same end user you use a PUT request with the account ID as a path parameter. The Jumio services that will be used for the transaction are determined by the workflow key value that is specified in the request body.
See Creating or Updating Accounts for details.
See also Integrating Jumio Services for a more detailed description.
Example /api/v1/accounts Request Body
{
"customerInternalReference":"myOrganization",
"workflowDefinition":{
"key": 10015
}
}
The response provides all of the information required to acquire the end user's credentials and finalize the transaction.
Example Response
{
"timestamp": "2022-11-28T23:45:02.536Z",
"account": {
"id": "572ac7b5-9f83-409d-ba8e-f0014e411c7e"
},
"web": {
"href": "https://greenunion.web.amer-1.jumio.ai/web/v4/app?authorizationToken=eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ&locale=en-US"
},
"sdk": {
"token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ"
},
"workflowExecution": {
"id": "41f71912-1c6b-4e2f-b340-d6dc10cd69b8",
"credentials": [
{
"id": "fdb1bc31-99a0-4671-8f2a-2bf7ca2faace",
"category": "ID",
"allowedChannels": [
"WEB",
"API",
"SDK"
],
"api": {
"token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ",
"parts": {
"front": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8/credentials/fdb1bc31-99a0-4671-8f2a-2bf7ca2faace/parts/FRONT",
"back": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8/credentials/fdb1bc31-99a0-4671-8f2a-2bf7ca2faace/parts/BACK"
},
"workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
}
},
{
"id": "e25c0737-5753-4812-ab5c-94813e067ec9",
"category": "FACEMAP",
"allowedChannels": [
"WEB",
"SDK"
]
},
{
"id": "bce8a24b-16ba-46a8-994e-fa76e4c4845b",
"category": "SELFIE",
"allowedChannels": [
"WEB",
"API",
"SDK"
],
"api": {
"token": "eyJhbGciOiJIUzUxMiIsInppcCI6IkdaSVAifQ.H4sIAAAAAAAA_5XOMQ7CMAwF0LtkxpKdOk7MxsjKDRInYWkBiUogIe5O2huw_v_09T-uvU-rOzoSUYka0XNSd3DZ7FxHHqLPFksA7WkCRq1QcmrQEYkbE1lsG98xU4-k5IFMCnDzHcrECFWqEVoVLWngV2__cLu0PvTj_lyXfIP1vlzB8jz7rduHvHRGDAmIMQB7GSeFK0zGOan2ZiG57w9fvJLI7AAAAA.0NpDK192_6kMSYfxFuqHPFkhdsKQBqieRvSqt3XAGLWRe7Y8u0aJalMa8TLEY8eA0XEw4TqRapVLDraRHUz4kQ",
"parts": {
"face": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8/credentials/bce8a24b-16ba-46a8-994e-fa76e4c4845b/parts/FACE"
},
"workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/572ac7b5-9f83-409d-ba8e-f0014e411c7e/workflow-executions/41f71912-1c6b-4e2f-b340-d6dc10cd69b8"
}
}
]
}
}