Daon Trust API - Simple Integration v1

Swagger API documentation for a Simple Integration. This API integration guide documents the minimum set of API calls required to perform a basic integration with Trust Web.

Server

https://{tenantId}.oak.trustx.com

URL for oak regional system.

https://{tenantId}.fir.trustx.com

URL for fir regional system

https://{tenantId}.gum.trustx.com

URL for gum regional system

Server Variables

Authentication

http bearerAuth

Access to the APIs is restricted by bearer auth

apiKey ApiKeyAuth

An API key is required to create a token

Fields

Key	In
X-Api-Key	Header

Process-manager

POST

/api/process-manager/processTokens

POST

/api/process-manager/processInstances/create

POST

/api/process-manager/processInstances

GET

/api/process-manager/processInstances/{processInstanceId}

GET

/api/process-manager/processInstances/{processInstanceId}/withParameters

GET

/api/process-manager/processInstances/search

Create Process Token

Auth

Request Body

object	object
name	string	maxLength: 50 minLength: 0
processDefnName	string	maxLength: 50 minLength: 0
processDefnVersion	int32
uiUrl	string	maxLength: 500 minLength: 0
status	string	Enum: `ACTIVE`,`INACTIVE`
type	string	Enum: `UNLIMITED`,`MULTI_USE_COUNT_LIMITED`,`MULTI_USE_TIME_LIMITED`
notBeforeDtm	date-time
notAfterDtm	date-time
maxCount	int32
maxProcessDuration	string
parameters	object
*	object

POST /api/process-manager/processTokens

xxxxxxxxxx
 
curl --request POST \ --url 'https://demo.oak.trustx.com/api/process-manager/processTokens' \ --header 'Authorization: Bearer {token}' \ --data '{  "name": "<<randmon value>>",  "type": "MULTI_USE_COUNT_LIMITED",  "status": "ACTIVE",  "uiUrl": "https://{tenantid}.{region}.trustx.com/web/trustweb",  "processDefnName": "<<Existing Process Defintino Name>>",  "processDefnVersion": 1,  "maxCount": 1}'
Copy

Responses

201

Created

object	object
id	string
tenantId	string
name	string	maxLength: 50 minLength: 0
processDefnName	string	maxLength: 50 minLength: 0
processDefnVersion	int32
uiUrl	string	maxLength: 500 minLength: 0
status	string	Enum: `ACTIVE`,`INACTIVE`
type	string	Enum: `UNLIMITED`,`MULTI_USE_COUNT_LIMITED`,`MULTI_USE_TIME_LIMITED`
notBeforeDtm	date-time
notAfterDtm	date-time
maxCount	int32
counter	int32
maxProcessDuration	string
parameters	object
*	object
createdDtm	date-time
createdBy	string
lastUpdatedDtm	date-time
lastUpdatedBy	string
startProcessAddress	string
forTest	boolean

Expand

400

Bad Request

401

Unauthorized

Response

xxxxxxxxxx
 
{ "id": "{string}", "tenantId": "{string}", "name": "{string}", "processDefnName": "{string}", "processDefnVersion": "{int32}", "uiUrl": "{string}", "status": "{string}", "type": "{string}", "notBeforeDtm": "{date-time}", "notAfterDtm": "{date-time}", "maxCount": "{int32}", "counter": "{int32}", "maxProcessDuration": "{string}", "parameters": {}, "createdDtm": "{date-time}", "createdBy": "{string}", "lastUpdatedDtm": "{date-time}", "lastUpdatedBy": "{string}", "startProcessAddress": "{string}", "forTest": "{boolean}"}
Copy

Create Process Instance

Auth

Query String

pt string

POST /api/process-manager/processInstances/create

xxxxxxxxxx
 
curl --request POST \ --url 'https://demo.oak.trustx.com/api/process-manager/processInstances/create' \ --header 'Authorization: Bearer {token}' \ --data pt={pt}
Copy

Responses

201

Created

object	object
redirectUrl	string
processInstanceId	string
themeUrl	string

400

Bad Request

401

Unauthorized

404

Not Found

Response

xxxxxxxxxx
 
{ "redirectUrl": "{string}", "processInstanceId": "{string}", "themeUrl": "{string}"}
Copy

Create Process Instance (with redirect)

Auth

Query String

pt string

POST /api/process-manager/processInstances

xxxxxxxxxx
 
curl --request POST \ --url 'https://demo.oak.trustx.com/api/process-manager/processInstances' \ --header 'Authorization: Bearer {token}' \ --data pt={pt}
Copy

Responses

307

Temporary Redirect

No response body

400

Bad Request

401

Unauthorized

Response

xxxxxxxxxx
 
No response
Copy

Process Instance

Auth

Path Params

processInstanceId string

GET /api/process-manager/processInstances/{processInstanceId}

xxxxxxxxxx
 
curl --get \ --url 'https://demo.oak.trustx.com/api/process-manager/processInstances/%7BprocessInstanceId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
id	string
tenantId	string
processDefnId	string
processDefnName	string
processDefnVersion	int32
lastName	string
firstName	string
phoneNumber	string
email	string
createdAt	date-time
elapsedMilliseconds	int64
status	string
statusMapped	string
review	object
status	string
comment	string
reviewer	string

400

Bad Request

401

Unauthorized

404

Not Found

Response

xxxxxxxxxx
 
{ "id": "{string}", "tenantId": "{string}", "processDefnId": "{string}", "processDefnName": "{string}", "processDefnVersion": "{int32}", "lastName": "{string}", "firstName": "{string}", "phoneNumber": "{string}", "email": "{string}", "createdAt": "{date-time}", "elapsedMilliseconds": "{int64}", "status": "{string}", "statusMapped": "{string}", "review": {  "status": "APPROVE",  "comment": "test",  "reviewer": "skyqc1-user Daon" }}
Copy

Process Instance with additional parameters

Auth

Path Params

processInstanceId string

GET /api/process-manager/processInstances/{processInstanceId}/withParameters

xxxxxxxxxx
 
curl --get \ --url 'https://demo.oak.trustx.com/api/process-manager/processInstances/%7BprocessInstanceId%7D/withParameters' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
id	string
tenantId	string
processDefnId	string
processDefnName	string
processDefnVersion	int32
lastName	string
firstName	string
phoneNumber	string
email	string
createdDtm	date-time
status	string
processTokenId	string
processTokenCounter	int32
processServerId	string
lastUpdatedDtm	date-time
expiringDtm	date-time
dateOfBirth	date
processDefnS3Bucket	string
processDefnS3Dir	string
processDefinitionType	string
processTokenParameters	object
*	object

400

Bad Request

401

Unauthorized

404

Not Found

Response

xxxxxxxxxx
 
{ "id": "{string}", "tenantId": "{string}", "processDefnId": "{string}", "processDefnName": "{string}", "processDefnVersion": "{int32}", "lastName": "{string}", "firstName": "{string}", "phoneNumber": "{string}", "email": "{string}", "createdDtm": "{date-time}", "status": "{string}", "processTokenId": "{string}", "processTokenCounter": "{int32}", "processServerId": "{string}", "lastUpdatedDtm": "{date-time}", "expiringDtm": "{date-time}", "dateOfBirth": "{date}", "processDefnS3Bucket": "{string}", "processDefnS3Dir": "{string}", "processDefinitionType": "{string}", "processTokenParameters": {}}
Copy

Search Process Instances

Auth

Query String

searchString	string	The string of text to search. This can be a name, Reference ID , customer details, email, etc.
startDateTime	string	An ISO timestamp. The default value is 0.
endDateTime	string	An ISO timestamp.

GET /api/process-manager/processInstances/search

xxxxxxxxxx
 
curl --get \ --url 'https://demo.oak.trustx.com/api/process-manager/processInstances/search' \ --header 'Authorization: Bearer {token}' \ --data searchString={searchString} \ --data startDateTime=2022-12-05%2015:00:00.000 \ --data endDateTime={endDateTime}
Copy

Responses

200

Root Type for ProcessInstanceSearch	object
page	int32
size	int32
totalSize	int32
totalPages	int32
content	array[object]
processInstaceId	int32
applicantName	string
applicantEmail	string
applicantPhoneNumber	string
processInstaceStatus	string
createdAt	date-time

Response

xxxxxxxxxx
 
{ "page": 0, "size": 2, "totalSize": 2, "totalPages": 2, "content": [  {   "processInstaceId": 12,   "applicantName": "John Doe",   "applicantEmail": "John.Doe@gmail.com",   "applicantPhoneNumber": "+1123456789",   "processInstaceStatus": "Approved",   "createdAt": "2022-12-05 15:00:00.000"  },  {   "processInstaceId": 13,   "applicantName": "Jane Doe",   "applicantEmail": "Jane.Doe@gmail.com",   "applicantPhoneNumber": "+1123456789",   "processInstaceStatus": "Approved",   "createdAt": "2022-12-05 15:00:00.000"  } ]}
Copy

Process Instance

Auth

Path Params

processInstanceId string

DELETE /api/process-manager/processInstances/{processInstanceId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://demo.oak.trustx.com/api/process-manager/processInstances/%7BprocessInstanceId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

No response body

400

Bad Request

401

Unauthorized

404

Not Found

Response

xxxxxxxxxx
 
No response
Copy

Userdata-server

GET

/api/userdata-server/processDefinitions/{processDefnId}/processInstances/{processInstanceId}/userdata

GET

/api/userdata-server/processDefinitions/{processDefnId}/processInstances/{processInstanceId}/getdata

Get User Data

Auth

Path Params

processDefnId	string
processInstanceId	string

GET /api/userdata-server/processDefinitions/{processDefnId}/processInstances/{processInstanceId}/userdata

xxxxxxxxxx
 
curl --get \ --url 'https://demo.oak.trustx.com/api/userdata-server/processDefinitions/%7BprocessDefnId%7D/processInstances/%7BprocessInstanceId%7D/userdata' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

object	object
documents	object
*	object
id	string
type	string
classification	string
captures	object
*	object
*	object
contentType	string
data	string
segmentedImages	object
*	object
id	string
capture	object
contentType	string
data	string
keyBiographicData	object
*	object
label	string
value	string
fieldName	string
fieldId	string
source	string
biographicData	array[object]
label	string
fieldId	string
fieldName	string
values	object
visualZoneValue	string
barcodeValue	string
mrzValue	string
nfcValue	string
portraitImage	object
id	string
capture	object
contentType	string
data	string
reports	object
reportsByCategory	object
*	object
*	object
id	string
name	string
description	string
outcome	string	Enum: `APPROVE`,`REVIEW`,`DECLINE`,`NA`
faces	object
*	object
id	string
capture	object
contentType	string
data	string
reports	object
reportsByCategory	object
*	object
*	object
id	string
name	string
description	string
outcome	string	Enum: `APPROVE`,`REVIEW`,`DECLINE`,`NA`
cloudFunctions	object
reports	object
reportsByCategory	object
*	object
*	object
id	string
name	string
description	string
outcome	string	Enum: `APPROVE`,`REVIEW`,`DECLINE`,`NA`
additionalDocuments	object
version	integer
documents	object
*	object
id	string
title	object
captures	object
*	object
*	object
contentType	string
data	string
customDataforms	object
*	object
formDataName	string
formDataValues	array[object]
id	string
type	string
label	object
values	object
value	string
review	object
status	string
comment	string
reviewer	string

Expand

400

Bad Request

401

Unauthorized

Response

xxxxxxxxxx
 
{ "documents": {}, "faces": {}, "cloudFunctions": {  "reports": {   "reportsByCategory": {}  } }, "additionalDocuments": {  "version": "{integer}",  "documents": {} }, "customDataforms": {}, "review": {  "status": "APPROVE",  "comment": "test",  "reviewer": "skyqc1-user Daon" }}
Copy

Get Data

Get base64 encoded representation of user data such as a document or face image.

Auth

Path Params

processDefnId	string
processInstanceId	string

Query String

path

string

The path to the user data. For example, a captured document image.

GET /api/userdata-server/processDefinitions/{processDefnId}/processInstances/{processInstanceId}/getdata

xxxxxxxxxx
 
curl --get \ --url 'https://demo.oak.trustx.com/api/userdata-server/processDefinitions/%7BprocessDefnId%7D/processInstances/%7BprocessInstanceId%7D/getdata' \ --header 'Authorization: Bearer {token}' \ --data path={path}
Copy

Responses

200

object	object
contentType	string
data	string

400

Bad Request

401

Unauthorized

403

Forbidden

Response

xxxxxxxxxx
 
{ "contentType": "{string}", "data": "{string}"}
Copy

Arthr-server

POST

/api/arthr/apiKeys/issue

DELETE

/api/arthr/apiKeys/{apiKeyId}

Create Token

Auth

POST /api/arthr/apiKeys/issue

xxxxxxxxxx
 
curl --request POST \ --url 'https://demo.oak.trustx.com/api/arthr/apiKeys/issue' \ --header 'X-Api-Key: {X-Api-Key}'
Copy

Responses

200

object	object
token	string
ttl	int32

400

Bad Request

401

Unauthorized

Response

xxxxxxxxxx
 
{ "token": "{string}", "ttl": "{int32}"}
Copy

Delete API Key

Auth

Path Params

apiKeyId string

DELETE /api/arthr/apiKeys/{apiKeyId}

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://demo.oak.trustx.com/api/arthr/apiKeys/%7BapiKeyId%7D' \ --header 'Authorization: Bearer {token}'
Copy

Responses

200

No response body

400

Bad Request

401

Unauthorized

Response

xxxxxxxxxx
 
No response
Copy