Sender · Sender – Type B

Pre-check API

Check whether to proceed with a full Type B lead submission using a lightweight request containing the applicant's name, address, and email. This check is primarily intended to identify duplicate leads before the full payload is sent.

Step-by-step instructions

  1. Obtain the referral code and test credentials from Konduit.
  2. Confirm the pre-check specification and test and production base URLs with Konduit.
  3. Submit the applicant's first name, last name, address, and email for the pre-check.
  4. Proceed with the full Type B API flow only when the pre-check decision is ACCEPT.

Request API

Example API Header
MethodPOST
URL – Testhttps://<QA-BASE-URL>/precheck
URL – Prodhttps://<PROD-BASE-URL>/precheck

Headers - Test

Headers
Accept: application/json
Authorization: To be issued by Konduit
Channel: API
Content-Type: application/json; charset=utf-8
Institution-Id: LGR
Partner-Id: xxxxxxx

Partner-Id: Please use the referral code issued by Konduit.

Headers - Prod

Headers
Accept: application/json
Authorization: To be issued by Konduit
Channel: API
Content-Type: application/json; charset=utf-8
Institution-Id: LGR
Partner-Id: xxxxxxx

Partner-Id: Please use the referral code issued by Konduit.

Example API Request body
Body
{
  "firstName": "Clark",
  "lastName": "Kent",
  "address": {
    "streetAddress": "5416 Brewer Rd",
    "zipCode": "35071",
    "city": "Gardendale",
    "state": "AL"
  },
  "email": "ckent@konduitworks.com"
}

Body Parameters

firstNamestring

The applicant's first name.

lastNamestring

The applicant's last name.

addressobject4 fields

The applicant's residential address.

streetAddressstring

The street address, including the house or building number.

zipCodestring

The ZIP code for the applicant's address.

citystring

The city where the applicant lives.

statestring

The two-letter state abbreviation for the applicant's address, such as AL.

emailstring

The applicant's email address, used as part of the duplicate check.

Response API

Proceed with the full lead submission when the decision is ACCEPT. Do not submit the full lead after REJECT. Correct the request before retrying a BAD_REQUEST response.

Example API response for accepted leads
Response
{
  "decision": "ACCEPT",
  "message": "Lead can be submitted."
}
Example API response for duplicate leads (not accepted)
Response
{
  "decision": "REJECT",
  "message": "Duplicate lead."
}
Example API response for a bad request
Response
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "email is required"
  }
}