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
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
onEvent
CallbackWhen 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
Nexus.link
EventsnexusEvent.name | Description | nexusEvent.metadata |
---|---|---|
debts_linked | The 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_linked | The consumer logged into a debt account to fetch additional details about debts with that lender. | none |
consolidation_incomplete | The consumer began an application for a debt-consolidation loan but did not finish it | none |
consolidation_offers_unavailable | The consumer began an application for a debt-consolidation loan but did not receive offers from a lender | none |
consolidation_offer_selected | The consumer selected a consolidation loan offer and was directed to the lender's site to submit the pre-filled application | none |
login_error | When 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_linked | When a consumer successfully links a servicer, a servicer_linked event will fire. | servicer . Servicer will include the name and the servicer_uuid . |
quit | The 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.
Updated about 2 months ago