TRtrulioo
Using the API

Submit data for the current step of a flow

Changed on
post/submit/{flowId}

Request

  • Base URL
    https://api.trulioo.com/wfs/interpreter-v2
  • URL
    https://api.trulioo.com/wfs/interpreter-v2/submit/{flowId}
  • Auth
    none required

Path parameters

flowIdstring required

The ID of the flow

Headers

x-hf-sessionstring

ID for a user state in the execution flow (generated in the first interaction with a flow).

Alternatively, this header can be omitted to directly submit data for the first form node. Note that direct submission is only supported for form nodes.

Selected language for flow execution

x-hf-retry-on-pendingboolean

This header determines whether the conditional node should block the flow's execution until the service completes and returns the next node. When set to true, the system will attempt to return the next node within 30 seconds.

  • Interactive Node: If the next node is interactive (e.g. a form node or an interactive service node), it will be returned.
  • End Node: If the next node is an end node, the end node will be returned.
  • Pending Response: If the process exceeds 30 seconds, the response will include "type": "pending", along with the header "x-hf-session", containing the session ID for tracking the user's state in the flow. This session ID can be used for continued polling to retrieve information related to that specific execution.

This mechanism allows the flow to continue progressing, even if the complete result is not immediately available.

Request body

FormSubmit required
OR
OR
OR
OR
FlowConnectorSubmit required
OR
OR
OR

Example request

{
  "firstNameFieldId": "John",
  "lastNameFieldId": "Doe",
  "streetFieldId": "main street",
  "aNumberFieldId": 4,
  "aCheckBoxGroupElementId": [
    "first_check_box_selected",
    "second_check_box_selected"
  ],
  "phoneNumberFieldId": {
    "area": "+1",
    "number": "2154567890"
  }
}

Response

Returns the step required to be submitted next in the current flow execution

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Changes

  • 6b139614a55bRevision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the response's property type changed from string to integer, and format from no format to int32 for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new bank_account_number enum value to the ////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the ////////// response property for the response status

    • warning

      added the new bank_account_number enum value to the //////// response property for the response status

    • warning

      added the new bic enum value to the ////// response property for the response status

    • warning

      added the new bic enum value to the //////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the //////////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the ////////// response property for the response status

    • warning

      added the new bic enum value to the //////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the ////////// response property for the response status

    • warning

      added the new clearing_system_id enum value to the //////// response property for the response status

    • warning

      added the new iban enum value to the ////// response property for the response status

    • warning

      added the new iban enum value to the //////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the //////////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the ////////// response property for the response status

    • warning

      added the new iban enum value to the //////// response property for the response status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status