Components and Attributes

Component List

ComponentHTML Element Name
Account Benefitsarray-account-benefits
Account Enrollarray-account-enroll
Account Loginarray-account-login
Account Settingsarray-account-settings
Knowledge Based Authentication (KBA)array-authentication-kba
Credit Alertsarray-credit-alerts
Credit Overviewarray-credit-overview
Credit Overview Mini (aka Entrypoint)array-credit-overview-mini
Credit Reportarray-credit-report
Credit Scorearray-credit-score
Credit Score Factors (deprecated; use Credit Score Insights)
Credit Score Insightsarray-credit-score-insights
Credit ScoreSightarray-credit-score-sight
Credit Score Simulatorarray-credit-score-simulator
Debt Analysisarray-credit-debt-analysis
Identity Protectarray-identity-protect
User Insights Snapshotarray-offers-credit-snapshot
Navigationarray-navbar
Help Centerarray-content-help-center
Privacy Policyarray-content-privacy-policy
Terms of Servicearray-content-terms-of-service

The set of attributes that a component takes is drawn from two sources:

  1. Common Attributes apply to all components.
  2. Component Attributes are specific to a particular component.

🚧

If you want to include a feature that's toggled by a Boolean attribute, you must explicitly set the attribute's value to true. The mere presence of the attribute (without a value) isn't enough.

Common Attributes

The following attribute are common to all components.

AttributeTypeDescription
appKeyUUIDA string token that uniquely identifies your application.
sandboxbooleanSet this to true when you're testing your web page, and remove it when you move to production.
userTokenUUIDA string token that verifies the customer's identity. You retrieve the token through the array-account-login or array-account-enroll JavaScript event.

Component Attributes

array-account-benefits

Common Attributes only

array-account-enroll

AttributeTypeDescription
loginHrefURLThe URL of your application's login page.
showSplashbooleanToggles the initial splash screen.
showEmailPasswordFieldsbooleanToggles the username and password page.
showQuickViewbooleanToggles the identity confirmation page without payment section.
showQuickViewPaymentbooleanToggles the identity confirmation page with payment section.
dobAsTextbooleanIf the DOB-SSN page takes DOB in the 'mm/dd/yyyy' format, this must be set to true
tuibooleantui (TransUnion), exp (Experian), and efx (Equifax) designate the bureaus that will verify the customer's identity. See array-authentication-kba for more information.
expbooleanSee array-authentication-kba.
efxbooleanSee array-authentication-kba.
termsOfUseHrefURLThe URL of the page that describes your application's terms of use.
privacyPolicyHrefURLThe URL of the page that describes your application's privacy policy.

🚧

If you set the showQuickView or showQuickViewPayment attribute to true, the signup JavaScript event isn't posted.

You can seed the information on the enrollment form by setting these attributes:

AttributeTypeDescription
firstName, lastNamestringSeeds the user's first and last names.
streetAddress, state, city, zipCodestringSeeds the elements of the customer's address.
dobDay, dobMonth, dobYearstringSeeds the elements of the customer's date of birth.
ssn1, ssn2, ssn3stringSeeds the first three, second three, and last four digits of the customer's social security number.
emailAddressstringSeeds the customer's email address.

Finally, you can supply your own customer identifier through the clientKey attribute.

🚧

Supplying your own clientKey value is strongly discouraged.

AttributeTypeDescription
clientKeyUUIDNormally, Array creates a random identifier that it uses to identify the User object that represents the customer. You can use your own identifier by specifying the clientkey attribute. The value that you provide may only contain alphanumeric characters and hyphens, and must be no longer than 36 characters.

array-account-login

AttributeTypeDescription
signUpHrefURLThe URL of your application's sign up page.
showRememberEmailbooleanIf true the "remember me" checkbox is displayed.

array-account-settings

AttributeTypeDescription
startPagesecurity or personalInformationcomponent page to start on

array-authentication-kba

Displays a "knowledge based authentication" (KBA) page that asks the customer to answer a set of personally-identifying questions that are generated and assessed by one or more identity verification providers. Currently, the verification providers you can choose from are the three credit bureaus, as represented by the tui (TransUnion), exp (Experian), and efx (Equifax) attributes.

You can request that one, two, or all three bureaus act as verification providers. If the first provider doesn't recognize the customer, the component tries the next provider, and so on to the third. By requesting multiple providers, you stand a better chance of verifying your customer. The default value for these optional attributes is true, so you can request all three bureaus by omitting the attributes altogether.

🚧

You must include all three verification provider attributes, or none of them. The component throws an error if you include only one or two.

AttributeTypeDescription
userIdstringA string token that identifies the customer.
tuibooleanUse TransUnion as an identity verification provider. The default is true.
expbooleanUse Experian as an identity verification provider. The default is true.
efxbooleanUse Equifax as an identity verification provider. The default is true.
showResultPagesbooleanDetermines whether or not the identity verification result is displayed to the customer. If you're using this component stand-alone, you must set this attribute to true.

array-credit-alerts

AttributeTypeDescription
maxPagesnumberthe maximum amount of pages of alerts, defaults to infinity
alertsPerPagenumberthe maximum number of alerts displayed per page, defaults to 20
bureauefx,exp,tui,alloverwrites the bureau and hides bureau-toggle
defaultBureauefx,exp,tui,allprovides a default bureau for the bureau toggle if no active bureau in cache
showAdsOffersbooleanIf set to true, the component includes a banner that displays ads and offers that are targeted at the customer. If omitted or set to false, the banner isn't displayed.

array-credit-disputes

pending

array-credit-overview

The array-credit-overview component displays the customer's credit score, and provides links to other credit tools and features (Score Simulator, Score Factors, credit bureau alerts, and so on).

AttributeTypeDescription
defaultBureauefx,exp,tui,allbureau preference
showAdsOffersbooleanIf set to true, the component includes a banner that displays ads and offers that are targeted at the customer. If omitted or set to false, the banner isn't displayed.
showScoreSightbooleanshow 'Score Sight' link
showIdentityProtectbooleanshow 'Identity Protect' link
showLoadingMessagebooleanwhen loading, also show text message (defaults to false)
creditAlertsLinkURLchange href of links to credit-alerts path
creditReportLinkURLchange href of links to credit-report path
debtAnalysisLinkURLchange href of links to debt-analysis path
identityProtectLinkURLchange href of links to identity-protect path
scoreFactorsLinkURLchange href of links to score-factors path
scoreSightLinkIR:change href of links to score-sight path
scoreSimulatorLinkURLchange href of links to score-simulator path
settingsLinkURLchange href of links to settings path
hideCreditAlertsbooleanhide 'Credit Alerts' link
hideScoreSimulatorbooleanhide 'Score Simulator' link
hideCreditReportbooleanhide 'Credit Report' link
hideDebtAnalysisbooleanhide 'Debt Analysis' link
hideScoreFactorsbooleanhide 'Score Factors' link
hideScoreSightbooleanhide 'Score Sight' link
hideIdentityProtectbooleanhide 'Identity Protect' link

array-credit-overview-mini

The array-credit-overview-mini component is an abbreviated version of array-credit-overview. The experience it presents depends on whether or not the customer is enrolled in Array:

  • If the customer isn't enrolled, the component displays a "Learn More" link, the URL of which is given by the linkLearnMore attribute. It's expected that you'll set this attribute to the URL of a page that describes the benefits of enrollment, and that includes a link to your enrollment page.

  • If the customer is enrolled, the component displays a condensed look at the customer's credit information, and provides a link to a "credit overview" page (attribute linkCreditOverview). It's expected that you'll set this attribute to the URL of a page that displays the main array-credit-overview component, or similar information.

AttributeTypeDescription
linkCreditOverviewURLThe URL of a page that displays an overview of credit information for enrolled customers.
linkLearnMoreURLThe URL of a page that lets an unenrolled customer enroll in Array.

array-credit-protection

pending

array-credit-report

The array-credit-report component retrieves and displays a customer's credit report. But first, the report must be ordered. There are two ways to order a report: You can tell the component to do it for you (automatic mode), or you can order it yourself (manual mode).

  • Automatic mode: You specify the credit bureau from which the report will be ordered by including the defaultBureau attribute. The system then orders a report for the customer identified by the userToken attribute; the attribute is described in Common Attributes.

  • Manual mode: You order the credit report yourself by calling the Order a Credit Report API, and then populate this component with the productCode, displayToken, and reportKey values that the API returns. Note that you must also supply the customer's userToken value.

The following attributes apply to both modes:

AttributeTypeDescription
autoExpandbooleanExpand all account sections.
livebooleanRetrieve the most recent report data.
autoExpandFirstAccountbooleanExpand the first account in each section
condensedbooleanUse the condensed theme.
hideBureauTogglebooleanControls the visibility of the credit bureau toggle. If hideBureauToggle is set to true, the toggle is hidden from view; if it's false or omitted, the toggle is displayed.
labelCrcHtmlCopyButtonstringThe text of the "Copy as HTML" button.
showLoadingMessagebooleanIf true, a text message is displayed when the component is loading. Defaults to false
creditAlertsLinkURLThe href value of the link to the credit alerts page.
creditReportLinkURLThe href value of the link to the credit report page.
overviewLinkURLThe href value of the link to the overview page.
scoreFactorsLinkURLThe href value of the link to the score factors page.
showAdsOffersbooleanIf set to true, the component includes a banner that displays ads and offers that are targeted at the customer. If omitted or set to false, the banner isn't displayed.

Additional automatic mode attributes:

AttributeTypeDescription
defaultBureauefx,exp,tui,allBureau from which the report is ordered.

Additional manual mode attributes:

AttributeTypeDescription
displayTokenstringRetrieved through Order a Credit Report.
productCodestringRetrieved through Order a Credit Report.
reportKeystringRetrieved through Order a Credit Report.

array-credit-score

The array-credit-score component retrieves and displays a customer's credit score. As with the array-credit-reportcomponent, this component operates in automatic mode or manual mode mode. See array-credit-report for an explanation of the two modes.

The following attributes apply to both modes:

AttributeTypeDescription
overviewLinkstringThe href value of the link to the score factors page.
scoreTrackerbooleanToggles credit history.
showAdsOffersbooleanIf set to true, the component includes a banner that displays ads and offers that are targeted at the customer. If omitted or set to false, the banner isn't displayed.
showLoadingMessagebooleanIf true, a text message is displayed when the component is loading. If omitted or set to false, the message isn't displayed.

Additional automatic mode attributes:

AttributeTypeDescription
bureauefx,exp,tui,allCredit bureau from which the report will be ordered.

🚧

The array-credit-report component calls this attribute defaultBureau.

Additional manual mode attributes:

AttributeTypeDescription
displayTokenstringRetrieved through Order a Credit Report.
productCodestringRetrieved through Order a Credit Report.
reportKeystringRetrieved through Order a Credit Report.

array-credit-score-insights

The array-credit-insights component displays the most important factors that were used to compute the customer's current credit score, factors such as payment history, credit utilization, amount of debt, and so on. The component obtains this information from the customer's credit report. As with the array-credit-reportcomponent, this component operates in automatic mode or manual mode mode. See array-credit-report for an explanation of the two modes.

The following attributes apply to both modes:

AttributeTypeDescription
showLoadingMessagebooleanIf true, a text message is displayed when the component is loading. Defaults to false.
creditReportLinkURLThe href value of the link to the credit report page. This applies to VantageScore reports, only; for FICO, the target of the link is determined automatically.

Additional automatic mode attributes:

AttributeTypeDescription
bureauefx,exp,tui,allCredit bureau from which the report will be ordered.

🚧

The array-credit-report component calls this attribute defaultBureau.

Additional manual mode attributes:

AttributeTypeDescription
displayTokenstringRetrieved through Order a Credit Report.
productCodestringRetrieved through Order a Credit Report.
reportKeystringRetrieved through Order a Credit Report.

In this mode, userToken is used to order and fetch data.

AttributeTypeDescription
hideBureauTogglebooleanControls the visibility of the credit bureau toggle. If hideBureauToggle is set to true, the toggle is hidden from view; if it's false or omitted, the toggle is displayed.

array-credit-score-simulator

Common Attributes only

array-credit-debt-analysis (simple)

In this mode, userToken is used to order and fetch data.

AttributeTypeDescription
showLoadingMessagebooleanwhen loading, also show text message (defaults to false)
hideBureauTogglebooleanControls the visibility of the credit bureau toggle. If hideBureauToggle is set to true, the toggle is hidden from view; if it's false or omitted, the toggle is displayed.

array-credit-debt-analysis (advanced)

In this mode, data was already ordered, and a reportKey and displayToken is used to fetch it

AttributeTypeDescription
displayTokenUUIDrequired for rendering specific report
hideBureauToggleBooleanControls the visibility of the credit bureau toggle. If hideBureauToggle is set to true, the toggle is hidden from view; if it's false or omitted, the toggle is displayed.
productCodestringrequired for rendering specific report
reportKeyUUIDrequired for rendering specific report
showLoadingMessageBooleanwhen loading, also show text message (defaults to false)

array-offers-credit-snapshot

AttributeTypeDescription
cosignerDisplayTokenUUIDdisplay token if user is a cosigner
cosignerOfferIdUUIDID of offer if user is a cosigner
signerDisplayTokenUUIDdisplay token for offer if user is a signer
signerOfferIdUUIDID of offer if user is a signer

array-identity-protect

AttributeTypeDescription
startPagedashboard | alerts | protectionServices | monitoredInformationThe page that's displayed when the Identity Protect module is initially presented.
brandEmailCustomerServicestringThe email address of your customer service department. The default is [email protected]
brandPhoneCustomerServicestringThe phone number of your customer service department presented with human-readable punctuation.
autoEnrollmentCodestringA string token that denotes the IDP product that the user is enrolled in. See the list, below

IDP Enrollment Codes

The autoEnrollmentCode attribute takes one of the following values. The descriptions are forthcoming:

  • idpBundle1Insurance1mmRestoreBundleMonitoring
  • idpBundle2Monitoring
  • idpChangeOfAddressMonitoring
  • idpChildSocialNetworkMonitoring
  • idpDarkWebMonitoring
  • idpFinancialAccountTakeover
  • idpInsurance1mmRestore
  • idpSSNMonitoring

array-content-help-center

AttributeTypeDescription
startPagefaqcontact

array-navbar

AttributeTypeDescription
showScoreSightbooleanshow 'Score Sight' link
privateHeaderbooleanshow the private header or the public if false or missing

array-content-privacy-policy

AttributeTypeDescription
companyAddressstringaddress of company
companyNamestringname of company
companyPhonestringphone number of company
complianceMailemailemail address for compliance
infoMailemailemail address for info
lastUpdatedatelast time policy was updated

array-content-terms-of-service

AttributeTypeDescription
companyAddressstringaddress of company
companyNamestringname of company
companyPhonestringphone number of company
complianceMailemailemail address for compliance
identityProtectionTermsURLlink to identity protection terms
infoMailemailemail address for info
lastUpdatedatelast time policy was updated
memberBenefitsTermsURLlink to member benefit terms
priorCancelationDaysnumbernumber of days notice required to cancel before billing date
reprocessCalendarDaysMarginnumbertime period for reprocessCount
reprocessCountnumbernumber of times payment will be retried
subscriptionAmountnumberdollar cost of subscription
subscriptionIntervalstringstring describing interval, like monthly