Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
Smile endpoints
| Method | Endpoint | Description |
|---|---|---|
| Accounts | ||
| GET |
list-accounts /accounts |
Get a list of user accounts. |
| DELETE |
delete-account /accounts/{id} |
Delete a user's particular account information including the related data. |
| GET |
get-account /accounts/{id} |
Get a user's particular account information. |
| Archives | ||
| GET |
get-archive /archives/{id} |
Get a user's archive by ID. |
| GET |
list-archives /archives |
Get the user's archives. |
| Contributions | ||
| GET |
list-contributions /contributions |
Get the user's social security contributions from employment data sources. |
| GET |
get-contribution /contributions/{id} |
Get the user's contribution by ID. |
| Documents | ||
| GET |
get-document /documents/{id} |
Get a user's document by ID. |
| GET |
list-documents /documents |
Get the user's documents from employment data sources. |
| Employments | ||
| GET |
list-employments /employments |
Get the user's previous employments. |
| GET |
get-employment /employments/{id} |
Get a user's employment by ID. |
| File Types | ||
| GET |
list-file-types /fileTypes |
Get the available file types for uploads. |
| Identities | ||
| GET |
get-identity /identities/{id} |
Get the user's identity profile by ID. |
| GET |
list-identities /identities |
Get a user's identity profiles from employment data sources. |
| Incomes | ||
| GET |
list-incomes /incomes |
Get the user's incomes from employment data sources. |
| GET |
get-income /incomes/{id} |
Get the user's income by ID. |
| Invite Templates | ||
| GET |
get-invite-template /inviteTemplates/{id} |
Get invite template. |
| PUT |
update-invite-template /inviteTemplates/{id} |
Update invite template. |
| DELETE |
delete-invite-template /inviteTemplates/{id} |
Delete invite template. |
| GET |
list-invite-templates /inviteTemplates |
Get the list of invite templates. |
| POST |
create-invite-template /inviteTemplates |
Create an invite template. |
| Invites | ||
| POST |
create-invite /invites |
Create and send an invite to a user |
| GET |
get-invite /invites/{id} |
Get invite sent to users by ID. |
| GET |
list-invites /invites |
Get the list of invites sent out to users. |
| Providers | ||
| GET |
get-provider /providers/{id} |
Get a data provider from the Smile Network. |
| GET |
list-providers /providers |
Get a list of employment data providers from the Smile Network. |
| Ratings | ||
| GET |
get-rating /ratings/{id} |
Get a user's ratings by ID. |
| GET |
list-ratings /ratings |
Get the user's ratings from employment data sources. |
| Tokens | ||
| POST |
create-token /tokens |
Refresh a token for a user |
| Transactions | ||
| GET |
list-transactions /transactions |
Get the user's transactions from employment data sources. |
| GET |
get-transaction /transactions/{id} |
Get a user's transaction by ID. |
| Uploads | ||
| GET |
get-upload /uploads/{id} |
Get a user's upload by ID (deprecated). |
| GET |
list-uploads /uploads |
Get the user's uploads (deprecated). |
| Users | ||
| GET |
list-users /users |
List users from the Smile Network. |
| POST |
create-user /users |
Create a user in the Smile Network. |
| GET |
get-user /users/{id} |
Get a particular user profile. |
| Webhooks | ||
| GET |
list-webhooks /webhooks |
List all webhook endpoints. |
| DELETE |
delete-webhook /webhooks/{id} |
Delete a webhook endpoint. |
| POST |
create-webhook /webhooks |
Create a webhook endpoint. |
| GET |
get-webhook /webhooks/{id} |
Get a webhook endpoint. |
| Other endpoints | ||
| GET |
list-invite-templates /inviteTemplates |
Get the list of invite templates. |
| GET |
list-archives /archives |
Get the user's archives. |
| GET |
get-document /documents/{id} |
Get a user's document by ID. |
| GET |
list-identities /identities |
Get a user's identity profiles from employment data sources. |
| DELETE |
delete-webhook /webhooks/{id} |
Delete a webhook endpoint. |
| GET |
get-user /users/{id} |
Get a particular user profile. |
| GET |
get-identity /identities/{id} |
Get the user's identity profile by ID. |
| POST |
create-user /users |
Create a user in the Smile Network. |
| GET |
get-account /accounts/{id} |
Get a user's particular account information. |
| POST |
create-token /tokens |
Refresh a token for a user |
Smile pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|