Connect

Connect a User via Network Token

Changed on

Create user from Spinwheel network token.

post/v1/users/connect/network

Request

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

Request body

extUserIdstring required

A unique external ID for the user

networkTokenstring required

Network token

ssnLastFourDigitsstring required
dateOfBirthstring required

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

includestring[]

Array of additional data abilities to include. Supported values: CREDIT_REPORT. When CREDIT_REPORT is present, credit report and liability data are included with the user information.

Example request

{
  "extUserId": "1166d9a1-5718-4443-a677-cc40627c5575",
  "ssnLastFourDigits": "9999",
  "dateOfBirth": "2000-01-01",
  "audit": {
    "consentTimestamp": "2025-03-15T14:30:00Z",
    "tosVersion": "v1.1",
    "tosLanguage": "en",
    "consentType": "WRITTEN",
    "userConsentDate": "2000-01-01"
  },
  "include": [
    "CREDIT_REPORT"
  ]
}

Response

Success

Changes

    • warning

      changed the pattern of the request property ///// from /^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$/ to ^\d{4}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$

    • warning

      changed the pattern of the request property from /^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$/ to ^\d{4}-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status