Process Instance in TrustX API

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 can be interacted with.

Create a Process Token

Example Request:

HTTP
    
​x
 
POST https://skyqc1.oak.trustx-qc.com/api/process-manager/processTokensContent-Type: application/jsonAuthorization: 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"    }}
Copy

Example Response:

JSON
    
 
{    "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"}
Copy

Create Process Instance

Example Request:

HTTP
    
 
POST https://skyqc1.oak.trustx-qc.com/api/process-manager/processInstances/create?pt={{processTokenId}}Authorization: Bearer {{token}}{}
Copy

Example Response:

JSON
    
{    "redirectUrl": "https://alek.org?ps=https%3A%2F%2Fskyqc1.oak.trustx-qc.com%2Fapi%2Fprocess-server%2FstartProcess%3Fpi%3DFHYDHK7SJ5QRHDKUNAXGUB4OUE",    "processInstanceId": "FHYDHK7SJ5QRHDKUNAXGUB4OUE"}
Copy

Start a Process Instance

Example Request:

HTTP
    
 
POST https://skyprodqc.oak.trustx.com/api/process-server/startProcess?pi=NY3YGDMK3MECEOHVDE7AYDQT74Content-Type: application/jsonAuthorization: Bearer {{token}}​{     "isMobile":true}
Copy

Example Response:

JSON
    
{    "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/"}
Copy

Introduction Screen

Introduction activity in Process Designer

Screen in Trust Web Flow:

Example Request:

HTTP
    
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-1c61b9f2-3657-421d-ac27-1e84cc67c1f3/continue?currentLanguage=enContent-Type: application/jsonAuthorization: Bearer {{token}}​{}
Copy

Example Response:

JSON
    
{    "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/"}
Copy

Capture Consent activity in the Process Designer

Screen in Trust Web Flow:

Example Request:

HTTP
    
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-fb798eb0-19a2-4bb8-9529-951835263bf0/continue?currentLanguage=enContent-Type: application/jsonAuthorization: Bearer {{token}}​{}
Copy

Example Response:

JSON
    
{    "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/"}
Copy

Capture Face Image Screen

Capture Face Image activity in Process Designer

Screen in Trust Web Flow:

Example Request:

HTTP
    
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?...Content-Type: application/jsonContent-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
Copy

Example Response:

JSON
    
{        "code": 202,        "message": "Successful processing.",        "status": "SUCCESSFUL_PROCESSING",        "tenantId": "skyprodqc",        "businessKey": "NY3YGDMK3MECEOHVDE7AYDQT74",        "stepId": "document-capture",        "screenId": "document-type-selection",        "screens": [            "document-type-selection",            "country-selection"        ],        "variables": {            "continueProcessUrl": "https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-2652b742-e385-4460-8084-4a0b7cbb822f/continue",            "activityConfig": {                "activities": [                    null,                    "consent",                    "face-capture",                    "document-capture",                    "additional-documents"                ],                "documentTypes": [                    "DRIVERS_LICENSE",                    "ID_CARD",                    "PASSPORT",                    "OTHER"                ],                "docKey": "doc1",                "countries": "{}",                "allowedCountries": [],                "defaultCountry": "gb"            }        },        "redirectUrl": null,        "themeUrl": null,        "currentLanguage": "en",        "defaultLanguage": "en",        "supportedLanguages": [],        "localizationConfigUrl": "https://cdn.trustx.com/"}
Copy

Continue After Face Upload

Example Request:

HTTP
    
POST https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/6KT7ETUKDYYZGZR7I3JOQPKQUU/topicName/L-f64d40d6-1d15-41c1-a345-31a3b4dc3f1a/continueContent-Type: application/jsonAuthorization: Bearer {{token}}{}
Copy

Example Response:

Success
Quality Failure (748)
Quality Failure (802)
Liveness Failure
    
    
 
{    "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/"}
Copy

Confirm Face Image

Confirm Face Image activity in the Process Designer

Example Request:

HTTP
    
POST https://skyqc1.oak.trustx-qc.com/api/process-server/processes/v1_activities/businessKeys/H7G3BG4WSYM2UA2RKYEXDXHDBU/topicName/L-cbf8dd31-8aaf-4b18-a4ea-77bd838f07eb/continueContent-Type: application/jsonAuthorization: Bearer {{token}}{  "photoConfirmed": true}
Copy

Example Response:

Confirm Image Response
Recapture Image 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/"}
Copy

Select Document Type Screen

Select Document Type activity in the Process Designer

Screen in Trust Web Flow:

Example Request:

HTTP
    
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-2652b742-e385-4460-8084-4a0b7cbb822f/continue?currentLanguage=enContent-Type: application/jsonAuthorization: Bearer {{token}}​{  "documentType": "DRIVERS_LICENSE",  "countryCode": "us"}
Copy

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:

JSON
    
{        "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/"}
Copy

Capture Document Image (Front-Side)

Capture Document Image activity in the Process Designer

Screen in Trust Web Flow:

Example Request:

HTTP
    
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-08bcf511-fb1e-43a9-80e7-51b160a0d4e5/continue?currentLanguage=enContent-Type: application/jsonAuthorization: Bearer {{token}}​{}
Copy

Example Response:

JSON
    
{        "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/"}
Copy

Capture Document Image (Back-side)

Capture Document Image activity in the Process Designer

Example Request:

HTTP
    
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-e112c5e5-cbf1-4483-a5c6-d15944b4048e/continue?currentLanguage=enContent-Type: application/jsonAuthorization: Bearer {{token}}​{}
Copy

Example Response:

JSON
    
{        "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/"}
Copy

Confirm Document Image

Select Additional Document Type

Example Request:

HTTP
    
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-91644859-a345-4fe7-b91a-48c01b97cb14/continue?currentLanguage=enContent-Type: application/jsonAuthorization: Bearer {{token}}​{}
Copy

Example Response:

JSON
    
{        "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/"}
Copy

Custom Data Form

Example Request:

HTTP
    
POST https://skyprodqc.oak.trustx.com/api/process-server/processes/v1_activities/businessKeys/NY3YGDMK3MECEOHVDE7AYDQT74/topicName/L-5f15146f-ed12-4774-999e-18244b046538/continue?currentLanguage=enContent-Type: application/jsonAuthorization: Bearer {{token}}​{}
Copy

Example Response:

JSON
    
 
{        "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/"}
Copy

Last updated on