Components and Attributes
Component List
Component | HTML Element Name |
---|---|
Account Benefits | array-account-benefits |
Account Enroll | array-account-enroll |
Account Login | array-account-login |
Account Settings | array-account-settings |
Knowledge Based Authentication (KBA) | array-authentication-kba |
Credit Alerts | array-credit-alerts |
Credit Overview | array-credit-overview |
Credit Overview Mini (aka Entrypoint) | array-credit-overview-mini |
Credit Report | array-credit-report |
Credit Score | array-credit-score |
Credit Score Factors (deprecated; use Credit Score Insights) | |
Credit Score Insights | array-credit-score-insights |
Credit Score Simulator | array-credit-score-simulator |
Debt Analysis | array-credit-debt-analysis |
Identity Protect | array-identity-protect |
User Insights Snapshot | array-offers-credit-snapshot |
Privacy Policy | array-content-privacy-policy |
Terms of Service | array-content-terms-of-service |
The set of attributes that a component takes is drawn from two sources:
- Common Attributes apply to all components.
- 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.
Attribute | Type | Description |
---|---|---|
appKey | UUID | A string token that uniquely identifies your application. |
sandbox | boolean | Set this to true when you're testing your web page, and remove it when you move to production. |
userToken | UUID | A 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
Attribute | Type | Description |
---|---|---|
loginHref | URL | The URL of your application's login page. This is the destination of the "Log In" link that's shown on the "Sign up" page. |
showSplash | boolean | Toggles the initial splash screen. |
showEmailPasswordFields | boolean | Toggles the username and password page. |
showQuickView | boolean | Toggles the identity confirmation page without 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 | tui (TransUnion), exp (Experian), and efx (Equifax) designate the bureaus that will verify the customer's identity. IMPORTANT: You can either omit all three bureau attributes, or provide values for all three. Any other combination throws an error. See array-authentication-kba for more information. |
exp | boolean | See array-authentication-kba. |
efx | boolean | See array-authentication-kba. |
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. |
If you set
showQuickView
totrue
, thesignup
JavaScript event isn't posted.
You can seed the information on the enrollment form by setting these attributes:
Attribute | Type | Description |
---|---|---|
firstName , lastName | string | Seeds the user's first and last names. |
streetAddress , state , city , zipCode | string | Seeds the elements of the customer's address. |
dobDay , dobMonth , dobYear | string | Seeds the elements of the customer's date of birth. dobDay and dobMonth must be given as two digits (05 rather than 5 , for example). dobYear is, of course, four digits. |
ssn1 , ssn2 , ssn3 | string | Seeds the first three, middle two, and last four digits of the customer's social security number. |
emailAddress | string | Seeds 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.
Attribute | Type | Description |
---|---|---|
clientKey | UUID | Normally, 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
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
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.
Attribute | Type | Description |
---|---|---|
userId | string | A string token that identifies the customer. |
tui | boolean | Use TransUnion as an identity verification provider. The default is true . |
exp | boolean | Use Experian as an identity verification provider. The default is true . |
efx | boolean | Use Equifax as an identity verification provider. The default is true . |
showResultPages | boolean | Determines 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
Attribute | Type | Description |
---|---|---|
maxPages | number | The maximum number of pages of alert maximum amount of pages of alerts, defaults to infinity |
alertsPerPage | number | the maximum number 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 |
showAdsOffers | boolean | If 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).
Attribute | Type | Description |
---|---|---|
defaultBureau | efx,exp,tui,all | bureau preference |
showAdsOffers | boolean | If 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. |
showIdentityProtect | boolean | show 'Identity Protect' link |
showLoadingMessage | boolean | when loading, also show text message (defaults to false) |
creditAlertsLink | URL | change href of links to credit-alerts path |
creditReportLink | URL | change href of links to credit-report path |
debtAnalysisLink | URL | change href of links to debt-analysis path |
identityProtectLink | URL | change href of links to identity-protect path |
scoreFactorsLink | URL | change href of links to score-factors path |
scoreSimulatorLink | URL | change href of links to score-simulator path |
settingsLink | URL | change href of links to settings path |
hideCreditAlerts | boolean | hide 'Credit Alerts' link |
hideScoreSimulator | boolean | hide 'Score Simulator' link |
hideCreditReport | boolean | hide 'Credit Report' link |
hideDebtAnalysis | boolean | hide 'Debt Analysis' link |
hideScoreFactors | boolean | hide 'Score Factors' link |
hideIdentityProtect | boolean | hide '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 mainarray-credit-overview
component, or similar information.
Attribute | Type | Description |
---|---|---|
linkCreditOverview | URL | The URL of a page that displays an overview of credit information for enrolled customers. |
linkLearnMore | URL | The 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 theuserToken
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
, andreportKey
values that the API returns. Note that you must also supply the customer'suserToken
value.
The following attributes apply to both modes:
Attribute | Type | Description |
---|---|---|
autoExpand | boolean | Expand all account sections. |
live | boolean | Retrieve the most recent report data. |
autoExpandFirstAccount | boolean | Expand the first account in each section |
condensed | boolean | Use the condensed theme. |
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 | The text of the "Copy as HTML" button. |
showLoadingMessage | boolean | If true, a text message is displayed when the component is loading. Defaults to false |
creditAlertsLink | URL | The href value of the link to the credit alerts page. |
creditReportLink | URL | The href value of the link to the credit report page. |
overviewLink | URL | The href value of the link to the overview page. |
scoreFactorsLink | URL | The href value of the link to the score factors page. |
showAdsOffers | boolean | If 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:
Attribute | Type | Description |
---|---|---|
defaultBureau | efx,exp,tui,all | Bureau from which the report is ordered. |
Additional manual mode attributes:
Attribute | Type | Description |
---|---|---|
displayToken | string | Retrieved through Order a Credit Report. |
productCode | string | Retrieved through Order a Credit Report. |
reportKey | string | Retrieved 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-report
component, 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:
Attribute | Type | Description |
---|---|---|
overviewLink | string | The href value of the link to the score factors page. |
scoreTracker | boolean | Toggles credit history. |
showAdsOffers | boolean | If 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. |
showLoadingMessage | boolean | If 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:
Attribute | Type | Description |
---|---|---|
bureau | efx,exp,tui,all | Credit bureau from which the report will be ordered. |
The
array-credit-report
component calls this attributedefaultBureau
.
Additional manual mode attributes:
Attribute | Type | Description |
---|---|---|
displayToken | string | Retrieved through Order a Credit Report. |
productCode | string | Retrieved through Order a Credit Report. |
reportKey | string | Retrieved 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-report
component, 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:
Attribute | Type | Description |
---|---|---|
showLoadingMessage | boolean | If true, a text message is displayed when the component is loading. Defaults to false . |
creditReportLink | URL | The 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:
Attribute | Type | Description |
---|---|---|
bureau | efx,exp,tui,all | Credit bureau from which the report will be ordered. |
The
array-credit-report
component calls this attributedefaultBureau
.
Additional manual mode attributes:
Attribute | Type | Description |
---|---|---|
displayToken | string | Retrieved through Order a Credit Report. |
productCode | string | Retrieved through Order a Credit Report. |
reportKey | string | Retrieved through Order a Credit Report. |
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-simulator
Common Attributes only
array-credit-debt-analysis (simple)
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 |
showLoadingMessage | Boolean | when loading, also show text message (defaults to false) |
array-offers-credit-snapshot
Attribute | Type | Description |
---|---|---|
cosignerDisplayToken | UUID | display token if user is a cosigner |
cosignerOfferId | UUID | ID of offer if user is a cosigner |
signerDisplayToken | UUID | display token for offer if user is a signer |
signerOfferId | UUID | ID of offer if user is a signer |
array-identity-protect
Attribute | Type | Description |
---|---|---|
startPage | dashboard | alerts | protectionServices | monitoredInformation | 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. |
autoEnrollmentCode | string | A 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-privacy-policy
Attribute | Type | Description |
---|---|---|
companyAddress | string | address of company |
companyName | string | name of company |
companyPhone | string | phone number of company |
complianceMail | email address for compliance | |
infoMail | 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 address for compliance | |
identityProtectionTerms | URL | link to identity protection terms |
infoMail | 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 |
Updated about 4 hours ago