Datasets:
davidfant
/
rapidapi-example-responses

Dataset card Data Studio Files Community
1
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/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/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-contribution
Get the user's contribution 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/1dd96e5b-ce7d-4f8d-b19b-f2fa4bd6686e/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-contribution
Get the user's contribution 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/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "createdAt": "2021-04-14T09:30:24Z", "name": "Event Notification Postback", "url": "https://webhook.clienturl.xyz", "eventTypes": ["ACCOUNT_CONNECTED"], "active": true, "secret": "a little secret", "updatedAt": "2021-04-14T09:30:24Z"}}
{"title": "WebhookGetResponse", "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": "Webhook", "type": "object", "description": "Receive event notifications via Webhooks.", "x-examples": {"Example": {"id": "17bbf36498de4d68a0d4f86c7b62f69f", "createdAt": "2021-04-14T09:30:24Z", "name": "Event Notification Postback", "url": "https://webhook.clienturl.xyz", "eventTypes": ["USER_CREATED"], "active": true, "secret": "a little secret", "updatedAt": "2021-04-14T09:30:24Z"}}, "x-internal": true, "x-tags": ["Webhooks"], "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": "Name of the webhook endpoint"}, "url": {"type": "string", "description": "URL of webhook, must begin with https://"}, "secret": {"type": "string", "description": "The key that will be used to generate HMAC-SHA512 hex digest value in the SmileAPI-Signature header."}, "eventTypes": {"type": "array", "items": {"title": "Ref-WebhookEventType", "description": "Event Type which will be sent as a notification via webhook", "type": "string", "enum": ["USER_CREATED", "ACCOUNT_CONNECTED", "ACCOUNT_DISCONNECTED", "ACCOUNT_FAILED", "ARCHIVE_STARTED", "ARCHIVE_ANALYZED", "ARCHIVE_REVOKED", "ARCHIVE_FAILED", "INVITE_INVITED", "INVITE_LINKED", "IDENTITY_ADDED", "RATING_ADDED", "TRANSACTIONS_ADDED", "DOCUMENTS_ADDED", "EMPLOYMENTS_ADDED", "INCOMES_ADDED", "CONTRIBUTIONS_ADDED", "ALL_EVENTS"]}}, "active": {"type": "boolean", "default": true}, "updatedAt": {"type": "string", "title": "Date and Time string", "format": "date-time", "description": "Date and time", "x-internal": true}}, "required": ["id", "createdAt", "name", "url", "eventTypes", "active", "updatedAt"]}}, "x-internal": true}
fecd2438-8469-4d33-b9d2-911466bfae16/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
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/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
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/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
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/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
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/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
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/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
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/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
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/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
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/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
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/ac9f7997-ae63-4a78-9438-045e089130f0/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-webhook
Get a webhook endpoint.
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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an 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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an 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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an 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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an 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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an invite template.
201
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": "InviteTemplatePostResponse", "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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an 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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an 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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an 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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an 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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an 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/6aa59bf6-583e-4a8a-9cf9-07973c47f3bc/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-invite-template
Create an 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/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (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/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (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/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (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/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (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/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (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/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (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/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (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/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (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/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (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/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (deprecated).
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"nextCursor": "1259723474", "items": [{"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 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": "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"]}}}}}, "x-internal": true}
fecd2438-8469-4d33-b9d2-911466bfae16/ad7e28ab-03c0-48ba-9067-33c4016f53d1/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-uploads
Get the user's uploads (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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"nextCursor": "1259723474", "items": [{"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": "InviteTemplateListResponse", "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": "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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
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/c5631855-b4c4-4e0e-9eca-db073b5453a0/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-invite-templates
Get the list of invite templates.
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/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete 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/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete 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/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete 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/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete 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/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete 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/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete invite template.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d"}
{"title": "InviteTemplateDeleteResponse", "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}}, "description": ""}
fecd2438-8469-4d33-b9d2-911466bfae16/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete 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/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete 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/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete 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/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete 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/3d9d5d1a-2d64-4dee-997a-b56e4214c962/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
delete-invite-template
Delete 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/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment 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/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment 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/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment 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/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment 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/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment 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/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment 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/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment 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/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment 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/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment 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/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment by ID.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "e-17bbf36498de4d68a0d4f86c7b62f69f", "name": "Digital Marketing", "description": "Gathering and reporting relevant data, maintaining specific reports and dashboards, using platforms and programs to address marketing requirements, and updating specific marketing materials.", "jobTitle": "Digital Marketing Assistant", "department": "Marketing", "employeeNumber": "EMP-123456", "employer": "ABC Corporation", "status": "Permanent", "startDate": "2016-02-24", "endDate": "2019-08-24", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "UPLOAD", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "abccorp"}}}
{"title": "Employment 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": "Employment", "type": "object", "x-internal": false, "description": "The stored employment information of the user from an employment data provider.", "x-examples": {"Example": {"id": "e-17bbf36498de4d68a0d4f86c7b62f69f", "name": "Digital Marketing", "description": "Gathering and reporting relevant data, maintaining specific reports and dashboards, using platforms and programs to address marketing requirements, and updating specific marketing materials.", "jobTitle": "Digital Marketing Assistant", "department": "Marketing", "employeeNumber": "EMP-123456", "employer": "ABC Corporation", "status": "Permanent", "startDate": "2016-02-24", "endDate": "2019-08-24", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "UPLOAD", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "abccorp"}}}, "x-tags": ["Employments"], "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "name": {"type": ["string", "null"], "description": "Work performed"}, "description": {"type": ["string", "null"], "description": "Description of work performed"}, "jobTitle": {"type": ["string", "null"], "description": "Job title"}, "department": {"type": ["string", "null"], "description": "Department or organization in place of employment"}, "employeeNumber": {"type": ["string", "null"], "description": "Employee number in the employment data provider"}, "employer": {"type": ["string", "null"], "title": "Employer", "x-internal": true, "description": "Employer name"}, "status": {"type": ["string", "null"], "description": "Status of employment"}, "startDate": {"type": "string", "description": "Start date", "format": "date"}, "endDate": {"type": ["string", "null"], "description": "End date", "format": "date"}, "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", "metadata"]}}}
fecd2438-8469-4d33-b9d2-911466bfae16/c709e026-b8e4-430d-9149-ff39ac6232e2/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-employment
Get a user's employment 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/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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": "InviteTemplateUpdateResponse", "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"]}}, "description": ""}
fecd2438-8469-4d33-b9d2-911466bfae16/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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/476b7f93-6721-4a82-b23f-52f32925d562/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
update-invite-template
Update 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/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction 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/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction 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/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction 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/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction 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/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction 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/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction 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/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction 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/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction 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/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction by ID.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "t-17bbf36498de4d68a0d4f86c7b62f69f", "date": "2021-04-21", "description": "Payment for web design project", "currency": "PHP", "amount": 10000, "referenceId": "string", "metadata": {"createdAt": "2021-04-21T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}}
{"title": "Transaction 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": "Transaction", "type": "object", "description": "The stored financial transaction data of the user from an employment data provider.", "x-tags": ["Transactions"], "x-examples": {"Example": {"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "t-17bbf36498de4d68a0d4f86c7b62f69f", "date": "2021-04-21", "description": "Payment for web design project", "currency": "PHP", "amount": 10000, "referenceId": "string", "metadata": {"createdAt": "2021-04-21T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}}}, "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "date": {"type": "string", "format": "date", "description": "Date of transaction"}, "description": {"type": ["string", "null"], "description": "Description of the transaction"}, "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"}, "referenceId": {"type": ["string", "null"], "description": "Reference transaction ID from 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"]}}, "required": ["id", "date", "currency", "amount", "metadata"]}}, "x-internal": true, "x-examples": {}}
fecd2438-8469-4d33-b9d2-911466bfae16/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction 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/595757dd-2ebc-4b67-8d94-b2729325c0db/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-transaction
Get a user's transaction 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/61fbc64a-4ace-4d80-bbfa-357b45dc4138/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-transactions
Get the user's transactions 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/61fbc64a-4ace-4d80-bbfa-357b45dc4138/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-transactions
Get the user's transactions from employment data sources.
200
null
{"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"nextCursor": "1259723474", "items": [{"id": "t-17bbf36498de4d68a0d4f86c7b62f69f", "date": "2021-04-21", "description": "Payment for web design project Milestone 2", "currency": "PHP", "amount": 10000, "referenceId": "string", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}, {"id": "t-17bbf36498de4d68a0d4f86c7b62f69f", "date": "2021-03-21", "description": "Payment for web design project Milestone 1", "currency": "PHP", "amount": 10000, "referenceId": "string", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}, {"id": "t-17bbf36498de4d68a0d4f86c7b62f69f", "date": "2021-02-12", "description": "Payment for Facebook Ad design", "currency": "PHP", "amount": 5000, "referenceId": "string", "metadata": {"createdAt": "2021-04-14T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}]}}
{"title": "Transaction 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": "Transaction", "type": "object", "description": "The stored financial transaction data of the user from an employment data provider.", "x-tags": ["Transactions"], "x-examples": {"Example": {"code": "OK", "message": "Success", "requestId": "5b79399a-6852-4234-bb0e-ad472648282d", "data": {"id": "t-17bbf36498de4d68a0d4f86c7b62f69f", "date": "2021-04-21", "description": "Payment for web design project", "currency": "PHP", "amount": 10000, "referenceId": "string", "metadata": {"createdAt": "2021-04-21T09:30:24Z", "sourceId": "17bbf36498de4d68a0d4f86c7b62f69f", "sourceType": "ACCOUNT", "userId": "tenant-5c1a2e8678e3494eba303ad1afa54ee8", "providerId": "upwork"}}}}, "properties": {"id": {"type": "string", "title": "Object ID", "description": "Unique ID of this object", "x-internal": true}, "date": {"type": "string", "format": "date", "description": "Date of transaction"}, "description": {"type": ["string", "null"], "description": "Description of the transaction"}, "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"}, "referenceId": {"type": ["string", "null"], "description": "Reference transaction ID from 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"]}}, "required": ["id", "date", "currency", "amount", "metadata"]}}}}}, "x-internal": true, "x-examples": {}}
fecd2438-8469-4d33-b9d2-911466bfae16/61fbc64a-4ace-4d80-bbfa-357b45dc4138/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-transactions
Get the user's transactions 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/61fbc64a-4ace-4d80-bbfa-357b45dc4138/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-transactions
Get the user's transactions 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/61fbc64a-4ace-4d80-bbfa-357b45dc4138/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-transactions
Get the user's transactions 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/61fbc64a-4ace-4d80-bbfa-357b45dc4138/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-transactions
Get the user's transactions 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/61fbc64a-4ace-4d80-bbfa-357b45dc4138/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-transactions
Get the user's transactions 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/61fbc64a-4ace-4d80-bbfa-357b45dc4138/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-transactions
Get the user's transactions 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/61fbc64a-4ace-4d80-bbfa-357b45dc4138/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-transactions
Get the user's transactions 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/61fbc64a-4ace-4d80-bbfa-357b45dc4138/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-transactions
Get the user's transactions 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"}}}