Retrieve events for an order

Returns a list of events for the specified order.

Event Types

Order Events

EventDescription
order_createdOrder created successfully
suborder_completedSuborder completed by the applicant
suborder_canceledSuborder canceled
suborder_expiredSuborder expired and the link is no longer accessible
suborder_no_dataAccount successfully connected but no data is available from the provider
suborder_skippedSuborder skipped by the applicant
certification_completedSelf-certification completed by the applicant

Link Events

EventDescription
login_attemptApplicant attempted to log in to the provider, resulting in an error

Email Notification Events

Sent to the applicant

EventDescription
email_first_sentInitial email sent to the applicant
email_first_delivery_errorInitial email failed to deliver to the applicant
email_first_deliveredInitial email successfully delivered to the applicant
email_first_link_openedApplicant opened the link in the initial email
email_first_unsubscribedApplicant unsubscribed from emails in the initial email
email_reminder_sentReminder email sent to the applicant
email_reminder_delivery_errorReminder email failed to deliver to the applicant
email_reminder_deliveredReminder email successfully delivered to the applicant
email_reminder_link_openedApplicant opened the link in the reminder email
email_reminder_unsubscribedApplicant unsubscribed from emails in the reminder email

SMS Notification Events

Sent to the applicant

EventDescription
sms_first_sentInitial SMS sent to the applicant
sms_first_delivery_errorInitial SMS failed to deliver to the applicant
sms_first_deliveredInitial SMS delivered to the applicant
sms_first_link_openedApplicant opened the link in the initial SMS
sms_first_unsubscribedApplicant unsubscribed from SMSs in the initial SMS
sms_reminder_sentReminder SMS sent to the applicant
sms_reminder_delivery_errorReminder SMS failed to deliver to the applicant
sms_reminder_deliveredReminder SMS delivered to the applicant
sms_reminder_link_openedApplicant opened the link in the reminder SMS
sms_reminder_unsubscribedApplicant unsubscribed from SMSs in the reminder SMS

Language
Credentials
Click Try It! to start a request and see the response here!