Trulioo Platform API (1.0.0)

The Trulioo Platform is used to create fast and compliant onboarding flows. The flow can be published from the dashboard in the Launcher page.

Purpose

Our new API helps you take advantage of our flow builder and access our catalog of KYC services. Build the flow that fits your requirements thanks to our no-code platform, embed it into your application, and onboard all your end-clients seamlessly, Trulioo Platform takes care of the rest. The orchestration document provides a flow execution API.

Key features

The Trulioo Platform API grants control of the flow execution and user state to the client. The user state is associated with a session id (x-hf-session). See the diagram below for an overview of the integration.

Four most important API Calls are:

• Initialize
• Submit data
• Retrieve profile data from a client
• Client Credential flow

Other end points

1. FlowStep operation

   Requests data about the current state of a user in the flow. Creates a state if none is provided by returning a Header (x-hf-session) which represents a session ID. If the header is passed in the request, the operation will return the step response according to the flow execution state, otherwise, it will generate a session and initialize the flow from the first step.

2. SubmitStep operation

   Submits data - triggers the execution of the current step, modifies the state with the data provided, and returns the next step in the flow. The flow execution always ends with an END step even if it is not added to the flow.

3. getBackStep operation

   Returns to the previous step in the flow - computes a backward step in the flow. Multiple backward steps can be performed until the root (first) step of the flow. Non-interactive services are re-executed if they exist between a backward and a forward step.

Other Considerations

• Flow steps defined in the builder may not coincide with the orchestration flow of execution. This can occur due to non-interactive services which are triggered in the background and condition logic which creates mutually exclusive reachable paths.
• Some services can take a long time to execute and will return a pending state rather than wait until the next step is computed. In this case, you can call FlowStep repeatedly until you get the next step.
• Field ids in the client form are automatically generated, therefore, we suggest implementing dynamic field mapping between the form and WF API.
• To test version of a flow rather than the live (published) version, prefix the endpoint path with /test.
• Flows can be published as authenticated using the flow builder UI. By restricting integration access exclusively to the Trulioo Platform API, this action enhances security and enables a regulated interaction with your flow.
• National ID and Social service number may have different names based on country. When applicable, a tooltip is added next to the field with the proper name based on the country chosen.

Resources

• For more comprehensive information and details on the authentication process, refer to: https://developer.trulioo.com/docs/keys-and-authentication.
• Please refer to the following resource for more information about the National ID and Social service number tooltips: https://developer.trulioo.com/docs/national-ids-supported-types. Note: not entering information for the correct National ID or Social service number type based on the country selected may lead to failed identification.
• If you encounter any issues or have further questions, reach out to our support team for assistance.

Use these endpoints when you want to connect an existing client to a flow.

Use these endpoints when you want to link/unlink end clients.