Accessing Unmasked Data

Here are the steps on using our secure endpoint to retrieve user SSNs or Account Numbers depending on your approved use case. In general, you can follow the documentation for the Connect a Preverified User, Order a Debt Profile endpoint or the Retrieve a User endpoint, with a couple exceptions. Rather than the usual base URL, instead fetch securely using:

https://secure-api.spinwheel.io or https://secure-sandbox-api.spinwheel.io

For optimized performance and response times, we suggest utilizing the unmask request on the Connect a Pre-Verified User or Order a Debt Profile endpoint, where you will reduce the number of calls and receive the data in the least latent response time. If your use case dictates that you will not know if you need the additional data until a later point, you can utilize the Retrieve a User endpoint.

🚧

Please note: The base URL for accessing normal flows that don't require the return of unmasked data or the submission of sensitive information should be https://api.spinwheel.io/. Any flow that requires the unmasked data or has sensitive data submitted via the API should use the base URL of https://secure-api.spinwheel.io/.

Use the unmask query parameter to retrieve the plain text for a respective field (ssn or accountNumber) For example:

Connect a Pre-Verified User via Phone Number

Sandbox: https://secure-sandbox-api.spinwheel.io/v1/users/connect/preverified/phoneNumber?unmask=ssn
Prod: https://secure-api.spinwheel.io/v1/users/connect/preverified/phoneNumber?unmask=ssn

Order a Debt Profile

Sandbox: https://secure-sandbox-api.spinwheel.io/v1/users/{userId}/debtProfile?unmask=ssn&unmask=accountNumber
Prod: https://secure-api.spinwheel.io/v1/users/{userId}/debtProfile?unmask=ssn&unmask=accountNumber

Retrieve a User Endpoint

Sandbox: https://secure-sandbox-api.spinwheel.io/v1/users?userId=xyz&unmask=ssn&unmask=accountNumber
Prod: https://secure-api.spinwheel.io/v1/users?userId=xyz&unmask=ssn&unmask=accountNumber

The response body will match the get-user-profile response linked above, but with the additional information at:
data.creditReports.0.profile.ssnFull

data.creditCards.[].cardProfile.accountNumber
data.autoLoans.[].accountNumber
data.homeLoans.[].accountNumber
data.personalLoans.[].accountNumber
data.studentLoans.[].accountNumber
data.miscellaneousLiabilities.[].accountNumber

In the case that you are only connecting user profile information, and not the user's Debt Profile, the unmasked ssn would also be available at the following path...

data.profile.ssn

Please note there are liabilities specific to a few creditors which will not provide full account numbers. This is to be expected based on the data available directly from the credit bureau.