Sign in

v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB
Connect

Connect a User via KBA

Connect a User using a set of personal questions provided by a credit bureau.

post/v1/users/connect/kba

Request body

firstNamestring required

The user's first name.

lastNamestring required

The user's last name.

dateOfBirthstring required

The date of birth. Formatted as YYYY-MM-DD.

ssnstring required

The user's ssn (without hyphens)

userIdstring required

An existing userId to connect with. One of extUserId or userId is required.

extUserIdstring required

A unique external ID for the user. One of extUserId or userId is required.

Example request

{
  "firstName": "Christy",
  "lastName": "Jenoval",
  "dateOfBirth": "2000-01-01",
  "ssn": "999999999",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Unit 208",
    "city": "San Francisco",
    "state": "CA",
    "zip": "90211",
    "zipExtension": "1234"
  },
  "userId": "7519c55d-68aa-4b21-b580-d70d4fb4f2ab",
  "extUserId": "1166d9a1-5718-4443-a677-cc40627c5575",
  "audit": {
    "consentTimestamp": "2025-03-15T14:30:00Z",
    "tosVersion": "v1.1",
    "tosLanguage": "en",
    "consentType": "WRITTEN"
  }
}

Response

Success

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "userId": "9226245b-4a4c-48e2-a8cb-9a0e114ed4af",
    "extUserId": "e04a4733-f134-458b-a579-4f91672b2e2c",
    "connectionId": "e3119f3a-ac24-4fa8-839b-c9db75848453",
    "connectionStatus": "IN_PROGRESS"
  }
}