DIM API

Callbacks Overview

Here's a breakdown of the callbacks on each DIM:

The callbacks that present on each DIM are listed in this table:

Module	onSuccess	onLoad	onExit	onEvent	onError	onResize	onSettled
loan-servicers-login
precision-pay
loan-pal
loan-list
transaction-history
student-loan-refi
auto-refi
personal-refi
auto-debit
debt-connect
identity-connect
credit-card-update
prequal
interest-rate-monitoring
balance-transfer

Errors

Here are the error events you can expect to see when the onEvent callback is invoked:

Common methods

onLoad

onLoad(metadata){
    // your code
}

// metadata
{
    'eventName': 'DROPIN_LOAD',
    'message': `${dropin} dropin module loaded.`
}

onExit

onExit(metadata){
    // your code
}

{
    'eventName': 'DROPIN_EXIT',
    'message': 'Drop in Module Closed.'
}

onError

onError(metadata) {
	// your code
}

{
    'eventName': '{eventName}',
    'message': '{message}',
    'metadata': {
        // details related to error
    }
}

onResize

onResize(metadata){
    // your code
}

{
    'eventName': 'DROPIN_RESIZE',
    'message': 'Dropin window size changed.',
    'metadata': {
        'height': 'height of dropin document', // in pixels like 786
        'width':  'width of dropin document' // in pixels like 500
    }
}

onEvent - Common use cases

AUTH_EXPIRE

The onEvent method is commonly triggered when a user's credentials have expired or been updated, known as the AUTH_EXPIRE event. This method is used by all dropin modules except for the connect dropin module. In addition, the metadata includes the noValidLoan and reauthenticateAccounts attributes. The noValidLoan attribute indicates whether the user has any valid loan accounts, while the reauthenticateAccounts attribute provides an array of loan accounts that require re-authentication.

When a consumer subscribes to this event and it is triggered, we send a callback to the consumer and unmount the dropin module. This allows the partner to provide their own re-authentication experience. If the consumer does not subscribe to this event, our default screen is displayed and the user goes through the re-authentication flow to authenticate their account.

CONNECT_LOAN_TO_CONTINUE

The CONNECT_LOAN_TO_CONTINUE method is triggered when a user does not have any loans. This method is used by all dropin modules except for the connect dropin module. In addition, the metadata includes the userInfo object.

onEvent(metadata){
    // your code
}

{
    'eventName': 'AUTH_EXPIRE',
    'message': 'Credentials Expired/Updated.',
    'metadata': {
        'extUserId': '{extUserId}',
        'shouldReconnect':  true,
        'noValidLoan': false,
        'reauthenticateAccounts': "<array of accounts needing re-auth>"
    }
}

{
    'eventName': 'CONNECT_LOAN_TO_CONTINUE',
    'message': 'Connect loan to use this Dropin.',
    'metadata': {
        'extUserId': '{extUserId}',
        'userInfo': '<userInfo>'
        "dimExitInitiated": true
    }
}

onSettled

onSettled(metadata){
    // your code
}

{
  'eventName': 'DIM_SETTLED',
  'message': `${dropin} Dropin Load complete`
}

To learn more about our debt APIs and 1-click solutions, visit spinwheel.io.