API Guide

Introduction
Getting Started
Getting User Data
Event Notifications
Additional Resources

Smile API

About our API
Understanding the API

Smile Network

Providers
- List Providersget
- Get Providerget
Users
Tokens
- Refresh Tokenpost
Consent Templates
Webhooks
Tasks
- List Tasksget
- Get Taskget

Smile Wink

Invitations
- Invites
- Invite Templates
Accounts
Multiple Application Warning Service
- List linksget
- Get Linkget

Smile Snap

Intelligent Document Processing
- Archives
- File Types
  - List File Typesget
Records
Verification

User Data

Identities
- List Identitiesget
- Get Identityget
Ratings
- List Ratingsget
- Get Ratingget
Documents
- List Documentsget
- Get Documentget
Employments
- List Employmentsget
- Get Employmentget
Incomes
- List Incomesget
- Get Incomeget
Contributions
- List Contributionsget
- Get Contributionget
Liabilities
- List Liabilitiesget
- Get Liabilityget
Transactions
- List Transactionsget
- Get Transactionget

User Insights

Estimated Incomes
- List Estimated Incomes (early access)get
- Get Estimated Incomeget
Insights
- List insightsget
- Get Insightget

API Guide

Introduction
Getting Started
Getting User Data
Event Notifications
Additional Resources

Smile API

About our API
Understanding the API

Smile Network

Providers
- List Providersget
- Get Providerget
Users
Tokens
- Refresh Tokenpost
Consent Templates
Webhooks
Tasks
- List Tasksget
- Get Taskget

Smile Wink

Invitations
- Invites
- Invite Templates
Accounts
Multiple Application Warning Service
- List linksget
- Get Linkget

Smile Snap

Intelligent Document Processing
- Archives
- File Types
  - List File Typesget
Records
Verification

User Data

Identities
- List Identitiesget
- Get Identityget
Ratings
- List Ratingsget
- Get Ratingget
Documents
- List Documentsget
- Get Documentget
Employments
- List Employmentsget
- Get Employmentget
Incomes
- List Incomesget
- Get Incomeget
Contributions
- List Contributionsget
- Get Contributionget
Liabilities
- List Liabilitiesget
- Get Liabilityget
Transactions
- List Transactionsget
- Get Transactionget

User Insights

Estimated Incomes
- List Estimated Incomes (early access)get
- Get Estimated Incomeget
Insights
- List insightsget
- Get Insightget

Get User

get https://sandbox.smileapi.io/v1/users/{id}

Get a particular user profile.

URL Expired

The URL for this request expired after 30 days.

Path Params

string

required

length between 1 and 200

ID of the specific object in the collection.

Responses

Response body

object

code

string

Request status code

OK CREATED INVALID_CREDENTIALS INVALID_PARAMETERS INVALID_TOKEN UNAUTHORIZED_ACCESS MISSING_RESOURCE REQUEST_LIMIT_EXCEEDED SERVER_ERROR UNSUPPORTED_METHOD SERVER_UNAVAILABLE TIME_LIMIT_EXCEEDED

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

A user is someone who is authorizing Smile to retrieve and share their employment and income data on their behalf.

string

required

Unique ID of this object

externalMetadata

object

required

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:

The JSON values must be Strings (no nested JSON objects allowed)
Only ASCII characters can be used
Maximum of 5 key/value pairs
Maximum key length of 50 characters
Maximum value length of 500 characters

Has additional fields

createdAt

date-time

required

Date and time

providers

array of strings

required

Array of providers connected to this user (listed by provider ID)

providers*

Response body

object

code

string

Request status code

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

Has additional fields

Response body

object

code

string

Request status code

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

Has additional fields

Response body

object

code

string

Request status code

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

Has additional fields

Response body

object

code

string

Request status code

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

Has additional fields

Response body

object

code

string

Request status code

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

Has additional fields

Response body

object

code

string

Request status code

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

Has additional fields

Response body

object

code

string

Request status code

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

Has additional fields

Response body

object

code

string

Request status code

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

Has additional fields

Response body

object

code

string

Request status code

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

Has additional fields

Response body

object

code

string

Request status code

message

string

Message response to the request

requestId

string

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

data

object

Has additional fields

Updated over 1 year ago

Create User

Tokens

Did this page help you?

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox.smileapi.io/v1/users/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Create User

Tokens

Did this page help you?

API Guide
Introduction
Getting Started
Getting User Data
Event Notifications
Additional Resources

Smile API
About our API
Understanding the API

Smile Network
Providers
Get Providerget
List Providersget
Users
Get Userget
Create Userpost
List Usersget
Tokens
Refresh Tokenpost
Consent Templates
Delete Consent Templatedelete
List Consent Templatesget
Create Consent Templatepost
Webhooks
Delete Webhookdelete
Get Webhookget
Create Webhookpost
List Webhooksget
Tasks
Get Taskget
List Tasksget

Smile Wink
Invitations
Invite Templates
Delete Invite Templatedelete
Update Invite Templateput
Get Invite Templateget
Create Invite Templatepost
List Invite Templatesget
Invites
List Invite Logsget
Get Inviteget
Create Invitepost
List Invitesget
Accounts
Disable Monitorpost
Generate account exportpost
Get Account Payloadget
Revoke Accountdelete
Get Accountget
List Accountsget
Multiple Application Warning Service
Get Linkget
List linksget

Smile Snap
Intelligent Document Processing
File Types
List File Typesget
Archives
Classify Archivepost
Get Archiveget
Create Archivepost
List Archivesget
Records
Blacklists (Alpha)
Get Blacklistget
List Blacklistsget
Create Blacklistpost
Maws (Alpha)
Get Mawget
List Mawsget
Create Mawpost
Footprints (Alpha)
Get Footprintget
List Footprintsget
Create Footprintpost
Signals(Beta)
Get Signalget
List Signalsget
Create Signalpost
Signals(Alpha)
Get Signalget
List Signalsget
Create Signalpost
Verification
Get Verificationget
Request Verificationpost
List Verificationsget

User Data
Identities
Get Identityget
List Identitiesget
Ratings
Get Ratingget
List Ratingsget
Documents
Get Documentget
List Documentsget
Employments
Get Employmentget
List Employmentsget
Incomes
Get Incomeget
List Incomesget
Contributions
Get Contributionget
List Contributionsget
Liabilities
Get Liabilityget
List Liabilitiesget
Transactions
Get Transactionget
List Transactionsget

User Insights
Estimated Incomes
Get Estimated Incomeget
List Estimated Incomes (early access)get
Insights
Get Insightget
List insightsget

API Guide
Introduction
Getting Started
Getting User Data
Event Notifications
Additional Resources

Smile API
About our API
Understanding the API

Smile Network
Providers
Get Providerget
List Providersget
Users
Get Userget
Create Userpost
List Usersget
Tokens
Refresh Tokenpost
Consent Templates
Delete Consent Templatedelete
List Consent Templatesget
Create Consent Templatepost
Webhooks
Delete Webhookdelete
Get Webhookget
Create Webhookpost
List Webhooksget
Tasks
Get Taskget
List Tasksget

Smile Wink
Invitations
Invite Templates
Delete Invite Templatedelete
Update Invite Templateput
Get Invite Templateget
Create Invite Templatepost
List Invite Templatesget
Invites
List Invite Logsget
Get Inviteget
Create Invitepost
List Invitesget
Accounts
Disable Monitorpost
Generate account exportpost
Get Account Payloadget
Revoke Accountdelete
Get Accountget
List Accountsget
Multiple Application Warning Service
Get Linkget
List linksget

Smile Snap
Intelligent Document Processing
File Types
List File Typesget
Archives
Classify Archivepost
Get Archiveget
Create Archivepost
List Archivesget
Records
Blacklists (Alpha)
Get Blacklistget
List Blacklistsget
Create Blacklistpost
Maws (Alpha)
Get Mawget
List Mawsget
Create Mawpost
Footprints (Alpha)
Get Footprintget
List Footprintsget
Create Footprintpost
Signals(Beta)
Get Signalget
List Signalsget
Create Signalpost
Signals(Alpha)
Get Signalget
List Signalsget
Create Signalpost
Verification
Get Verificationget
Request Verificationpost
List Verificationsget

User Data
Identities
Get Identityget
List Identitiesget
Ratings
Get Ratingget
List Ratingsget
Documents
Get Documentget
List Documentsget
Employments
Get Employmentget
List Employmentsget
Incomes
Get Incomeget
List Incomesget
Contributions
Get Contributionget
List Contributionsget
Liabilities
Get Liabilityget
List Liabilitiesget
Transactions
Get Transactionget
List Transactionsget

User Insights
Estimated Incomes
Get Estimated Incomeget
List Estimated Incomes (early access)get
Insights
Get Insightget
List insightsget

200OK

400Standard error response

401Standard error response

403Standard error response

404Standard error response

415Standard error response

429Standard error response

500Standard error response

501Standard error response

503Standard error response

504Standard error response