SPspinwheel
Connect

Connect a User - User Profile

Changed on

Connect a User that has already been verified using another credit bureau. This API requires Spinwheel Support approval to enable it before it can be used.

post/v1/users/connect/preverified/userProfile

Request

  • Base URL
    https://sandbox-api.spinwheel.io
  • URL
    https://sandbox-api.spinwheel.io/v1/users/connect/preverified/userProfile
  • Auth
    • API key in header Authorization
    • or API key in header Authorization

Request body

firstNamestring required

The first name of the user.

lastNamestring required

The last name of the user.

phoneNumberstring required

The phone number in E.164 format.

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",
  "phoneNumber": "+14155552671",
  "dateOfBirth": "2000-01-01",
  "ssn": "999999999",
  "addresses": [
    {
      "addressLine1": "123 Main St",
      "addressLine2": "Unit: 234",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94103"
    }
  ],
  "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",
    "verificationDate": "2023-01-15",
    "identityVerifiedTimestamp": "2025-03-15T14:30:00Z",
    "userConsentDate": "2023-01-15",
    "verificationType": "EXPERIAN.PRECISE_ID_KNOWLEDGE_IQ"
  }
}

Response

Success

Example response

{
  "status": {
    "code": 200,
    "desc": "success",
    "messages": [
      {
        "desc": "Example description"
      }
    ]
  },
  "data": {
    "userId": "9226245b-4a4c-48e2-a8cb-9a0e114ed4af",
    "extUserId": "e3119f3a-ac24-4fa8-839b-c9db75848453",
    "connectionId": "e3119f3a-ac24-4fa8-839b-c9db75848453",
    "connectionStatus": "IN_PROGRESS",
    "profile": {
      "addresses": [
        {
          "addressLine1": "123 Main Street",
          "addressLine2": "Unit 208",
          "city": "San Francisco",
          "state": "CA",
          "zip": "90211",
          "zipExtension": "1234"
        }
      ]
    }
  }
}

Changes

  • aa032469622fRevision changes
    • breaking

      the response property ////// became optional for the status

    • breaking

      the response property ////// became optional for the status

    • warning

      added the new FAILED enum value to the / response property for the response status

    • warning

      added the new IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new SUCCESS enum value to the / response property for the response status

    • info

      added the non-success response with the status