HomeGuidesAPI Reference

Guidance

Help consumers get out of debt faster

Give consumers an overview of all their debts, drill into the details, and help them pay off credit-card debt faster with a consolidation loan—all with Nexus.guidance.

Calling Nexus.guidance

Nexus.guidance expects to receive a single options object as a parameter. This options object allows you to specify an optional onEvent callback to take actions based on your borrower's activity within Nexus:

// Assuming you have a button your Consumer can click to start linking their debts
let nexusButton = document.querySelector('#nexus-guidance-button')

// Attach click handler to invoke Nexus.guidance
nexusButton.addEventListener('click', e => {
  Nexus.guidance({
    // the function to call when an important event takes place within Nexus
    onEvent: handleEvent
  })
})

onEvent Callback

When Nexus transmits an event, your onEvent callback will be called with one an argument, a JavaScript object with a top-level property nexusEvent containing an object with the details of the event:

{
   nexusEvent: {
     name: "debts_linked"
     consumer: {
       uuid: "dceea28c-2245-41a8-a558-fef1643f99b2"
     },
     workflow:  "guidance",
     metadata: {},
   }
 }

Nexus.link Events

nexusEvent.nameDescriptionnexusEvent.metadata
debts_linkedThe consumer's credit report was successfully requested. To fetch data about the consumer's debts, use our GraphQL API with the consumer's uuid.none
debt_account_linkedThe consumer logged into a debt account to fetch additional details about debts with that lender.none
consolidation_incompleteThe consumer began an application for a debt-consolidation loan but did not finish itnone
consolidation_offers_unavailableThe consumer began an application for a debt-consolidation loan but did not receive offers from a lendernone
consolidation_offer_selectedThe consumer selected a consolidation loan offer and was directed to the lender's site to submit the pre-filled applicationnone
login_errorWhen a consumer fails login, we will send an event with one of the following reasons in the metadata: invalid_credentials, challenge_failed, servicer_error, or login_error.reason and servicer. Servicer will include the name and the servicer_uuid.
servicer_linkedWhen a consumer successfully links a servicer, a servicer_linked event will fire.servicer. Servicer will include the name and the servicer_uuid.
quitThe consumer closed Nexus. Note: unlike other workflows, Nexus.guidance has no "end", so the quit event does not necessarily mean exiting prematurely. Instead, borrowers must quit to close Nexus even after successfully linking debts and applying for a consolidation loan.none

📘

Consumer IDs

When relying on Nexus to create consumers, you will need to capture the consumer.uuid that is returned in order to make API calls on behalf of your consumers.