id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
api_score
float64
0
10
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/fe0b22cf-d86a-4518-8d82-40a5ee266f60/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-rating
Get a user's ratings by ID.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "upwork", "name": "Upwork", "longName": "Upwork Global Inc.", "logoUrl": "https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png", "type": "GIG", "typeLabel": "Gig Platform", "subType": "SERVICES", "subTypeLabel": "Professional Services", "active": true, "enabled": true, "mfa": true, "accountConnection": true, "supported": ["IDENTITIES", "TRANSACTIONS"]}}
{"title": "Provider Get Response", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"title": "Provider", "type": "object", "description": "An employment data provider. A provider holds employment and income information of the user.", "x-tags": ["Providers"], "x-examples": {"Example": {"id": "upwork", "name": "Upwork", "longName": "Upwork Global Inc.", "logoUrl": "https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png", "type": "GIG", "typeLabel": "Gig Platform", "subType": "SERVICES", "subTypeLabel": "Professional Services", "active": true, "enabled": true, "mfa": true, "accountConnection": true, "supported": ["IDENTITIES", "TRANSACTIONS"]}}, "properties": {"id": {"type": "string", "description": "Unique ID of the data provider"}, "name": {"type": "string", "description": "Name of the data provider"}, "longName": {"type": "string", "description": "Full name or legal name of the data provider"}, "logoUrl": {"type": "string", "description": "URL to the data provider's logo"}, "type": {"type": "string", "enum": ["GIG", "GOVERNMENT", "SYSTEM", "EMPLOYER"], "description": "Type of employment data provider"}, "typeLabel": {"type": "string", "description": "Type label of employment data provider, like \"Gig Platform\"", "enum": ["Gig Platform", "Govt Service", "System", "Employer"]}, "subType": {"type": "string", "description": "Subset of Type of employment data provider", "enum": ["SERVICES", "TRANSPORTATION", "SHARING", "TRADING", "INSURANCE", "HRIS", "PAYROLL", "ISIC-A", "ISIC-B", "ISIC-C", "ISIC-D", "ISIC-E", "ISIC-F", "ISIC-G", "ISIC-H", "ISIC-I", "ISIC-J", "ISIC-K", "ISIC-L", "ISIC-M", "ISIC-N", "ISIC-O", "ISIC-P", "ISIC-Q", "ISIC-R", "ISIC-S", "ISIC-T", "ISIC-U"]}, "subTypeLabel": {"type": "string", "description": "Subtype label of employment data provider, like \"Services\"", "enum": ["Professional Services", "Transport and Delivery", "Asset Sharing", "Online Selling", "Social Insurance", "Payroll System", "Human Resource Information System", "Agriculture, forestry and fishing", "Mining and quarrying", "Manufacturing", "Electricity, gas, steam and air conditioning supply", "Water supply; sewerage, waste management and remediation activities", "Construction", "Wholesale and retail trade; repair of motor vehicles and motorcycles", "Transportation and storage", "Accommodation and food service activities", "Information and communication", "Financial and insurance activities", "Real estate activities", "Professional, scientific and technical activities", "Administrative and support service activities", "Public administration and defense; compulsory social security", "Education", "Human health and social work activities", "Arts, entertainment and recreation", "Other service activities", "Activities of households as employers; undifferentiated goods; and services-producing activities of households for own use", "Activities of extraterritorial organization and bodies"]}, "active": {"type": "boolean", "description": "Indicates whether data provider integration is working"}, "enabled": {"type": "boolean", "description": "Indicates whether data provider is enabled or access is allowed for the client"}, "mfa": {"type": "boolean", "description": "Whether data provider requires multi-factor authentication."}, "accountConnection": {"type": "boolean", "description": "Whether a real-time account connection is available for this data provider", "default": true}, "supported": {"type": "array", "description": "Supported data points for this employment data provider", "items": {"type": "string", "enum": ["IDENTITIES", "TRANSACTIONS", "RATINGS", "EMPLOYMENTS", "DOCUMENTS", "INCOMES", "CONTRIBUTIONS"]}}}, "required": ["id", "name", "longName", "logoUrl", "type", "typeLabel", "subType", "subTypeLabel", "active", "enabled", "mfa", "accountConnection", "supported"]}}, "x-internal": true, "x-examples": {}, "description": ""}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/19535eb4-a9b6-45eb-8075-f5c07c89efad/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-provider
Get a data provider from the Smile Network.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/0e52dfd0-e1f1-4408-98a6-1b0875d5cc07/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-user
Create a user in the Smile Network.
201
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"user": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "externalMetadata": {}, "createdAt": "2021-04-14T09:30:24Z", "providers": ["upwork"]}, "token": {"expiresAt": "2021-04-14T09:30:24Z", "mode": "SANDBOX", "accessToken": ""}}}
{"title": "User Post Response", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object", "properties": {"user": {"title": "User", "type": "object", "description": "A user is someone who is authorizing Smile to retrieve and share their employment and income data on their behalf.", "x-tags": ["Users"], "x-examples": {"Example": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "externalMetadata": {"property1": "string", "property2": "string"}, "createdAt": "2021-04-14T09:30:24Z", "providers": ["upwork"]}}, "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "externalMetadata": {"title": "Object-ExternalMetadata", "type": "object", "additionalProperties": {"type": "string"}, "maxProperties": 5, "description": "The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:\n- The JSON values must be Strings (no nested JSON objects allowed)\n- Only ASCII characters can be used\n- Maximum of 5 key/value pairs\n- Maximum key length of 50 characters\n- Maximum value length of 500 characters", "x-internal": true}, "createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "providers": {"description": "Array of providers connected to this user (listed by provider ID)", "type": "array", "items": {"type": "string"}}}, "required": ["id", "externalMetadata", "createdAt", "providers"]}, "token": {"title": "Token", "type": "object", "x-tags": ["Tokens"], "description": "A method for securely transmitting information between Smile and the user.", "x-examples": {"Example": {"expiresAt": "2021-04-14T09:30:24Z", "mode": "SANDBOX", "accessToken": "string"}}, "properties": {"expiresAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "mode": {"type": "string", "enum": ["SANDBOX", "PRODUCTION"], "description": "Valid Smile mode for the Token"}, "accessToken": {"type": "string", "description": "Short-lived token to initiate link flow"}}, "required": ["expiresAt", "mode", "accessToken"]}}, "required": ["user", "token"]}}, "x-internal": true, "x-examples": {}}
fecd2438-8469-4d33-b9d2-911466bfae16/0e52dfd0-e1f1-4408-98a6-1b0875d5cc07/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-user
Create a user in the Smile Network.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/0e52dfd0-e1f1-4408-98a6-1b0875d5cc07/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-user
Create a user in the Smile Network.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/0e52dfd0-e1f1-4408-98a6-1b0875d5cc07/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-user
Create a user in the Smile Network.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/0e52dfd0-e1f1-4408-98a6-1b0875d5cc07/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-user
Create a user in the Smile Network.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/0e52dfd0-e1f1-4408-98a6-1b0875d5cc07/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-user
Create a user in the Smile Network.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/0e52dfd0-e1f1-4408-98a6-1b0875d5cc07/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-user
Create a user in the Smile Network.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/0e52dfd0-e1f1-4408-98a6-1b0875d5cc07/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-user
Create a user in the Smile Network.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/0e52dfd0-e1f1-4408-98a6-1b0875d5cc07/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-user
Create a user in the Smile Network.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/0e52dfd0-e1f1-4408-98a6-1b0875d5cc07/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-user
Create a user in the Smile Network.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"nextCursor": "1259723474", "items": [{"id": "tenant-17bbf36498de4d68a0d4f86c7b62f69f", "externalMetadata": {"property1": "string", "property2": "string"}, "createdAt": "2021-04-14T09:30:24Z", "providers": ["upwork"]}, {"id": "tenant-17bbf36498de4d68a0d4f86c7b62f69f", "externalMetadata": {"property1": "string", "property2": "string"}, "createdAt": "2021-04-14T09:30:24Z", "providers": ["freelancer"]}, {"id": "tenant-17bbf36498de4d68a0d4f86c7b62f69f", "externalMetadata": {"property1": "string", "property2": "string"}, "createdAt": "2021-04-14T09:30:24Z", "providers": ["grab"]}, {"id": "tenant-17bbf36498de4d68a0d4f86c7b62f69f", "externalMetadata": {"key1": "value", "key2": "value"}, "createdAt": "2021-04-14T09:30:24Z", "providers": ["upwork", "freelancer", "grab"]}]}}
{"title": "User List Response", "type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object", "properties": {"nextCursor": {"title": "Object-Next-Cursor", "type": "string", "description": "The next cursor value that can be used in the following query.", "x-internal": false}, "items": {"type": "array", "items": {"title": "User", "type": "object", "description": "A user is someone who is authorizing Smile to retrieve and share their employment and income data on their behalf.", "x-tags": ["Users"], "x-examples": {"Example": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "externalMetadata": {"property1": "string", "property2": "string"}, "createdAt": "2021-04-14T09:30:24Z", "providers": ["upwork"]}}, "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "externalMetadata": {"title": "Object-ExternalMetadata", "type": "object", "additionalProperties": {"type": "string"}, "maxProperties": 5, "description": "The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply:\n- The JSON values must be Strings (no nested JSON objects allowed)\n- Only ASCII characters can be used\n- Maximum of 5 key/value pairs\n- Maximum key length of 50 characters\n- Maximum value length of 500 characters", "x-internal": true}, "createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "providers": {"description": "Array of providers connected to this user (listed by provider ID)", "type": "array", "items": {"type": "string"}}}, "required": ["id", "externalMetadata", "createdAt", "providers"]}}}}}, "x-internal": true, "x-examples": {}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/bfa74475-4983-4288-a950-f2ea3d5d1dc3/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-users
List users from the Smile Network.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "name": "Email Template v1", "company": {"name": "XYZ Bank", "logoUrl": "https://xyzbank.co/logo.png"}, "email": {"sendEmail": true, "senderName": "XYZ Bank", "replyAddress": "[email protected]", "subject": "Please connect your work account to share your data with us", "body": "Hello ${firstName}! We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time."}, "landingPage": {"header": "Share your employment and income data with us at ${companyName}", "description": "We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.", "button": "START NOW"}, "successPage": {"header": "Thank you for sharing your employment and income data with us at ${companyName}", "description": "The process was successful! Please wait for us to get in touch!", "button": "Connect another account"}}}
{"title": "InviteTemplateGetResponse", "type": "object", "x-internal": true, "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"title": "InviteTemplate", "x-tags": ["Invite Templates"], "type": "object", "description": "Template to be used for sending invites.", "x-examples": {"Example": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "name": "Email Template v1", "company": {"name": "XYZ Bank", "logoUrl": "https://xyzbank.co/logo.png"}, "email": {"sendEmail": true, "senderName": "XYZ Bank", "replyAddress": "[email protected]", "subject": "Please connect your work account to share your data with us", "body": "Hello ${firstName}! We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for providing you service. It will be a quick process and should take no more than a few seconds of your time."}, "landingPage": {"header": "Share your employment and income data with us at ${companyName}", "description": "We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for providing you service. It will be a quick process and should take no more than a few seconds of your time.", "button": "START NOW"}, "successPage": {"header": "Thank you for sharing your employment and income data with us at ${companyName}", "description": "The process was successful! Please wait for us to get in touch!", "button": "Connect another account"}}}, "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "name": {"type": "string", "description": "Template name"}, "company": {"type": "object", "required": ["name", "logoUrl"], "properties": {"name": {"type": "string", "description": "Company name that it will appear in the invite landing page and any invitation message"}, "logoUrl": {"type": "string", "description": "Company logo that will appear in the invite email and landing page"}}}, "email": {"type": "object", "required": ["sendEmail", "senderName", "replyAddress", "subject", "body"], "properties": {"sendEmail": {"type": "boolean", "description": "Send email using this template (boolean value: true/false)"}, "senderName": {"type": "string", "description": "Sender name that it will appear in the email message"}, "replyAddress": {"type": "string", "description": "Reply-to address that will be shown when replying to an invite email", "format": "email"}, "subject": {"type": "string", "description": "Subject that it will appear in the email message"}, "body": {"type": "string", "description": "Text that it will appear in email message"}}}, "landingPage": {"type": "object", "required": ["header", "description", "button"], "properties": {"header": {"type": "string", "description": "Header text that will appear in the landing page"}, "description": {"type": "string", "description": "Description of the landing page"}, "button": {"type": "string", "description": "Text that it will appear in the landing page"}}}, "successPage": {"type": "object", "required": ["header", "description", "button"], "properties": {"header": {"type": "string", "description": "Header text that will appear in the success page"}, "description": {"type": "string", "description": "Description of the success page after an account has been linked or data has been uploaded"}, "button": {"type": "string", "description": "Text that it will appear in the landing page"}}}}, "required": ["id", "name", "company", "email", "landingPage", "successPage"]}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/43a4cba2-1783-44dd-9535-62d34307b27d/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-invite-template
Get invite template.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"nextCursor": "1259723474", "items": [{"id": "17bbf36498de4d68a0d4f86c7b62f69f", "date": "2021-04-30", "currency": "PHP", "amount": 1375, "referenceId": "PA9634415", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "sss-ph"}}]}}
{"title": "Contribution List Response", "x-stoplight": {"id": "xqq606vnqa1nk"}, "type": "object", "x-internal": true, "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object", "properties": {"nextCursor": {"title": "Object-Next-Cursor", "type": "string", "description": "The next cursor value that can be used in the following query.", "x-internal": false}, "items": {"type": "array", "items": {"title": "Contribution", "x-stoplight": {"id": "ymth27j2l09a4"}, "type": "object", "description": "The social security insurance contribution made by, or in behalf, of a user as recorded by the employment data provider.", "x-examples": {"Example": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "date": "2021-04-30", "currency": "PHP", "amount": 1375, "referenceId": "PA9634415", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "sss-ph"}}}, "x-tags": ["Contributions"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "date": {"type": "string", "format": "date", "description": "Date of the contribution"}, "currency": {"type": "string", "title": "Currency ISO Codes", "description": "Currency in 3 character alpha ISO 4217", "enum": ["AFN", "DZD", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "THB", "PAB", "BBD", "BYN", "BZD", "BMD", "VES", "BOB", "BRL", "BND", "BGN", "BIF", "CAD", "CVE", "KYD", "GHS", "XOF", "XAF", "XPF", "CLP", "COP", "KMF", "CDF", "BAM", "NIO", "CRC", "HRK", "CZK", "GMD", "DKK", "MKD", "DJF", "STD", "DOP", "VND", "XCD", "EGP", "SVC", "ETB", "EUR", "FKP", "FJD", "HUF", "GIP", "HTG", "PYG", "GNF", "GYD", "HKD", "UAH", "ISK", "INR", "IRR", "IQD", "JMD", "JOD", "KES", "PGK", "LAK", "EEK", "KWD", "MWK", "AOA", "MMK", "GEL", "LVL", "LBP", "ALL", "HNL", "SLL", "LRD", "LYD", "SZL", "LTL", "LSL", "MGA", "MYR", "TMT", "MUR", "MZN", "MXN", "MDL", "MAD", "NGN", "ERN", "NAD", "NPR", "ANG", "ILS", "RON", "TWD", "NZD", "BTN", "KPW", "NOK", "PEN", "MRO", "TOP", "PKR", "MOP", "UYU", "PHP", "GBP", "BWP", "QAR", "GTQ", "ZAR", "OMR", "KHR", "MVR", "IDR", "RUB", "RWF", "SHP", "SAR", "RSD", "SCR", "SGD", "SBD", "KGS", "SOS", "TJS", "LKR", "SDG", "SRD", "SEK", "CHF", "SYP", "BDT", "WST", "TZS", "KZT", "TTD", "MNT", "TND", "TRY", "AED", "UGX", "CLF", "USD", "UZS", "VUV", "KRW", "YER", "JPY", "CNY", "ZMW", "ZWL", "PLN"], "x-internal": true}, "amount": {"type": "number", "description": "Amount of the contribution"}, "referenceId": {"type": "string", "description": "Reference contribution ID from the data provider"}, "metadata": {"title": "Reference Metadata", "type": "object", "description": "Metadata related to account-specific data", "x-internal": true, "properties": {"createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "accountId": {"type": "string", "description": "The accountId of this object"}, "sourceId": {"type": "string", "description": "The ACCOUNT or ARCHIVE ID associated with this object"}, "sourceType": {"type": "string", "enum": ["ACCOUNT", "UPLOAD", "ARCHIVE"], "description": "Indicates whether the source associated with this object is either ACCOUNT or ARCHIVE type"}, "userId": {"type": "string", "description": "The user ID associated with this object"}, "providerId": {"type": "string", "description": "The provider ID associated with this object"}}, "required": ["createdAt", "sourceId", "sourceType", "userId", "providerId"]}}}}}}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6c031273-4287-49b7-961c-8053348ecbb8/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
list-contributions
Get the user's social security contributions from employment data sources.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "u-17bbf36498de4d68a0d4f86c7b62f69f", "createdAt": "2021-04-14T09:30:24Z", "providerId": "user-provided", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "type": "SOCIAL_SECURITY", "state": {"status": "STARTED", "errorCode": null, "errorMessage": null, "updatedAt": "2021-04-14T09:30:24Z"}, "rawFiles": [{"id": "f-17bbf36498de4d68a0d4f86c7b62f69f", "createdAt": "2021-04-14T09:30:24Z", "name": "Screen Shot 2021-04-14 at 5.30.24 PM", "subType": "PERSONAL_INFORMATION", "size": 3048, "format": "PNG", "url": "https://file.smileapi.io/tenants/smileapi/user/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg"}]}}
{"title": "Upload Get Response", "type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"title": "Upload", "type": "object", "description": "Collection of files.", "x-internal": false, "x-examples": {"Example": {"id": "u-17bbf36498de4d68a0d4f86c7b62f69f", "createdAt": "2021-04-14T09:30:24Z", "providerId": "user-provided", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "type": "PAYSLIP", "state": {"status": "STARTED", "errorCode": null, "errorMessage": null, "updatedAt": "2021-04-14T09:30:24Z"}, "rawFiles": [{"id": "f-17bbf36498de4d68a0d4f86c7b62f69f", "createdAt": "2021-04-14T09:30:24Z", "name": "Screen Shot 2021-04-14 at 5.30.24 PM", "subType": "PERSONAL_INFORMATION", "size": 3048, "format": "PNG", "url": "https://file.smileapi.io/tenants/smileapi/user/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg"}]}}, "x-tags": ["Uploads"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "providerId": {"type": "string", "description": "ID of the data provider"}, "userId": {"type": "string", "description": "User ID associated with this account"}, "type": {"type": "string", "enum": ["PAYSLIP", "TAX_DOCUMENT", "COMPANY_ID", "SOCIAL_SECURITY"], "description": "Type of document uploaded"}, "state": {"type": "object", "required": ["status", "updatedAt"], "properties": {"status": {"type": "string", "enum": ["STARTED", "ANALYZED", "UNSUPPORTED", "ERROR", "REVOKED"], "description": "Upload status"}, "errorCode": {"type": ["string", "null"], "description": "Error code", "enum": ["MISSING_MANDATARY_FIELD", "INVALID_FIELD_FORMAT", "SYSTEM_ERROR", null, null]}, "errorMessage": {"type": ["string", "null"], "description": "Error message"}, "updatedAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}}}, "rawFiles": {"description": "Collection of files", "type": "array", "items": {"title": "RawFile", "type": "object", "description": "Scanned or photographed document or form uploaded by the user to be able to share hardcopy employment and income information. File size limit is 15 MB.", "x-examples": {}, "x-internal": false, "x-tags": ["Uploads"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "name": {"type": "string", "description": "File name"}, "subType": {"type": ["string", "null"], "description": "Type of document uploaded"}, "size": {"type": "integer", "description": "File size in kilobytes"}, "format": {"type": "string", "enum": ["PDF", "PNG", "TIFF", "JPEG"], "description": "File type (only JPEG, PNG, PDF, or TIFF formats are supported)"}, "url": {"type": "string", "description": "URL to access the file. URL will expire after 7 days"}}, "required": ["id", "createdAt", "name", "subType", "size", "format", "url"]}}}, "required": ["id", "createdAt", "providerId", "userId", "type", "state", "rawFiles"]}}, "description": "", "x-internal": true}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e96d8c75-4484-4584-99b3-215a02353cd1/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-upload
Get a user's upload by ID (deprecated).
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "inc-17bbf36498de4d68a0d4f86c7b62f69f", "workItem": null, "employer": "ABC Corporation", "startDate": "2021-06-01", "endDate": "2021-06-15", "paymentMethod": "Cash", "currency": "PHP", "frequency": "Monthly", "baseAmount": 8500, "grossAmount": 10000, "netAmount": 7820.25, "metadata": {"createdAt": "2021-06-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "UPLOAD", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "abccorp"}}}
{"title": "Income Get Response", "type": "object", "x-internal": true, "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"title": "Income", "type": "object", "description": "The stored income information of the user from an employment data provider.", "x-examples": {"Example": {"id": "inc-17bbf36498de4d68a0d4f86c7b62f69f", "workItem": null, "employer": "ABC Corporation", "startDate": "2021-06-01", "endDate": "2021-06-15", "currency": "PHP", "frequency": "Monthly", "baseAmount": 8500, "grossAmount": 10000, "netAmount": 7820.25, "metadata": {"createdAt": "2021-06-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "UPLOAD", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "user-provided"}}}, "x-internal": false, "x-tags": ["Incomes"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "workItem": {"type": ["string", "null"], "description": "Work performed (specially in the case of contract or freelance jobs)"}, "employer": {"type": ["string", "null"], "title": "Employer", "x-internal": true, "description": "Employer name"}, "startDate": {"type": "string", "description": "Start date", "format": "date"}, "endDate": {"type": ["string", "null"], "format": "date", "description": "End date"}, "currency": {"type": "string", "title": "Currency ISO Codes", "description": "Currency in 3 character alpha ISO 4217", "enum": ["AFN", "DZD", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "THB", "PAB", "BBD", "BYN", "BZD", "BMD", "VES", "BOB", "BRL", "BND", "BGN", "BIF", "CAD", "CVE", "KYD", "GHS", "XOF", "XAF", "XPF", "CLP", "COP", "KMF", "CDF", "BAM", "NIO", "CRC", "HRK", "CZK", "GMD", "DKK", "MKD", "DJF", "STD", "DOP", "VND", "XCD", "EGP", "SVC", "ETB", "EUR", "FKP", "FJD", "HUF", "GIP", "HTG", "PYG", "GNF", "GYD", "HKD", "UAH", "ISK", "INR", "IRR", "IQD", "JMD", "JOD", "KES", "PGK", "LAK", "EEK", "KWD", "MWK", "AOA", "MMK", "GEL", "LVL", "LBP", "ALL", "HNL", "SLL", "LRD", "LYD", "SZL", "LTL", "LSL", "MGA", "MYR", "TMT", "MUR", "MZN", "MXN", "MDL", "MAD", "NGN", "ERN", "NAD", "NPR", "ANG", "ILS", "RON", "TWD", "NZD", "BTN", "KPW", "NOK", "PEN", "MRO", "TOP", "PKR", "MOP", "UYU", "PHP", "GBP", "BWP", "QAR", "GTQ", "ZAR", "OMR", "KHR", "MVR", "IDR", "RUB", "RWF", "SHP", "SAR", "RSD", "SCR", "SGD", "SBD", "KGS", "SOS", "TJS", "LKR", "SDG", "SRD", "SEK", "CHF", "SYP", "BDT", "WST", "TZS", "KZT", "TTD", "MNT", "TND", "TRY", "AED", "UGX", "CLF", "USD", "UZS", "VUV", "KRW", "YER", "JPY", "CNY", "ZMW", "ZWL", "PLN"], "x-internal": true}, "frequency": {"type": ["string", "null"], "title": "Pay Period", "description": "Pay period", "enum": ["Hourly", "Daily", "Weekly", "Semimonthly", "Monthly", "Bimonthly", "Quarterly", "Annually", "Variable", "Unspecified", null, null], "x-internal": true}, "baseAmount": {"type": ["number", "null"], "description": "Base amount"}, "grossAmount": {"type": ["number", "null"], "description": "Gross amount"}, "netAmount": {"type": ["number", "null"], "description": "Net amount"}, "metadata": {"title": "Reference Metadata", "type": "object", "description": "Metadata related to account-specific data", "x-internal": true, "properties": {"createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "accountId": {"type": "string", "description": "The accountId of this object"}, "sourceId": {"type": "string", "description": "The ACCOUNT or ARCHIVE ID associated with this object"}, "sourceType": {"type": "string", "enum": ["ACCOUNT", "UPLOAD", "ARCHIVE"], "description": "Indicates whether the source associated with this object is either ACCOUNT or ARCHIVE type"}, "userId": {"type": "string", "description": "The user ID associated with this object"}, "providerId": {"type": "string", "description": "The provider ID associated with this object"}}, "required": ["createdAt", "sourceId", "sourceType", "userId", "providerId"]}}, "required": ["id", "startDate", "currency", "metadata"]}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/6e547b07-23e4-4b3f-a0b6-2b8bacfa35be/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-income
Get the user's income by ID.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
415
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
400
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/9/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
201
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"expiresAt": "2021-04-14T09:30:24Z", "mode": "SANDBOX", "accessToken": "string"}}
{"title": "Token Post Response", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"title": "Token", "type": "object", "x-tags": ["Tokens"], "description": "A method for securely transmitting information between Smile and the user.", "x-examples": {"Example": {"expiresAt": "2021-04-14T09:30:24Z", "mode": "SANDBOX", "accessToken": "string"}}, "properties": {"expiresAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "mode": {"type": "string", "enum": ["SANDBOX", "PRODUCTION"], "description": "Valid Smile mode for the Token"}, "accessToken": {"type": "string", "description": "Short-lived token to initiate link flow"}}, "required": ["expiresAt", "mode", "accessToken"]}}, "x-internal": true, "x-examples": {}}
fecd2438-8469-4d33-b9d2-911466bfae16/e70a0e4d-36d5-4c2b-b05b-6c9d9ebe371a/10/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
create-token
Refresh a token for a user
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/0/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-contribution
Get the user's contribution by ID.
501
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/1/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-contribution
Get the user's contribution by ID.
504
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/2/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-contribution
Get the user's contribution by ID.
403
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/3/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-contribution
Get the user's contribution by ID.
503
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/4/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-contribution
Get the user's contribution by ID.
404
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/5/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-contribution
Get the user's contribution by ID.
429
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/6/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-contribution
Get the user's contribution by ID.
401
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}
fecd2438-8469-4d33-b9d2-911466bfae16/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/7/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-contribution
Get the user's contribution by ID.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "date": "2021-04-30", "currency": "PHP", "amount": 1375, "referenceId": "PA9634415", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "sss-ph"}}}
{"title": "Contribution Get Response", "x-stoplight": {"id": "9r9jv3d46jvrw"}, "type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"title": "Contribution", "x-stoplight": {"id": "ymth27j2l09a4"}, "type": "object", "description": "The social security insurance contribution made by, or in behalf, of a user as recorded by the employment data provider.", "x-examples": {"Example": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "date": "2021-04-30", "currency": "PHP", "amount": 1375, "referenceId": "PA9634415", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "sss-ph"}}}, "x-tags": ["Contributions"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "date": {"type": "string", "format": "date", "description": "Date of the contribution"}, "currency": {"type": "string", "title": "Currency ISO Codes", "description": "Currency in 3 character alpha ISO 4217", "enum": ["AFN", "DZD", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "THB", "PAB", "BBD", "BYN", "BZD", "BMD", "VES", "BOB", "BRL", "BND", "BGN", "BIF", "CAD", "CVE", "KYD", "GHS", "XOF", "XAF", "XPF", "CLP", "COP", "KMF", "CDF", "BAM", "NIO", "CRC", "HRK", "CZK", "GMD", "DKK", "MKD", "DJF", "STD", "DOP", "VND", "XCD", "EGP", "SVC", "ETB", "EUR", "FKP", "FJD", "HUF", "GIP", "HTG", "PYG", "GNF", "GYD", "HKD", "UAH", "ISK", "INR", "IRR", "IQD", "JMD", "JOD", "KES", "PGK", "LAK", "EEK", "KWD", "MWK", "AOA", "MMK", "GEL", "LVL", "LBP", "ALL", "HNL", "SLL", "LRD", "LYD", "SZL", "LTL", "LSL", "MGA", "MYR", "TMT", "MUR", "MZN", "MXN", "MDL", "MAD", "NGN", "ERN", "NAD", "NPR", "ANG", "ILS", "RON", "TWD", "NZD", "BTN", "KPW", "NOK", "PEN", "MRO", "TOP", "PKR", "MOP", "UYU", "PHP", "GBP", "BWP", "QAR", "GTQ", "ZAR", "OMR", "KHR", "MVR", "IDR", "RUB", "RWF", "SHP", "SAR", "RSD", "SCR", "SGD", "SBD", "KGS", "SOS", "TJS", "LKR", "SDG", "SRD", "SEK", "CHF", "SYP", "BDT", "WST", "TZS", "KZT", "TTD", "MNT", "TND", "TRY", "AED", "UGX", "CLF", "USD", "UZS", "VUV", "KRW", "YER", "JPY", "CNY", "ZMW", "ZWL", "PLN"], "x-internal": true}, "amount": {"type": "number", "description": "Amount of the contribution"}, "referenceId": {"type": "string", "description": "Reference contribution ID from the data provider"}, "metadata": {"title": "Reference Metadata", "type": "object", "description": "Metadata related to account-specific data", "x-internal": true, "properties": {"createdAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}, "accountId": {"type": "string", "description": "The accountId of this object"}, "sourceId": {"type": "string", "description": "The ACCOUNT or ARCHIVE ID associated with this object"}, "sourceType": {"type": "string", "enum": ["ACCOUNT", "UPLOAD", "ARCHIVE"], "description": "Indicates whether the source associated with this object is either ACCOUNT or ARCHIVE type"}, "userId": {"type": "string", "description": "The user ID associated with this object"}, "providerId": {"type": "string", "description": "The provider ID associated with this object"}}, "required": ["createdAt", "sourceId", "sourceType", "userId", "providerId"]}}}}, "x-internal": true}
fecd2438-8469-4d33-b9d2-911466bfae16/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/8/0
Smile
Smile provides user-authorized access to valuable employment and income data from HR, payroll, commerce, and marketplace platforms through a single API!
0.1
get-contribution
Get the user's contribution by ID.
500
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {}}
{"type": "object", "properties": {"code": {"type": "string", "title": "Object-Metadata-Ref-API-Code", "description": "Request status code", "enum": ["OK", "CREATED", "INVALID_CREDENTIALS", "INVALID_PARAMETERS", "INVALID_TOKEN", "UNAUTHORIZED_ACCESS", "MISSING_RESOURCE", "REQUEST_LIMIT_EXCEEDED", "SERVER_ERROR", "UNSUPPORTED_METHOD", "SERVER_UNAVAILABLE", "TIME_LIMIT_EXCEEDED"], "x-internal": false}, "message": {"type": "string", "title": "Object-Metadata-Ref-Message", "description": "Message response to the request", "x-internal": false}, "requestId": {"type": "string", "title": "Object-Metadata-Ref-RequestID", "description": "Unique ID that is added to the body of every response for easy traceability of the request in our logs.", "x-internal": false}, "data": {"type": "object"}}}