Webhooks

CreditConnect offers a few webhooks that helps the integrator know in real time when event occur. Webhooks are sent via HTTPS POST to a URL provided by the Integrator. The message body is JSON.

If there is a problem delivering the webhook, CreditConnect will retry up to 15 times using exponential backoff over a period of about 35 hours.

user.authenticated

Sent when a User (Applicant or Property Owner) successfully completes authentication via the KBA Portal.

{
  "event": "user.authenticated",
  "demo_mode": false,
  "data": {
    "user_id": 1
  }
}

credit.ordered

Sent when an Applicant orders their Credit Report.

Note, this is currently only fired when the Applicant orders their own Credit Report. It does not currently fire when a Credit Report is ordered for a property owner. CreditConnect may choose, without warning, to start sending credit.ordered webhooks when Credit Reports are ordered for property owners too. Do not assume the user_id refers only to an Applicant.

{
  "event": "credit.ordered",
  "demo_mode": false,
  "data": {
    "user_id": 1
  }
}

background.requested

Sent when it is time for the Integrator to fulfill the background check. Once the background is complete the Integrator should post the results back into CreditConnect using the Background Results API.

{
  "event": "background.requested",
  "demo_mode": false,
  "data": {
    "user_id": 1
  }
}

report.shared

Sent when the Applicant shares their report. The same webhook is sent when the report is shared for the first time, or shared again after being revoked.

applicant_id is the User ID of the Applicant that is sharing their report. po_id is the User ID of the Property Owner that the report is being shared with.

{
  "event": "report.shared",
  "demo_mode": false,
  "data": {
    "applicant_id": 1,
    "po_id": 2
  }
}