v1

latestOpenAPI 3.0.02026-07-2459256884.4 KB

Connect

Connect a User via Network Token

Create user from Spinwheel network token.

post/v1/users/connect/network

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 capabilities to include in the response. When absent, the endpoint behaves exactly as it does today.

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

Example response

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