Entity Custom Fields
In this guide, you will learn about the new "Entity Custom Fields" feature, designed to empower partners to send identifiers and Risk-requested items using unlimited custom fields. By leveraging this feature, partners can ensure that their software works seamlessly, leading to increased Boarding Rates. Additionally, partners can avoid waiting for Risk to request information manually, streamlining their operations.
Enhance software functionality with the ability to send multiple identifiers and Risk-requested items.
Increase boarding rates by ensuring smooth operations and efficient data handling.
Eliminating manual information requests from Risk leads to faster processes and reduced wait times.
How It Works
These custom fields can be created on the following types of entities and their individual users via their respective Profile pages in the Portal or through an API call:
Merchant
Referrer
Facilitator
This custom field will now be associated with the entity or individual user when their Profile page is reviewed in the Portal, or when retrieving details about a user or entity using the API, such as using GET /merchants
or GET /logins
(Users) where the new custom field can even be used in a query to more quickly retrieve a specific user or entity.
Warning: Each custom field must be manually set as we do not provide a drop-down of previously added custom fields or an auto-complete feature.
Ensure you match your custom field exactly to ensure your risk policies, decisions, and fee rules will apply to that entity or user.
Keys and Values
Each set of entity custom fields utilizes a key: value
pair similar to most coding languages to help identify each unique field and each field's unique value.
Each Key (Field) can be between 1 and 500 characters.
Each Value can be between 1 and 500 characters.
Entity Custom Fields Setup
Now that you understand the basics and best practices for setting up a custom entity field, let’s get started.
As mentioned above, Entity Custom Fields must be set individually for each user or entity. Since no dropdown menus, duplication function, auto-complete options, or predefined lists are available to select previously-created Entity Custom Fields, it is crucial to adhere precisely to your Key naming conventions. This precision is vital to prevent any complications concerning fee application, Risk Policies, or Risk Decisions configured around this new field.
Setup for Existing Entities
Portal Setup - Existing Entities
In the expandable content below, we’ll provide the step-by-step setup process for new Entity Custom Fields in the Portal:
API Reference and Setup - Existing Entities
In the expandable content below, we’ve included the API reference for the /entityCustomFields
endpoint, the endpoint used to create new Entity Custom Fields overall.
We include the reference here as the request and response bodies are the steps for existing entity setup. For the API reference by itself, visit our API Documentation.
It’s important to note that this endpoint can only be used to create new entity custom fields for existing Merchants because an existing Entity ID (e.g. t1_ent_123abc4d567890efg1h2i34
) is a mandatory request body parameter when sending a POST /entityCustomFields
request independently.
Setup For New Entities
Sending Custom Fields with New Entities During Signup
When creating a new entity on the platform, whether during Merchant Signup or Referrer Boarding, you can optionally add the following JSON object array to the signup form at the entity data level like so:
Pre-Populated Signup Form - HTTP Query String
As mentioned above, you can send multiple entity custom fields at once within the Entity creation HTTP query by simply duplicating the section above as needed and giving each new duplicate section new, unique key
names.
Applying Entity Custom Fields with Risk Policies
By utilizing Entity Custom Fields in conjunction with Risk Decisions or Policies, you can significantly enhance your risk management processes. Risk Assessment is made more effective through personalization for specific entities using Entity Custom Fields. Integration with Risk Decisions or Policies enhances decision-making through entity-specific data insights allowing improved entity compliance and higher boarding rates by organizing your customized compliance-related information to better align to your individual risk practices. Efficient Risk Monitoring in real-time becomes possible by utilizing Entity Custom Fields to monitor key risk indicators, encouraging holistic risk management practices.