Search
Introduction
This guide will describe how activities in a Process Definition can be navigated programatically using the API. Requests and responses are provided for each activity that would be used as part of a typical ID&V flow in TrustX.
For information on configuring a Process Definition using the Backoffice Process Designer, see the Process Definition Guide.
Create a Process Token
Example Request:
POST https://skyqc1.oak.trustx-qc.com/api/process-manager/processTokens
Content-Type: application/json
Authorization: Bearer {{token}}
{
"name": "{{$randomIngverb}}-{{$randomNoun}}",
"description": "{{$randomPhrase}}",
"status": "ACTIVE",
"type": "UNLIMITED",
"processDefnName": "{{processdefname}}",
"processDefnVersion": {{processdefversion}},
"uiUrl": "{{$randomUrl}}",
"parameters": {
"firstName": "{{$randomFirstName}}",
"lastName": "{{$randomLastName}}",
"email": "{{$randomEmail}}",
"phoneNumber": "{{$randomPhoneNumber}}",
"referenceID": "asdasd"
}
}
Example Response:
{
"createdDtm": "2023-12-14T22:44:06.219Z",
"lastUpdatedDtm": "2023-12-14T22:44:06.219Z",
"createdBy": "API Key: jasontestapikey",
"lastUpdatedBy": "API Key: jasontestapikey",
"id": "IRV4KRZC4UGNUUBGT47N7K27IQ",
"tenantId": "skyqc1",
"name": "synthesizing-panel",
"processDefnName": "xProofTrustXIntegrationDocoSampleProcess",
"processDefnVersion": 3,
"uiUrl": "http://constance.net",
"status": "ACTIVE",
"type": "UNLIMITED",
"counter": 0,
"maxProcessDuration": "PT48H",
"parameters": {
"firstName": "Cathy",
"lastName": "Cassin",
"email": "Myrl_Rempel89@yahoo.com",
"phoneNumber": "310-443-0819",
"referenceID": "asdasd"
},
"forTest": false,
"startProcessAddress": "http://localhost:9091/processInstances?tn=skyqc1&pt=IRV4KRZC4UGNUUBGT47N7K27IQ"
}
Create Process Instance
Example Request:
POST https://skyqc1.oak.trustx-qc.com/api/process-manager/processInstances/create?pt={{processTokenId}}
Authorization: Bearer {{token}}
{}
Example Response:
{
"redirectUrl": "https://alek.org?ps=https%3A%2F%2Fskyqc1.oak.trustx-qc.com%2Fapi%2Fprocess-server%2FstartProcess%3Fpi%3DFHYDHK7SJ5QRHDKUNAXGUB4OUE",
"processInstanceId": "FHYDHK7SJ5QRHDKUNAXGUB4OUE"
}
Start a Process Instance
Example Request:
POST https://skyprodqc.oak.trustx.com/api/process-server/startProcess?pi=NY3YGDMK3MECEOHVDE7AYDQT74
Content-Type: application/json
{
"isMobile":true
}
Example Response:
{
"code": 202,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyqc1",
"businessKey": "6KT7ETUKDYYZGZR7I3JOQPKQUU",
"stepId": "face-capture",
"screenId": "instructions",
"screens": [
"instructions",
"capture"
],
"variables": {
"preSignedHeaders": {
"Content-Type": "image/jpeg",
"x-amz-server-side-encryption": "aws:kms",
"x-amz-tagging": "RemoveAfter=30d",
"x-amz-server-side-encryption-aws-kms-key-id": "8965bbca-14f2-4edd-8d77-ab9c8fad1c84"
},
"continueProcessUrl": "https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/6KT7ETUKDYYZGZR7I3JOQPKQUU/topicName/L-f64d40d6-1d15-41c1-a345-31a3b4dc3f1a/continue",
"activityConfig": {
"faceImageFormat": "jpeg",
"faceKey": "face1",
"cameraHeight": 720,
"activities": null,
"cameraWidth": 1280,
"timeoutInSeconds": 60
},
"preSignedImageUrl": "https://sky-qc-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyqc1/processDefinitions/3TS76CKBQXUYXRV6ZVC3XTDY2Y/processInstances/6KT7ETUKDYYZGZR7I3JOQPKQUU/faces/face1/c8da0912-209f-464c-a3b4-48a7845a6ace/face.jpeg?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEOn%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJHMEUCIQDHu8K%2BVewrmjE0W7FKi%2FyEjVpdoMC22DaZNWtrpPdvOgIgY5%2FyF6NuWzBPDDJvpJTBrXML9Zt8FFYR2YupzgpEBpAq%2FgQIYhAAGgw1ODgyMjI0MDEyNjkiDLtc8%2BAH3XYnmXluayrbBH3X%2FSyKi8WBNcLymUA4whfOTM3KbJZk1Y7kI319UVJNngQYRe5%2FDaksmOho%2FgLnhGO79UFSuvmNPAS%2BIR02LJTNIjav8cn%2BoqFDo5IFROs6l68yVR4G1Ke9V1OngekevWVgDjeQTZBbv7RDIE2JTEv3L%2FhdGdFjtva78b9vnxVaphQ306J3g6aPOHpRynHBCKSm7AvW5fn9GrMav6MZCALFUvNDBNAlv7rkz%2BzdEDnPnmjZ7vlYRPjtfhBWX1alka4TcNKZUqDUTZGupe7vA5yQvjG9TFK%2Be9G72FYltZGduqYsfyhpWWJxeXtIF4hg4f2%2FQYn1j7PymZ3uSFMshQjbmNGFr%2Fbpat3fcmoIQtrMcu57puz0DlBbpm5dKb2P75ip%2Br3QakNlBJ7Vue%2B%2BKQxs%2BqASXXwh3S8DUFYTcHdM4fiZKtOL7bkHrlFCzb93EsWF7xIDYswNFr6czu3rXxVwBsXi%2F%2FEpOo%2BsELNK869Hbiox63tpnzbgg2UaXXRyu1JMuWm41dqLX9zhnt8w2kbIudDUx1c0OHdeWx2%2B4KelDsTM5cBg8Q1HBd%2F3iiGODxX9ouLwznoGEorSKQfi3w64A7KTDFjkiHupyAbP6VSMIP0YwRtzA%2BoK9OAKqfThrJQkAd%2F2R%2Brwj7%2Bd2aUSZMWaTPdqYHprSmN4C8qAdynVNQIYOhI5t%2F4v2Fmfy0C5FWszjbj6ql6487jpEQ4Z5IuQD6CNAJYp0YHUZhHxerBxE8kQVu48a97tGU%2F%2BvalVHby97S8dSbUoRI1ZGb8feshBc8m%2FEhhc%2FSsggDCU4OyrBjqaAdIfpcaYJj9D8s99ZYjcekMrBo%2BvvRmhsSXRuC7gJj8zemTPbMd%2Fv9CZ%2F3sWpNUS7hvfXP%2BfpFw2Nnx8rgOVN88c4xZ0WLdC%2FrzAUi%2BegiP64a2Q6nJl9msFCVUhbDCKTZv50a9Mikc39W9Momf9f5NqIEglbiXWIz5W1wsFVDt1eG8ivxsyfnI96A8W0YoNZD1fTmF61AkDzOA%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231214T164052Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id%3Bx-amz-tagging&X-Amz-Expires=172800&X-Amz-Credential=ASIAYR5GJRL2UJ3JIAFQ%2F20231214%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=8a87c61c0db7f4d59f74dedf79f1a5717316f8cf16c421c36e5fd8d798784b36"
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": null,
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.oak.trustx-qc.com/"
}
Introduction Screen
Screen in Trust Web Flow:
Example Request:
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-1c61b9f2-3657-421d-ac27-1e84cc67c1f3/continue?currentLanguage=en
Content-Type: application/json
{}
Example Response:
{
"code": 202,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyprodqc",
"businessKey": "NY3YGDMK3MECEOHVDE7AYDQT74",
"stepId": "consent",
"screenId": "consent",
"screens": [
"consent"
],
"variables": {
"continueProcessUrl": "https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-fb798eb0-19a2-4bb8-9529-951835263bf0/continue",
"activityConfig": {
"activities": [
null,
"consent",
"face-capture",
"document-capture",
"additional-documents"
],
"items": [
"{\"title\":\"Terms and Conditions\",\"label\":\"termsAndConditions\",\"url\":\"https://cdn.trustx.com/consents/2023-08-29-term_of_use_consent.html\",\"type\":\"url\"}",
"{\"title\":\"Privacy Policy\",\"label\":\"privacyPolicy\",\"url\":\"https://cdn.trustx.com/consents/2023-08-29-privacy_policy_consent.html\",\"type\":\"url\"}"
]
}
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": "en",
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.trustx.com/"
}
Capture Consent Screen
Screen in Trust Web Flow:
Example Request:
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-fb798eb0-19a2-4bb8-9529-951835263bf0/continue?currentLanguage=en
Content-Type: application/json
{}
Example Response:
{
"code": 202,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyprodqc",
"businessKey": "NY3YGDMK3MECEOHVDE7AYDQT74",
"stepId": "face-capture",
"screenId": "instructions",
"screens": [
"instructions",
"capture"
],
"variables": {
"preSignedHeaders": {
"x-amz-server-side-encryption": "aws:kms",
"x-amz-tagging": "RemoveAfter=30d",
"x-amz-server-side-encryption-aws-kms-key-id": "2e4180f4-3f49-4cda-8e75-56ee977e0996",
"Content-Type": "image/jpeg"
},
"continueProcessUrl": "https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-648c37b4-cc5b-417c-9437-d97b344f4c8f/continue",
"activityConfig": {
"faceImageFormat": "jpeg",
"faceKey": "face1",
"cameraHeight": 720,
"activities": [
null,
"consent",
"face-capture",
"document-capture",
"additional-documents"
],
"cameraWidth": 1280,
"timeoutInSeconds": 60
},
"preSignedImageUrl": "https://sky-prod-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyprodqc/processDefinitions/I5HO6PWJAXA5UEX2JF2UQ33QRY/processInstances/NY3YGDMK3MECEOHVDE7AYDQT74/faces/face1/ed4c9138-40bf-4abc-859e-319fa06aa6dc/face.jpeg?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJ%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJHMEUCIA25BMVkiqDuAJVt11EpkBnwpyD7tP5SWZCFY4Z9lRTxAiEAmnuMR70FMWgmpqT7jiUW%2FQbr85xKhSjueKcAOR%2B0YBoqhgUIGBABGgw4OTAzNzMyNzI1NjQiDGGTsAoL9oce6gWnYCrjBBWASvtJj2uebh911Lswfw6MML7LmOQoFK9zRr3I%2FpYasfolCLcpIFs0ay9qKvcgF8%2BFAnqCz9n35zegFJcNsKcM%2Fy8ly7t93LNwi4GVySVSlmGS6Bc70IeNFlON%2FVNfnVej5CiS2cDDywj17m3YM4A30GK0kZjmZXKo1g5WtrfMZ84ah4gqfdUp9u4zE5eHsxtLRiqg12xHszcf6O4TZkRyCoarTRNPXKSqf9Y1bzWVbfkuS8cpfZYZGDeLomsyi3SjSnuRC8fsnNAifOL9cedw8B4Qobm%2BJ9lyTxO20I%2F%2FYDT5MaNaRmbh2Sqp4uv87HYqu9s7%2BjsB1Xw0mx2q%2BP6i9gDpSnQA%2BSAmZXnPJiX59Q3dXDuDCKKBzcY%2FsbjjvKte0MXYRMvWPDCrbgxi62fBdI%2BlHLe%2F%2BlJgB2snOoGwJPFSy%2BvQMKolXrVihn7mhqG2lM%2FWJsPkFqH3evsi11bLpU%2BuHKKXSkqqqxIvZ0mS6YpMlGy4lYZ0Elmd6syBbAXpW2dGsd%2BGez7CZaXcdR8A4eNj6F56rtvw%2FxibIkh1Y%2FwaB7Ww8nMNIxjkvDjOWALqhUIlmHFjMd%2FRVtllFk%2BeZgP44BAgBg1d9wksfDGOGGxSlvgXoop%2FCYPy7PHFUJc3Ei5%2ByhKlGQ8m1yylc9EILts0WsGE1O%2BucbDViktPuQKFy53TNvnToqw6C98FKfUBDr5S4myRnfan3s4EJnhvQpt8buCvvetlYUZ162SjCG1Ll8jwsmYtOBbgzt3wb2goXLuz6R6ChhuetGityXEbl2FxxMdi7FxyIkfb7vlyRwmqMNS83KsGOpoBN0QkQ8tYnMNM8TRCK3nVX0GbctR5D2%2Fzys1n56eAFcNMwwrkXCEwC0SMl7c47j2rNpRz3G8Gj0AnArlnqjchh4VgBzo%2FlJvh5QASRUMlF%2Bo4D3cLgx0nVNyC7VfeCONVkg5NuQ4Ij3pOAd4Jn0YwZlnr4B5k5xKFiJMeKkkfagKNA3j62WiIc8NT30p%2F81RcK%2B4rTH0xlXFJ0Q%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231211T143604Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id%3Bx-amz-tagging&X-Amz-Expires=172800&X-Amz-Credential=ASIA46TTB6P2MFKGBS7T%2F20231211%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=5d7e3382c488ee1025c98922d60a8a80f11e455631ced07d4262843aa0c9e56f"
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": "en",
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.trustx.com/"
}
Capture Face Image Screen
Screen in Trust Web Flow:
Example Request:
PUT https://sky-qc-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyqc1/processDefinitions/3TS76CKBQXUYXRV6ZVC3XTDY2Y/processInstances/6KT7ETUKDYYZGZR7I3JOQPKQUU/faces/face1/c8da0912-209f-464c-a3b4-48a7845a6ace/face.jpeg?...
Host: {aws_url}
User-Agent: {browser_user_agent}
Accept: */*
Content-Length: 121212
Content-Type: image/jpeg
<the raw bytes>
Example Response:
200 OK
Continue After Face Upload
Example Request:
POST https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/6KT7ETUKDYYZGZR7I3JOQPKQUU/topicName/L-f64d40d6-1d15-41c1-a345-31a3b4dc3f1a/continue
Content-Type: application/json
{}
Example Response:
{
"code": 202,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyqc1",
"businessKey": "H7G3BG4WSYM2UA2RKYEXDXHDBU",
"stepId": "face-capture",
"screenId": "preview",
"screens": [
"preview"
],
"variables": {
"continueProcessUrl": "https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/H7G3BG4WSYM2UA2RKYEXDXHDBU/topicName/L-cbf8dd31-8aaf-4b18-a4ea-77bd838f07eb/continue",
"activityConfig": {
"activities": null
}
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": null,
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.oak.trustx-qc.com/"
}
{
"code": 748,
"message": "No face could be found in the image. ",
"status": "NO_FACE",
"tenantId": "skyqc1",
"businessKey": "SVJTRN4LYMIUZRHJWLNFL6C65Y",
"stepId": "face-capture",
"screenId": "preview",
"screens": [
"instructions",
"capture"
],
"variables": {
"preSignedHeaders": {
"x-amz-server-side-encryption": "aws:kms",
"x-amz-tagging": "RemoveAfter=30d",
"x-amz-server-side-encryption-aws-kms-key-id": "8965bbca-14f2-4edd-8d77-ab9c8fad1c84",
"Content-Type": "image/jpeg"
},
"continueProcessUrl": "https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/SVJTRN4LYMIUZRHJWLNFL6C65Y/topicName/L-8e31f35e-cd06-47b6-aecf-7663a1702a2d/continue",
"activityConfig": {
"faceImageFormat": "jpeg",
"faceKey": "face1",
"cameraHeight": 720,
"activities": null,
"cameraWidth": 1280,
"timeoutInSeconds": 60
},
"preSignedImageUrl": "https://sky-qc-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyqc1/processDefinitions/VYF32LFZABZLMQSLWQYXOJL3PE/processInstances/SVJTRN4LYMIUZRHJWLNFL6C65Y/faces/face1/49a7f6bd-e336-4a29-9450-cd186cada6ad/face.jpeg?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJHMEUCIQC%2Fh%2BS9SHJbPNBLz07PGiOqr6tFhaaXoR%2F0tDDDcm5OdwIgTNkQPH%2F3yXpCE22mbU0Gnx%2Famnb9O1b%2FBEr4BXvB%2BBsq%2FgQIahAAGgw1ODgyMjI0MDEyNjkiDDbsnYuxysVf0V3aPyrbBO90L7NZ3HE%2BCzv7nFpjmG2FxZQK0HmaucGLUzgT6uFabsI%2By18u12Ayn54EKZgsKYXKyhNTYzisz%2F60aIphKbGoBJjDB9DhaVxOEKZrYccu%2B4TmJC3FxFO81p7jFMf3YMV7F9JLTqjihDtQGUr6AYusknJ5javr4Y%2B%2Br%2Bqk1RORyNdugaCS%2B1%2Fntr7QaO6TnS9i6%2Bg6V4kbs8rnO7wV1ZgI1b6tG%2FqqlTyVe5%2BphSba1PqhAi6miyJRRw8xzNC2TMsTepqYnGT7TJ5uJh%2F09izoY9Qv%2FMH9DkSJXZwc0cOjPH3FvpDhpT5db2nLRof4k%2F7cQcG%2FsSRpZTYUt3kpZQQUFMyLznVl72usLRnhh7XbZ68htl6f2wezez9XXFxwb6DTM77R%2FoZJ%2FR%2BPzFYtktP13IcuWnM4%2FDCrKtINrSRKYYUzEoKn6cwryfA9t8xtrC73JRy5JEE%2FqDvNNcGuBGKwHiJS3HkZ%2BWiTs8lCH2yWLRGYQWRxdNFgc5ohLqK5bZCQVxNV4DltyBFIaUst37tTu0gGJLZYAsdR6LXIHmDcuucdExuR55brR%2BScvwmvZ0PmlYJCLwkPo7Ec4fMDkXmQPl9fGH2NJy%2Fh9HxWdKKnzJyLiyrW7HvftS4dhq5EuodDJXACaCAmK8sCEOUO%2Fo7IaA6T151pnmxlROXjHSsJDlFIcum%2F%2FB4ZeC54VNmfIHzXmud7WVPMSaqqI%2FfDfdKNKNxhotwYQDlBDAZ4EVfR15ef%2FUmMoAhHpwOZ3K33WnMTh7Qkyx3XxWre2BeP4f1U1n7e1wk4lfep1TCG0%2B6rBjqaAdI4dxFugGTk%2B3Ef0hIbdOSJEJKRp8KuFO4xiiU7sCI9eUTyNlz3EQOG6BDWAeYJ9t5bxCP%2BQI%2BpfxIQPWaEz7NP1swA2li92jlCP1DuTBVhaVTj2bXVfDvmr%2FzSt9eJZYNcQESXz9yH3Rsj6l7ol0eiNPZGBHC%2BhqAuo696dI5cSugEjPL6fsJ3KyOpLUIrzI4ZadqBAO%2FCrLM%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231215T011902Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id%3Bx-amz-tagging&X-Amz-Expires=172800&X-Amz-Credential=ASIAYR5GJRL2W43DDK5Q%2F20231215%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=f8409f71531860f7ab76142fa152c590d5f3916dfd61e2d7e35ebcd2d9cc5efa"
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": null,
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.oak.trustx-qc.com/"
}
{
"code": 802,
"message": "Face too small. Please move closer to camera.",
"status": "TOO_SMALL",
"tenantId": "skyqc1",
"businessKey": "6KQATJG5OLK5APL2I7LL3TAM5Q",
"stepId": "face-capture",
"screenId": "preview",
"screens": [
"instructions",
"capture"
],
"variables": {
"preSignedHeaders": {
"x-amz-server-side-encryption": "aws:kms",
"x-amz-tagging": "RemoveAfter=30d",
"x-amz-server-side-encryption-aws-kms-key-id": "8965bbca-14f2-4edd-8d77-ab9c8fad1c84",
"Content-Type": "image/jpeg"
},
"continueProcessUrl": "https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/6KQATJG5OLK5APL2I7LL3TAM5Q/topicName/L-c045dc2d-e49c-4b29-b034-c224799c0042/continue",
"activityConfig": {
"faceImageFormat": "jpeg",
"faceKey": "face1",
"cameraHeight": 720,
"activities": null,
"cameraWidth": 1280,
"timeoutInSeconds": 60
},
"preSignedImageUrl": "https://sky-qc-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyqc1/processDefinitions/VYF32LFZABZLMQSLWQYXOJL3PE/processInstances/6KQATJG5OLK5APL2I7LL3TAM5Q/faces/face1/65db1490-a5d0-4482-a6cd-cade7135a5e3/face.jpeg?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJHMEUCIQDaCQUCyg9HEXHz%2FNH%2FDES1MYauypAQMNQp8eAS2SiO%2FgIgY3wVg4V%2F6FAELHaUuX67V6DWr0bZBv1QFi8mZpGHRs4q%2FgQIaxAAGgw1ODgyMjI0MDEyNjkiDAkB35%2Ff%2FmE74sUR5CrbBLbdWW1IPkdY1RLAxjnbLysLAeA5oYgxJ9gKU4ohrbXB%2BA%2FH47bY0ZUylu3HmtZ4aLDPr3tsWHvqR4uzkkbNAmDztvsQ%2FbYJITbTZBOtuzldNEyx%2BiEKjxGlipWzJ2w5cP9F2axyMXSvkeDbt3dE6Gvfqw6Jwy8abveeRU4bz0nZAVHh6X4fCJeDD6%2FIiR4VuzpXZY3bNxLEdclJhB8pdJTQ3Po8EHqZYJPbqTUwQhPWch2e3D2Wu%2FoEXIT4iogkzDd6EP0ZHO21oMnHSTtjtA2hPmXHUIYO9oE9m3m%2BUu4k1z%2Bm4EYYJhg3NmdiU7lG9kW67mAdaFlxxpcoaxxautbECrVJa5zRgmFRfthtzJM%2FYAfG0q9wXVbOzy14Ji3nHWS8OZSpE%2BQSo7e11z9ukW3wvsA6Jpf7elcNEDQguaovn62iyA2LIH4rIwNKeFTiHnnvdqT4kdmHgCldkZojgwQetjvuj6ACbFGwIgQIV0RyOsw8tCeBM%2BZP%2FK1CrJ8DzOKfDcLmP8VkEvg37Tg0RSuqk1Dfj82FRSxYvgbphqoBVcNknavi0PbD2N4mqkj1%2FWszErTj2VTu6AovU2plgKDN1atQPpMhD9wyr8XxyLtwiNEAQ0J5vD9Yr%2B%2FJiwdTza1V7zcGuQw5kGeqHkDOK4Pu2%2FoI9tjZbNJVZKq0vLIRpCrnlfUGenoSnZtBV62du%2Fa%2F5%2B88H5bAVZvRvD4jJB3%2FkpTwlFjzp%2Fg%2ByQ%2F7VZRoFb8j1Vc7mqDtHBxfWS%2FLe9XcS%2F9Dj%2FWj2GjOZ4HqtG9TtwQ1QHVyqRuwWzCC1e6rBjqaAaFG8uEQfkmPaa%2BZHfbnX7vUd49kiocaC%2FHdjrEPXeGvOg5TfSakeVMymzpm%2BrfLbJ4qX11SEqkBvXRImIzHMFjMIlNIL0mPZbSLS7qeud1decMZ08Vt55yM80mp7wzZPw8rZ8%2FTed8tHCJPDfRbPpSne5W9hpXkxH9u9Qm2F5Xzc%2B4xfe%2BFS9BVWO87X9H7nNAiwIN4FuelnwQ%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231215T012314Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id%3Bx-amz-tagging&X-Amz-Expires=172800&X-Amz-Credential=ASIAYR5GJRL2YIXCDR6T%2F20231215%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=866075fee4579c89337a074dac83c29ee8efef2046946d963bd18d38c676d4fd"
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": null,
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.oak.trustx-qc.com/"
}
{
"code": 120,
"message": "Error while trying to check face liveness",
"status": "FACE_LIVENESS_CHECK_FAILED",
"tenantId": "skyqc1",
"businessKey": "6RNPABWVSO5C7IFO3D3KCCEEX4",
"stepId": "face-capture",
"screenId": "preview",
"screens": [
"instructions",
"capture"
],
"variables": {
"preSignedHeaders": {
"Content-Type": "image/jpeg",
"x-amz-server-side-encryption": "aws:kms",
"x-amz-tagging": "RemoveAfter=30d",
"x-amz-server-side-encryption-aws-kms-key-id": "8965bbca-14f2-4edd-8d77-ab9c8fad1c84"
},
"continueProcessUrl": "https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/6RNPABWVSO5C7IFO3D3KCCEEX4/topicName/L-5e69fa6d-0bfe-4c63-95af-351e63f6bc54/continue",
"activityConfig": {
"faceImageFormat": "jpeg",
"faceKey": "face1",
"cameraHeight": 720,
"activities": null,
"cameraWidth": 1280,
"timeoutInSeconds": 60
},
"preSignedImageUrl": "https://sky-qc-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyqc1/processDefinitions/VYF32LFZABZLMQSLWQYXOJL3PE/processInstances/6RNPABWVSO5C7IFO3D3KCCEEX4/faces/face1/55595ca1-6c3b-49fb-b3c9-bb1edd278c9e/face.jpeg?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJIMEYCIQDrvhK70hbrKyAlMteJp3e6kiE4Y5RUw1WfBrjdGIyDMQIhANjb0CjUEcaDeTQJK9CxAtSGj0fyIMlCZw7IiE9yq2yUKv4ECGoQABoMNTg4MjIyNDAxMjY5IgwApiAinHW74fwSbJUq2wTk1oGY1eukvILF8fWZ23%2B88mMLGFamNnBF8lvVggs6LZDeQPeyUsZXt5OAuBzjAvA7lSxHYzPVU5x0bjPrt1iC3LfLbA7GwnyBMo%2F%2FE7QtPuVJMX%2FkAQKegtluR%2FQRffWIMsJiR%2BFjJ5liqs7wGh3jsKKjWw6Rz5O7HYfy6yNRckR44s6qwUA33OdYRORIrZg0tIdylA2jQXkAxCcgyofoJhPX6LGipI8V%2Ba8XcEltBDcTQVbZ02qp5PnxDos%2F1NwmwUrKGt6%2BtTfCp%2Fl%2Buhz0xYfNitFfYDeR3RE18A2kvmSdrT4rJHSkO2FUwwkSc81iQMtPACqm9WlHpo4baf%2FV%2BGI4q2ZtO2C2PuwKFyTDJngOEMRRrz2FnLUgvinNUrNYX7nHGPXzCFjallUQfPdEDIAqyqCANUYb093KKAo6jnR%2Bc7ACIHtIPcwCJRTLdJtVtO22U%2F4vSDXOAIkruZYQcQBKoq0bhmU6EziAQgGk1SQdI9qkKtYf%2FospM98HkBEKpllfMb2U4cWbW1dLBWPiXfFEKpckXNMbAzYF1JRYIQqd5QVVUU0%2F1JqEMdG3RSBaBWgGS4Xko8VVJnGbYTsbliEFOXmSDRb9t%2B4UHrp3nf6Lodleo%2BI0STuMsIPGlcK%2FEbVOUErGxJFlz06Yp6118aahITGqJ8z44INwic6NozpvyH2hDMuMQr%2BwRYY7IvkV6CyP7t7yistRZNXww1fOxt%2BtIee3oT3kV7G2GbFN9h%2FnMTD73sdNxmEisrnwgwY1x1RqvI5raoXWN40hJTWOMQ%2B0BJssDcIGHMgwotLuqwY6mQHb8Gtme7amIkDtA5hw2%2BFXjxQPdtk%2FITM2bzh1QM7ykE4QM2adLfbbxOfDjKqJFGkxup%2FrNXFDWTlzD2XosKq6aGpjDEiytUA85M8DQUNutQfoLrs%2BWZRqwasdYe%2FKOcWhi8PZOYKXx8JDjtOMt%2FnG9oDidsU%2BDEvE9LHE1W0yMvX%2BF%2FMAjJVpZa1vSy9rutQZCWxwDZ3iZ6c%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231215T011722Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id%3Bx-amz-tagging&X-Amz-Expires=172800&X-Amz-Credential=ASIAYR5GJRL2UIUSUHEV%2F20231215%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=5aab9cf9bdb10f8d4f28bf52843786d4f926b4d09bcf5ad99082e318beb35bfc"
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": null,
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.oak.trustx-qc.com/"
}
Confirm Face Image
Example Request:
POST https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/H7G3BG4WSYM2UA2RKYEXDXHDBU/topicName/L-cbf8dd31-8aaf-4b18-a4ea-77bd838f07eb/continue
Content-Type: application/json
{
"photoConfirmed": true
}
Example Response:
{
"code": 202,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyqc1",
"businessKey": "AIZKI75MR2CBXGGK3DI7MDYMBM",
"stepId": "document-capture",
"screenId": "document-type-selection",
"screens": [
"document-type-selection",
"country-selection"
],
"variables": {
"continueProcessUrl": "https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/AIZKI75MR2CBXGGK3DI7MDYMBM/topicName/L-d886f3ea-1c7b-409d-b85e-6f68ec7de2e1/continue",
"activityConfig": {
"activities": null,
"documentTypes": [
"DRIVERS_LICENSE",
"ID_CARD",
"PASSPORT",
"OTHER"
],
"docKey": "doc1",
"countries": "{}",
"allowedCountries": [],
"defaultCountry": "gb"
}
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": null,
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.oak.trustx-qc.com/"
}
{
"code": 202,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyqc1",
"businessKey": "UNGMGCWIGRRNGG424OHY2OJ2MU",
"stepId": "face-capture",
"screenId": "instructions",
"screens": [
"instructions",
"capture"
],
"variables": {
"preSignedHeaders": {
"Content-Type": "image/jpeg",
"x-amz-server-side-encryption": "aws:kms",
"x-amz-tagging": "RemoveAfter=30d",
"x-amz-server-side-encryption-aws-kms-key-id": "8965bbca-14f2-4edd-8d77-ab9c8fad1c84"
},
"continueProcessUrl": "https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/UNGMGCWIGRRNGG424OHY2OJ2MU/topicName/L-50b64894-863c-4357-9e4d-329f4d28317a/continue",
"activityConfig": {
"faceImageFormat": "jpeg",
"faceKey": "face1",
"cameraHeight": 720,
"activities": null,
"cameraWidth": 1280,
"timeoutInSeconds": 60
},
"preSignedImageUrl": "https://sky-qc-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyqc1/processDefinitions/VYF32LFZABZLMQSLWQYXOJL3PE/processInstances/UNGMGCWIGRRNGG424OHY2OJ2MU/faces/face1/2336fb2d-0cca-4efa-bd02-247924ba5f14/face.jpeg?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEOr%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJHMEUCIQCtfEthqWWCZW04YAVjhw05vwIHl1kw1BNtDB9Fc1I7rQIgNLqjuO3RyVfY9IKv1pmOiNCAiPJVGrQjXR7irzGvpX0q%2FgQIYxAAGgw1ODgyMjI0MDEyNjkiDKzMWYZDakHEfO6Q7yrbBFdxsRnqtRIDon%2BsGgKjs1%2BycONJtKQlZUIyf%2F%2FfkugSeu%2FQXjVILQ1GfKdfA%2BlR6tYHLk6LDJyGyRpIRhTn9Amfcrv24THS7%2BY4kueqIRw01jHi0P2uvVJ%2FF9ON8wR40XLn7TzYyS58vZNnjyFLrVHEuczYqzsGiHhRQjcmlMO%2B%2BNBacqfJSX1HUnc76KQJ14Vmfwc4ZJ7itL87z%2FvEQQPcRMyafyvWyfjfgQesUfXBMP6AkXHur%2Btfv7mwBzqp5ohtTbT05WDHzHbLlHMEAN9bZf7miOMeA79EscgAUBA8%2FkPw6hlN2gnw3qdU29eEaYY5eTaOaw4T3Q3fLkdMsDmndeT7dKaVic4fwrjc3c97NyTgxjcuAlPS%2Bk%2FGK0JGb9tq89MM77sxqs84gUfxyX9KwdU0puvdiQW4qtMY7Klpcta4jEDXZ1oYiVYR9YKaE6ObWjsz%2FLEGtrigXRzpcloM62OY18GSXRePHkZ4fc3k3k3dh4bKT865rFTGmSORcxcxWprK57RnVRtaWFpRqfEb%2BiTYQEoisXCnpEnYjvtUxI9ZDogarvBowyDCt%2FlPbNUIKEOQ75F0FVHsVyj5umV63y7BftkA9E0Gj79dUcHShW6cXGOWA4S35Gpp67q4WA66O6AUI17N1eM7ImgdsBN590kbF1N35ocRZfALT%2FXWOxBWUFmhzDnqwOVDQHSq6nA7PWAPf5pk%2F4OWo60O00elvX2qQVVHmn643pexP3HRljISqyADFHuvfn5%2F4swWoTg0MqjR3k3upp8AU7zlrQ0oOBOU80YrRrsA2zCage2rBjqaAWe9k8C74tW4CLf0LVisihtgQbOBNtys2cknExLcXqk3FGRa0IvKqnW2DpkPOBJnmzUTskyKhUzP4NyJaGQjnzn6qpdMz1GeScX2zRGnn8JX%2FFuwHxiMetZyny9%2Be%2BBxVZr1cOANRaSmqm2VrZwUWfIOALxPbpmw8mpv2fgBL9EyVA%2BHRj7uVgj4v3r48QBhjcBq9o2OG6y1ogw%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231214T175122Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id%3Bx-amz-tagging&X-Amz-Expires=172800&X-Amz-Credential=ASIAYR5GJRL223FDVZTU%2F20231214%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=744079bdbf436ba3bbf303595314d196616ef930dca2e3a4e47c63d7265788ad"
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": null,
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.oak.trustx-qc.com/"
}
Select Document Type Screen
Screen in Trust Web Flow:
Example Request:
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-2652b742-e385-4460-8084-4a0b7cbb822f/continue?currentLanguage=en
Content-Type: application/json
{
"documentType": "DRIVERS_LICENSE",
"countryCode": "us"
}
Accepted document types include:
"DRIVERS_LICENSE""ID_CARD"
"PASSPORT"
"OTHER"
countryCode is the 2 digit ISO country code: https://www.iso.org/obp/ui/#search
Example Response:
{
"code": 202,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyprodqc",
"businessKey": "NY3YGDMK3MECEOHVDE7AYDQT74",
"stepId": "document-capture",
"screenId": "instructions",
"screens": [
"instructions",
"capture"
],
"variables": {
"preSignedHeaders": {
"x-amz-server-side-encryption": "aws:kms",
"x-amz-tagging": "RemoveAfter=30d",
"x-amz-server-side-encryption-aws-kms-key-id": "2e4180f4-3f49-4cda-8e75-56ee977e0996",
"Content-Type": "image/jpeg"
},
"continueProcessUrl": "https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-88808b52-7bad-4f17-b5d3-96a05e3b0520/continue",
"activityConfig": {
"side": "FRONT",
"documentType": "DRIVERS_LICENSE",
"cameraWidth": 2560,
"captureOrientation": "PORTRAIT",
"docKey": "doc1",
"useNativeCapture": false,
"timeoutInSeconds": 60,
"cameraHeight": 1440,
"allowBack": true,
"countryCode": "ie",
"activities": [
null,
"consent",
"face-capture",
"document-capture",
"additional-documents"
],
"docImageFormat": "jpeg",
"croppingTolerance": 0.06,
"documentAspectRatio": 1.58
},
"frontCroppedPreSignedImageUrl": "https://sky-prod-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyprodqc/processDefinitions/I5HO6PWJAXA5UEX2JF2UQ33QRY/processInstances/NY3YGDMK3MECEOHVDE7AYDQT74/idDocs/doc1/5b029be1-2782-49e1-972a-c2ca5d74241b/a016f935-9310-41ed-8491-97b3b8ed6e1f/FRONT.Cropped.jpeg?KHAYAgf5V1TaxXNmdGtjUUTuh8PvMYGHnHBITZsEx3dSrLOrgLK3PZoZigB8dto5zVGhQVKtDjAjU%2F6laIfbvp2LzwTdyhDgQTh9lggXUKCGn8Vn92q9nSHUugYHeSirAcQiBTzZUOj78iO%2BpZysZroRsjD2vdyrBjqZAcwSV4gMbBw5e3yl8ZLdy9vA%2B6mISQwr83oE9JjRhSnH1zZq7QlNF0ebQZYXDvOC1iLimUU977y2XibLK4QC18Y7efg%2FVjSXnvjAnRo2q%2Fo2IE0Duj5BytAhEwKNV7YGGRgCGk0Zmcr6yb%2Bu3JrzoTWLjo1GNWeYd9vIE4DEq6w74SzFFGjCR%2BToydqrLR0NSr5xqM36CucjQg%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231211T143846Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id%3Bx-amz-tagging&X-Amz-Expires=172800&X-Amz-Credential=ASIA46TTB6P2IBXOD36L%2F20231211%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=2f703c0b8b0214e38216989b0c2898a8ff94a5bad661777a7a27b2b49593a140"
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": "en",
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.trustx.com/"
}
Capture Document Image (Front-Side)
Screen in Trust Web Flow:
Example Request:
PUT https://sky-dev-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skydev1/processDefinitions/SBO5X6LWGGLIAT5MEGUGW7FARQ/processInstances/QWK2KEAKG2DRJFLCZ4Y2UYKNG4/idDocs/doc1/ca91e176-a948-4070-b710-f49e59d4f058/cb3082bd-56f1-40b2-a7ed-f39fb85a538a/FRONT.Uncropped.id.bin?....
Host: {aws_url}
User-Agent: {browser_user_agent}
Accept: */*
Content-Length: 121212
Content-Type: image/jpeg
<the raw bytes>
Example Response:
Continue After Document Upload
Example Request:
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-08bcf511-fb1e-43a9-80e7-51b160a0d4e5/continue?currentLanguage=en
Content-Type: application/json
{}
Example Response:
{
"code": 202,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyprodqc",
"businessKey": "NY3YGDMK3MECEOHVDE7AYDQT74",
"stepId": "document-capture",
"screenId": "instructions",
"screens": [
"instructions",
"capture",
"preview"
],
"variables": {
"preSignedHeaders": {
"x-amz-server-side-encryption": "aws:kms",
"x-amz-tagging": "RemoveAfter=30d",
"x-amz-server-side-encryption-aws-kms-key-id": "2e4180f4-3f49-4cda-8e75-56ee977e0996",
"Content-Type": "image/jpeg"
},
"continueProcessUrl": "https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-27ef62e0-0100-4e7c-ae69-4a80f48eb180/continue",
"backCroppedPreSignedImageUrl": "https://sky-prod-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyprodqc/processDefinitions/I5HO6PWJAXA5UEX2JF2UQ33QRY/processInstances/NY3YGDMK3MECEOHVDE7AYDQT74/idDocs/doc1/5b029be1-2782-49e1-972a-c2ca5d74241b/6c7cb502-1adf-4405-ab4e-ebbeb5997b2f/BACK.Cropped.jpeg?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJ%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJGMEQCICT0mMzkzR0HC5ZSUu8X1p5ynYgW4f2GhbgUtYvK0KiNAiBOGL...",
"activityConfig": {
"side": "BACK",
"documentType": "DRIVERS_LICENSE",
"cameraWidth": 2560,
"captureOrientation": "PORTRAIT",
"docKey": "doc1",
"useNativeCapture": false,
"timeoutInSeconds": 60,
"cameraHeight": 1440,
"countryCode": "ie",
"activities": [
null,
"consent",
"face-capture",
"document-capture",
"additional-documents"
],
"docImageFormat": "jpeg",
"croppingTolerance": 0.06,
"documentAspectRatio": 1.58
},
"backUnCroppedPreSignedImageUrl": "https://sky-prod-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyprodqc/processDefinitions/I5HO6PWJAXA5UEX2JF2UQ33QRY/processInstances/NY3YGDMK3MECEOHVDE7AYDQT74/idDocs/doc1/5b029be1-2782-49e1-972a-c2ca5d74241b/6c7cb502-1adf-4405-ab4e-ebbeb5997b2f/BACK.Uncropped.jpeg?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJ%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJHMEUCIQCVlFSSc%2F0Q1CYA6PiuwpjWykbmuKBjCAgnMDF6nqQh3gIgKi4gY5%2BTODx7Y8uDZzHI1ubv3Z9SwiNKGdsfmYkZ9aYqhgUIGBABGgw4OTAzNzMyNzI1NjQiDClB%2FPEhsadcsTYWKSrjBBW9DohGfuzC9J3NPprcjwwkxHVx76RfscbuIxxeyXiN5aeqC1R144gk8nTzajY952bvhOLdBeeJWGPo89JkL5StFe32bBp5LTVjcb1RCtGpko7V7AiD1TnBAmG5T84MQzVt8Q1yfAyegTzgzD27CkbonG5vt6Pg9Q8I3moYIIkimJCNonykfbHZbX2maFtKP1i5..."
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": "en",
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.trustx.com/"
}
Capture Document Image (Back-side)
Example Request:
PUT https://sky-dev-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skydev1/processDefinitions/SBO5X6LWGGLIAT5MEGUGW7FARQ/processInstances/QWK2KEAKG2DRJFLCZ4Y2UYKNG4/idDocs/doc1/ca91e176-a948-4070-b710-f49e59d4f058/cb3082bd-56f1-40b2-a7ed-f39fb85a538a/FRONT.Uncropped.id.bin?....
Host: {aws_url}
User-Agent: {browser_user_agent}
Accept: */*
Content-Length: 121212
Content-Type: image/jpeg
<the raw bytes>
Example Response:
200 OK
Continue after Upload
Example Request:
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-e112c5e5-cbf1-4483-a5c6-d15944b4048e/continue?currentLanguage=en
Content-Type: application/json
{}
Example Response:
{
"code": 202,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyprodqc",
"businessKey": "NY3YGDMK3MECEOHVDE7AYDQT74",
"stepId": "additional-documents",
"screenId": "selection",
"screens": [
"selection"
],
"variables": {
"continueProcessUrl": "https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-91644859-a345-4fe7-b91a-48c01b97cb14/continue",
"activityConfig": {
"additionalDocsVersion": 1,
"additionalDocuments": [
{
"id": "healthInsuranceCard",
"required": true,
"title": {
"values": {
"en": "Health Insurance Card"
}
},
"status": "WAITING"
},
{
"id": "electricityBill",
"required": false,
"title": {
"values": {
"en": "Electricity Bill"
}
},
"status": "WAITING"
},
{
"id": "residenceCard",
"required": false,
"title": {
"values": {
"en": "Residence Card"
}
},
"status": "WAITING"
}
],
"additionalDocumentsRequirements": {
"minAdditionalDocuments": 1
},
"activities": [
null,
"consent",
"face-capture",
"document-capture",
"additional-documents"
]
}
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": "en",
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.trustx.com/"
}
Confirm Document Image
Select Additional Document Type
Example Request:
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-91644859-a345-4fe7-b91a-48c01b97cb14/continue?currentLanguage=en
Content-Type: application/json
{}
Example Response:
{
"code": 202,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyprodqc",
"businessKey": "NY3YGDMK3MECEOHVDE7AYDQT74",
"stepId": "additional-documents",
"screenId": "instructions",
"screens": [
"instructions",
"processing"
],
"variables": {
"preSignedHeaders": {
"x-amz-server-side-encryption": "aws:kms",
"x-amz-tagging": "RemoveAfter=30d",
"x-amz-server-side-encryption-aws-kms-key-id": "2e4180f4-3f49-4cda-8e75-56ee977e0996",
"Content-Type": "image/jpeg"
},
"continueProcessUrl": "https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-cc5e44c7-c888-451e-bb79-0c34a5853b94/continue",
"activityConfig": {
"additionalDocsVersion": 1,
"additionalDocumentPages": {
"currentPage": 1,
"totalPages": 2
},
"activities": [
null,
"consent",
"face-capture",
"document-capture",
"additional-documents"
],
"useNativeCapture": false,
"docImageFormat": "jpeg",
"selectedAdditionalDocument": {
"id": "healthInsuranceCard",
"required": true,
"title": {
"values": {
"en": "Health Insurance Card"
}
},
"subtitle": {
"values": {
"en": "Take a photo of your health insurance card"
}
},
"instructions": [
{
"values": {
"en": "Place your document on the clear background providing high contrast to your document, and is well lit and without glare"
}
},
{
"values": {
"en": "Position document inside the marked area and hold still for a few moments until the process is completed"
}
},
{
"values": {
"en": "Verify that photo of your document is clear and readable"
}
}
],
"imageHref": "https://cdn.oak.trustx.com/additionalDocs/tenants/skyprodqc/I5HO6PWJAXA5UEX2JF2UQ33QRY-0/healthInsuranceCard.png",
"pages": {
"bounded": true,
"minPages": 2,
"maxPages": -1
}
},
"timeoutInSeconds": 60
},
"additionalDocumentPreSignedImageUrl": "https://sky-prod-oak-data-eu-west-1.s3.eu-west-1.amazonaws.com/tenants/skyprodqc/processDefinitions/I5HO6PWJAXA5UEX2JF2UQ33QRY/processInstances/NY3YGDMK3MECEOHVDE7AYDQT74/additionalDocs/healthInsuranceCard/643d6359-c4ec-4f6f-a104-93f9c1ac98b9/b4aec49e-ca5d-4c5d-b408-d79eed037200/page_1.Uncropped.jpeg?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEJ%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCWV1LXdlc3QtMSJGMEQCIQDbOkvJD8dBMi8a9P1ZW55rwleNHc5ayaBdoD9aBMo5QAIfVZtRarRc24fA4HpTdnrO%2FibR62RxTS%2B9k0B7PN%2BLdCqGBQgYEAEaDDg5MDM3MzI3MjU2NCIM%2F50ywLMv8Qql7e9kKuME5nfw0sLlSbYPx8RPG6khChpU1kJWDLpWSeEB86kICA9Vhht83KBMptKYBtKbTOFqa600s57brKm4COHpjzIzWRA51r6qxg0d1DIIebk4n3jXYGERHtVcwfbhIKiO03J416sSMakt9wxfiDKxCiBQl6AbWqXAZSC%2FGEXPgmdvOo4JEl67eAJ%2B1e4YVMxt7K7UHBSRe9QPiNEywVSPGRLAzNaQuMWEP%2Fbe73qV6NjcxRSNuWIak7ZpVEr5opnzyWyr2x1vALKxE%2BqfUCMzTAkg%2BoKmXeiTK5Q4rltHwk26GnP25ma35G5PVeMsvGTk%2FArLL7AgWSBCBZ5aJQfH0IS%2BDQP6gLT0a9PUY0kCWA9p8%2BglQiBmZt5x0E%2Bm2KBhMqCAr2svttQyUOHd%2FImIiSFCFCZgApd48H3tYLhJ74WoeChg9QsjEzvtCn0Aw6GWMscFn0KYHlGprCs8ZhFjQpDuJVN%2BfOHjFjkl8wXcPMQGp%2B%2BLS%2BmCpfTsokJ549Ed4eGwSnk61sXbnt78tPCEB3o4K5tfz5TeKfli1y8iQtxeoNfkAsGuulkdw5hmy60e3lUO02szHQCnvGuzA5nRk81Yk9XATXYbgXksdfTfI3FQiSQMRPwmVO%2BEY8VhlqnioX1ddGSRijsGLperxGSyh0Q79ZXcB2jBvU0vAo87hVhfffC3%2BbyHTr00DQlU4RzvijWyUgBPsyt%2FmhN7LWH6sHI36ovGQRcBmNhfGnd8IAIsrzu7E19ouizcsaBsJQy84598btd3RDr2ohsHpfL4Y94OROiJTn%2B1mIzZCO2G9uEu7iTOGucw1MDcqwY6mwExeAJS0beyZkNf%2F26LL3qPKcVFPlmxcDBy8y1ZXyCalU9rA94FOkMEuBXxqjmuc3RK0eJF%2FOFT5fQX6gBej5qeOZw5rnKvbJhiSJIFLYI9IcuiWN%2FOjLXIlJr4O7gjwinkcC2sqWoaGAUFH9jxS6BZ%2F7cqX6FD8IGyDT1Q8LOcieMdqy4W1nkp%2BnFOh8gJWZnhaQiFjEbnQIEoTQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231211T144436Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption%3Bx-amz-server-side-encryption-aws-kms-key-id%3Bx-amz-tagging&X-Amz-Expires=172800&X-Amz-Credential=ASIA46TTB6P2EY5KJ3X2%2F20231211%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=f94236563c3ae486df9b533bbcef464c634aa48e7761b1a3bfbdff484f87c909"
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": "en",
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.trustx.com/"
}
Custom Data Form
Example Request:
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-5f15146f-ed12-4774-999e-18244b046538/continue?currentLanguage=en
Content-Type: application/json
{}
Example Response:
{
"code": 200,
"message": "Successful processing.",
"status": "SUCCESSFUL_PROCESSING",
"tenantId": "skyprodqc",
"businessKey": "NY3YGDMK3MECEOHVDE7AYDQT74",
"stepId": "thank-you",
"screenId": "thank-you",
"screens": [
"thank-you"
],
"variables": {
"activityConfig": {
"activities": [
null,
"consent",
"face-capture",
"document-capture",
"additional-documents"
]
}
},
"redirectUrl": null,
"themeUrl": null,
"currentLanguage": "en",
"defaultLanguage": "en",
"supportedLanguages": [],
"localizationConfigUrl": "https://cdn.trustx.com/"
}
On This Page
Process Instance in TrustX APIIntroductionCreate Process InstanceStart a Process InstanceIntroduction ScreenCapture Consent ScreenCapture Face Image ScreenContinue After Face UploadConfirm Face ImageSelect Document Type ScreenCapture Document Image (Front-Side)Continue After Document UploadCapture Document Image (Back-side)Continue after UploadConfirm Document ImageSelect Additional Document TypeCustom Data Form