API Reference
API Keys

Connect a User via Network Token

post
https://sandbox-api.spinwheel.io/v1/users/connect/network

Create user from Spinwheel network token.

When utilizing the include parameter, you will return a dataStatus.statusCode - below is the breakdown:

CodestatusMeaningAPI response example
2000SUCCESSResponse includes creditReports, liabilities, and summaries.Success with credit report
4040ERRORUser is successfully connected, however no credit report was found for the user.Credit report not found
4030ERRORUser is successfully connected, however no credit report data was returned. Contact your Spinwheel Representative for Client Configuration.Credit bureau not configured
5000ERRORUser is successfully connected, however the credit report failed to return.Credit report failed

Body Params
string
required

A unique external ID for the user

string
required

Network token

string
required
length between 4 and 4
string
required
/^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|3[01])$/

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

audit
object
required

Verification and consent audit trail. Documents the client's identity verification of the user and the user's consent to the Spinwheel End User Agreement.

include
array of strings

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.

include
Responses

Updated 6 days ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago

Did this page help you?