Getting started with flows

Wanting to try out Digital Identity but don’t know where to start? Fear not, here you’ll find all the information you need to get started in no time.

To follow this guide, you’ll need Postman.

Creating an API key

The first step is to create an API key, we have a detailed guide on how to do this via API here, and these are the steps to do it using our dashboard.

  1. Move your cursor to the left menu and click your username. A pop-up will show up with a counter of checks made and options to change your language.
  2. Click API key from the pop-up. A list of API keys will be displayed.
  3. Click Create API key from the top right corner. A form will be displayed.
  4. Enter the Name, Version(Version 1 is recommended) and Billing Hub.
  5. Click Create. The API key will be shown. Make sure to copy it and keep it safe as it will not be displayed again.

Creating a flow

Once you have created an API key, you can create a Flow. Flows are a sequence of Identity Validations that will be included in your validation process. The order in which you enter them will be the order in which they appear to the user. Follow these steps in Postman to create a flow:

  1. Make a POST request to the Create Flow endpoint (https://api.identity.truora.com/v1/flows).
  2. Create a Header named Truora-API-Key and set its value to the API key you created.
  3. Create a Header named Content-Type and set its value to application/json.
  4. Set the Body to raw and enter your flow in the following json format:
{
    "name":"flow_name",
    "identity_verifications":[
        {
            "name": "validation_1"
        },
        {
            "name": "validation_2"
        }
    ]
}
  1. Replace flow_name with the name of your flow.
  2. Replace validation_1 and validation_2 with the names of the validations. (i.e., enter_authorization, email_verification, phone_verification, document_verification, document_verification_with_face_recognition, and document_verification_with_liveness).
  3. Add as many validations as you need in the identity verifications parameter according to the json syntax previously defined
  4. Send the request. Copy the flow_id from the response, you will need it later to search or edit your flow.

Branding your flow

Once you have created the flow, you can customize its colors and add a custom logo to it. Follow these steps to brand your flow:

  1. Make a POST request to the Update Flow endpoint (https://api.identity.truora.com/v1/flows/{{flow_id}}). And replace the {{flow_id}} with the flow_id you got from creating a flow
  2. Create a Header named Truora-API-Key and set its value to the API key you created.
  3. Create a Header named Content-Type and set its value to application/json.
  4. Set the Body to raw and enter your flow in the following json format:
{
    "name":"flow_name",
    "theme": {
        "primary_color": "color",
        "company_logo_url": "logo_url"
    },
    "identity_verifications":[
        {
            "name": "validation_1"
        },
        {
            "name": "validation_2"
        }
    ]
}
  1. Replace color with a hash followed by a hexadecimal representation of the color. (e.g., #CCCCCC).
  2. Replace logo_url with the url of the logo of your company.
  3. Change any other aspects of the flow as you see fit, or leave them as they were.
  4. Send the request.

Keep in mind that: this properties added under the theme parameter can be added while creating the flow, here they are presented separately for simplicity reasons. You can find the entire API reference here.