Array

The Array Developer Hub

Welcome to the Array developer hub. You'll find comprehensive guides and documentation to help you start working with Array as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Component Attributes

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

Besides componenet attributes, we also pass data using query paramers in 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 w/o payment section
showQuickViewPaymentbooleantoggles ientity confirmation page with pament section
dobAsTextbooleanif the DOB-SSN page takes DOB in the 'mm/dd/yyyy' formate, this must be set to "true"
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

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

ArrayWebComponent attributes only

array-credit-disputes

Pending

array-credit-overview

attributetypedescription
showScoreSightbooleanshow 'Score Sight' link
defaultBureauefx,exp,tui,allbureau preference, session storage takes priority

array-credit-protection

Pending

array-credit-report (simple)

In this mode the userToken is used to order reports

attributetypedescription
autoExpandbooleanauto expand all account sections
autoExpandFirstAccountbooleanauto expand first account of each section
condensedbooleanrender condensed theme
defaultBureauefx,exp,tui,allbureau preference, session storage takes priority

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

array-credit-report-1b

attributetypedescription
autoExpandbooleanauto expand all account sections
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

array-credit-report-3b

attributetypedescription
autoExpandbooleanauto expand all account sections
displayTokenstringrequired for rendering specific report
productCodestringrequired for rendering specific report
reportKeystringrequired for rendering specific report
showLoadingbooleanprevent normal rendering of the component

array-credit-report-condensed

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

attributetypedescription
autoExpandbooleanauto expand all account sections
bureauefx,exp,tuiexplicit bureau selection
displayTokenstringrequired for rendering specific report
productCodestringrequired for rendering specific report
reportKeystringrequired for rendering specific report

array-credit-score (simple)

attributetypedescription
bureauefx,exp,tuidetermines bureau when usertoken is present
userTokenUUIDrequired for fetching score when no reportKey/displayToken
scoreTrackerbooleantoggles credit history

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

array-credit-score-factors

ArrayWebComponent attributes only

array-credit-score-sight

attributetypedescription
efxbooleanenable Equifax
expbooleanenable Experian
tuibooleanenable Transunion

array-credit-score-simulator

ArrayWebComponent attributes only

array-credit-debt-analysis

ArrayWebComponent attributes only

array-content-help-center

ArrayWebComponent attributes only

array-identity-protect-insurance

ArrayWebComponent attributes only

array-identity-protect

Pending

array-navbar

attributetypedescription
showScoreSightbooleanshow 'Score Sight' link

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

Updated about a month ago

Component Attributes


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.