Components and Attributes

Component Summary

Component NameComponent Tag
Account Benefitsarray-account-benefits
Account Enrollarray-account-enroll
Account Loginarray-account-login
Account Settingsarray-account-settings
KBAarray-authentication-kba
Credit Alertsarray-credit-alerts
Credit Overviewarray-credit-overview
Credit Reportarray-credit-report
Credit Report Condensedarray-credit-report-condensed
Credit Scorearray-credit-score
Credit Score Factorsarray-credit-score-factors
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
Help Centerarray-content-help-center
Privacy Policyarray-content-privacy-policy
Terms of Servicearray-content-terms-of-service

Component Attributes

Component attributes have two sources:

  1. Common Attributes — These attributes are common to all components:
  2. Component Attributes - These attributes are specific to a particular component.

Query Parameters

In addition to component attributes, we pass data appending query parameters to the URL

  1. The parameter string of a URL begins with a '?' and each parameter is separated by a '&'. For example, https://whitelabel.array.io/signup?firstName=Thomas&lastName=Friedman would pass the values Thomas and Friedman for lastName and firstName to the enroll component.

Common Attributes

The following attribute are common to all components

attributevaluesdescription
appKeyUUIDdefines the client, and therefore the HTML file referenced by the component
sandboxbooleandetermines whether we are using the sandboxed API
userTokenUUIDuser authorization token
sessionStoragePrefixstringprefix for all components which share cache. defaults to userToken if available
apiUrl*URLprivate override for API calls

Component Attributes

array-account-benefits

Common Attributes only

array-account-enroll

attributetypedescription
loginHrefURLThe URL of your application's login page.
showEmailPasswordFieldsbooleanenable username/password page
showQuickViewbooleantoggles identity confirmation page without payment section
showQuickViewPaymentbooleantoggles 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"
tuibooleanuse TUI as question provider for verifying identity
expbooleanuse EXP as question provider for verifying identity
efxbooleanuse EFX as question provider for verifying identity
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.

️ WARNING

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

The tui, exp, and efx attributes are optional. If not provided, default values are true. If provided, all three attributes must be specified.

Query parameters are passed as attributes to the component. If you're using a component and not the portal, use a query string, otherwise pass the attributes directly.

query parameterstypedescription
clientKey, userIdUUIDsets a custom clientKey/userId
firstName, lastNamestringseeds the first and last names for the user in the form
streetAddress, state, zipCodestringseeds the street address for the user in the form
dobDay, dobMonth, dobYearstringseeds the values for the date of birth in the form
ssn1, ssn2, ssn3stringseeds the first three, second three, and last four digits of the social security number
emailAddressstringseeds the email address for the user in the form

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

attributetypedescription
userIdstringArray userId
tuibooleanuse TUI as an authentication provider
expbooleanuse EXP as an authentication provider
efxbooleanuse EFX as an authentication provider

The tui, exp, and efx attributes are optional. If not provided, default values are true. If provided, all three attributes must be specified.

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

array-credit-alerts

attributetypedescription
maxPagesnumberthe maximum amount of pages of alerts, defaults to infinity
alertsPerPagenumberthe maxmimum amount 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

array-credit-disputes

Pending

array-credit-overview

attributetypedescription
defaultBureauefx,exp,tui,allbureau preference, session storage takes priority
showScoreSightbooleanshow 'Score Sight' link
showIdentityProtectbooleanshow 'Identity Protect' link
showLoadingMessagebooleanwhen loading, also show text message (defaults to false)
creditAlertsLinkstringchange href of links to credit-alerts path
creditLockLinkstringchange href of links to credit-lock path
creditReportLinkstringchange href of links to credit-report path
debtAnalysisLinkstringchange href of links to debt-analysis path
identityProtectLinkstringchange href of links to identity-protect path
scoreFactorsLinkstringchange href of links to score-factors path
scoreSightLinkstringchange href of links to score-sight path
scoreSimulatorLinkstringchange href of links to score-simulator path
settingsLinkstringchange href of links to settings path
hideCreditAlertsbooleanhide 'Credit Alerts' link
hideScoreSimulatorbooleanhide 'Score Simulator' link
hideCreditLockbooleanhide 'Credit Lock' link
hideCreditReportbooleanhide 'Credit Report' link
hideDebtAnalysisbooleanhide 'Debt Analysis' link
hideScoreFactorsbooleanhide 'Score Factors' link
hideScoreSightbooleanhide 'Score Sight' link
hideIdentityProtectbooleanhide 'Identity Protect' link

array-credit-protection

Pending

array-credit-report (simple)

In this mode the userToken is used to order reports

attributetypedescription
autoExpandbooleanauto expand all account sections
livebooleanThe component will retrieve the most recent report available for the same bureau
autoExpandFirstAccountbooleanauto expand first account of each section
condensedbooleanrender condensed theme
defaultBureauefx,exp,tui,allbureau preference, session storage takes priority
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.
labelCrcHtmlCopyButtonstringdetermines the text of the 'copy as html' button
showLoadingMessagebooleanwhen loading, also show text message (defaults to false)
creditAlertsLinkstringchange href of links to credit-alerts path
creditReportLinkstringchange href of links to credit-report path
overviewLinkstringchange href of links to overview path
scoreFactorsLinkstringchange href of links to score-factors path

array-credit-report (advanced)

In this mode a single report is displayed, which must have been pre-ordered using the API.

attributetypedescription
autoExpandbooleanauto expand all account sections
livebooleanThe component will retrieve the most recent report available for the same bureau
autoExpandFirstAccountbooleanauto expand first account of each section
condensedbooleanrender condensed theme
defaultBureauefx,exp,tui,allbureau preference, session storage takes priority
displayTokenstringrequired 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
reportKeystringrequired for rendering specific report
labelCrcHtmlCopyButtonstringdetermines the text of the 'copy as html' button
showLoadingMessagebooleanwhen loading, also show text message (defaults to false)
creditAlertsLinkstringchange href of links to credit-alerts path
creditReportLinkstringchange href of links to credit-report path
overviewLinkstringchange href of links to overview path
scoreFactorsLinkstringchange href of links to score-factors path

array-credit-report-condensed

attributetypedescription
autoExpandbooleanauto expand all account sections
livebooleanThe component will retrieve the most recent report available for the same bureau
bureauefx,exp,tuiexplicit bureau selection
displayTokenstringrequired for rendering specific report
productCodestringrequired for rendering specific report
reportKeystringrequired for rendering specific report
showLoadingMessagebooleanwhen loading, also show text message (defaults to false)

array-credit-score (simple)

In this mode we order, fetch, and then display, credit-score data.

attributetypedescription
bureauefx,exp,tui, alldetermines bureau when usertoken is present
userTokenUUIDrequired for fetching score when no reportKey/displayToken
scoreTrackerbooleantoggles credit history
overviewLinkstringoverrides default href for score factors link
showLoadingMessagebooleanwhen loading, also show text message (defaults to false)

array-credit-score (advanced)

In this mode we fetch, and then display, credit-score data that has already been ordered.

attributetypedescription
reportKeyUUIDrequired for fetching score when no userToken
displayTokenUUIDrequired for fetching score when no userToken
scoreTrackerbooleantoggles credit history
productCodestringdetermines bureau when no userToken
overviewLinkstringoverrides default href for score factors link
showLoadingMessagebooleanwhen loading, also show text message (defaults to false)

array-credit-score-factors (simple)

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-factors (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
sessionStoragePrefixUUIDspecify the prefix in the session storage
showLoadingMessagebooleanwhen loading, also show text message (defaults to false)

array-credit-score-sight

attributetypedescription
efxbooleanenable Equifax
expbooleanenable Experian
tuibooleanenable Transunion

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
sessionStoragePrefixUUIDspecify the prefix in the session storage
showLoadingMessageBooleanwhen loading, also show text message (defaults to false)

array-content-help-center

attributetypedescription
startPagefaq | contactThe page that's displayed when the Identity Protect module is initially presented.

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. The default is +1-844-395-7319 (the Array-Credmo support number).