Jumio Platform API - Accounts (1.0.0)

Download OpenAPI specification:Download

Create a new account to onboard new end-users, or Update an existing account for returning end users.

All other transactions in a given user journey are tied to the Account ID, so always start each customer journey with the appropriate account request.

Account

Create and update end-user accounts.

Account Creation

Creates a new account. Do this first when onboarding a new customer.
Use Account update for changes to existing accounts.

Related guide: Account Creation and Updates

Authorizations:

BearerAuth

header Parameters

User-Agent

required

string

Value for the User-Agent header

Request Body schema: application/json

userReference	string [ 1 .. 100 ] characters Internal ID used by the customer for the end user (must not contain PII). See also Optional fields.
customerInternalReference required	string [ 1 .. 100 ] characters Internal reference used in the customer backend to identify the request (must not contain PII). Must not contain any of the following characters: <>"/;`%{}\|
reportingCriteria	string [ 1 .. 255 ] characters Additional information provided by the customer for searching and aggregation purposes. See also Optional fields.
callbackUrl	string [ 1 .. 255 ] characters URL to override the default callback url for this particular request. See also Optional fields.
tokenLifetime	string^([+-]?\d+)([smhd]{1})$ Override the default token lifespan with another duration (example '1d' or '30m' or '600s'): s - seconds m - minutes h - hours d - days See also Optional Fields.
	object (webSettings) Web client settings.
required	object (workflowDefinition) Definition of the specific documents necessary to execute for the particular capabilities on them.
	object (userConsent) User Consent information.
	object Allows overriding certain settings for the workflow execution.

Responses

Request samples

Payload

Content type

application/json

{"userReference": "string",
"customerInternalReference": "string",
"reportingCriteria": "string",
"callbackUrl": "https://mypreferredendpoint.com/callback",
"tokenLifetime": "15m",
"web": {"successUrl": "string",
"errorUrl": "string",
"locale": "strin"
},
"workflowDefinition": {"key": "10163",
"credentials": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category": "ID",
"country": {"predefinedType": "DEFINED",
"values": ["AUT"
]
},
"type": {"predefinedType": "DEFINED",
"values": ["DRIVING_LICENSE"
]
}
}
],
"capabilities": {"watchlistScreening": { },
"documentVerification": {"enableExtraction": true
},
"ekycCheck": {"searchType": "string"
},
"workflowDecision": {"riskScoreRulesetId": "string",
"decisionLabelRulesetId": "string"
},
"ruleset": {"ids": [ ]
}
}
},
"userConsent": {"userIp": "string",
"userLocation": {"country": "string",
"state": "string"
},
"consent": {"obtained": "yes",
"obtainedAt": "2022-07-20T17:20:35.000Z"
}
},
"overrideSettings": {"property1": "string",
"property2": "string"
}
}

Response samples

201
401
403
404

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"account": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"web": {"href": "http://example.com",
"successUrl": "http://example.com",
"errorUrl": "http://example.com"
},
"sdk": {"token": "string"
},
"workflowExecution": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"credentials": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"category": "ID",
"country": {"predefinedType": "DEFINED",
"values": ["AUT"
]
},
"type": {"predefinedType": "DEFINED",
"values": ["DRIVING_LICENSE"
]
},
"allowedChannels": ["string"
],
"api": {"token": "string",
"parts": {"front": "http://example.com",
"back": "http://example.com",
"face": "http://example.com",
"facemap": "http://example.com",
"prepared_data": "http://example.com",
"device_risk": "http://example.com",
"document": "http://example.com"
},
"workflowExecution": "http://example.com"
}
}
]
}
}

Account Update

Update an existing account.

Related guide: Account Creation and Updates

Authorizations:

BearerAuth

path Parameters

accountId

required

string <uuid>

Example: bbf3a261-9bf9-400c-b218-cd275596d8d9

Unique Account Identifier.

header Parameters

User-Agent

required

string

Value for the User-Agent header

Request Body schema: application/json

userReference	string [ 1 .. 100 ] characters Internal ID used by the customer for the end user (must not contain PII). See also Optional fields.
customerInternalReference required	string [ 1 .. 100 ] characters Internal reference used in the customer backend to identify the request (must not contain PII). Must not contain any of the following characters: <>"/;`%{}\|
reportingCriteria	string [ 1 .. 255 ] characters Additional information provided by the customer for searching and aggregation purposes. See also Optional fields.
callbackUrl	string [ 1 .. 255 ] characters URL to override the default callback url for this particular request. See also Optional fields.
tokenLifetime	string^([+-]?\d+)([smhd]{1})$ Override the default token lifespan with another duration (example '1d' or '30m' or '600s'): s - seconds m - minutes h - hours d - days See also Optional Fields.
	object (webSettings) Web client settings.
required	object (workflowDefinition) Definition of the specific documents necessary to execute for the particular capabilities on them.
	object (userConsent) User Consent information.
	object Allows overriding certain settings for the workflow execution.

Responses

Request samples

Payload

Content type

application/json

{"userReference": "string",
"customerInternalReference": "string",
"reportingCriteria": "string",
"callbackUrl": "https://mypreferredendpoint.com/callback",
"tokenLifetime": "15m",
"web": {"successUrl": "string",
"errorUrl": "string",
"locale": "strin"
},
"workflowDefinition": {"key": "10163",
"credentials": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category": "ID",
"country": {"predefinedType": "DEFINED",
"values": ["AUT"
]
},
"type": {"predefinedType": "DEFINED",
"values": ["DRIVING_LICENSE"
]
}
}
],
"capabilities": {"watchlistScreening": { },
"documentVerification": {"enableExtraction": true
},
"ekycCheck": {"searchType": "string"
},
"workflowDecision": {"riskScoreRulesetId": "string",
"decisionLabelRulesetId": "string"
},
"ruleset": {"ids": [ ]
}
}
},
"userConsent": {"userIp": "string",
"userLocation": {"country": "string",
"state": "string"
},
"consent": {"obtained": "yes",
"obtainedAt": "2022-07-20T17:20:35.000Z"
}
},
"overrideSettings": {"property1": "string",
"property2": "string"
}
}

Response samples

200
401
403
404

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"account": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
"web": {"href": "http://example.com",
"successUrl": "http://example.com",
"errorUrl": "http://example.com"
},
"sdk": {"token": "string"
},
"workflowExecution": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"credentials": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"label": "string",
"category": "ID",
"country": {"predefinedType": "DEFINED",
"values": ["AUT"
]
},
"type": {"predefinedType": "DEFINED",
"values": ["DRIVING_LICENSE"
]
},
"allowedChannels": ["string"
],
"api": {"token": "string",
"parts": {"front": "http://example.com",
"back": "http://example.com",
"face": "http://example.com",
"facemap": "http://example.com",
"prepared_data": "http://example.com",
"device_risk": "http://example.com",
"document": "http://example.com"
},
"workflowExecution": "http://example.com"
}
}
]
}
}