Push Notifications

You can choose to receive push notifications of application events including for:

  • Application status

  • Signing status

  • Boarding status

Push notifications are transmitted using the PAPI notificationStatusRequest object.

Authentication

Authentication credentials must be provided for both test and production environments:

  • Token-based authentication. You must provide the token and URL endpoint.
  • Basic authentication. You must provide the username, password, and URL endpoint.

Available Notifications

Let us know which push notifications you'd like to receive.

Available Notifications

Notification

Flow

Description

EMAIL_SENT

Guided

Transmitted when an email is sent to a customer:

  • At the time of account creation.
  • On 7 days of no action.
  • On 14 days of no action.

 

Note: Not applicable to our NA Payments Facilitator partners.

REGISTRATION_ERROR

Guided

Transmitted when the customer inputs an incorrect:

  • Date of birth
  • Phone number
  • Password
Note: Not applicable to our NA Payments Facilitator partners.

REGISTRATION_COMPLETED

Guided

Transmitted when a customer successfully creates an account.

Note: Not applicable to our NA Payments Facilitator partners.

SIGNATURE_STATUS

Guided

Managed

Transmitted on change of an applicant’s signature status including when:

  • Draft
  • Accepted
  • Signed
  • Declined
  • Expired
Note: Not applicable to our NA Payments Facilitator partners.

APPLICATION_SUBMITTED

All

Transmitted when the application is received and boarded.

BOARDING_STATUS

All

Transmitted on change of the application status when:

  • COMPLETE
  • INPROGRESS (EU)
  • DECLINED
  • WITHDRAWN
  • ERROR
  • TIMED OUT
  • PEND (NA)
  • UNKNOWN

 

❮ Back to Boarding  Next: Error Messages ❯