Guidance

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. See our guide for using onEvent callbacks.

📘

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.