Create an Account Relation

(Account Relations is currently in Closed Beta and may not be available for all users. Please contact support for additional questions.)

What is a Relation?

A Relation is a type of field that represents a real-world connection between different entities.

Relations can represent two kinds of real-world relationships.

  • The relationship between two accounts, such as the relationship between a passenger and a driver in the context of a ride sharing business.
  • The link between an account and a type of transaction, such as all the rides associated with a particular passenger or driver.

Examples of Account relations

Common scenarios in which you may find relations helpful include:

KYB (Know Your Business)

Organizations want to be able to track relationships between individuals or associated people and businesses.

A business might wish to track relationships between individuals and businesses. To achieve this, the business would create a Relation between the Ultimate Beneficial Owners (UBOs) Account type and the respective business entity’s Account type, reflecting their real-life business relationship.

AML (Anti-Money Laundering)

A business might seek to monitor transactions linked to a particular individual for fraud detection purposes. To facilitate this, the business would create a Relation between the user Account type and the relevant Transaction type.

Transaction-first verifications (API)

For API-first verifications, a business might want to see all Verifications transactions related to an account. To do so, they would establish a Relation between the Verifications Transaction type and the Account type.

Create an Account Relation

accounts-relation-1

Open the fields settings tab of an Account type.

  • When hovering over Accounts in the Dashboard navigation bar, click Types to view all Account Types.
  • Click on an Account Type to which you want to add a Relation, then click Settings in the upper right corner. This will open to the Fields tab of the Account Type Settings.

Step 1: Add a field to this account

  • Click + Add Field in the upper right corner of the Fields table.

  • In the Name field, enter a name for the Relation. It can have spaces and numbers, but it must begin with a letter. Choose a name that defines the purpose of the relationship with the other entity.

    🚨 The field ID auto-generates from the field name. The field ID is not editable.
  • Click the Type dropdown and select Relation as the field Type.

  • To establish the relationship between this field and another Account or Transaction type, click the Related object dropdown and select the Account Type or Transaction Type you want to relate to this field.

    When you choose a related object, more input fields will appear below, allowing you to set up an accompanying field on the related object.
  • Decide whether to leave the relation field as a string or turn this field into an array of the related field.

    If the relationship you’re representing is a 1:1 relationship, then do not choose this option. If this is a relationship of one to many, then it may be useful to turn this field into an array.

    For example, in a scenario where this relation represents the relationship between a driver and their rides, you would turn this field into an "array" so that this field can store multiple rides from the related Rides transaction type.

Because Relations represent bidirectional relationships, they require the creation of two new Relation fields, one on each related object. Setting up the related field on the related object is the last step in creating a relation.

  • Enter a name for the related field in the field labeled Name of field on [related field].
  • The field ID for this accompanying field will auto-generate from its field name. The ID is not editable.
  • Decide whether to leave this field as a string or turn it into an array of the first field. For example, if your ride haling service offers the ability for multiple riders accounts to share a ride, you would allow multiple rider accounts to be associated with the ride transaction type.

Use Relations within workflows

After creating a Relation, you can configure Workflows to relate objects automatically.

After creating a transaction or account, you can add an Action step to an existing Workflow to relate objects automatically, using the following steps:

  1. Add a step to your workflow and choose Action as the type.
  2. In the Find Action… dropdown, search for and choose “Set Relation.”
  3. Using the Object dropdown, set the Object to the Source Object.
  4. Using the Relation dropdown, choose the relevant Relation.
  5. Using the Assigned object dropdown, set the Assigned object to the Target Object.
  6. If you want the workflow to execute even if it encounters errors, unfurl Advanced configuration and click Continue on error.

account-relation-2

Save your changes

When relations have been configured and your Workflow has new runs, you can see the Relations module within an account or transaction record. Users can click on the account / transaction tokens to view associated records.

account-relations-3