Common Attributes — These attributes are common to all components:
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
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
attribute
values
description
appKey
UUID
defines the client, and therefore the HTML file referenced by the component
sandbox
boolean
determines whether we are using the sandboxed API
userToken
UUID
user authorization token
sessionStoragePrefix
string
prefix for all components which share cache. defaults to userToken if available
toggles identity confirmation page without payment section
showQuickViewPayment
boolean
toggles identity confirmation page with payment section
dobAsText
boolean
if the DOB-SSN page takes DOB in the 'mm/dd/yyyy' format, this must be set to "true"
tui
boolean
use TUI as question provider for verifying identity
exp
boolean
use EXP as question provider for verifying identity
efx
boolean
use EFX as question provider for verifying identity
termsOfUseHref
URL
The URL of the page that describes your application's terms of use.
privacyPolicyHref
URL
The 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 parameters
type
description
clientKey, userId
UUID
sets a custom clientKey/userId
firstName, lastName
string
seeds the first and last names for the user in the form
streetAddress, state, zipCode
string
seeds the street address for the user in the form
dobDay, dobMonth, dobYear
string
seeds the values for the date of birth in the form
ssn1, ssn2, ssn3
string
seeds the first three, second three, and last four digits of the social security number
emailAddress
string
seeds the email address for the user in the form
array-account-login
attribute
type
description
signUpHref
URL
The URL of your application's sign up page.
showRememberEmail
boolean
If true the "remember me" checkbox is displayed.
array-account-settings
attribute
type
description
startPage
security or personalInformation
component page to start on
array-authentication-kba
attribute
type
description
userId
string
Array userId
tui
boolean
use TUI as an authentication provider
exp
boolean
use EXP as an authentication provider
efx
boolean
use 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
attribute
type
description
companyAddress
string
address of company
companyName
string
name of company
companyPhone
string
phone number of company
complianceMail
email
email address for compliance
infoMail
email
email address for info
lastUpdate
date
last time policy was updated
array-content-terms-of-service
attribute
type
description
companyAddress
string
address of company
companyName
string
name of company
companyPhone
string
phone number of company
complianceMail
email
email address for compliance
identityProtectionTerms
URL
link to identity protection terms
infoMail
email
email address for info
lastUpdate
date
last time policy was updated
memberBenefitsTerms
URL
link to member benefit terms
priorCancelationDays
number
number of days notice required to cancel before billing date
reprocessCalendarDaysMargin
number
time period for reprocessCount
reprocessCount
number
number of times payment will be retried
subscriptionAmount
number
dollar cost of subscription
subscriptionInterval
string
string describing interval, like monthly
array-credit-alerts
attribute
type
description
maxPages
number
the maximum amount of pages of alerts, defaults to infinity
alertsPerPage
number
the maxmimum amount of alerts displayed per page, defaults to 20
bureau
efx,exp,tui,all
overwrites the bureau and hides bureau-toggle
defaultBureau
efx,exp,tui,all
provides a default bureau for the bureau toggle if no active bureau in cache
array-credit-disputes
Pending
array-credit-overview
attribute
type
description
defaultBureau
efx,exp,tui,all
bureau preference, session storage takes priority
showScoreSight
boolean
show 'Score Sight' link
showIdentityProtect
boolean
show 'Identity Protect' link
showLoadingMessage
boolean
when loading, also show text message (defaults to false)
creditAlertsLink
string
change href of links to credit-alerts path
creditLockLink
string
change href of links to credit-lock path
creditReportLink
string
change href of links to credit-report path
debtAnalysisLink
string
change href of links to debt-analysis path
identityProtectLink
string
change href of links to identity-protect path
scoreFactorsLink
string
change href of links to score-factors path
scoreSightLink
string
change href of links to score-sight path
scoreSimulatorLink
string
change href of links to score-simulator path
settingsLink
string
change href of links to settings path
hideCreditAlerts
boolean
hide 'Credit Alerts' link
hideScoreSimulator
boolean
hide 'Score Simulator' link
hideCreditLock
boolean
hide 'Credit Lock' link
hideCreditReport
boolean
hide 'Credit Report' link
hideDebtAnalysis
boolean
hide 'Debt Analysis' link
hideScoreFactors
boolean
hide 'Score Factors' link
hideScoreSight
boolean
hide 'Score Sight' link
hideIdentityProtect
boolean
hide 'Identity Protect' link
array-credit-protection
Pending
array-credit-report (simple)
In this mode the userToken is used to order reports
attribute
type
description
autoExpand
boolean
auto expand all account sections
live
boolean
The component will retrieve the most recent report available for the same bureau
autoExpandFirstAccount
boolean
auto expand first account of each section
condensed
boolean
render condensed theme
defaultBureau
efx,exp,tui,all
bureau preference, session storage takes priority
hideBureauToggle
boolean
Controls 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.
labelCrcHtmlCopyButton
string
determines the text of the 'copy as html' button
showLoadingMessage
boolean
when loading, also show text message (defaults to false)
creditAlertsLink
string
change href of links to credit-alerts path
creditReportLink
string
change href of links to credit-report path
overviewLink
string
change href of links to overview path
scoreFactorsLink
string
change 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.
attribute
type
description
autoExpand
boolean
auto expand all account sections
live
boolean
The component will retrieve the most recent report available for the same bureau
autoExpandFirstAccount
boolean
auto expand first account of each section
condensed
boolean
render condensed theme
defaultBureau
efx,exp,tui,all
bureau preference, session storage takes priority
displayToken
string
required for rendering specific report
hideBureauToggle
boolean
Controls 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.
productCode
string
required for rendering specific report
reportKey
string
required for rendering specific report
labelCrcHtmlCopyButton
string
determines the text of the 'copy as html' button
showLoadingMessage
boolean
when loading, also show text message (defaults to false)
creditAlertsLink
string
change href of links to credit-alerts path
creditReportLink
string
change href of links to credit-report path
overviewLink
string
change href of links to overview path
scoreFactorsLink
string
change href of links to score-factors path
array-credit-report-condensed
attribute
type
description
autoExpand
boolean
auto expand all account sections
live
boolean
The component will retrieve the most recent report available for the same bureau
bureau
efx,exp,tui
explicit bureau selection
displayToken
string
required for rendering specific report
productCode
string
required for rendering specific report
reportKey
string
required for rendering specific report
showLoadingMessage
boolean
when loading, also show text message (defaults to false)
array-credit-score (simple)
In this mode we order, fetch, and then display, credit-score data.
attribute
type
description
bureau
efx,exp,tui, all
determines bureau when usertoken is present
userToken
UUID
required for fetching score when no reportKey/displayToken
scoreTracker
boolean
toggles credit history
overviewLink
string
overrides default href for score factors link
showLoadingMessage
boolean
when 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.
attribute
type
description
reportKey
UUID
required for fetching score when no userToken
displayToken
UUID
required for fetching score when no userToken
scoreTracker
boolean
toggles credit history
productCode
string
determines bureau when no userToken
overviewLink
string
overrides default href for score factors link
showLoadingMessage
boolean
when loading, also show text message (defaults to false)
array-credit-score-factors (simple)
In this mode, userToken is used to order and fetch data.
attribute
type
description
hideBureauToggle
boolean
Controls 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
attribute
type
description
displayToken
UUID
required for rendering specific report
hideBureauToggle
boolean
Controls 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.
productCode
string
required for rendering specific report
reportKey
UUID
required for rendering specific report
sessionStoragePrefix
UUID
specify the prefix in the session storage
showLoadingMessage
boolean
when loading, also show text message (defaults to false)
In this mode, userToken is used to order and fetch data.
attribute
type
description
showLoadingMessage
boolean
when loading, also show text message (defaults to false)
hideBureauToggle
boolean
Controls 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
attribute
type
description
displayToken
UUID
required for rendering specific report
hideBureauToggle
Boolean
Controls 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.
productCode
string
required for rendering specific report
reportKey
UUID
required for rendering specific report
sessionStoragePrefix
UUID
specify the prefix in the session storage
showLoadingMessage
Boolean
when loading, also show text message (defaults to false)
array-content-help-center
attribute
type
description
startPage
faq | contact
The page that's displayed when the Identity Protect module is initially presented.
The page that's displayed when the Identity Protect module is initially presented.
brandEmailCustomerService
string
The email address of your customer service department. The default is [email protected]
brandPhoneCustomerService
string
The phone number of your customer service department presented with human-readable punctuation. The default is +1-844-395-7319 (the Array-Credmo support number).
