Component Attributes

Component Summary

Component NameComponent TagParent/EmbeddedPublic
Credit Alertsarray-credit-alertsParentYes
Credit Overviewarray-credit-overviewParentYes
Credit Reportarray-credit-reportParentYes
Credit Report 1 Bureauarray-credit-report-1bEmbeddedYes
Credit Report 3 Bureauarray-credit-report-3bEmbeddedYes
Credit Report Condensedarray-credit-report-condensedEmbeddedYes
Credit Scorearray-credit-scoreParentYes
Credit Score Factorsarray-credit-score-factorsParentYes
Credit ScoreSightarray-credit-score-sightParentYes
Credit Score Simulatorarray-credit-score-simulatorParentYes
Debt Analysisarray-credit-debt-analysisParentYes
Identity Protect Insurancearray-identity-protect-insuranceParentYes
User Insights Snapshotarray-offers-credit-snapshotParentYes
Account Benefitsarray-account-benefitsParentNo
Account Enrollarray-account-enrollParentNo
Account Loginarray-account-loginParentNo
Account Settingsarray-account-settingsParentNo
Bureau Togglearray-credit-bureau-toggleEmbeddedNo
Help Centerarray-content-help-centerParentNo
KBAarray-authentication-kbaEmbeddedNo
Navigationarray-navbarParentNo
Privacy Policyarray-content-privacy-policyParentNo
Terms of Servicearray-content-terms-of-serviceParentNo

Component Attributes

Component attributes have two sources:

  1. ArrayWebComponent — 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.

1. ArrayWebComponent

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

2. Component Attributes

array-account-benefits

ArrayWebComponent attributes only

array-account-enroll

attributetypedescription
loginHrefURLset custom href for login link
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

️ 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
showRememberEmailbooleanenable 'remember me' functionality

array-account-settings

attributetypedescription
startPagesecurity,personalInformationcomponent page to start on

array-authentication-kba

attributetypedescription
userIdstringArray userId
tuibooleanuse TUI as question provider
expbooleanuse EXP as question provider
efxbooleanuse EFX as question 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-credit-bureau-toggle

attributetypedescription
allbooleantoggle all bureaus
activeefx,exp,tui,alloverride for active bureau, else calculated from available product codes
efxbooleanshow equifax toggle
expbooleanshow experian toggle
tuibooleanshow transunion toggle

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

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
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
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-1b

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
bureauefx,exp,tui,allexplicit bureau selection
displayTokenstringrequired for rendering specific report
productCodestringrequired for rendering specific report
reportKeystringrequired for rendering specific report
showLoadingstringprevent normal rendering of the component
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-3b

attributetypedescription
autoExpandbooleanauto expand all account sections
livebooleanThe component will retrieve the most recent report available for the same bureau
displayTokenstringrequired for rendering specific report
productCodestringrequired for rendering specific report
reportKeystringrequired for rendering specific report
showLoadingbooleanprevent normal rendering of the component
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.

ArrayWebComponent attributes only

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
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

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

ArrayWebComponent attributes only

array-credit-debt-analysis (simple)

attributetypedescription
showLoadingMessagebooleanwhen loading, also show text message (defaults to false)

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

ArrayWebComponent attributes only

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
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, contactset initial page to render

array-identity-protect-insurance

attributetypedescription
brandPhoneCustomerServicestringchange href and labels of customer support phone numbers

array-identity-protect

attributetypedescription
startPagedashboard, alerts, protectionServices, monitoredInformationset initial page to render
brandNamestringchange brand name from html content
brandPhoneCustomerServicestringchange href and labels of customer support phone numbers

array-navbar

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

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