POST
request to the webhook_url
attribute of the screening group you created.BEGIN_SCREENING
BEGIN_SCREENING
webhook when an applicant signs up and begins the AIV screening.SCREENING_COMPLETED
SCREENING_COMPLETED
webhook will fire. Note that this event fires when an individual income screening is completed, not the entire screening group.SCREENING_GROUP_COMPLETED
SCREENING_GROUP_COMPLETED
webhook will fire. This means that the income verification report has been generated and is ready to be presented.BANK_NOT_SUPPORTED
BANK_NOT_SUPPORTED
webhook will fire. The applicant's bank will be in the value property.NO_BANK
NO_BANK
webhook will fire.BANK_CANNOT_CONNECT
BANK_CANNOT_CONNECT
webhook will fire. The applicant's bank will be in the value property.SHARE_BANK
SHARE_BANK
webhook will fire. This only occurs with screening groups with more than 1 applicant.
Example:NO_INCOME
NO_INCOME
webhook will fire. This only occurs with screening groups with more than 1 applicant.RE_OPEN_SCREENING
In Progress
on your end until the SCREENING_COMPLETED
webhook fires again.REPORT_SOON_TO_EXPIRE
REPORT_SOON_TO_EXPIRE
.REPORT_EXPIRED
REPORT_EXPIRED
.Verification-Signature
. The hash is created using HMAC-SHA256 and is hex encoded. Verification-Signature
header value.