What is a meta object?
Organizations can use a “meta” object (valid JSON) to send additional supplementary data fields (nested meta data) in the payload to Alloy. Because Alloy only sends data that the data services require, supplemental data is not passed to third-party data services and stays within Alloy.
Required data fields used by data services (e.g., required parameters) are placed at the root level. In contrast, additional supplementary data fields are recommended to be nested under a generic “meta” object. A meta object is a place for trackable data that can be used as input attributes and created as tags in a workflow.
We suggest using a meta object (JSON) to wrap meta data (supplemental information of the applicant) for the following reasons:
- Keeps the data structured and organized.
- Easy to identify.
- From these passed in additional data, we can build more tags and/or decisional logic.
How does a meta object work?
Below is a sample of what meta objects can look like in a payload sent to Alloy.
{
/*
Data services commonly require the following parameters
(NOTE: “required” parameters are determined and dependent on what
data services and products the workflow is using):
*/
“name_first”: “...”,
“name_last”: “...”,
“email_address”: “...”,
“phone_number”: “...”,
“document_ssn”: “...”,
“birth_date”: “...”,
“address_line_1”: “...”,
“address_city”: “...”,
“address_state”: “...”,
“address_postal_code”: “...”,
“address_country_code”: “...”,
“ip_address_v4”: “...”,
“iovation_blackbox”: “...”,
// Meta object Example:
“meta”: {
// Meta data nested under the meta object
“existing_customer”: false, // Supplemental data keys can be called
whatever the team decides to call;
this example uses boolean data type
“product_name”: “12 Month CD”, // NOTE: If used, the product name
(string) must always be the same
and consistent
“product_id”: “123abc-456efg-7890-hijklmn",
“referring_domain”: “https://www.abc123bank.com/”
}
}
*NOTE: Ellipses (…) were used to replace sensitive PII values
Please don’t hesitate to contact support@alloy.com for further assistance and consider these other helpful articles:
Comments
0 comments
Article is closed for comments.