openapi: 3.0.0 info: title: Smile API version: 1.14.0 description: 'The Smile API provides employment and income data from a single API. ' contact: name: Smile Technology Pte Ltd url: https://www.getsmileapi.com email: info@getsmileapi.com termsOfService: https://www.getsmileapi.com/terms-and-conditions servers: - url: https://sandbox.smileapi.io/v1 description: Sandbox - url: https://open.smileapi.io/v1 description: Production paths: /providers: get: summary: List Providers tags: - Providers responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProviderListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: upwork name: Upwork longName: Upwork Global Inc. logoUrl: >- https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png type: GIG typeLabel: Gig Platform subType: SERVICES subTypeLabel: Professional Services active: true enabled: true mfa: true accountConnection: true supported: - IDENTITIES - id: freelancer name: Freelancer longName: Freelancer Technology Pty Limited logoUrl: >- https://cdn.smileapi.io/image/provider-logo/v20210813064500/freelancer.png type: GIG typeLabel: Gig Platform subType: SERVICES subTypeLabel: Professional Services active: true enabled: true mfa: true accountConnection: true supported: - IDENTITIES - id: grab name: Grab longName: Grab Holdings Inc logoUrl: >- https://cdn.smileapi.io/image/provider-logo/v20210813064500/freelancer.png type: GIG typeLabel: Gig Platform subType: TRANSPORTATION subTypeLabel: Transport and Delivery active: true enabled: true mfa: true accountConnection: true supported: - IDENTITIES '400': $ref: '#/components/responses/Standard-Errors' operationId: list-providers description: Get a list of employment data providers from the Smile Network. parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/size' - schema: type: string in: query name: type description: Filter results to certain type of providers. - schema: type: string in: query name: subType description: Filter results to certain subset of a certain subtype of providers - schema: type: boolean in: query name: active description: Filter results to active or inactive providers. - schema: type: boolean in: query name: enabled description: Filter results to enabled or disabled providers. - schema: type: boolean in: query name: accountConnection description: Filter results to providers with real-time account connections. - schema: type: string in: query name: name description: Filter results by provider name - schema: type: array items: type: string in: query name: ids description: >- Filter results by provider ids, each id will be matched exactly, please following this format 'ids=id1,id2,id3'. - schema: type: array maxItems: 10 items: type: string in: query name: topIds description: >- Show these providers on the top of the list, please following this format 'ids=id1,id2,id3'. parameters: [] /providers/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: Get Provider tags: - Providers responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProviderGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: upwork name: Upwork longName: Upwork Global Inc. logoUrl: >- https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png type: GIG typeLabel: Gig Platform subType: SERVICES subTypeLabel: Professional Services active: true enabled: true mfa: true accountConnection: true supported: - IDENTITIES - TRANSACTIONS operationId: get-provider description: Get a data provider from the Smile Network. parameters: [] /users: get: summary: List Users tags: - Users responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: tenant-17bbf36498de4d68a0d4f86c7b62f69f externalMetadata: property1: string property2: string createdAt: '2021-04-14T09:30:24Z' session: channel: Default channelId: null userId: tenantId-123abc456def789abc123def456abc78 status: IN_PROGRESS - id: tenant-17bbf36498de4d68a0d4f86c7b62f69f externalMetadata: property1: string property2: string createdAt: '2021-04-14T09:30:24Z' session: channel: Default channelId: null userId: tenantId-123abc456def789abc123def456abc78 status: IN_PROGRESS - id: tenant-17bbf36498de4d68a0d4f86c7b62f69f externalMetadata: property1: string property2: string createdAt: '2021-04-14T09:30:24Z' session: channel: Default channelId: null userId: tenantId-123abc456def789abc123def456abc78 status: IN_PROGRESS - id: tenant-17bbf36498de4d68a0d4f86c7b62f69f externalMetadata: key1: value key2: value createdAt: '2021-04-14T09:30:24Z' session: channel: WinkSite channelId: site-123abc456def789abc123def456abc78 userId: tenantId-123abc456def789abc123def456abc78 status: COMPLETED operationId: list-users description: List users from the Smile Network. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - schema: type: string format: date example: '2021-04-01' in: query name: startDate description: Filter by user creation date, start of date range (YYYY-MM-DD) - schema: type: string format: date example: '2021-04-21' in: query name: endDate description: Filter by user creation date, end of date range (YYYY-MM-DD) parameters: [] post: summary: Create User operationId: create-user requestBody: content: application/json: schema: $ref: '#/components/schemas/UserPostRequest' description: '' responses: '201': description: OK content: application/json: schema: $ref: '#/components/schemas/UserPostResponse' examples: {} description: Create a user in the Smile Network. tags: - Users /users/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View User tags: - Users responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: tenant-17bbf36498de4d68a0d4f86c7b62f69f externalMetadata: property1: string property2: string createdAt: '2021-04-14T09:30:24Z' session: channel: WinkSite channelId: site-123abc456def789abc123def456abc78 userId: tenantId-123abc456def789abc123def456abc78 status: COMPLETED operationId: get-user description: View a particular user profile. parameters: [] /users/{id}/payload: get: tags: - Users summary: View User Session Payload description: Retrieve the payload data for a specific user session operationId: get-user-session-payload parameters: - name: id in: path description: The user ID required: true schema: type: string example: tenant-123abc456def789abc123def456abc78 responses: '200': description: User session payload retrieved successfully content: application/json: schema: $ref: '#/components/schemas/UserPayloadGetResponse' '400': $ref: '#/components/responses/Standard-Errors' '401': $ref: '#/components/responses/Standard-Errors' '403': $ref: '#/components/responses/Standard-Errors' '404': $ref: '#/components/responses/Standard-Errors' '500': $ref: '#/components/responses/Standard-Errors' /users/{id}/resetSession: post: tags: - Users summary: Reset User Session description: Clean the payload data for a specific user session operationId: reset-user-session parameters: - name: id in: path description: The user ID required: true schema: type: string example: tenant-123abc456def789abc123def456abc78 responses: '200': description: User session payload reset successfully content: application/json: schema: $ref: '#/components/schemas/CommonResponse' /tokens: post: summary: Refresh Token operationId: create-token responses: '201': description: OK content: application/json: schema: $ref: '#/components/schemas/TokenPostResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: expiresAt: '2021-04-14T09:30:24Z' mode: SANDBOX accessToken: string description: Refresh a token for a user tags: - Tokens parameters: - schema: type: string minLength: 1 maxLength: 200 in: query name: userId required: true description: the user whom to create token for. /consentTemplates: post: description: Create a consent template operationId: create-consent-template requestBody: content: application/json: schema: $ref: '#/components/schemas/ConsentTemplateCreateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ConsentTemplateCreateResponse' description: OK summary: Create Consent Template tags: - Consent Templates x-contentType: application/json x-accepts: application/json get: description: List consent templates operationId: list-consent-templates parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConsentTemplateListResponse' description: OK summary: List Consent Templates tags: - Consent Templates x-accepts: application/json /consentTemplates/{id}: delete: summary: Delete Consent Template responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommonResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d operationId: delete-consent-template description: Delete a consent template tags: - Consent Templates parameters: - $ref: '#/components/parameters/id' /webhooks: get: summary: List Webhooks tags: - Webhooks responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WebhookListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - 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' operationId: list-webhooks description: List all webhook endpoints. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' parameters: [] post: summary: Create Webhook responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WebhookPostResponse' examples: Example: value: 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 secret: a little secret active: true updatedAt: '2021-04-14T09:30:24Z' operationId: create-webhook description: Create a webhook endpoint. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebhookPostRequest' examples: Example: value: name: Event Notification Postback url: https://webhook.clienturl.xyz eventTypes: - ACCOUNT_CONNECTED - IDENTITY_ADDED active: true secret: a little secret tags: - Webhooks /webhooks/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Webhook tags: - Webhooks responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WebhookGetResponse' examples: Example: value: 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' operationId: get-webhook description: View a webhook endpoint. delete: summary: Delete Webhook responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WebhookDeleteResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d operationId: delete-webhook description: Delete a webhook endpoint. tags: - Webhooks /tasks: get: summary: List Tasks tags: - Tasks responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TaskListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: task-a2e3ad1afa54ee818678e3494eb5ca30 type: LINK_ACCOUNT startedAt: '2023-04-14T09:31:24Z' finishedAt: '2023-04-14T09:33:21Z' status: Finished datapoints: - IDENTITIES - DOCUMENTS - EINCOMES - INCOMES metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork - id: task-a2e3ad18678e3494eb5ca301afa54ee8 type: LINK_ACCOUNT startedAt: '2023-04-14T09:31:24Z' finishedAt: null status: Started datapoints: [] metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork operationId: list-tasks description: List the user's tasks. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - schema: type: string format: date example: '2021-04-01' in: query name: startDate description: Filter by task created date, start of date range (YYYY-MM-DD) - schema: type: string format: date example: '2021-04-21' in: query name: endDate description: Filter by task created date, end of date range (YYYY-MM-DD) - $ref: '#/components/parameters/sourceId' /tasks/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Task tags: - Tasks responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TaskGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: task-a2e3ad1afa54ee818678e3494eb5ca30 type: LINK_ACCOUNT startedAt: '2023-04-14T09:31:24Z' finishedAt: '2023-04-14T09:33:21Z' status: Finished datapoints: - IDENTITIES - DOCUMENTS - EINCOMES - LINK - INSIGHT metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork operationId: get-task description: View a user's task by ID. /accounts: get: summary: List Accounts tags: - Accounts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: a-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' providerId: grab userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 connectionStatus: ERROR connection: status: ERROR errorCode: ACCOUNT_DISABLED errorMessage: Account is disabled updatedAt: '2021-04-14T09:30:24Z' monitorStatus: UNSUPPORTED monitor: status: UNSUPPORTED updatedAt: null - id: a-7fa7e260ad724f39b61427f6ac2edc69 createdAt: '2021-04-15T09:30:24Z' providerId: freelancer userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 connectionStatus: CONNECTED connection: status: CONNECTED errorCode: null errorMessage: null updatedAt: '2021-04-18T09:30:24Z' monitorStatus: ACTIVE monitor: stust: ACTIVE updatedAt: '2023-03-14T09:30:24Z' - id: a-79da958ecb2143659747deaebca1cfe0 createdAt: '2021-04-17T09:30:24Z' providerId: upwork userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 connectionStatus: CONNECTED connection: status: CONNECTED errorCode: null errorMessage: null updatedAt: '2021-04-19T09:30:24Z' monitorStatus: ACTIVE monitor: status: ACTIVE updatedAt: null operationId: list-accounts description: List a list of user accounts. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - schema: type: string format: date example: '2021-04-01' in: query name: startDate description: Filter by account linking date, start of date range (YYYY-MM-DD) - schema: type: string format: date example: '2021-04-21' in: query name: endDate description: Filter by account linking date, end of date range (YYYY-MM-DD) parameters: [] /accounts/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Account tags: - Accounts operationId: get-account description: View a user's particular account information. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: a-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' providerId: grab userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 connectionStatus: ERROR connection: status: ERROR errorCode: ACCOUNT_DISABLED errorMessage: Account is disabled updatedAt: '2021-04-14T09:30:24Z' monitorStatus: ACTIVE monitor: status: ACTIVE updatedAt: '2021-04-14T09:30:24Z' parameters: [] delete: summary: Revoke Account tags: - Accounts operationId: delete-account description: >- Delete a user's particular account information including the related data. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommonResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d parameters: [] /accounts/{id}/payload: parameters: - $ref: '#/components/parameters/id' get: summary: View Account Payload tags: - Accounts operationId: get-account-payload description: View a user's particular account payload. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountPayloadGetResponse' parameters: [] /accounts/{id}/exports/generate: parameters: - $ref: '#/components/parameters/id' post: summary: Generate account export tags: - Accounts operationId: generate-account-export description: Generate a particular account export. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AccountExportGenerateRequest' examples: Example: value: exportExtensionType: PDF description: '' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AccountExportGenerateResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: export-4d686c7b62f69fa0d4f817bbf36498de createdAt: '2021-04-14T09:30:24Z' accountId: a-17bbf36498de4d68a0d4f86c7b62f69f exportExtensionType: PDF md5: f8498de49d68a0d4bbf36f6c7b62f617 downloadUrl: >- https://file.smileapi.io/tenants/xx/users/xx-2c4f00ad9b014466868b57b554e9391b/accounts/a-35aa43673f024b26bd699c713e885ddb/exports/export-4d686c7b62f69fa0d4f817bbf36498de.pdf parameters: [] /accounts/{accountId}/disableMonitor: parameters: - name: accountId in: path required: true schema: type: string description: the particular account ID. post: summary: Disable Monitor tags: - Accounts responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommonResponse' operationId: disable-account-monitor description: disable monitor account data. /invites: get: summary: List Invites tags: - Invites responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InviteListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: 17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' fullName: George Cimafranca Palomero, Jr firstName: George lastName: Palomero email: gpalomero1234@smileapi.io templateId: tpl-b2c5e816-65ad-4130-819d-db89acc5869a winkTemplateId: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d userId: tenantId-b2c5e816-65ad-4130-819d-db89acc5869a status: INVITED updatedAt: '2021-04-14T09:30:24Z' invitedAt: '2021-04-14T09:30:24Z' linkedAt: '2021-04-14T09:30:24Z' inviteLandingPageUrl: >- https://user.getsmileapi.com/invite-user/xx-xxxxxx?token=xxxxxxxxx operationId: list-invites description: List the list of invites sent out to users. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' post: summary: Create Invite operationId: create-invite responses: '201': description: OK content: application/json: schema: $ref: '#/components/schemas/InvitePostResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: 17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' fullName: George Cimafranca Palomero, Jr firstName: George lastName: Palomero email: gpalomero1234@smileapi.io templateId: tpl-b2c5e816-65ad-4130-819d-db89acc5869a winkTemplateId: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d userId: tenantId-b2c5e816-65ad-4130-819d-db89acc5869a status: INVITED updatedAt: '2021-04-14T09:30:24Z' invitedAt: '2021-04-14T09:30:24Z' linkedAt: '2021-04-14T09:30:24Z' inviteLandingPageUrl: >- https://user.getsmileapi.com/invite-user/xx-xxxxxx?token=xxxxxxxxx description: Create and send an invite to a user requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InvitePostRequest' examples: Example: value: fullName: Ryan Joseph Peterson Chua Ng firstName: Ryan lastName: Ng email: ryan1234@smileapi.io templateId: tpl-b2c5e81665ad4130819ddb89acc5869a winkTemplateId: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d tags: - Invites /invites/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Invite tags: - Invites responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InviteGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: 17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' fullName: George Cimafranca Palomero, Jr firstName: George lastName: Palomero email: gpalomero1234@smileapi.io templateId: tpl-b2c5e816-65ad-4130-819d-db89acc5869a winkTemplateId: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d userId: tenantId-b2c5e816-65ad-4130-819d-db89acc5869a status: INVITED updatedAt: '2021-04-14T09:30:24Z' invitedAt: '2021-04-14T09:30:24Z' linkedAt: '2021-04-14T09:30:24Z' inviteLandingPageUrl: >- https://user.getsmileapi.com/invite-user/xx-xxxxxx?token=xxxxxxxxx operationId: get-invite description: View invite sent to users by ID. /invites/{inviteId}/logs: parameters: - name: inviteId in: path schema: type: string minLength: 1 maxLength: 200 description: ID of the specific invite in the collection. required: true get: summary: List Invite Logs tags: - Invites parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InviteLogListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - id: invl-b2c5e816-65ad-4130-819d-db89acc5869a inviteId: inv-b2c5e816-65ad-4130-819d-db89acc5869a createdAt: '2021-04-14T09:30:24Z' inviteStatus: INVITED userId: tenant-17bbf36498de4d68a0d4f86c7b62f69f operationId: list-invite-log description: List invite log. /inviteTemplates: get: summary: List Invite Templates tags: - Invite Templates responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InviteTemplateListResponse' examples: Example: value: 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: replies@xyz.co 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 operationId: list-invite-templates description: Get the list of invite templates. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' post: summary: Create Invite Template operationId: create-invite-template responses: '201': description: OK content: application/json: schema: $ref: '#/components/schemas/InviteTemplatePostResponse' examples: Example: value: 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: replies@xyz.co 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 description: Create an invite template. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InviteTemplatePostRequest' examples: Example: value: name: Email Template v1 company: name: XYZ Bank logoUrl: https://xyzbank.co/logo.png email: sendEmail: true senderName: XYZ Bank replyAddress: replies@xyz.co 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: >- 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. description: >- Share your employment and income data with us at {{company.name}} button: START NOW successPage: header: >- The process was successful! Please wait for us to get in touch! description: >- Thank you for sharing your employment and income data with us at {{company.name}} button: Connect another account description: '' tags: - Invite Templates /inviteTemplates/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: Get Invite Template tags: - Invite Templates responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InviteTemplateGetResponse' examples: Example: value: 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: replies@xyz.co 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 operationId: get-invite-template description: Get invite template. put: summary: Update Invite Template operationId: update-invite-template responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InviteTemplateUpdateResponse' examples: Example: value: 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: replies@xyz.co 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 tags: - Invite Templates description: Update invite template. requestBody: content: application/json: schema: $ref: '#/components/schemas/InviteTemplateUpdateRequest' examples: Example: value: name: Email Template v1 company: name: XYZ Bank logoUrl: https://xyzbank.co/logo.png email: sendEmail: true senderName: XYZ Bank replyAddress: replies@xyz.co 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 granting you a loan. It will be a quick process and should take no more than a few minutes of your time. landingPage: header: >- We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for granting you a loan. It will be a quick process and should take no more than a few minutes of your time. description: >- Share your employment and income data with us at {{company.name}} button: START NOW successPage: header: >- The process was successful! Please wait for us to get in touch! description: >- Thank you for sharing your employment and income data with us at {{company.name}} button: Connect another account description: '' delete: summary: Delete Invite Template operationId: delete-invite-template responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InviteTemplateDeleteResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d tags: - Invite Templates description: Delete invite template. /archives: get: summary: List Archives responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArchiveListResponse' examples: Example: value: 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/users/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg classification: null analysis: null operationId: list-archives description: List the user's archives. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - schema: $ref: '#/components/schemas/FileTypeId' in: query name: fileType description: Filter by archive date, start of date range (YYYY-MM-DD) - schema: type: string format: date example: '2021-04-01' in: query name: startDate description: Filter by archive date, start of date range (YYYY-MM-DD) - schema: type: string format: date example: '2021-04-21' in: query name: endDate description: Filter by archive date, end of date range (YYYY-MM-DD) tags: - Archives post: summary: Create Archive description: Create an archive. operationId: create-archive tags: - Archives requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ArchiveCreateRequest' examples: Example: value: userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 fileType: PAYSLIP rawFiles: - fileExtensionType: PDF fileSubtype: PAYSLIP fileName: 2021-04-14-17bbf36498de4d68a0d4f86c7b62f69f.pdf fileContent: base64 encoded file content Example2: value: userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 fileType: null rawFiles: - fileExtensionType: PDF fileSubtype: null fileName: 2021-04-14-17bbf36498de4d68a0d4f86c7b62f69f.pdf fileContent: base64 encoded file content description: request parameters responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArchiveCreateResponse' /archives/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Archive responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArchiveGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: u-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' providerId: user-provided userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 type: SOCIAL_SECURITY state: status: STARTED errorCode: null errorMessage: null updatedAt: '2021-04-14T09:30:24Z' rawFiles: - id: f-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' name: Screen Shot 2021-04-14 at 5.30.24 PM subType: PERSONAL_INFORMATION size: 3048 format: PNG url: >- https://file.smileapi.io/tenants/smileapi/users/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg classification: null analysis: null Example2: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: u-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' providerId: user-provided userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 type: PAYSLIP state: status: ANALYZED 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: PAYSLIP size: 3048 format: PNG url: >- https://file.smileapi.io/tenants/smileapi/users/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg classification: null analysis: startDate: '2023-04-16' endDate: '2023-04-30' payDate: '2023-04-30' employeeName: John Doe currency: PHP grossAmount: 10000 netAmount: 9000 employerName: Acme Inc. ssNumber: '1234567890' philHealthNumber: '123456789012' taxNumber: '123456789' pagIbigNumber: '123456789012' operationId: get-archive description: View a user's archive by ID. tags: - Archives delete: summary: Revoke Archive tags: - Archives operationId: delete-archive description: >- Delete a user's particular archive information including the related data. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommonResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d parameters: [] /archives/classify: post: summary: Classify Archive description: Classify an archive. operationId: create-and-classify-archive tags: - Archives requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ArchiveClassifyRequest' examples: Example: value: userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 rawFiles: - fileExtensionType: PDF fileSubtype: null fileName: 2021-04-14-17bbf36498de4d68a0d4f86c7b62f69f.pdf fileContent: base64 encoded file content description: request parameters responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArchiveClassifyResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: u-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' providerId: user-provided userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 type: SOCIAL_SECURITY state: status: STARTED errorCode: null errorMessage: null updatedAt: '2021-04-14T09:30:24Z' rawFiles: - id: f-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' name: Screen Shot 2021-04-14 at 5.30.24 PM subType: PERSONAL_INFORMATION size: 3048 format: PNG url: >- https://file.smileapi.io/tenants/smileapi/users/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg classification: fileType: PAYSLIP analysis: null /archives/-/payslips/uploadRawFile: post: summary: Upload payslip file requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ArchivePayslipRawFileUploadRequest' description: request parameters responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArchiveResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: u-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' providerId: user-provided userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 type: 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: PAYSLIP size: 3048 format: PNG url: >- https://file.smileapi.io/tenants/smileapi/users/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg operationId: upload-payslip-file description: Upload payslip file. tags: - Archives /archives/-/payslips/queryPrediction: get: summary: Get the payslip prediction data parameters: - schema: type: string in: query name: archiveId required: true description: Archive ID responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArchivePayslipPredictionQueryResponse' operationId: get-archive-payslip-data description: Get Archive payslip data. tags: - Archives /archives/-/payslips/listPredictions: get: summary: list the payslip predictions tags: - Archives parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/startDate' - $ref: '#/components/parameters/endDate' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ArchivePayslipPredictionsListResponse' operationId: list-archive-payslip-predictions description: List Archive payslip predictions. /archives/-/payslips/sendManualResult: post: summary: Send payslip manual check result requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ArchivePayslipManualResultSendRequest' description: request parameters responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CommonResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d operationId: send-payslip-manual-result description: send payslip manual check result. tags: - Archives /uploads: get: summary: List Uploads responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UploadListResponse' examples: Example: value: 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/users/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg operationId: list-uploads description: List the user's uploads (deprecated). parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - schema: type: string format: date example: '2021-04-01' in: query name: startDate description: Filter by upload date, start of date range (YYYY-MM-DD) - schema: type: string format: date example: '2021-04-21' in: query name: endDate description: Filter by upload date, end of date range (YYYY-MM-DD) tags: - Uploads deprecated: true x-internal: false /uploads/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Upload responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UploadGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: u-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' providerId: user-provided userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 type: SOCIAL_SECURITY state: status: STARTED errorCode: null errorMessage: null updatedAt: '2021-04-14T09:30:24Z' rawFiles: - id: f-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' name: Screen Shot 2021-04-14 at 5.30.24 PM subType: PERSONAL_INFORMATION size: 3048 format: PNG url: >- https://file.smileapi.io/tenants/smileapi/users/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg operationId: get-upload description: View a user's upload by ID (deprecated). tags: - Uploads deprecated: true x-internal: false /fileTypes: get: summary: List File Types responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FileTypeListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - logoUrl: >- https://cdn.smileapi.io/image/provider-logo/v20210813064500/SOCIAL_SECURITY.png type: SOCIAL_SECURITY typeLabel: SOCIAL SECURITY Records active: true enabled: true ocr: true supported: - IDENTITIES - DOCUMENTS - EMPLOYMENTS operationId: list-file-types description: Get the available file types for uploads. tags: - File Types parameters: - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/size' - schema: type: string in: query name: type description: Filter results to certain type of file types. - schema: type: boolean in: query name: active description: Filter results to active or inactive file types. - schema: type: boolean in: query name: enabled description: Filter results to enabled or disabled file types. - schema: type: boolean in: query name: ocr description: Filter results to file types that support OCR. /identities: get: summary: List Identities tags: - Identities responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IdentityListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: i-17bbf36498de4d68a0d4f86c7b62f69f fullName: George Cimafranca Palomero, Jr firstName: George middleName: Cimafranca lastName: Palomero suffix: Jr gender: Male dob: '1970-08-24' maritalStatus: Married countryResidence: PH citizenship: Citizen photoUrl: >- https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg referenceId: george profileUrl: https://upwork.com/profiles/george.jpg emails: - address: gpalomero1234@yahoo.com type: Primary phones: - number: '+639175551234' type: Mobile socialProfiles: - socialUrl: https://www.facebook.com/gpalomero type: Facebook addresses: - fullAddress: >- 12 Maybunga St, Barangay Paraiso, Pasig City, NCR, 1600, PH line1: 12 Maybunga St line2: Barangay Paraiso city: Pasig City region: NCR zip: '1600' country: PH latitude: '14.573454' longitude: '121.085042' type: Primary metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork - id: i-24bbf36498ac4d26a0d4f86c7b62f83z fullName: Ryan Joseph Peterson Chua Ng firstName: Ryan Joseph Peterson middleName: Chua lastName: Ng suffix: null gender: Male dob: '1995-06-24' maritalStatus: Single countryResidence: null citizenship: Citizen photoUrl: >- https://cdn.smileapi.io/image/avatar/v20211115191600/ryan.jpg referenceId: ~02c0bf6ae6a581ee2b profileUrl: >- https://www.upwork.com/freelancers/~02c0bf6ae6a581ee2b emails: - address: ryan1234@gmail.com type: Primary phones: - number: '+639559994321' type: Mobile - number: '+63289053000' type: Fixed socialProfiles: - socialUrl: https://www.facebook.com/ryanpetersonng type: Facebook - socialUrl: https://www.twitter.com/xklxyz type: Twitter addresses: - fullAddress: 24 Eagle St, Binondo, Manila, NCR, 1008, PH line1: 24 Eagle St line2: Binondo city: Manila region: NCR zip: '1008' country: PH latitude: '14.600454' longitude: '120.969042' type: Primary metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork - id: i-48ace87698bd6e67a0d4f86c7b62h76c fullName: Christina Tan firstName: Christina middleName: dela Cruz lastName: Tan suffix: null gender: Female dob: '1997-02-12' maritalStatus: Single countryResidence: null citizenship: Citizen photoUrl: >- https://cdn.smileapi.io/image/avatar/v20211115191600/christina.jpg referenceId: null profileUrl: null emails: - address: christina4321@yahoo.com type: Primary phones: - number: '+639559996789' type: Mobile - number: '+639226789888' type: Mobile socialProfiles: [] addresses: - fullAddress: null line1: null line2: null city: null region: null zip: null country: PH latitude: null longitude: null type: Primary metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork operationId: list-identities description: Get a user's identity profiles from employment data sources. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/sourceId' parameters: [] /identities/{id}: get: summary: Get Identity responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IdentityGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: i-17bbf36498de4d68a0d4f86c7b62f69f fullName: George Cimafranca Palomero, Jr firstName: George middleName: Cimafranca lastName: Palomero suffix: Jr gender: Male dob: '1970-08-24' maritalStatus: Married countryResidence: PH citizenship: Citizen photoUrl: >- https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg referenceId: george profileUrl: https://upwork.com/profiles/george.jpg emails: - address: gpalomero1234@yahoo.com type: Primary phones: - number: '+639175551234' type: Mobile socialProfiles: - socialUrl: https://www.facebook.com/gpalomero type: Facebook addresses: - fullAddress: >- 12 Maybunga St, Barangay Paraiso, Pasig City, NCR, 1600, PH line1: 12 Maybunga St line2: Barangay Paraiso city: Pasig City region: NCR zip: '1600' country: PH latitude: '14.573454' longitude: '121.085042' type: Primary metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork operationId: get-identity description: Get the user's identity profile by ID. tags: - Identities parameters: [] parameters: - $ref: '#/components/parameters/id' /ratings: get: summary: List Ratings tags: - Ratings responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RatingListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: r-17bbf36498de4d68a0d4f86c7b62f69f currentRating: 90 maxRating: 100 calculatedPercentage: 90 reviewsReceived: 12 likesReceived: 8 jobsCompleted: 12 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork operationId: list-ratings description: List the user's ratings from employment data sources. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/sourceId' /ratings/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Rating tags: - Ratings responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RatingGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: r-17bbf36498de4d68a0d4f86c7b62f69f currentRating: 90 maxRating: 100 calculatedPercentage: 90 reviewsReceived: 12 likesReceived: 8 jobsCompleted: 12 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork operationId: get-rating description: View a user's ratings by ID. /documents: get: summary: List Documents tags: - Documents responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DocumentListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: d-17bbf36498de4d68a0d4f86c7b62f69f name: >- Facebook Social Media Marketing Professional Certificate docId: ABCD123456 issueDate: '2007-08-24' expiryDate: '2010-08-24' documentType: IDENTIFICATION status: VALID fileUrl: >- https://images.credly.com/size/680x680/images/c4a900b7-8d1b-4e8f-a572-347985eeaa5c/Coursera_Badge__1_.png metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: grab operationId: list-documents description: List the user's documents from employment data sources. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/sourceId' /documents/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Document tags: - Documents responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/DocumentGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: d-17bbf36498de4d68a0d4f86c7b62f69f name: Facebook Social Media Marketing Professional Certificate docId: ABCD123456 issueDate: '2007-08-24' expiryDate: '2010-08-24' fileUrl: >- https://images.credly.com/size/680x680/images/c4a900b7-8d1b-4e8f-a572-347985eeaa5c/Coursera_Badge__1_.png metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: grab operationId: get-document description: View a user's document by ID. /employments: get: summary: List Employments tags: - Employments responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EmploymentListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - 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: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: UPLOAD userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: abccorp - id: 17bbf36498de4d68a0d4f86c7b62f69f name: Executive Assistant description: >- Contribute to the efficiency of the business by providing personalized and timely support to executive members particularly the CEO. Responsibilities include managing calendars, making travel arrangements and preparing expense reports. jobTitle: EA to the CEO department: Administation employeeNumber: CDE-98765 employer: CDE Corporation status: Permanent startDate: '2015-06-14' endDate: '2016-01-30' metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: UPLOAD userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: abccorp operationId: list-employments parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/accountId' - schema: type: string format: date in: query description: Filter by employment date, start of date range (YYYY-MM-DD) name: startDate - schema: type: string format: date in: query name: endDate description: Filter by employment date, end of date range (YYYY-MM-DD) - $ref: '#/components/parameters/sourceId' description: Get the user's previous employments. parameters: [] /employments/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: Get Employment responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EmploymentGetResponse' examples: Example: value: 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: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: UPLOAD userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: abccorp operationId: get-employment tags: - Employments description: Get a user's employment by ID. /incomes: get: summary: List Incomes tags: - Incomes responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IncomeListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: inc-17bbf36498de4d68a0d4f86c7b62f69f workItem: null employer: ABC Corporation startDate: '2021-06-16' endDate: '2021-06-30' paymentMethod: Bank currency: PHP frequency: Monthly baseAmount: 8500 grossAmount: 10000 netAmount: 7820.25 metadata: createdAt: '2021-06-30T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: UPLOAD userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: abccorp - id: inc-18adf56798de4d68a9f3g34c7b62f32e workItem: null employer: ABC Corporation startDate: '2021-06-01' endDate: '2021-06-15' paymentMethod: Bank currency: PHP frequency: Monthly baseAmount: 8500 grossAmount: 10000 netAmount: 7820.25 metadata: createdAt: '2021-06-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: UPLOAD userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: abccorp operationId: list-incomes description: List the user's incomes from employment data sources. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/accountId' - schema: type: string format: date in: query name: startDate description: Filter by income date, start of date range (YYYY-MM-DD) - schema: type: string format: date in: query name: endDate description: Filter by income date, end of date range (YYYY-MM-DD) - $ref: '#/components/parameters/sourceId' /incomes/{id}: get: summary: View Income tags: - Incomes responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IncomeGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: inc-17bbf36498de4d68a0d4f86c7b62f69f workItem: null employer: ABC Corporation startDate: '2021-06-01' endDate: '2021-06-15' paymentMethod: Cash currency: PHP frequency: Monthly baseAmount: 8500 grossAmount: 10000 netAmount: 7820.25 metadata: createdAt: '2021-06-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: UPLOAD userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: abccorp operationId: get-income description: View the user's income by ID. parameters: [] parameters: - $ref: '#/components/parameters/id' /incomes/alpha/incomeestimators: post: summary: Create IncomeEstimator operationId: create-alpha-income-estimator description: > ## Create an **IncomeEstimator** object. This endpoint requires `consent`, `templateId`, `emailAddress`, and `countryCode`. ### Supported template | Template ID | Country | Required parameters | | --- | --- | --- | | `tpl-incomeestimator-001` | PH | `consent`, `templateId`, `emailAddress`, `countryCode` | ### Field rules - `templateId` must be `tpl-incomeestimator-001`. - `emailAddress` must be a valid email address. - `countryCode` identifies the country or region of the subject. ### Interpreting the result - `probability` is the raw model probability that the subject is a High earner. Use it as the primary decisioning signal. - `certainty` indicates how far `probability` is from the decision boundary of `0.5`. It is not another probability. - `tier` is a convenience label intended for presentation in your user interface. ### Sandbox Test Values | Parameter | Value | Expected Response | |----------------|-----------------------------|------------------------| | `countryCode` | `PH` | | | `emailAddress` | `gpalomero1234@smileapi.io` | `resultCode = SUCCESS` | tags: - Income Estimators (Alpha) requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/IncomeEstimatorPostRequest' examples: tpl-incomeestimator-001: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-incomeestimator-001 emailAddress: gpalomero1234@smileapi.io countryCode: PH responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IncomeEstimatorPostResponse' examples: Success: value: code: OK message: Income estimators submitted successfully. requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: ind-1234567890 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Income estimators submitted successfully. requestMeta: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-incomeestimator-001 emailAddress: gpalomero1234@smileapi.io countryCode: PH result: income: monthlyMin: 50000 monthlyMax: 100000 currency: PHP tier: HIGH probability: 0.7388 certainty: MEDIUM modelVersion: 1.0.0 get: summary: List IncomeEstimators operationId: list-alpha-income-estimators description: List all IncomeEstimator objects. tags: - Income Estimators (Alpha) parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - name: id in: query required: false schema: type: string example: ind-1234567890 description: Filter IncomeEstimator objects by a specific IncomeEstimator ID. - name: startDate in: query required: false schema: type: string format: date example: '2021-04-14' description: >- Filter IncomeEstimator objects by the start date and time of the request range. - name: endDate in: query required: false schema: type: string format: date example: '2021-04-14' description: >- Filter IncomeEstimator objects by the end date and time of the request range. - name: emailAddress in: query required: false schema: type: string format: email example: gpalomero1234@smileapi.io description: Filter IncomeEstimator objects by a specific email address. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IncomeEstimatorListResponse' examples: Success: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - id: ind-1234567890 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Income estimators submitted successfully. requestMeta: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-incomeestimator-001 emailAddress: gpalomero1234@smileapi.io countryCode: PH result: income: monthlyMin: 50000 monthlyMax: 100000 currency: PHP tier: HIGH probability: 0.7388 certainty: MEDIUM modelVersion: 1.0.0 /incomes/alpha/incomeestimators/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View IncomeEstimator operationId: get-alpha-income-estimator description: View an IncomeEstimator object by unique ID. tags: - Income Estimators (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/IncomeEstimatorGetResponse' examples: Success: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: ind-1234567890 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Income estimators submitted successfully. requestMeta: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-incomeestimator-001 emailAddress: gpalomero1234@smileapi.io countryCode: PH result: income: monthlyMin: 50000 monthlyMax: 100000 currency: PHP tier: HIGH probability: 0.7388 certainty: MEDIUM modelVersion: 1.0.0 /contributions: get: summary: List Contributions responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContributionListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: 17bbf36498de4d68a0d4f86c7b62f69f date: '2021-04-30' currency: PHP amount: 1375 referenceId: PA9634415 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: nbi_ph operationId: list-contributions description: >- Get the user's social security contributions from employment data sources. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/accountId' - $ref: '#/components/parameters/sourceId' - schema: type: string format: date in: query name: startDate description: Filter by contribution date, start of date range (YYYY-MM-DD) - schema: type: string format: date in: query name: endDate description: Filter by contribution date, end of date range (YYYY-MM-DD) tags: - Contributions /contributions/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: Get Contribution responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContributionGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: 17bbf36498de4d68a0d4f86c7b62f69f date: '2021-04-30' currency: PHP amount: 1375 referenceId: PA9634415 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: example_id operationId: get-contribution description: Get the user's contribution by ID. tags: - Contributions /liabilities: parameters: [] get: operationId: list-liabilities description: List user liabilities from employment data sources. summary: List Liabilities tags: - Liabilities responses: '200': description: Liabilities Response content: application/json: schema: $ref: '#/components/schemas/LiabilityListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: lia-123abc456def789abc123def456abc78 type: Salary Loan referenceId: SL201601011234567 startDate: '2016-07-05' firstAmortizationDate: '2016-09-01' endDate: '2017-08-01' amortizationFrequency: Monthly currency: PHP loanAmount: 16000 amortizationAmount: 738.32 outstandingBalance: 25599.76 nextPaymentAmount: 732.38 overduePaymentAmount: 0 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-123abc456def789abc123def456abc78 sourceType: ACCOUNT userId: tenantId-123abc456def789abc123def456abc78 providerId: abccorp parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/sourceId' - schema: type: string format: date example: '2021-04-01' in: query name: startDate description: Filter by startDate, start of date range (YYYY-MM-DD) - schema: type: string format: date example: '2021-04-21' in: query name: endDate description: Filter by startDate, end of date range (YYYY-MM-DD) /liabilities/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: Get Liability tags: - Liabilities responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LiabilityGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: lia-123abc456def789abc123def456abc78 type: Salary Loan referenceId: SL201601011234567 startDate: '2016-07-05' firstAmortizationDate: '2016-09-01' endDate: '2017-08-01' amortizationFrequency: Monthly currency: PHP loanAmount: 16000 amortizationAmount: 738.32 outstandingBalance: 25599.76 nextPaymentAmount: 732.38 overduePaymentAmount: 0 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-123abc456def789abc123def456abc78 sourceType: ACCOUNT userId: tenantId-123abc456def789abc123def456abc78 providerId: abccorp operationId: get-liabilities description: Get the user's liabilities by ID. /transactions: get: summary: List Transactions tags: - Transactions responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TransactionListResponse' examples: Example: value: 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: a-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: a-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: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork operationId: list-transactions description: Get the user's transactions from employment data sources. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/accountId' - schema: type: string format: date example: '2021-04-01' in: query name: startDate description: Filter by transaction date, start of date range (YYYY-MM-DD) - schema: type: string format: date example: '2021-04-21' in: query name: endDate description: Filter by transaction date, end of date range (YYYY-MM-DD) - $ref: '#/components/parameters/sourceId' /transactions/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: Get Transaction tags: - Transactions responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TransactionGetResponse' examples: Example: value: 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: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork operationId: get-transaction description: Get a user's transaction by ID. /alpha/forms: get: summary: List Forms tags: - Forms (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: form-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' name: Personal Information userId: tenant-5c1a2e8678e3494eb winkSiteId: ws-17bbf36498de4d68a0d4f86c7b62f69f winkSiteSessionId: wss-17bbf36498df69fe4d68a0d4f86c7b62 reference: form_1 data: firstName: John lastName: Doe email: john.doe@abc.com - id: form-17bbf36c7b62f69f498de4d68a0d4f86 createdAt: '2021-04-14T09:30:24Z' name: Income Information userId: tenant-5c1a2e8678e3494eb winkSiteId: ws-17bbf36498de4d68a0d4f86c7b62f69f winkSiteSessionId: wss-17bbf36498df69fe4d68a0d4f86c7b62 reference: form_2 data: monthlyIncome: 50000 employmentStatus: Active employer: ABC Corp operationId: list-alpha-forms parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - schema: type: string in: query description: Filter by wink site ID name: winkSiteId - schema: type: string format: date in: query description: Filter by form date, start of date range (YYYY-MM-DD) name: startDate - schema: type: string format: date in: query name: endDate description: Filter by form date, end of date range (YYYY-MM-DD) description: List the user's forms data. parameters: [] /alpha/forms/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Form responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/FormGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: form-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' name: Personal Information userId: tenant-5c1a2e8678e3494eb winkSiteId: ws-17bbf36498de4d68a0d4f86c7b62f69f winkSiteSessionId: wss-17bbf36498df69fe4d68a0d4f86c7b62 reference: form_1 data: firstName: John lastName: Doe email: john.doe@abc.com operationId: get-alpha-form tags: - Forms (Alpha) description: View a user's form by ID. /eincomes: parameters: [] get: operationId: list-eincomes description: >- List users' estimated income from contribution- and transaction-based data sources. This data set contains derived income amounts from a variety of sources such as social security contributions, annual salary calculations, and computed earnings from transactions in various platforms. *Estimated Incomes is currently in alpha.* summary: List Estimated Incomes tags: - Estimated Incomes responses: '200': description: Estimated Incomes Response content: application/json: schema: $ref: '#/components/schemas/EincomeListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: einc-a-123abc456def789abc123def456abc78 month: 2021-06 currency: PHP amount: 1000 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-123abc456def789abc123def456abc78 sourceType: ACCOUNT userId: tenantId-123abc456def789abc123def456abc78 providerId: abccorp parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/sourceId' - schema: type: string in: query name: startMonth description: Filter by eincome date, start of date range (YYYY-MM) - schema: type: string in: query name: endMonth description: Filter by eincome date, end of date range (YYYY-MM) /eincomes/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Estimated Income tags: - Estimated Incomes responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EincomeGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: einc-17bbf36498de4d68a0d4f86c7b62f69f month: 2021-06 currency: PHP baseAmount: 1000 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-123abc456def789abc123def456abc78 sourceType: ACCOUNT userId: tenantId-123abc456def789abc123def456abc78 providerId: abccorp operationId: get-eincomes description: View the user's estimated incomes by ID. /insights: parameters: [] get: operationId: list-insights description: List insights from data sources. summary: List insights tags: - Insights parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/sourceId' responses: '200': description: List Insights Response content: application/json: schema: $ref: '#/components/schemas/InsightListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: insight-123abc456def789abc123def456abc78 cutoffTime: '2022-07-05T10:30:11Z' features: incomes_count: 100 incomes_first_income_month_range: 10 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-123abc456def789abc123def456abc78 sourceType: ACCOUNT userId: tenantId-123abc456def789abc123def456abc78 providerId: abccorp /insights/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Insight tags: - Insights responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/InsightGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: insight-123abc456def789abc123def456abc78 cutoffTime: '2022-07-05T10:30:11Z' features: incomes_count: 100 incomes_first_income_month_range: 10 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-123abc456def789abc123def456abc78 sourceType: ACCOUNT userId: tenantId-123abc456def789abc123def456abc78 providerId: abccorp operationId: get-feature-insight description: View the user's insight by ID. /alpha/verifications: get: summary: List Verifications tags: - Verification responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VerificationListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - id: 5b79399a-6852-4234-bb0e-ad472648282d createdAt: '2021-04-14T09:30:24Z' updatedAt: '2021-04-14T09:30:24Z' status: PROCESSING errorMessage: null requestMeta: firstName: George lastName: Smith middleName: null fullName: George Smith additionalData: ids: - idType: tin_ph idSubType: null idNumber: 1234567890 consent: type: Terms And Conditions version: 1 consentedWith: I aggree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null result: null - id: 5b79399a-6853-4234-bb0e-ad472648282d createdAt: '2021-04-14T09:30:24Z' updatedAt: '2021-04-14T09:30:24Z' status: COMPLETED errorMessage: null requestMeta: firstName: George2 lastName: Smith middleName: null fullName: George2 Smith additionalData: ids: - idType: tin_ph idSubType: null idNumber: 1234567890 dob: '1990-01-01' gender: Female address: null employer: null employmentStatus: null email: someone@gmail.com phone: 639123456789 consent: type: Terms And Conditions version: 1 consentedWith: I aggree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null result: finalMatches: true names: firstNameMatches: true lastNameMatches: true middleNameMatches: null fullNameMatches: true additionalData: ids: - idType: tin_ph idSubType: null idNumber: 1234567890 matches: true dobMatches: true genderMatches: false addressMatches: null phoneMatches: value: 639123456789 matches: true disposable: false deliverable: null active: true provider: Smart Communications freeProvider: false emailMatches: value: someone@gmail.com matches: true disposable: false deliverable: true active: true provider: Google LLC freeProvider: true operationId: list-verifications description: List verificatins. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - name: verificationId in: query required: false schema: type: string description: Filter to those associated with a particular verification ID. - name: finalMatches in: query required: false schema: type: boolean description: Filter to those associated with verification final match result. - schema: type: string format: date in: query name: startDate description: Filter by create date, start of date range (YYYY-MM-DD) - schema: type: string format: date in: query name: endDate description: Filter by create date, end of date range (YYYY-MM-DD) post: summary: Request Verification tags: - Verification requestBody: content: application/json: schema: $ref: '#/components/schemas/VerificationCreateRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VerificationCreateResponse' operationId: create-verification description: sumbit required parameters to request verification. /alpha/verifications/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: Get Verification tags: - Verification responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VerificationGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: 5b79399a-6853-4234-bb0e-ad472648282d createdAt: '2021-04-14T09:30:24Z' updatedAt: '2021-04-14T09:30:24Z' status: COMPLETED errorMessage: null requestMeta: firstName: George2 lastName: Smith middleName: null fullName: George2 Smith additionalData: ids: - idType: tin_ph idSubType: null idNumber: 1234567890 dob: '1990-01-01' gender: Female address: null employer: null employmentStatus: null email: someone@gmail.com phone: 639123456789 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null result: finalMatches: true names: firstNameMatches: true lastNameMatches: true middleNameMatches: null fullNameMatches: true additionalData: ids: - idType: tin_ph idSubType: null idNumber: 1234567890 matches: true dobMatches: true genderMatches: false addressMatches: null phoneMatches: value: 639123456789 matches: true disposable: false deliverable: null active: true provider: Smart Communications freeProvider: false emailMatches: value: someone@gmail.com matches: true disposable: false deliverable: true active: true provider: Google LLC freeProvider: true operationId: get-verification description: Get verification by ID. /alpha/signals: post: summary: Create Signal operationId: create-alpha-signal tags: - Signals (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SignalPostResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: signal-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' requestMeta: phone: '+639178902345' consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d result: events_arbitrary_day30: 0 events_preloan_day30: 0 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SignalPostRequest' get: summary: List Signals tags: - Signals (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SignalListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - signal: id: signal-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' requestMeta: phone: '+639178902345' consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d result: events_arbitrary_day30: 0 events_preloan_day30: 0 operationId: list-alpha-signals description: List all Signals. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - name: signalId in: query required: false schema: type: string description: Filter Signal Requests by a specific Signal Request ID. - name: phone in: query required: false schema: type: string description: Filter Signal Requests by a specific mobile phone. - schema: type: string format: date in: query name: startDate description: >- Filter Signal Requests by request date, start of date range (YYYY-MM-DD) - schema: type: string format: date in: query name: endDate description: >- Filter Signal Requests by request date, end of date range (YYYY-MM-DD) /alpha/signals/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Signal description: View Signal by unique ID. operationId: get-alpha-signal tags: - Signals (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SignalGetResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: signal-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' requestMeta: phone: '+639178902345' consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d result: events_arbitrary_day30: 0 events_preloan_day30: 0 /beta/signals: post: summary: Create Signal description: > ## Create a **Signal** object. This endpoint requires the following mandatory parameters: `consent`, `phone`, `countryCode`, and `templateId`. ### Supported Template | Template ID | Region | Required Parameters | |-----------------------------------------------------------|--------------|-------------------------------------------------| | `tpl-sgn003001` | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | | `signalTpl-cb19dbc4d13b985674bd5f20bfeee7e8` (deprecated) | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | | `signalTpl-f250f305c3bf0aa690cca93ef0f0fb03` (deprecated) | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | | `signalTpl-f6b74d81a4807f4c01e6a920920775ad` (deprecated) | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | | `signalTpl-7a01659636c119ca4566308effd05d06` (deprecated) | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | | `signalTpl-e5ba74fe8089fe44eeeafb68991b1e70` (deprecated) | PH (default) | `consent`, `templateId`, `countryCode`, `phone` | ### Field Guidelines - `phone` must include the country code (e.g., `+639559991234` or `639559991234`) - MD5 encryption is supported using the format: `MD5(countryCode + phone)`, e.g., `MD5(+639559991234)` ### Sandbox Test Values | Parameter | Value | Expected Response | |---------------|-----------------|------------------------| | `templateId` | `tpl-sgn003001` | | | `countryCode` | `PH` | | | `phone` | `639559991234` | `resultCode = SUCCESS` | For all other valid `phone` and `countryCode` combinations, the response will return: `resultCode = NO_DATA`, and no items will be included. You may also contact **Smile** to request additional specialized `templateId`s for other regions or business cases. operationId: create-beta-signal tags: - Signals (Beta) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BetaSignalPostResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: signal-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' signalType: Signal1 requestMeta: phone: '+639178902345' emailAddress: null fullName: null curp: null nss: null countryCode: PH templateId: tpl-sgn002001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d items: - name: events_arbitrary_day30 value: '0' valueType: NUMBER - name: events_preloan_day30 value: '0' valueType: NUMBER - name: events_debt_day90_amount value: A0 valueType: STRING requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BetaSignalPostRequest' get: summary: List Signals operationId: list-beta-signals tags: - Signals (Beta) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BetaSignalListResponse' examples: Signal1: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - signal: id: signal-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' signalType: Signal1 requestMeta: phone: '+639178902345' emailAddress: null fullName: null curp: null nss: null countryCode: PH templateId: tpl-sgn002001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d items: - name: events_arbitrary_day30 value: '0' valueType: NUMBER - name: events_preloan_day30 value: '0' valueType: NUMBER - name: events_debt_day90_amount value: A0 valueType: STRING Signal2: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - signal: id: signal-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' signalType: Signal2 requestMeta: phone: '639178902345' emailAddress: null fullName: null curp: null nss: null countryCode: PH templateId: tpl-sgn003001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d items: - name: events_arbitrary_day30 value: 0 valueType: NUMBER - name: events_preloan_day30 value: 0 valueType: NUMBER - name: events_debt_day90_amount value: A0 valueType: STRING description: List all Signals. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - name: signalId in: query required: false schema: type: string description: Filter Signal Requests by a specific Signal Request ID. - name: signalType in: query required: false schema: $ref: '#/components/schemas/SignalType' description: Filter Signal Requests by a specific Signal Type. - name: phone in: query required: false schema: type: string description: Filter Signal Requests by a specific mobile phone. - schema: type: string format: date in: query name: startDate description: >- Filter Signal Requests by request date, start of date range (YYYY-MM-DD) - schema: type: string format: date in: query name: endDate description: >- Filter Signal Requests by request date, end of date range (YYYY-MM-DD) /beta/signals/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Signal description: View Signal by unique ID. operationId: get-beta-signal tags: - Signals (Beta) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BetaSignalGetResponse' examples: Signal1: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: signal-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' signalType: Signal1 requestMeta: phone: '+639178902345' emailAddress: null fullName: null curp: null nss: null countryCode: PH templateId: tpl-sgn002001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - name: events_arbitrary_day30 value: '0' valueType: NUMBER - name: events_preloan_day30 value: '0' valueType: NUMBER - name: events_debt_day90_amount value: A0 valueType: STRING Signal2: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: signal-bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' signalType: Signal2 requestMeta: phone: '639178902345' emailAddress: null fullName: null curp: null nss: null countryCode: PH templateId: tpl-sgn003001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - name: events_arbitrary_day30 value: '0' valueType: NUMBER - name: events_preloan_day30 value: '0' valueType: NUMBER - name: events_debt_day90_amount value: A0 valueType: STRING /beta/signals/createSignal2: post: summary: Create Signal2 description: >+ ## Create a **Signal2** object. This endpoint requires the following mandatory parameters: `consent`, `phone`, `countryCode`, and `templateId`. ### Supported Template | Template ID | Region | Required Parameters | |-----------------|-----------------------------------------------------------------------------------------|-------------------------------------------------| | `tpl-sgn002001` | IN (India), MX (Mexico), PH (Philippines), ID (Indonesia), CO (Colombia), TH (Thailand) | `consent`, `templateId`, `countryCode`, `phone` | ### Field Guidelines - `phone` must include the country code without leading '+' (e.g., `639559991234`) - MD5 encryption is supported using the format: `MD5(countryCode + phone)`, e.g., `MD5(639559991234)` ### Sandbox Test Values | Parameter | Value | Expected Response | |---------------|-----------------|------------------------| | `templateId` | `tpl-sgn002001` | | | `countryCode` | e.g., `PH` | | | `phone` | `639559991234` | `resultCode = SUCCESS` | For all other valid `phone` and `countryCode` combinations, the response will return: `resultCode = NO_DATA`, and no items will be included. You may also contact **Smile** to request additional specialized `templateId`s for other regions or business cases. operationId: create-beta-signal2 tags: - Signals (Beta) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BetaSignalPostResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: signal-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' signalType: Signal2 requestMeta: phone: '639559991234' emailAddress: null fullName: null curp: null nss: null countryCode: PH templateId: tpl-sgn003001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - name: events_arbitrary_day30 value: 0 valueType: NUMBER - name: events_preloan_day30 value: 0 valueType: NUMBER - name: events_debt_day90_amount value: A0 valueType: STRING requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BetaSignal2PostRequest' /beta/signals/createSignal3: post: summary: Create Signal3 description: >+ ## Create a Signal3 object. This endpoint supports different templates depending on region and use case. Required parameters: `consent`, `templateId`, plus additional fields depending on the selected template. ### Supported Templates | Template ID | Region(s) | Required Parameters | |-----------------------------------|---------------|--------------------------------------------------| | `tpl-sgn003002` | MX (Mexico) | `phone`, `fullName`, `curp` | | `tpl-social-securities-signal-th` | TH (Thailand) | `fullName`, `mobileNumber`, `idType`, `idNumber` | ### Sandbox Test Values | Template ID | Parameters | Expected Response | |-----------------------------------|--------------------------------------------------------------------------------------------------|------------------------| | `tpl-sgn003002` | `phone = 529559991234`, `fullName = John Doe`, `curp = DOEJ800101HDFXXX01` | `resultCode = SUCCESS` | | `tpl-social-securities-signal-th` | `mobileNumber = 669178912345`, `fullName = John Doe`, `idType = PID`, `idNumber = 1234567890123` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system returns `resultCode = NO_DATA` and the response contains no items. ### Remarks In production mode, if the API request is successful, a Signal3 object will be created with the status of `PROCESSING`. When the Status becomes `COMPLETED` or `ERROR`. operationId: create-beta-signal3 tags: - Signals (Beta) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BetaSignalPostResponse' examples: Example_MX: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: signal-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' signalType: Signal3 requestMeta: emailAddress: john.doe@example.com fullName: John Doe phone: '529559991234' curp: DOEJ800101HDFXXX01 nss: '12345678901' templateId: tpl-sgn003002 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - name: events_arbitrary_day30 value: '0' valueType: NUMBER - name: events_preloan_day30 value: '0' valueType: NUMBER - name: events_debt_day90_amount value: A0 valueType: STRING Example_TH: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: signal-f46e632fg9g258d5bb12c8d2bg96bbg8 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' signalType: Signal3 requestMeta: fullName: John Doe mobileNumber: '669178912345' idType: PID idNumber: '1234567890123' templateId: tpl-social-securities-signal-th consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - name: events_arbitrary_day30 value: '0' valueType: NUMBER - name: events_preloan_day30 value: '0' valueType: NUMBER - name: events_debt_day90_amount value: A0 valueType: STRING requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BetaSignal3PostRequest' examples: Example_MX: value: emailAddress: john.doe@example.com fullName: John Doe phone: '529559991234' curp: DOEJ800101HDFXXX01 nss: '12345678901' templateId: tpl-sgn003002 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null Example_TH: value: fullName: John Doe mobileNumber: '669178912345' idType: PID idNumber: '1234567890123' templateId: tpl-social-securities-signal-th consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null /alpha/footprints: post: summary: Create Footprint operationId: create-alpha-footprint description: >- ## Create a **Footprint** object. This endpoint requires the following mandatory parameters: - `consent` - `templateId` Additional required fields depend on the selected `templateId`. ### Supported Templates | Template ID | Input Type | Required Parameters | |-------------------------|------------------------|-------------------------------------------------------------| | `tpl-email-footprint` | Email address only | `consent`, `templateId`, `emailAddress`, `countryCode` | | `tpl-mobile-footprint` | Mobile number only | `consent`, `templateId`, `mobileNumber`, `countryCode` | | `tpl-score-footprint` | Email + mobile number | `consent`, `templateId`, `emailAddress`, `mobileNumber`, `countryCode` | | `tpl-ftp005001` (deprecated) | Email address only | `consent`, `templateId`, `emailAddress`, `countryCode` | | `tpl-ftp005002` (deprecated) | Mobile number only | `consent`, `templateId`, `mobileNumber`, `countryCode` | ### Field Rules - For `tpl-ftp005001`, `emailAddress` **must** be provided and `mobileNumber` should be omitted or `null`. - For `tpl-ftp005002`, `mobileNumber` **must** be provided and `emailAddress` should be omitted or `null`. - For `tpl-score-footprint`, `emailAddress` **and** `mobileNumber` **must** both be provided. - For all templates, `countryCode` is required and must be a valid ISO country code. ### Sandbox Test Values | Template ID | Test Input | Expected Response | |-------------------------|---------------------------------------------------------------------------------------------|------------------------| | `tpl-email-footprint` | `emailAddress = gpalomero1234@smileapi.io`, `countryCode = PH` | `resultCode = SUCCESS` | | `tpl-mobile-footprint` | `mobileNumber = 639559991234`, `countryCode = PH` | `resultCode = SUCCESS` | | `tpl-score-footprint` | `emailAddress = gpalomero1234@smileapi.io`, `mobileNumber = 639559991234`, `countryCode = PH` | `resultCode = SUCCESS` | For all other valid input combinations, if no mock data is matched, the response will return: `resultCode = NO_DATA`, and no items will be included. tags: - Footprints (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaFootprintPostResponse' examples: Example_Email: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: footprint-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' requestMeta: emailAddress: gpalomero1234@smileapi.io mobileNumber: null countryCode: PH templateId: tpl-email-footprint footprintItemsTimeout: 5 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - name: email.registered value: 'false' valueType: BOOLEAN - name: email.creationTime value: '2021-04-14T09:30:24Z' valueType: STRING - name: email.companyName value: Google valueType: STRING Example_Mobile: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: footprint-e35d5af85aaf721ef8f147c4aa01b7c1 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' requestMeta: emailAddress: null templateId: tpl-mobile-footprint mobileNumber: '639559991234' countryCode: PH footprintItemsTimeout: 10 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - name: mobile.valid value: 'false' valueType: BOOLEAN - name: mobile.creationTime value: '2021-04-14T09:30:24Z' valueType: STRING - name: mobile.companyName value: Globe valueType: STRING Example_Score: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: footprint-e35d5af85aaf721ef8f147c4aa01b7c2 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' requestMeta: emailAddress: gpalomero1234@smileapi.io templateId: tpl-score-footprint mobileNumber: '639559991234' countryCode: PH footprintItemsTimeout: 5 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - name: email.registered value: 'true' valueType: BOOLEAN - name: email.creationTime value: '2021-04-14T09:30:24Z' valueType: STRING - name: email.companyName value: Google valueType: STRING - name: mobile.valid value: 'true' valueType: BOOLEAN - name: mobile.creationTime value: '2021-04-14T09:30:24Z' valueType: STRING - name: mobile.companyName value: Globe valueType: STRING - name: analysis.fraudScore value: '50' valueType: NUMBER requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AlphaFootprintPostRequest' examples: Example_Email: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-email-footprint emailAddress: gpalomero1234@smileapi.io mobileNumber: null countryCode: PH footprintItemsTimeout: 5 Example_Mobile: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-mobile-footprint emailAddress: null mobileNumber: '639559991234' countryCode: PH footprintItemsTimeout: 10 Example_Score: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-score-footprint emailAddress: gpalomero1234@smileapi.io mobileNumber: '639559991234' countryCode: PH footprintItemsTimeout: 5 get: summary: List Footprints operationId: list-alpha-footprints tags: - Footprints (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaFootprintListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - id: footprint-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' requestMeta: emailAddress: someone@email.com templateId: tpl-email-footprint mobileNumber: null countryCode: null footprintItemsTimeout: 15 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - name: email.registered value: 'false' valueType: BOOLEAN - name: email.creationTime value: '2021-04-14T09:30:24Z' valueType: STRING - name: email.companyName value: Google valueType: STRING description: List all Footprints. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - name: footprintId in: query required: false schema: type: string description: Filter footprints by a specific Footprint ID. - name: emailAddress in: query required: false schema: type: string description: Filter footprints by a specific email address. - name: mobileNumber in: query required: false schema: type: string description: Filter footprints by a specific mobile number. - schema: type: string format: date in: query name: startDate description: >- Filter footprints by the start date of the request range (YYYY-MM-DD). - schema: type: string format: date in: query name: endDate description: Filter footprints by the end date of the request range (YYYY-MM-DD). /alpha/footprints/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Footprint description: View Footprint by unique ID. operationId: get-alpha-footprint tags: - Footprints (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaFootprintGetResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: footprint-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' requestMeta: emailAddress: someone@email.com templateId: tpl-email-footprint mobileNumber: null countryCode: null footprintItemsTimeout: 20 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - name: email.registered value: 'false' valueType: BOOLEAN - name: email.creationTime value: '2021-04-14T09:30:24Z' valueType: STRING - name: email.companyName value: Google valueType: STRING /links: parameters: [] get: operationId: list-links description: List links from data sources. summary: List links tags: - Links parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/sourceId' responses: '200': description: List Links Response content: application/json: schema: $ref: '#/components/schemas/LinkListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: link-123abc456def789abc123def456abc78 startDate: '2023-01-05T10:30:11Z' endDate: '2023-07-05T10:30:11Z' records: - count: 2 linkedAt: - '2023-04-05T10:30:11Z' - '2023-07-01T10:30:11Z' metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-123abc456def789abc123def456abc78 sourceType: ACCOUNT userId: tenantId-123abc456def789abc123def456abc78 providerId: abccorp /links/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Link operationId: get-link description: View the Account's link result by ID. tags: - Links responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LinkGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: link-123abc456def789abc123def456abc78 startDate: '2023-01-05T10:30:11Z' endDate: '2023-07-05T10:30:11Z' records: - count: 2 linkedAt: - '2023-04-05T10:30:11Z' - '2023-07-01T10:30:11Z' metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-123abc456def789abc123def456abc78 sourceType: ACCOUNT userId: tenantId-123abc456def789abc123def456abc78 providerId: abccorp /alpha/maws: post: summary: Create Maw operationId: create-alpha-maw description: >- ## Create a Maw2 object. This endpoint requires **four mandatory parameters**: `consent`, `mobileNumber`, `countryCode`, and `templateId`. ### Supported Template | Template ID | Region(s) | Required Parameters | |--------------------------------------------------------|--------------------------------------------------------------------------------------|-------------------------------| | `tpl-maw002001` | IN (India), MX (Mexico), PH (Philippines),ID (Indonesia),CO (Colombia),TH (Thailand) | `mobileNumber`, `countryCode` | | `mawTpl-bfc93eb72d24860bf62429a1dd06708d` (deprecated) | IN (India), MX (Mexico), PH (Philippines),ID (Indonesia),CO (Colombia),TH (Thailand) | `mobileNumber`, `countryCode` | ### Sandbox Test Values | Parameter | Value | Expected Response | |--------------|-----------------|------------------------| | templateId | `tpl-maw002001` | | | countryCode | `PH` | | | mobileNumber | `639559991234` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system returns `resultCode = NO_DATA` and the response contains no items. tags: - Maws (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaMawPostResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! requestMeta: mobileNumber: '6381789801234' countryCode: PH templateId: tpl-maw002001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - date: '2021-04-14' level: '2' source: seat duration: '10' platformId: 5b79399a68524234bb0ead472648282d - date: '2021-03-14' level: '3' source: sms duration: null platformId: 5b79399a68524234bb0ead472648282d requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AlphaMawPostRequest' examples: Example: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-maw002001 mobileNumber: '6381789801234' countryCode: PH get: summary: List Maws operationId: list-alpha-maws tags: - Maws (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaMawListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' requestMeta: mobileNumber: '6381789801234' countryCode: PH templateId: mawTpl-xxxxxxxxxxxxxxx consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - date: '2021-04-14' level: '2' source: seat duration: '10' platformId: 5b79399a68524234bb0ead472648282d - date: '2021-03-14' level: '3' source: sms duration: null platformId: 5b79399a68524234bb0ead472648282d description: List all Maws. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - name: mawId in: query required: false schema: type: string description: Filter maws by a specific Maw ID. - name: mobileNumber in: query required: false schema: type: string description: Filter maws by a specific mobile number. - schema: type: string format: date in: query name: startDate description: Filter maws by the start date of the request range (YYYY-MM-DD). - schema: type: string format: date in: query name: endDate description: Filter maws by the end date of the request range (YYYY-MM-DD). /alpha/maws/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Maw description: View Maw by unique ID. operationId: get-alpha-maw tags: - Maws (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaMawGetResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: '' resultMessage: '' requestMeta: mobileNumber: '6381789801234' countryCode: PH templateId: mawTpl-xxxxxxxxxxxxxxx consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null items: - date: '2021-04-14' level: '2' source: seat duration: '10' platformId: 5b79399a68524234bb0ead472648282d - date: '2021-03-14' level: '3' source: sms duration: null platformId: 5b79399a68524234bb0ead472648282d /beta/maws/requestMaw2: post: summary: Create Maw2 operationId: create-beta-maw2 description: >- ## Create a Maw2 object. This endpoint requires **four mandatory parameters**: `consent`, `mobileNumber`, `countryCode`, and `templateId`. ### Supported Template | Template ID | Region(s) | Required Parameters | |--------------------------------------------------------|--------------------------------------------------------------------------------------|-------------------------------| | `tpl-maw002001` | IN (India), MX (Mexico), PH (Philippines),ID (Indonesia),CO (Colombia),TH (Thailand) | `mobileNumber`, `countryCode` | | `mawTpl-bfc93eb72d24860bf62429a1dd06708d` (deprecated) | IN (India), MX (Mexico), PH (Philippines),ID (Indonesia),CO (Colombia),TH (Thailand) | `mobileNumber`, `countryCode` | ### Sandbox Test Values | Parameter | Value | Expected Response | |--------------|-----------------|------------------------| | templateId | `tpl-maw002001` | | | countryCode | `PH` | | | mobileNumber | `639559991234` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system returns `resultCode = NO_DATA` and the response contains no items. tags: - Maws (Beta) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BetaMawPostResponse' examples: tpl-maw002001: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW2 requestMeta: mobileNumber: '6381789801234' countryCode: PH templateId: tpl-maw002001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: - date: '2021-04-14' level: '2' source: seat duration: '10' platformId: 5b79399a68524234bb0ead472648282d - date: '2021-03-14' level: '3' source: sms duration: null platformId: 5b79399a68524234bb0ead472648282d maw3Items: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BetaMaw2PostRequest' examples: tpl-maw002001: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-maw002001 mobileNumber: '6381789801234' countryCode: PH /beta/maws/requestMaw3: post: summary: Create Maw3 operationId: create-beta-maw3 description: >- ## Create a **Maw** object. This endpoint supports different templates depending on region and use case. Required parameters: `consent`, `templateId`, plus additional fields depending on the selected template. ### Supported Templates | Template ID | Region | Required Parameters | |-----------------|------------------|-----------------------------------------------------------------------------| | `tpl-maw004001` | Mexico (MX) | `mobileNumber`, `countryCode`, `fullName`, `idType=NATIONAL_ID`, `idNumber` | | `tpl-maw004002` | Africa countries | `gaid` | | `tpl-maw004003` | Philippines (PH) | `mobileNumber`, `countryCode`, `fullName`, `idType=NATIONAL_ID`, `idNumber` | ### Sandbox Test Values | Template ID | Parameters | Expected Response | |-----------------|---------------------------------------------------------------------------------------------------------|------------------------| | `tpl-maw004001` | `mobileNumber = 529559991234`, `countryCode = MX`, `fullName = George`, `idNumber = ZAZD801124MBSYQN13` | `resultCode = SUCCESS` | | `tpl-maw004002` | `gaid = '00000000-0000-0000-0000-000000000000'` | `resultCode = SUCCESS` | | `tpl-maw004003` | `mobileNumber = 639559991234`, `countryCode = PH`, `fullName = George`, `idNumber = 4561234567` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system will return: `resultCode = NO_DATA`, and no items will be included in the response. tags: - Maws (Beta) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BetaMawPostResponse' examples: tpl-maw004001: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW3 requestMeta: templateId: tpl-maw004001 mobileNumber: '6381789801234' countryCode: MX fullName: George idNumber: '12345678901234' idType: NATIONAL_ID gaid: '' consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: [] maw3Items: - name: events_i_daydiff_loan_g_30day_l1imbank_max value: '5' valueType: NUMBER - name: events_m_ds_all_g_15day_d_count value: '2021-04-14T09:30:24Z' valueType: NUMBER - name: events_gaid_timediff_loan_g_60day value: '888' valueType: NUMBER tpl-maw004002: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW3 requestMeta: templateId: tpl-maw004002 gaid: 00000000-0000-0000-0000-000000000000 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: [] maw3Items: - name: events_i_daydiff_loan_g_30day_l1imbank_max value: '5' valueType: NUMBER - name: events_m_ds_all_g_15day_d_count value: '2021-04-14T09:30:24Z' valueType: NUMBER - name: events_gaid_timediff_loan_g_60day value: '888' valueType: NUMBER tpl-maw004003: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW3 requestMeta: templateId: tpl-maw004003 mobileNumber: '639559991234' countryCode: PH fullName: George idNumber: '4561234567' idType: TIN gaid: '' consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: [] maw3Items: - name: events_i_daydiff_loan_g_30day_l1imbank_max value: '5' valueType: NUMBER - name: events_m_ds_all_g_15day_d_count value: '2021-04-14T09:30:24Z' valueType: NUMBER - name: events_gaid_timediff_loan_g_60day value: '888' valueType: NUMBER requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BetaMaw3PostRequest' examples: tpl-maw004001: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-maw004001 mobileNumber: '6381789801234' countryCode: MX fullName: George idNumber: '12345678901234' idType: NATIONAL_ID gaid: '' tpl-maw004002: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-maw004002 gaid: 00000000-0000-0000-0000-000000000000 tpl-maw004003: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-maw004003 mobileNumber: '639559991234' countryCode: PH fullName: George idNumber: '4561234567' idType: TIN gaid: '' /beta/maws: get: summary: List Maws operationId: list-beta-maws tags: - Maws (Beta) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BetaMawListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW2 requestMeta: mobileNumber: '6381789801234' countryCode: PH templateId: tpl-maw002001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: - date: '2021-04-14' level: '2' source: seat duration: '10' platformId: 5b79399a68524234bb0ead472648282d - date: '2021-03-14' level: '3' source: sms duration: null platformId: 5b79399a68524234bb0ead472648282d maw3Items: null - id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW3 requestMeta: templateId: tpl-maw004002 gaid: 00000000-0000-0000-0000-000000000000 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: [] maw3Items: - name: events_i_daydiff_loan_g_30day_l1imbank_max value: '5' valueType: NUMBER - name: events_m_ds_all_g_15day_d_count value: '2021-04-14T09:30:24Z' valueType: NUMBER - name: events_gaid_timediff_loan_g_60day value: '888' valueType: NUMBER - id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW3 requestMeta: templateId: tpl-maw004001 mobileNumber: '6381789801234' countryCode: MX fullName: George idNumber: '12345678901234' idType: NATIONAL_ID gaid: nulL consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: [] maw3Items: - name: events_i_daydiff_loan_g_30day_l1imbank_max value: '5' valueType: NUMBER - name: events_m_ds_all_g_15day_d_count value: '2021-04-14T09:30:24Z' valueType: NUMBER - name: events_gaid_timediff_loan_g_60day value: '888' valueType: NUMBER description: List all Maws. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - name: mawId in: query required: false schema: type: string description: Filter Maws by a specific Maw ID. - name: mawType in: query required: false schema: $ref: '#/components/schemas/MawType' description: Filter maws by a specific Maw Type. - name: mobileNumber in: query required: false schema: type: string description: Filter Maws by a specific mobile number. - schema: type: string format: date in: query name: startDate description: Filter Maws by the start date of the request range (YYYY-MM-DD). - schema: type: string format: date in: query name: endDate description: Filter Maws by the end date of the request range (YYYY-MM-DD). /beta/maws/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Maw description: View Maw by unique ID. operationId: get-beta-maw tags: - Maws (Beta) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BetaMawGetResponse' examples: tpl-maw002001: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW2 requestMeta: mobileNumber: '6381789801234' countryCode: PH templateId: tpl-maw002001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: - date: '2021-04-14' level: '2' source: seat duration: '10' platformId: 5b79399a68524234bb0ead472648282d - date: '2021-03-14' level: '3' source: sms duration: null platformId: 5b79399a68524234bb0ead472648282d maw3Items: [] tpl-maw004001: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW3 requestMeta: templateId: tpl-maw004001 mobileNumber: '6381789801234' countryCode: MX fullName: George idNumber: '12345678901234' idType: NATIONAL_ID gaid: nulL consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: [] maw3Items: - name: events_i_daydiff_loan_g_30day_l1imbank_max value: '5' valueType: NUMBER - name: events_m_ds_all_g_15day_d_count value: '2021-04-14T09:30:24Z' valueType: NUMBER - name: events_gaid_timediff_loan_g_60day value: '888' valueType: NUMBER tpl-maw004002: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW3 requestMeta: templateId: tpl-maw004002 gaid: 00000000-0000-0000-0000-000000000000 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: [] maw3Items: - name: events_i_daydiff_loan_g_30day_l1imbank_max value: '5' valueType: NUMBER - name: events_m_ds_all_g_15day_d_count value: '2021-04-14T09:30:24Z' valueType: NUMBER - name: events_gaid_timediff_loan_g_60day value: '888' valueType: NUMBER tpl-maw004003: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: maw-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: MAW3 requestMeta: templateId: tpl-maw004003 mobileNumber: '639559991234' countryCode: PH fullName: George idNumber: '4561234567' idType: TIN gaid: '' consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null maw2Items: [] maw3Items: - name: events_i_daydiff_loan_g_30day_l1imbank_max value: '5' valueType: NUMBER - name: events_m_ds_all_g_15day_d_count value: '2021-04-14T09:30:24Z' valueType: NUMBER - name: events_gaid_timediff_loan_g_60day value: '888' valueType: NUMBER /alpha/validations: get: summary: List Validations description: List previously submitted validations. operationId: list-alpha-validations tags: - Validations (Alpha) parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - $ref: '#/components/parameters/userId' - $ref: '#/components/parameters/startDate' - $ref: '#/components/parameters/endDate' - name: type in: query required: false schema: type: string description: Filter by validation type (e.g. BankAccount). responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaValidationListResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - id: vld-00d49fe7b5834ba79474cb1373998ff3 createdAt: '2025-01-21T02:22:24Z' status: COMPLETED resultCode: PASSED resultMessage: null result: type: BankAccount matchScore: 100 matchScoreDescription: Strong Match requestMeta: name: George idType: national_id idNumber: '' countryCode: PH bic: '' iban: AT610904300234573201 accountNumber: '' templateId: tpl-vld006001 consent: type: Terms version: '1.0' consentedAt: '2025-01-20T12:00:00Z' consentedWith: I aggree to ... consentTemplateId: null /alpha/validations/validateBankAccount: post: summary: Validate Bank Account description: Submit bank account details for validation. operationId: alpha-validate-bank-account tags: - Validations (Alpha) requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AlphaValidationValidateBankAccountRequest' examples: Example: value: name: George idType: national_id idNumber: '' countryCode: PH bic: '' iban: AT610904300234573201 accountNumber: '' templateId: tpl-vld006001 consent: type: Terms version: '1.0' consentedAt: '2025-01-20T12:00:00Z' consentedWith: I agree to ... consentTemplateId: null responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaValidationCreateResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: vld-00d49fe7b5834ba79474cb1373998ff3 createdAt: '2025-01-21T02:22:24Z' status: COMPLETED resultCode: PASSED resultMessage: null result: type: BankAccount matchScore: 100 matchScoreDescription: Strong Match requestMeta: name: George idType: national_id idNumber: '' countryCode: PH bic: '' iban: AT610904300234573201 accountNumber: '' templateId: tpl-vld006001 consent: type: Terms version: '1.0' consentedAt: '2025-01-20T12:00:00Z' consentedWith: I aggree to ... consentTemplateId: null /alpha/validations/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Validation description: Retrieve a validation by ID. operationId: get-alpha-validation tags: - Validations (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaValidationGetResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: vld-00d49fe7b5834ba79474cb1373998ff3 createdAt: '2025-01-21T02:22:24Z' status: COMPLETED resultCode: PASSED resultMessage: null result: type: BankAccount matchScore: 100 matchScoreDescription: Strong Match requestMeta: name: George idType: national_id idNumber: '' countryCode: PH bic: '' iban: AT610904300234573201 accountNumber: '' templateId: tpl-vld006001 consent: type: Terms version: '1.0' consentedAt: '2025-01-20T12:00:00Z' consentedWith: I aggree to ... consentTemplateId: null /alpha/blacklists: post: summary: Create Blacklist1 operationId: create-alpha-blacklist description: >- ## Create a **Blacklist** object. This endpoint requires the following input parameters: `consent`, `mobileNumber`, `templateId`, and `countryCode`. ### Default Behavior - If `templateId` is **not provided**, it defaults to `tpl-blk002001`. - If `countryCode` is **omitted**, it defaults to `PH`. ### Supported Template | Template ID | Region | Required Parameters | |--------------------------------------------------------------|--------------|--------------------------------------------------------| | `tpl-blk002001` | PH (default) | `consent`, `mobileNumber`, `countryCode`, `templateId` | | `blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e` (deprecated) | PH (default) | `consent`, `mobileNumber`, `countryCode`, `templateId` | ### Field Rules - `templateId` is optional; if missing, the system uses `tpl-blk002001`. - `countryCode` is also optional; if omitted, it defaults to `PH`. ### Sandbox Test Values | Parameter | Value | Expected Response | |-----------------|------------------|----------------------------------------| | `mobileNumber` | `639559991234` | | | `countryCode` | `PH` | `resultCode = SUCCESS`, `hit = true` | For all other valid mobile number and country code combinations, the response will return: `resultCode = SUCCESS`, but `hit = false`. tags: - Blacklists (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaBlacklistPostResponse' examples: tpl-blk002001: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: blacklist-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: BLACKLIST1 requestMeta: mobileNumber: '639559991234' countryCode: PH applicationDate: '2023-01-21' templateId: tpl-blk002001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null result: hit: true dates: - '2021-04-14' - '2021-03-14' - '2021-02-14' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AlphaBlacklist1PostRequest' examples: tpl-blk002001: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-blk002001 mobileNumber: '639559991234' applicationDate: '2023-01-21' countryCode: PH get: summary: List Blacklists operationId: list-alpha-blacklists tags: - Blacklists (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaBlacklistListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: null items: - id: blacklist-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: BLACKLIST1 requestMeta: mobileNumber: '639559991234' countryCode: PH applicationDate: '2023-01-21' templateId: tpl-blk002001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null result: hit: true dates: - '2021-04-14' - '2021-03-14' - '2021-02-14' - id: blacklist-f45d521ef8f147c4aa01b7c1af85aaf8 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: BLACKLIST2 requestMeta: mobileNumber: '639559991234' idType: TIN idNumber: '4561234567' countryCode: PH applicationDate: null templateId: tpl-blacklist-007001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null result: hit: true dates: - '2021-04-14' description: List all Blacklists. parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - name: blacklistId in: query required: false schema: type: string example: blacklist-e35d521ef8f147c4aa01b7c1af85aaf7 description: Filter blacklists by a specific Blacklist ID. - name: mobileNumber in: query required: false schema: type: string example: '639559991234' description: Filter blacklists by a specific mobile number. - name: type in: query required: false schema: type: string enum: - BLACKLIST1 - BLACKLIST2 example: BLACKLIST1 description: Filter blacklists by Blacklist type. - schema: type: string format: date in: query name: startDate example: '2021-04-01' description: >- Filter blacklists by the start date of the request range (YYYY-MM-DD). - schema: type: string format: date in: query name: endDate example: '2021-04-30' description: Filter blacklists by the end date of the request range (YYYY-MM-DD). /alpha/blacklists/requestBlacklist2: post: summary: Create Blacklist2 operationId: create-alpha-blacklist2 description: > ## Create a **Blacklist2** object. This endpoint requires the following input parameters: `consent`, `mobileNumber`, `templateId`, and `countryCode`. `idType` and `idNumber` are supported identity fields for the Blacklist2 template and should be provided when available. ### Supported Template | Template ID | Region | Required Parameters | |------------------------|--------------|--------------------------------------------------------| | `tpl-blacklist-007001` | PH (default) | `consent`, `mobileNumber`, `countryCode`, `templateId` | ### Field Rules - `templateId` must be `tpl-blacklist-007001`. - `countryCode` is required. - For `countryCode = PH`, `idType` must be one of: `NATIONAL_ID`, `SSS`, `UMID`, `TIN`, `PRC`, `PHILHEALTH`, `PASSPORT`, `DRIVER_LICENSE`, `VOTER_ID`, or `POSTAL_ID`. ### Sandbox Test Values | Parameter | Value | Expected Response | |----------------|------------------------|--------------------------------------| | `templateId` | `tpl-blacklist-007001` | | | `mobileNumber` | `639559991234` | | | `countryCode` | `PH` | | | `idType` | `TIN` | | | `idNumber` | `4561234567` | `resultCode = SUCCESS`, `hit = true` | For all other valid input combinations, the response will return: `resultCode = SUCCESS`, but `hit = false`. tags: - Blacklists (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaBlacklistPostResponse' examples: tpl-blacklist-007001: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: blacklist-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: BLACKLIST2 requestMeta: mobileNumber: '639559991234' idType: TIN idNumber: '4561234567' countryCode: PH applicationDate: null templateId: tpl-blacklist-007001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null result: hit: true dates: - '2021-04-14' - '2021-03-14' - '2021-02-14' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AlphaBlacklist2PostRequest1' examples: tpl-blacklist-007001: value: consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null templateId: tpl-blacklist-007001 mobileNumber: '639559991234' idType: TIN idNumber: '4561234567' countryCode: PH /alpha/blacklists/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Blacklist description: View Blacklist by unique ID. operationId: get-alpha-blacklist tags: - Blacklists (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AlphaBlacklistGetResponse' examples: BLACKLIST1: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: blacklist-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: BLACKLIST1 requestMeta: mobileNumber: '639559991234' countryCode: PH applicationDate: '2023-01-21' templateId: tpl-blacklist-007001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null result: hit: true dates: - '2021-04-14' - '2021-03-14' - '2021-02-14' BLACKLIST2: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: id: blacklist-e35d521ef8f147c4aa01b7c1af85aaf7 createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! type: BLACKLIST2 requestMeta: mobileNumber: '639559991234' idType: TIN idNumber: '4561234567' countryCode: PH applicationDate: null templateId: tpl-blacklist-007001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null result: hit: true dates: [] /alpha/socialSecurities: post: summary: Create Social Security operationId: create-social-security description: >+ ## Create a Social Security object. This endpoint requires **mandatory parameters**: `consent`, `mobileNumber`, `fullName`, `curp`, `emailAddress`, and `templateId`. ### Supported Template | Template ID | Region(s) | Required Parameters | |-----------------|-------------|----------------------------------------------------| | `tpl-sss003001` | MX (Mexico) | `mobileNumber`, `fullName`, `curp`, `emailAddress` | ### Sandbox Test Values | Parameter | Value | Expected Response | |--------------|-------------------------|------------------------| | templateId | `tpl-sss003001` | | | emailAddress | Any valid email address | | | curp | Any valid curp | | | fullName | Any string | | | mobileNumber | `529559991234` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system returns `resultCode = NO_DATA` and the response contains no items. ### Remarks In production mode, if the API request is successful, a SocialSecurity object will be created with the status of `PROCESSING`. When the Status becomes `COMPLETED` or `ERROR`, it will be notified through the [webhook](https://docs.getsmileapi.com/reference/webhooks#records-completed). Generally, the API will return the result in about 1 minute. tags: - Social Security (Alpha) requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SocialSecurityPostRequest' examples: Example: value: emailAddress: john.doe@example.com fullName: John Doe mobileNumber: '529559991234' curp: DOEJ800101HDFXXX01 templateId: tpl-sss003001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/SocialSecurityPostResponse' examples: Example: value: code: CREATED message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: ss-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' status: PROCESSING resultCode: null resultMessage: null result: null requestMeta: emailAddress: john.doe@example.com fullName: John Doe mobileNumber: '529559991234' curp: DOEJ800101HDFXXX01 templateId: tpl-sss003001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d get: summary: List Social Securities operationId: list-social-securities description: List all social security records for users tags: - Social Security (Alpha) parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - name: socialSecurityId in: query required: false schema: type: string description: Filter social securities by social security id - schema: type: string format: date in: query name: startDate description: >- Filter social securities by report date, start of date range (YYYY-MM-DD) - schema: type: string format: date in: query name: endDate description: >- Filter social securities by report date, end of date range (YYYY-MM-DD) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SocialSecurityListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: ss-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! result: fullName: John Doe curp: DOEJ800101HDFXXX01 nss: '12345678901' reportDate: '2024-01-15' employerName: ABC Corporation employerRegistration: ABC123456 state: SINALOA contributionDays: 365 contributionBaseAmount: 50000 currency: MXN requestMeta: emailAddress: john.doe@example.com fullName: John Doe mobileNumber: '529559991234' curp: DOEJ800101HDFXXX01 templateId: tpl-sss003001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d - id: ss-28ccf47509ef5e79b1e5g97d8c73g80g createdAt: '2021-04-10T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! result: fullName: Jane Smith curp: SMIT850215MDFXXX02 nss: '98765432109' reportDate: '2024-01-10' employerName: XYZ Company employerRegistration: XYZ789012 state: SINALOA contributionDays: 300 contributionBaseAmount: 45000 currency: MXN requestMeta: emailAddress: jane.smith@example.com fullName: Jane Smith mobileNumber: '+1987654321' curp: SMIT850215MDFXXX02 templateId: tpl-sss003001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-10T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d /alpha/socialSecurities/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Social Security operationId: get-social-security description: View a social security record by ID tags: - Social Security (Alpha) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SocialSecurityGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: ss-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! result: fullName: John Doe curp: DOEJ800101HDFXXX01 nss: '12345678901' reportDate: '2024-01-15' employerName: ABC Corporation employerRegistration: ABC123456 state: SINALOA contributionDays: 365 contributionBaseAmount: 50000 currency: MXN requestMeta: emailAddress: john.doe@example.com fullName: John Doe mobileNumber: '529559991234' curp: DOEJ800101HDFXXX01 templateId: tpl-sss003001 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: ct-5b79399a68524234bb0ead472648282d /beta/socialSecurities: post: summary: Create Social Security operationId: create-beta-social-security description: >+ ## Create a Social Security object. This endpoint requires **mandatory parameters**: `consent`, `mobileNumber`, `fullName`, `curp`, `emailAddress`, and `templateId`. ### Supported Template | Template ID | Region(s) | Required Parameters | |-----------------|-------------|----------------------------------------------------| | `tpl-sss003002` | MX (Mexico) | `mobileNumber`, `fullName`, `curp`, `emailAddress`| ### Sandbox Test Values | Parameter | Value | Expected Response | |--------------|-------------------------|------------------------| | templateId | `tpl-sss003002` | | | emailAddress | Any valid email address | | | curp | Any valid curp | | | fullName | Any string | | | mobileNumber | `529559991234` | `resultCode = SUCCESS` | For **all other valid input combinations**, if no mock data match is found, the system returns `resultCode = NO_DATA` and the response contains no items. ### Remarks In production mode, if the API request is successful, a SocialSecurity object will be created with the status of `PROCESSING`. When the Status becomes `COMPLETED` or `ERROR`. tags: - Social Securities (Beta) requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/schemas-SocialSecurityPostRequest' examples: Example: value: emailAddress: john.doe@example.com fullName: John Doe mobileNumber: '529559991234' curp: DOEJ800101HDFXXX01 nss: '12345678901' templateId: tpl-sss003002 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/schemas-SocialSecurityPostResponse' examples: Example: value: code: CREATED message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: ss-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' status: PROCESSING resultCode: null resultMessage: null result: null requestMeta: emailAddress: john.doe@example.com fullName: John Doe mobileNumber: '529559991234' curp: DOEJ800101HDFXXX01 templateId: tpl-sss003002 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null get: summary: List Social Securities operationId: list-beta-social-securities description: List all social security records for users tags: - Social Securities (Beta) parameters: - $ref: '#/components/parameters/size' - $ref: '#/components/parameters/cursor' - name: socialSecurityId in: query required: false schema: type: string description: Filter social securities by social security id - schema: type: string format: date in: query name: startDate description: >- Filter social securities by report date, start of date range (YYYY-MM-DD) - schema: type: string format: date in: query name: endDate description: >- Filter social securities by report date, end of date range (YYYY-MM-DD) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/schemas-SocialSecurityListResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: nextCursor: '1259723474' items: - id: ss-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! result: fullName: John Doe curp: DOEJ800101HDFXXX01 nss: '12345678901' payMark: true reportDate: '2024-01-15' employerName: ABC Corporation employerRegistration: ABC123456 state: SINALOA contributionDays: 365 contributionBaseAmount: 50000 currency: MXN requestMeta: emailAddress: john.doe@example.com fullName: John Doe mobileNumber: '529559991234' curp: DOEJ800101HDFXXX01 templateId: tpl-sss003002 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null - id: ss-28ccf47509ef5e79b1e5g97d8c73g80g createdAt: '2021-04-10T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! result: fullName: Jane Smith curp: SMIT850215MDFXXX02 nss: '98765432109' payMark: null reportDate: '2024-01-10' employerName: XYZ Company employerRegistration: XYZ789012 state: SINALOA contributionDays: 300 contributionBaseAmount: 45000 currency: MXN requestMeta: emailAddress: jane.smith@example.com fullName: Jane Smith mobileNumber: '+1987654321' curp: SMIT850215MDFXXX02 templateId: tpl-sss003002 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-10T09:30:24Z' consentTemplateId: null /beta/socialSecurities/{id}: parameters: - $ref: '#/components/parameters/id' get: summary: View Social Security operationId: get-beta-social-security description: View a social security record by ID tags: - Social Securities (Beta) responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/schemas-SocialSecurityGetResponse' examples: Example: value: code: OK message: Success requestId: 5b79399a-6852-4234-bb0e-ad472648282d data: id: ss-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' status: COMPLETED resultCode: SUCCESS resultMessage: Success! result: fullName: John Doe curp: DOEJ800101HDFXXX01 nss: '12345678901' payMark: false reportDate: '2024-01-15' employerName: ABC Corporation employerRegistration: ABC123456 state: SINALOA contributionDays: 365 contributionBaseAmount: 50000 currency: MXN requestMeta: emailAddress: john.doe@example.com fullName: John Doe mobileNumber: '529559991234' curp: DOEJ800101HDFXXX01 templateId: tpl-sss003002 consent: type: Terms And Conditions version: 1 consentedWith: I agree to the terms and conditions. consentedAt: '2021-04-14T09:30:24Z' consentTemplateId: null /alpha/employerBasics/query: get: summary: Fuzzy search employers and return employers' basic information operationId: query-employer-basics tags: - Employers parameters: - name: keyword in: query description: >- Business name of the employer. Fuzzy search, please provide a minimum of 3 characters. schema: type: string example: ABC Inc. minLength: 3 maxLength: 255 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EmployerBasicQueryResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: - businessName: ABC Inc. registrations: - number: '1507304' organization: dti_ph status: Registered date: '2020-02-10' scope: Philippines matchPercentage: 100 sources: - DTI verificationStatus: VERIFIED /alpha/employers/query: get: summary: Query Employer operationId: query-employer tags: - Employers parameters: - name: businessName in: query description: >- Business name of the employer. Exact query, please provide a minimum of 3 characters. Return only one record. If not found, an empty array will be returned. schema: type: string example: ABC Inc. minLength: 3 maxLength: 255 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EmployerQueryResponse' examples: Example: value: code: OK message: Success requestId: 5b72199a-6852-4234-bb0e-ad472648282d data: - businessName: ABC Inc. shortName: ABC registrations: - number: '1507304' organization: dti_ph status: Registered date: '2020-02-10' scope: Philippines isicCode: ISIC-K isicSector: Financial and Insurance Activities psic: '64191' psicIndustry: Expanded commercial banking (universal banking) businessAddress: fullAddress: 123 Main St., Anytown, Any line1: 123 Main St. line2: Apt. 123 city: Anytown region: Anyregion zipCode: '12345' country: PH latitude: null longitude: null contactPersons: - contactName: John Doe position: Owner contactEmail: john.doe@abc.com contactPhone: '+639123456789' licenses: - licenseNumber: '123456789' licenseType: Transfer Agent licenseIssuedDate: '2020-02-10' licenseStatus: Active components: schemas: UserCreatedEvent: title: 'Webhook: User Created Event' x-tags: - Users type: object x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: USER_CREATED createdAt: '2021-04-14T09:30:24Z' data: userId: string properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object required: - userId properties: userId: type: string description: The connected user ID. session: $ref: '#/components/schemas/UserSession' required: - id - version - type - createdAt - data description: Payload when a new user and link token is created AccountCreatedEvent: title: 'Webhook: Account Created Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - providers required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: ACCOUNT_CREATED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string providers: - string description: Payload when a user start to connect his/her work account. ContributionsUpdatedEvent: title: 'Webhook: Contributions Updated Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id count: type: integer description: the updated count of the records. default: 0 updatedFrom: $ref: '#/components/schemas/RefDateTime' updatedTo: $ref: '#/components/schemas/RefDateTime' updatedAt: $ref: '#/components/schemas/RefDateTime' required: - userId - accountId - providers - count - updatedFrom - updatedTo - updatedAt required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: CONTRIBUTIONS_UPDATED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string providers: - string count: 10 updatedFrom: '2021-04-14T09:30:24Z' updatedTo: '2023-04-14T09:30:24Z' updatedAt: '2021-04-14T09:30:24Z' description: Payload when contributions udpated. EincomesUpdatedEvent: title: 'Webhook: Estimated Incomes Updated Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id count: type: integer description: the updated count of the records. default: 0 updatedFrom: $ref: '#/components/schemas/RefDateTime' updatedTo: $ref: '#/components/schemas/RefDateTime' updatedAt: $ref: '#/components/schemas/RefDateTime' required: - userId - accountId - providers - count - updatedFrom - updatedTo - updatedAt required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: EINCOMES_UPDATED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string providers: - string count: 10 updatedFrom: '2021-04-14T09:30:24Z' updatedTo: '2023-04-14T09:30:24Z' updatedAt: '2021-04-14T09:30:24Z' description: Payload when account update estimated incomes. IncomesUpdatedEvent: title: 'Webhook: Incomes Updated Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id count: type: integer description: the updated count of the records. default: 0 updatedFrom: $ref: '#/components/schemas/RefDateTime' updatedTo: $ref: '#/components/schemas/RefDateTime' updatedAt: $ref: '#/components/schemas/RefDateTime' required: - userId - accountId - providers - count - updatedFrom - updatedTo - updatedAt required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: INCOMES_UPDATED createdAt: '2023-04-14T09:30:24Z' data: userId: l17f7340df7fla-243275f71a5d4030bc2ceeaa1ecd5163 accountId: a-5329a7fcc4f746ed9281196203f79927 providers: - tin_ph count: 10 updatedFrom: '2021-04-14T09:30:24Z' updatedTo: '2023-04-14T09:30:24Z' updatedAt: '2021-04-14T09:30:24Z' description: Payload when account update incomes. DocumentsUpdatedEvent: title: 'Webhook: Documents Updated Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id updatedIds: type: array items: type: string count: type: integer description: the updated count of the records. default: 0 updatedAt: $ref: '#/components/schemas/RefDateTime' required: - userId - accountId - providers - count - updatedIds - updatedAt required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: DOCUMENTS_UPDATED createdAt: '2023-04-14T09:30:24Z' data: userId: l17f7340df7fla-243275f71a5d4030bc2ceeaa1ecd5163 accountId: a-5329a7fcc4f746ed9281196203f79927 providers: - tin_ph updatedIds: - d-b16d5acefbda46eab37ba441d6a2943b count: 1 updatedAt: '2023-05-14T09:30:24Z' description: account update documents. EmploymentsUpdatedEvent: title: 'Webhook: Employments Updated Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id updatedIds: type: array items: type: string count: type: integer description: the updated count of the records. default: 0 updatedAt: $ref: '#/components/schemas/RefDateTime' required: - userId - accountId - providers - updatedIds - count - updatedAt required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69g version: 1 type: EMPLOYMENTS_UPDATED createdAt: '2023-05-03T09:30:24Z' data: userId: l17f7340df7fla-243275f71a5d4030bc2ceeaa1ecd5163 accountId: a-5329a7fcc4f746ed9281196203f79927 providers: - nbi_ph updatedIds: - e-460f98489960421eac1c65d14b219a60 count: 1 updatedAt: '2023-05-14T09:30:00Z' description: when account update employments. LiabilitiesUpdatedEvent: title: 'Webhook: Liabilities Updated Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id updatedIds: type: array items: type: string count: type: integer description: the updated count of the records. default: 0 updatedAt: $ref: '#/components/schemas/RefDateTime' required: - userId - accountId - providers - updatedIds - count - updatedAt required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: LIABILITIES_UPDATED createdAt: '2023-05-12T09:30:24Z' data: userId: l17f7340df7fla-243275f71a5d4030bc2ceeaa1ecd5163 accountId: a-5329a7fcc4f746ed9281196203f79927 providers: - nbi_ph updatedIds: - lia-3ba4346eb48445609fc676bee06f2c64 count: 1 updatedAt: '2023-05-14T09:30:24Z' description: when account update liabilities. AccountConnectedEvent: title: 'Webhook: Account Connected Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. loginName: type: string description: the login name user used. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - loginName - providers required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: ACCOUNT_CONNECTED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string loginName: string providers: - string description: Payload when a user successfully connects his/her work account. AccountDisconnectedEvent: title: 'Webhook: Account Disconnected Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - providers required: - id - version - type - createdAt - data x-examples: example-1: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: ACCOUNT_DISCONNECTED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string providers: - string description: >- Payload when a user disconnects or revokes the link to his/her work account. TaskStartedEvent: title: 'Webhook: Task Started Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: $ref: '#/components/schemas/TaskStartedEventData' required: - id - version - type - createdAt - data x-examples: example-1: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: TASK_STARTED createdAt: '2021-04-14T09:30:24Z' data: userId: string sourceId: string sourceType: ACCOUNT taskType: LINK_ACCOUNT providers: - string description: Event indicates data sync of an account is started. TaskFinishedEvent: title: 'Webhook: Task Finished Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: $ref: '#/components/schemas/TaskFinishedEventData' required: - id - version - type - createdAt - data x-examples: example-1: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: TASK_FINISHED createdAt: '2021-04-14T09:30:24Z' data: userId: string sourceId: string sourceType: ACCOUNT taskType: LINK_ACCOUNT status: SUCCEEDED errorCode: null providers: - nbi_ph description: Event indicates data sync of an account is finished. AccountSyncTaskFinishedEvent: title: 'Webhook: Account Sync Task Finished Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The user ID. sourceId: type: string description: The source ID . sourceType: $ref: '#/components/schemas/RefSourceType' providers: type: array description: The providers this account associated to items: type: string description: Provider id status: type: string description: the status of the task enum: - SUCCEEDED - FAILED monitorStatus: $ref: '#/components/schemas/AccountMonitorStatus' datapoints: type: array items: $ref: '#/components/schemas/RefDatapoint' payload: $ref: '#/components/schemas/AllDatapointPayload' required: - userId - sourceId - sourceType - providers - status - monitorStatus - datapoints required: - id - version - type - createdAt - data x-examples: example-1: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: ACCOUNT_SYNC_TASK_FINISHED createdAt: '2021-04-14T09:30:24Z' data: userId: string sourceId: string sourceType: ACCOUNT providers: - string description: Event indicates data sync of an account is finished. AccountFailedEvent: title: 'Webhook: Account Failed Event' x-tags: - Accounts type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. loginName: type: string description: the login name user used. errorCode: type: string description: Account connection error code. errorMessage: type: string description: Account connection error message. providers: type: array items: type: string required: - userId - accountId - loginName - errorCode - errorMessage - providers required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: ACCOUNT_FAILED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string loginName: string errorCode: string errorMessage: string providers: - string description: Payload when the account linking process is unsuccessful. ArchiveStartedEvent: title: 'Webhook: Archive Started Event' x-tags: - Archives type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. archiveId: type: string description: The uploaded archive ID. required: - userId - archiveId required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: ARCHIVE_STARTED createdAt: '2021-04-14T09:30:24Z' data: userId: string archiveId: string description: >- Payload when a user has uploaded one or several files which becomes an "archive" in Smile. ArchiveAnalyzedEvent: title: 'Webhook: Archive Analyzed Event' x-tags: - Archives type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. archiveId: type: string description: The uploaded archive ID. required: - userId - archiveId required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: ARCHIVE_ANALYZED createdAt: '2021-04-14T09:30:24Z' data: userId: string archiveId: string description: >- Payload when an archive has been analyzed and converted into JSON data automatically via OCR. ArchiveRevokedEvent: title: 'Webhook: Archive Revoked Event' x-tags: - Archives type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. archiveId: type: string description: The uploaded archive ID. required: - userId - archiveId required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: ARCHIVE_REVOKED createdAt: '2021-04-14T09:30:24Z' data: userId: string archiveId: string description: Payload when user removes permission to access or use an archive. ArchiveFailedEvent: title: 'Webhook: Archive Failed Event' x-tags: - Archives type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. archiveId: type: string description: The uploaded archive ID. errorCode: type: string description: Archive error code. errorMessage: type: string description: Archive error message. required: - userId - archiveId - errorCode - errorMessage required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: ARCHIVE_FAILED createdAt: '2021-04-14T09:30:24Z' data: userId: string archiveId: string errorCode: string errorMessage: string description: >- Payload when the the archive creation or analysis process is unsuccessful. InviteInvitedEvent: title: 'Webhook: Invite Invited Event' x-tags: - Invites type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The invite user ID. inviteId: type: string description: The invite ID. required: - userId - inviteId required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: INVITE_INVITED createdAt: '2021-04-14T09:30:24Z' data: userId: string inviteId: string description: Payload when an invitation is sent out to a user successfully. InviteLinkedEvent: title: 'Webhook: Invite Linked Event' x-tags: - Invites type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The invite user ID. inviteId: type: string description: The invite ID. required: - userId - inviteId required: - id - version - type - createdAt - data description: >- Payload when the a user that has been sent an invitation is able to link his or her work account successfully. x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: INVITE_LINKED createdAt: '2021-04-14T09:30:24Z' data: userId: string inviteId: string IdentityAddedEvent: title: 'Webhook: Identity Added Event' x-tags: - Identities type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. identityId: type: string description: the new identity ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - identityId - providers required: - id - version - type - createdAt - data description: Payload when identity data about a user is added. x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: IDENTITY_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string identityId: string providers: - string RatingAddedEvent: title: 'Webhook: Rating Added Event' x-tags: - Ratings type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. ratingId: type: string description: The added rating ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - ratingId - providers required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: RATING_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string ratingId: string providers: - string description: Payload when rating data about a user is added. WebhookCommonEvent: type: object required: - id - version - type - createdAt properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' LinkAddedEvent: allOf: - $ref: '#/components/schemas/WebhookCommonEvent' - type: object properties: data: type: object title: LinkAddedEventData properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. id: type: string description: The added link ID. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - id - providers title: 'Webhook: Link Added Event' x-tags: - Links x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: LINK_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string ratingId: string providers: - string description: Payload when link data about a user is added. TransactionsAddedEvent: title: 'Webhook: Transactions Add Event' x-tags: - Transactions type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. count: type: number description: The number of transactions added. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - count - providers required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: TRANSACTIONS_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string count: 0 providers: - string description: Payload when transactions data shared by a user are added. DocumentsAddedEvent: title: 'Webhook: Documents Added Event' x-tags: - Documents type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. count: type: number description: The number of documents added. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - count - providers required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: DOCUMENTS_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string count: 0 providers: - string description: Payload when documents data shared by a user are added. EmploymentsAddedEvent: title: 'Webhook: Employments Added Event' x-tags: - Employments type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. count: type: number description: The number of employments added. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - count - providers required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: EMPLOYMENTS_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string count: 0 providers: - string description: Payload when employment data shared by a user are added. IncomesAddedEvent: title: 'Webhook: Incomes Added Event' x-tags: - Incomes type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. count: type: number description: the number of incomes added. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - count - providers required: - id - version - type - createdAt - data x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: INCOMES_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string count: 0 providers: - string description: Payload when income data shared by a user are added. EincomeAddedEvent: title: 'Webhook: Estimated Income Added Event' x-tags: - Estimated Incomes type: object deprecated: true properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. count: type: number description: the number of eincomes added. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - count - providers required: - id - version - type - createdAt - data x-examples: Example: id: einc-17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: EINCOMES_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string count: 0 providers: - string description: Payload when estimated incomes data shared by a user are added. EincomesAddedEvent: title: 'Webhook: Estimated Income Added Event' x-tags: - Estimated Incomes type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. count: type: number description: the number of eincomes added. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - count - providers required: - id - version - type - createdAt - data x-examples: Example: id: einc-17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: EINCOMES_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string count: 0 providers: - string description: Payload when estimated incomes data shared by a user are added. InsightAddedEvent: title: 'Webhook: Insight Added Event' x-tags: - Features type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. id: type: string description: >- The id of the insight. It can be used to the API GET /insight/{id} providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - id - providers required: - id - version - type - createdAt - data x-examples: Example: id: et-17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: INSIGHT_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string id: insight-17bbf36498de4d68a0d4f86c7b62f69f providers: - string description: Payload when features calculated after the user linked an account. LiabilitiesAddedEvent: title: 'Webhook: Liability Added Event' x-tags: - Liabilities type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. count: type: number description: the number of eincomes added. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - count - providers required: - id - version - type - createdAt - data x-examples: Example: id: lia-17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: LIABILITIES_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string count: 0 providers: - string description: Payload when liabilities data shared by a user are added. ContributionsAddedEvent: title: 'Webhook: Contributions Added Event' x-tags: - Contributions type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: type: object properties: userId: type: string description: The connected user ID. accountId: type: string description: The connected account ID. count: type: number description: the number of contributions added. providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - accountId - count - providers required: - id - version - type - createdAt - data description: Payload when contributions data shared by a user are added. x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: CONTRIBUTIONS_ADDED createdAt: '2021-04-14T09:30:24Z' data: userId: string accountId: string count: 0 providers: - string VerificationStartedEvent: title: 'Webhook: Verification Started Event' x-tags: - Verifications type: object required: - id - version - type - createdAt - data allOf: - $ref: '#/components/schemas/SmileCommonEvent' - type: object properties: data: type: object title: Verification Started Event Data required: - verificationId properties: verificationId: type: string x-examples: example-1: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: VERIFICATION_STARTED createdAt: '2021-04-14T09:30:24Z' data: verificationId: ver-8a62f69f08de4dd4f86c7b17bbf36496 description: Event indicates verification process is started. VerificationCompletedEvent: title: 'Webhook: Verification Completed Event' x-tags: - Verifications type: object allOf: - $ref: '#/components/schemas/SmileCommonEvent' - type: object properties: data: type: object title: Verification Started Event Data required: - verificationId - resultCode - result properties: verificationId: type: string resultCode: type: string resultMessage: type: string result: $ref: '#/components/schemas/VerificationResult' required: - id - version - type - createdAt - data x-examples: example-1: id: 17bbf36498de4d68a0d4f86c7b62f69f version: 1 type: VERIFICATION_STARTED createdAt: '2021-04-14T09:30:24Z' data: verificationId: ver-8a62f69f08de4dd4f86c7b17bbf36496 resultCode: SUCCESS resultMessage: Verification completed successfully result: finalMatches: true names: firstNameMatches: true lastNameMatches: true middleNameMatches: null fullNameMatches: true additionalData: ids: - idType: tin_ph idSubType: null idNumber: 1234567890 matches: true dobMatches: true genderMatches: false addressMatches: null phoneMatches: value: 639123456789 matches: true disposable: false deliverable: null active: true provider: Smart Communications freeProvider: false emailMatches: value: someone@gmail.com matches: true disposable: false deliverable: true active: true provider: Google LLC freeProvider: true description: Event indicates verification process is completed. RecordCreatedEvent: title: 'Webhook: Record Started Event' type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: $ref: '#/components/schemas/RecordCreatedEventData' required: - id - version - type - createdAt - data description: Event indicates record is created. RecordCompletedEvent: title: 'Webhook: Record Completed Event' type: object properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' data: $ref: '#/components/schemas/RecordCompletedEventData' required: - id - version - type - createdAt - data description: Event indicates data sync of an account is finished. UserSessionCompletedEvent: title: 'Webhook: User Session Completed Event' x-tags: - User Sessions type: object allOf: - $ref: '#/components/schemas/SmileCommonEvent' - type: object required: - data properties: data: type: object properties: session: $ref: '#/components/schemas/UserSession' payload: $ref: '#/components/schemas/UserPayload' required: - session - payload x-examples: Example: id: et-123abc456def789abc123def456abc78 version: 1 type: USER_SESSION_COMPLETED createdAt: '2021-04-14T09:30:24Z' data: session: userId: tenantId-123abc456def789abc123def456abc78 channel: WinkSite channelId: site-123abc456def789abc123def456abc78 status: COMPLETED payload: metadata: channel: WinkSite channelId: site-123abc456def789abc123def456abc78 userId: tenantId-123abc456def789abc123def456abc78 status: COMPLETED forms: - id: form-xxxxxxxxxxx name: Personal Information data: {} accounts: - id: a-xxxxxxxxxxx providerId: nbi_ph payload: {} archives: - id: archive-xxxxxxxxxxx fileType: payslip payload: {} description: User session is completed. UserSessionResetEvent: title: 'Webhook: User Session Reset Event' x-tags: - User Sessions type: object allOf: - $ref: '#/components/schemas/SmileCommonEvent' - type: object required: - data properties: data: type: object properties: session: $ref: '#/components/schemas/UserSession' required: - session x-examples: Example: id: et-123abc456def789abc123def456abc78 version: 1 type: USER_SESSION_RESET createdAt: '2021-04-14T09:30:24Z' data: session: userId: tenantId-123abc456def789abc123def456abc78 channel: WinkSite channelId: site-123abc456def789abc123def456abc78 status: IN_PROGRESS description: User session is reset. RefPrcProfession: type: string description: PROFESSIONAL REGULATION COMMISSION license profession enum: - AERONAUTICAL ENGINEER - AGRICULTURAL AND BIOSYSTEMS ENGINEER - AGRICULTURIST - AIR COND. & REFRIGERATION SPECIALIST - ARCHITECT - CERTIFIED MILL FOREMAN - CERTIFIED MINE FOREMAN - CERTIFIED PLANT MECHANIC - CERTIFIED PUBLIC ACCOUNTANT - CERTIFIED QUARRY FOREMAN - CHEMICAL ENGINEER - CHEMICAL TECHNICIAN - CHEMIST - CHINESE DRUGGIST - CIVIL ENGINEER - CRIMINOLOGIST - CUSTOMS BROKER - DENTAL HYGIENIST - DENTAL TECHNOLOGIST - DENTIST - ELECTRONICS ENGINEER - ELECTRONICS TECHNICIAN - ENVIRONMENTAL PLANNER - FISHERIES TECHNOLOGIST - FOREIGN MEDICAL PROFESSIONAL - FORESTER - GEODETIC ENGINEER - GEOLOGIC AIDE - GEOLOGIST - GUIDANCE COUNSELOR - INTERIOR DESIGNER - LANDSCAPE ARCHITECT - LIBRARIAN - MASTER PLUMBER - MECHANICAL ENGINEER - MEDICAL LABORATORY TECHNICIAN - MEDICAL TECHNOLOGIST - METALLURGICAL ENGINEER - METALLURGICAL PLANT FOREMAN - MIDWIFE - MIDWIFE (RA 2382) - MINING ENGINEER - NAVAL ARCHITECT - NURSE - NUTRITIONIST DIETITIAN - OCCUPATIONAL THERAPIST - OCCUPATIONAL THERAPY TECHNICIAN - OCULAR PHARMACOLOGIST - OPTOMETRIST - PHARMACIST - PHYSICAL THERAPIST - PHYSICIAN - PROFESSIONAL ELECTRICAL ENGINEER - PROFESSIONAL ELECTRONICS ENGINEER - PROFESSIONAL FOOD TECHNOLOGIST - PROFESSIONAL MECHANICAL ENGINEER - PROFESSIONAL TEACHER - PSYCHOLOGIST - PSYCHOMETRICIAN - RADIOLOGIC TECHNOLOGIST - REAL ESTATE APPRAISER - REAL ESTATE BROKER - REAL ESTATE CONSULTANT - REAL ESTATE SALESPERSONS - REGISTERED ELECTRICAL ENGINEER - REGISTERED MASTER ELECTRICIAN - RESPIRATORY THERAPIST - SANITARY ENGINEER - SOCIAL WORKER - SPEECH LANGUAGE PATHOLOGY - VETERINARIAN - X-RAY TECHNOLOGIST ObjectMetadataRefCode: type: string title: ObjectMetadataRefCode 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 example: OK x-internal: false ObjectMetadataRefMessage: type: string title: ObjectMetadataRefMessage description: Message response to the request example: Success x-internal: false ObjectMetadataRefRequestID: type: string title: ObjectMetadataRefRequestID description: >- Unique ID that is added to the body of every response for easy traceability of the request in our logs. x-internal: false example: 5b79399a-6852-4234-bb0e-ad472648282d ObjectNextCursor: title: ObjectNextCursor type: string example: '1259723474' description: The next cursor value that can be used in the following query. x-internal: false RefDatapoint: type: string title: Datapoint enum: - IDENTITIES - TRANSACTIONS - RATINGS - EMPLOYMENTS - DOCUMENTS - INCOMES - CONTRIBUTIONS - EINCOMES - LIABILITIES - LINK - INSIGHTS description: Supported data points for this employment data provider example: IDENTITIES Provider: title: Provider type: object description: >- An employment data provider. A provider holds employment and income information of the user. x-tags: - Providers x-examples: Example: id: upwork name: Upwork longName: Upwork Global Inc. logoUrl: >- https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png type: GIG typeLabel: Gig Platform subType: SERVICES subTypeLabel: Professional Services active: true enabled: true mfa: true accountConnection: true supported: - IDENTITIES - TRANSACTIONS properties: id: type: string description: Unique ID of the data provider example: upwork name: type: string description: Name of the data provider example: Upwork longName: type: string description: Full name or legal name of the data provider logoUrl: type: string description: URL to the data provider's logo example: >- https://cdn.smileapi.io/image/provider-logo/v20210813064500/upwork.png type: type: string enum: - GIG - GOVERNMENT - SYSTEM - EMPLOYER - CREDENTIAL description: Type of employment data provider example: GIG typeLabel: type: string description: Type label of employment data provider, like "Gig Platform" example: Gig Platform enum: - Gig Platform - Govt Service - System - Employer - Credential subType: type: string description: Subset of Type of employment data provider enum: - SERVICES - TRANSPORTATION - SHARING - TRADING - INSURANCE - HRIS - PAYROLL - WALLET - IDENTIFICATION - ISIC-A - ISIC-B - ISIC-C - ISIC-D - ISIC-E - ISIC-F - ISIC-G - ISIC-H - ISIC-I - ISIC-J - ISIC-K - ISIC-L - ISIC-M - ISIC-N - ISIC-O - ISIC-P - ISIC-Q - ISIC-R - ISIC-S - ISIC-T - ISIC-U subTypeLabel: type: string description: Subtype label of employment data provider, like "Services" example: Professional Services enum: - Professional Services - Transport and Delivery - Asset Sharing - Online Selling - Social Insurance - Payroll System - Tamper-proof document issuance & verification systems - Human Resource Information System - Identification - Agriculture, forestry and fishing - Mining and quarrying - Manufacturing - Electricity, gas, steam and air conditioning supply - >- Water supply; sewerage, waste management and remediation activities - Construction - >- Wholesale and retail trade; repair of motor vehicles and motorcycles - Transportation and storage - Accommodation and food service activities - Information and communication - Financial and insurance activities - Real estate activities - Professional, scientific and technical activities - Administrative and support service activities - Public administration and defense; compulsory social security - Education - Human health and social work activities - Arts, entertainment and recreation - Other service activities - >- Activities of households as employers; undifferentiated goods; and services-producing activities of households for own use - Activities of extraterritorial organization and bodies active: type: boolean description: Indicates whether data provider integration is working enabled: type: boolean description: >- Indicates whether data provider is enabled or access is allowed for the client mfa: type: boolean description: Whether data provider requires multi-factor authentication. accountConnection: type: boolean description: >- Whether a real-time account connection is available for this data provider default: true supported: type: array description: Supported data points for this employment data provider items: $ref: '#/components/schemas/RefDatapoint' monitorSupported: type: boolean description: Whether support CDS for this data provider default: false required: - id - name - longName - logoUrl - type - typeLabel - subType - subTypeLabel - active - enabled - mfa - accountConnection - supported - monitorSupported ProviderListResponse: type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Provider' x-examples: {} title: Provider List Response description: '' ProviderGetResponse: title: Provider Get Response properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Provider' x-examples: {} description: '' RefObjectID: type: string title: Object ID description: Unique ID of this object example: 17bbf36498de4d68a0d4f86c7b62f69f ObjectExternalMetadata: title: ObjectExternalMetadata type: object additionalProperties: type: string maxProperties: 5 description: >- The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters can be used - Maximum of 5 key/value pairs - Maximum key length of 50 characters - Maximum value length of 500 characters RefDateTime: type: string title: Date and Time string format: date-time example: '2021-04-14T09:30:24Z' description: Date and time SessionChannel: type: string description: The channel type enum: - WinkSite - Default UserSessionStatus: description: The status of a user session type: string enum: - IN_PROGRESS - COMPLETED - REVOKED example: IN_PROGRESS UserSession: description: User session resource type: object properties: userId: type: string description: The user ID associated with this session example: tenantId-123abc456def789abc123def456abc78 channel: $ref: '#/components/schemas/SessionChannel' channelId: type: string description: The wink site ID example: site-123abc456def789abc123def456abc78 status: $ref: '#/components/schemas/UserSessionStatus' required: - userId - status User: title: User type: object description: >- A user is someone who is authorizing Smile to retrieve and share their employment and income data on their behalf. x-tags: - Users x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f externalMetadata: property1: string property2: string createdAt: '2021-04-14T09:30:24Z' session: channel: Default channelId: null userId: tenantId-123abc456def789abc123def456abc78 status: IN_PROGRESS properties: id: $ref: '#/components/schemas/RefObjectID' externalMetadata: $ref: '#/components/schemas/ObjectExternalMetadata' createdAt: $ref: '#/components/schemas/RefDateTime' providers: deprecated: true description: Array of providers connected to this user (listed by provider ID) type: array default: [] items: type: string example: upwork session: $ref: '#/components/schemas/UserSession' required: - id - externalMetadata - createdAt - providers UserListResponse: title: User List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/User' x-examples: {} UserPostRequest: type: object properties: externalMetadata: $ref: '#/components/schemas/ObjectExternalMetadata' x-examples: {} title: User Post Request description: Create user request body Token: title: Token type: object x-tags: - Tokens description: >- A method for securely transmitting information between Smile and the user. x-examples: Example: id: tk-ac86a0f7d46545f89adee8607a727573 expiresAt: '2021-04-14T09:30:24Z' mode: SANDBOX accessToken: string properties: id: type: string description: Unique identifier for the Token expiresAt: $ref: '#/components/schemas/RefDateTime' mode: type: string enum: - SANDBOX - PRODUCTION example: SANDBOX description: Valid Smile mode for the Token accessToken: type: string description: Short-lived token to initiate link flow required: - expiresAt - mode - accessToken UserPostResponse: title: User Post Response description: Create user response body properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: user: $ref: '#/components/schemas/User' token: $ref: '#/components/schemas/Token' required: - user - token x-examples: {} UserGetResponse: title: User Get Response properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/User' x-examples: {} RefGender: type: string title: GenderEnum enum: - Male - Female - Non-binary - null example: Male description: Gender RefMaritalStatus: type: string title: RefMaritalStatus enum: - Divorced - Married - Separated - Single - Widowed - Lifetime Partner - null example: Married description: Marital status RefCountry: type: string nullable: true title: Country ISO Codes enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - XK - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - AN - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RS - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - CS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - XT - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - null description: 2 character alpha ISO-3166 codes example: PH RefContactType: type: string nullable: true title: Contact Types enum: - Primary - Secondary - Work - Personal - null description: Primary contact, with secondary marked as either 'Work' or 'Personal' example: Primary RefPhoneNumber: type: string nullable: true title: International Phone Number pattern: ^\+[1-9]\d{1,14}$ description: Phone numbers in international E.164 format example: '+639175551234' RefPhoneType: type: string nullable: true title: Ref-Phone-Type example: Mobile enum: - Mobile - Fixed - Unspecified - null description: Phone type RefAddress: title: Address Object type: object description: Address object properties: fullAddress: type: string nullable: true description: Full address line1: type: string nullable: true description: Line 1 of street address line2: type: string nullable: true description: Line 2 of street address city: type: string nullable: true description: City region: type: string nullable: true description: Geographic region such as state or province zip: type: string nullable: true description: Post code country: $ref: '#/components/schemas/RefCountry' latitude: type: string nullable: true pattern: >- ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$ description: Latitude coordinates longitude: type: string nullable: true pattern: >- ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$ description: Longitude coordinates type: type: string nullable: true enum: - Primary - Secondary - null description: Whether address is primary or secondary tags: type: array default: [] example: - Primary - Home items: type: string enum: - Primary - Secondary - Home - Work - Mailing - Foreign - Billing - Permanent - Shipping - null description: Address tags, such as primary or secondary, home or work, etc. required: - type IdentityPayload: type: object properties: id: $ref: '#/components/schemas/RefObjectID' fullName: type: string example: George Cimafranca Palomero, Jr description: Full name firstName: type: string example: George description: First name nullable: true middleName: type: string example: Cimafranca description: Middle name nullable: true lastName: type: string example: Palomero description: Last name nullable: true suffix: type: string example: Jr description: Suffix nullable: true gender: $ref: '#/components/schemas/RefGender' dob: type: string format: date description: Date of birth nullable: true maritalStatus: $ref: '#/components/schemas/RefMaritalStatus' countryResidence: $ref: '#/components/schemas/RefCountry' citizenship: type: string enum: - Citizen - Resident Alien - Non-resident Alien - Undocumented - Others description: Citizenship nullable: true photoUrl: type: string example: https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg description: URL to photo or avatar nullable: true referenceId: type: string description: Reference profile ID from the data provider example: ~02c0bf6ae6a581ee2b nullable: true profileUrl: type: string description: Public profile URL example: https://www.upwork.com/freelancers/~02c0bf6ae6a581ee2b nullable: true latestEmployerName: type: string deprecated: true description: The lastest employer name at now, it will be removed in the future. emails: type: array description: A collection of email addresses items: type: object title: email properties: address: type: string format: email example: gpalomero@yahoo.com description: Email address nullable: true type: $ref: '#/components/schemas/RefContactType' required: - address - type phones: type: array description: A collection of phone numbers items: type: object title: phone properties: number: $ref: '#/components/schemas/RefPhoneNumber' type: $ref: '#/components/schemas/RefPhoneType' required: - number - type socialProfiles: type: array description: A collection of social media URLs items: type: object title: socialProfile properties: socialUrl: type: string example: https://www.facebook.com/gpalomero description: URL to social media page nullable: true type: type: string enum: - Twitter - Facebook - LinkedIn - Others example: Facebook description: Social media type nullable: true required: - socialUrl - type addresses: type: array items: $ref: '#/components/schemas/RefAddress' required: - id - fullName - emails - phones - socialProfiles - addresses RatingPayload: type: object required: - id properties: id: $ref: '#/components/schemas/RefObjectID' currentRating: type: number description: Current rating example: 90 nullable: true maxRating: type: number description: Maximum possible rating example: 100 nullable: true calculatedPercentage: type: number description: >- Current rating expressed as percentage, calculated by currentRating/maxRating x 100 example: 90 nullable: true reviewsReceived: type: number description: >- Number of reviews the employee received, which is the basis for the current rating example: 12 nullable: true likesReceived: type: number description: Recommendations or kudos received example: 8 nullable: true jobsCompleted: type: number description: Jobs actually completed in the employment platform example: 12 nullable: true DocumentPayload: type: object required: - id - name properties: id: $ref: '#/components/schemas/RefObjectID' name: type: string description: Document name example: Facebook Social Media Marketing Professional Certificate docId: type: string description: Document number example: ABCD123456 nullable: true status: type: string description: >- Document status，only for NBI verification, It's VALID if the NBI verification status is valid. example: VALID nullable: true documentType: type: string description: Document Type example: IDENTIFICATION enum: - IDENTIFICATION - PAYSLIP - CLEARANCE - CERTIFICATE issueDate: type: string description: Issue date format: date example: '2007-08-24' nullable: true expiryDate: type: string description: Expiry date format: date example: '2010-08-24' nullable: true fileUrl: type: string description: Publicly available URL reference for the document example: >- https://images.credly.com/size/680x680/images/c4a900b7-8d1b-4e8f-a572-347985eeaa5c/Coursera_Badge__1_.png nullable: true remarks: type: string description: Remarks section example: NO RECORD ON FILE nullable: true RefEmployer: type: string title: Employer nullable: true description: Employer name example: ABC Corporation RefCurrency: 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 example: PHP RefPayPeriod: type: string nullable: true title: Pay Period description: Pay period enum: - Hourly - Daily - Weekly - Semimonthly - Monthly - Bimonthly - Quarterly - Annually - Variable - Unspecified - null example: Annually IncomePayload: type: object required: - id - startDate - currency properties: id: $ref: '#/components/schemas/RefObjectID' workItem: type: string description: Work performed (specially in the case of contract or freelance jobs) nullable: true employer: $ref: '#/components/schemas/RefEmployer' startDate: type: string description: Start date format: date example: '2021-06-01' endDate: type: string example: '2021-06-15' format: date description: End date nullable: true currency: $ref: '#/components/schemas/RefCurrency' frequency: $ref: '#/components/schemas/RefPayPeriod' baseAmount: type: number description: Base amount nullable: true grossAmount: type: number description: Gross amount nullable: true netAmount: type: number description: Net amount nullable: true TransactionPayload: type: object required: - id - date - currency - amount properties: id: $ref: '#/components/schemas/RefObjectID' date: type: string format: date example: '2021-04-21' description: Date of transaction description: type: string description: Description of the transaction example: Payment for web design project nullable: true currency: $ref: '#/components/schemas/RefCurrency' amount: type: number example: 10000 description: Transaction amount referenceId: type: string description: Reference transaction ID from data provider nullable: true EmploymentPayload: type: object required: - id - startDate properties: id: $ref: '#/components/schemas/RefObjectID' name: type: string description: Work performed example: Digital Marketing nullable: true description: type: string description: Description of work performed example: >- Gathering and reporting relevant data, maintaining specific reports and dashboards, using platforms and programs to address marketing requirements, and updating specific marketing materials. nullable: true jobTitle: type: string description: Job title example: Digital Marketing Assistant nullable: true department: type: string description: Department or organization in place of employment example: Marketing nullable: true employeeNumber: type: string description: Employee number in the employment data provider example: EMP-123456 nullable: true employerNumber: type: string description: Employer number in the employment data provider example: ER-654321 nullable: true employer: $ref: '#/components/schemas/RefEmployer' status: type: string description: Status of employment example: Permanent nullable: true startDate: type: string description: Start date format: date example: '2016-02-24' endDate: type: string description: End date format: date example: '2019-08-24' nullable: true reportedDate: type: string description: Reported date format: date example: '2019-08-25' nullable: true ContributionPayload: type: object required: - id - date - currency - amount properties: id: $ref: '#/components/schemas/RefObjectID' date: type: string format: date description: Date of the contribution example: '2021-04-30' currency: $ref: '#/components/schemas/RefCurrency' amount: type: number description: Amount of the contribution example: 1375 referenceId: type: string description: Reference contribution ID from the data provider example: PA9634415 LiabilityPayload: type: object required: - id - type - startDate - loanAmount - currency - amortizationFrequency properties: id: $ref: '#/components/schemas/RefObjectID' type: type: string description: the loan type example: Salary Loan referenceId: type: string description: the loan referenceId startDate: type: string format: date description: the loan start date endDate: type: string format: date description: the loan end date firstAmortizationDate: type: string format: date description: the loan first amortization date amortizationFrequency: $ref: '#/components/schemas/RefPayPeriod' currency: $ref: '#/components/schemas/RefCurrency' loanAmount: type: number description: loan amount amortizationAmount: type: number description: loan amortization amount outstandingBalance: type: number description: loan outstanding balance nextPaymentAmount: type: number description: loan next payment amount overduePaymentAmount: type: number description: loan total overdue amount EincomePayload: type: object required: - id - month - currency - baseAmount - amount properties: id: $ref: '#/components/schemas/RefObjectID' month: type: string description: the month example: 2021-06 currency: $ref: '#/components/schemas/RefCurrency' baseAmount: type: number deprecated: true description: >- income amount, has been renamed to amount, baseAmount will be removed in the future nullable: true amount: type: number description: income amount nullable: true LinkPayload: type: object required: - id - endDate properties: id: type: string example: link-123456789012345678901234567890 description: Link request ID startDate: $ref: '#/components/schemas/RefDateTime' endDate: $ref: '#/components/schemas/RefDateTime' records: type: array description: Link records default: [] items: type: object title: LinkRecord required: - count properties: count: type: integer description: >- The number of times the user has linked at least one account with other participating organizations linkedAt: type: array default: [] description: The latest link time of each application items: $ref: '#/components/schemas/RefDateTime' ObjectFeature: type: object properties: incomes_count: type: integer example: 9 description: The quantity of the estimated incomes incomes_first_income_month_range: type: integer example: -999 description: >- Calculate the interval from the first income record time to the current time by month incomes_missing_month_max: type: integer example: -999 description: >- From all estimated incomes, calculate the number of months between the last payment month and the next payment month, and then take the maximum value incomes_missing_month_count: type: integer example: -999 description: >- From all estimated incomes, calculate the months diff between current income month and the before income month, and count if the diff > 1 incomes_amount_sum: type: number example: -999 description: From all estimated incomes, calculate the total of the amount incomes_amount_average: type: number example: 1100 description: >- From all estimated incomes, calculate the average amount of the total amount incomes_amount_min: type: number example: 1000 description: From all estimated incomes, get the minimum amount incomes_amount_max: type: number example: 1200 description: From all estimated incomes, get the maximum amount incomes_amount_median: type: number example: 1200 description: From all estimated incomes, get the median amount incomes_amount_std: type: number example: 1000 description: From all estimated incomes, get the median amount incomes_last3_months_amount_sum: type: number example: 6000 description: >- From all estimated incomes in last 3 months, calculate the total of the amount incomes_last3_months_amount_average: type: number example: 1100 description: >- From all estimated incomes in last 3 months, calculate the average amount of the total amount incomes_last3_months_amount_min: type: number example: 1000 description: From all estimated incomes in last 3 months, get the minimum amount incomes_last3_months_amount_max: type: number example: 1200 description: From all estimated incomes in last 3 months, get the maximum amount incomes_last3_months_amount_median: type: number example: 1200 description: From all estimated incomes in last 3 months, get the median amount incomes_last3_months_amount_std: type: number example: 1000 description: >- From all estimated incomes in last 3 months, get the standard deviation of the amount incomes_last6_months_amount_sum: type: number example: 6000 description: >- From all estimated incomes in last 6 months, calculate the total of the amount incomes_last6_months_amount_average: type: number example: 1100 description: >- From all estimated incomes in last 6 months, calculate the average amount of the total amount incomes_last6_months_amount_min: type: number example: 1000 description: From all estimated incomes in last 6 months, get the minimum amount incomes_last6_months_amount_max: type: number example: 1200 description: From all estimated incomes in last 6 months, get the maximum amount incomes_last6_months_amount_median: type: number example: 1200 description: From all estimated incomes in last 6 months, get the median amount incomes_last6_months_amount_std: type: number example: 1000 description: >- From all estimated incomes in last 6 months, get the standard deviation of the amount incomes_last9_months_amount_sum: type: number example: 6000 description: >- From all estimated incomes in last 9 months, calculate the total of the amount incomes_last9_months_amount_average: type: number example: 1100 description: >- From all estimated incomes in last 9 months, calculate the average amount of the total amount incomes_last9_months_amount_min: type: number example: 1000 description: From all estimated incomes in last 9 months, get the minimum amount incomes_last9_months_amount_max: type: number example: 1200 description: From all estimated incomes in last 9 months, get the maximum amount incomes_last9_months_amount_median: type: number example: 1200 description: From all estimated incomes in last 9 months, get the median amount incomes_last9_months_amount_std: type: number example: 1000 description: >- From all estimated incomes in last 9 months, get the standard deviation of the amount incomes_last12_months_amount_sum: type: number example: 6000 description: >- From all estimated incomes in last 12 months, calculate the total of the amount incomes_last12_months_amount_average: type: number example: 1100 description: >- From all estimated incomes in last 12 months, calculate the average amount of the total amount incomes_last12_months_amount_min: type: number example: 1000 description: From all estimated incomes in last 12 months, get the minimum amount incomes_last12_months_amount_max: type: number example: 1200 description: From all estimated incomes in last 12 months, get the maximum amount incomes_last12_months_amount_median: type: number example: 1200 description: From all estimated incomes in last 12 months, get the median amount incomes_last12_months_amount_std: type: number example: 1000 description: >- From all estimated incomes in last 12 months, get the standard deviation of the amount incomes_last18_months_amount_sum: type: number example: 6000 description: >- From all estimated incomes in last 18 months, calculate the total of the amount incomes_last18_months_amount_average: type: number example: 1100 description: >- From all estimated incomes in last 18 months, calculate the average amount of the total amount incomes_last18_months_amount_min: type: number example: 1000 description: From all estimated incomes in last 18 months, get the minimum amount incomes_last18_months_amount_max: type: number example: 1200 description: From all estimated incomes in last 18 months, get the maximum amount incomes_last18_months_amount_median: type: number example: 1200 description: From all estimated incomes in last 18 months, get the median amount incomes_last18_months_amount_std: type: number example: 1000 description: >- From all estimated incomes in last 18 months, get the standard deviation of the amount incomes_last18_months_max_amount_count: type: number example: 1000 description: >- From all estimated incomes in last 18 months, find the maximum amount, and count the number of monthly income equal to the maximum amount incomes_starting_amount: type: number example: 1000 description: the estimated income from when the user has started earning income incomes_current_amount: type: number example: 1000 description: the amount from the latetest one record incomes_latest_growth: type: number example: 1000 description: >- For the latetest one record, calculate the growth of income from the same month last year liabilities_loan_count: type: integer example: 1000 description: For the latetest one record, calculate the count of records liabilities_loan_amount_min: type: number example: 1000 description: From all liabilities, calculate the minimum of the amount liabilities_loan_amount_max: type: number example: 1000 description: From all liabilities, calculate the maximum of the amount liabilities_loan_amount_total: type: number example: 1000 description: From all liabilities, calculate the total of the amount liabilities_loan_amount_average: type: number example: 1000 description: From all liabilities, calculate the average of the amount liabilities_loan_amount_std: type: number example: 1000 description: From all liabilities, calculate the standard deviation of the amount liabilities_finished_loan_count: type: number example: 1000 description: >- From all liabilities that outstandingBalance <= 0, calculate the count of the records liabilities_outstanding_loan_count: type: integer example: 10 description: >- From all liabilities that outstandingBalance > 0, calculate the count of the records liabilities_outstanding_amount_max: type: number example: 1000 description: >- From all liabilities that outstandingBalance > 0, calculate the count of the records liabilities_outstanding_amount_total: type: number example: 1000 description: >- From all liabilities that outstandingBalance > 0, calculate the total of the amount liabilities_outstanding_amount_average: type: number example: 1000 description: >- From all liabilities that outstandingBalance > 0, calculate the average of the amount liabilities_overdue_loan_count: type: integer example: 10 description: >- From all liabilities that overduePaymentAmount > 0, calculate the count of the records liabilities_overdue_amount_total: type: number example: 1000 description: >- From all liabilities that overduePaymentAmount > 0, calculate the total of the amount liabilities_overdue_amount_average: type: number example: 1000 description: >- From all liabilities that overduePaymentAmount > 0, calculate the average of the amount liabilities_ongoing_amortization_amount_sum: type: number example: 1000 description: >- Sum of all amortization amounts for ongoing/current liabilities (not yet fully paid off) liabilities_ongoing_amortization_amount_min: type: number example: 1000 description: >- Smallest of all amortization amounts for ongoing/current liabilities (not yet fully paid off) liabilities_ongoing_amortization_amount_max: type: number example: 1000 description: >- Largest of all amortization amounts for ongoing/current liabilities (not yet fully paid off) liabilities_ongoing_amortization_amount_average: type: number example: 1000 description: >- Average of all amortization amounts for ongoing/current liabilities (not yet fully paid off) liabilities_ongoing_amortization_amount_median: type: number example: 1000 description: >- Median of all amortization amounts for ongoing/current liabilities (not yet fully paid off) liabilities_ongoing_amortization_amount_std: type: number example: 1000 description: >- Standard deviation of all amortization amounts for ongoing/current liabilities (not yet fully paid off) liabilities_payment_count: type: number example: 10 description: Quantity of liability payments made (across all liability records) liabilities_payment_amount_max: type: number example: 1000 description: >- Largest amount of payments made for liabilities (across all liability records). liabilities_payment_amount_min: type: number example: 1000 description: >- Smallest amount of payments made for liabilities (across all liability records). liabilities_payment_amount_median: type: number example: 1000 description: >- Median amount of payments made for liabilities (across all liability records). liabilities_payment_amount_average: type: number example: 1000 description: >- Average amount of payments made for liabilities (across all liability records). liabilities_payment_amount_sum: type: number example: 1000 description: >- Total amount of payments made for liabilities (across all liability records). liabilities_payment_amount_std: type: number example: 1000 description: >- Standard deviation of payments made for liabilities (across all liability records). employments_current_status: type: string example: EMPLOYED description: >- The user's current employment status, may be one of: EMPLOYED, GIG (for gig economy workers), or UNEMPLOYED employments_employer_count: type: integer example: 3 description: Quantity of unique employers employments_current_tenure: type: integer example: 5 description: Quantity of months at current employer identity_age: type: integer example: 30 description: Age of the user based on date of birth link_days_since_first: type: integer example: 130 description: >- Number of days since the first account connection, if MAW is enabled. link_days_since_last: type: integer example: 2 description: Number of days since the last account connection, if MAW is enabled. link_day3_count: type: integer example: 2 description: >- Number of tenants this account has connected to in the last 3 days, if MAW is enabled. link_day7_count: type: integer example: 5 description: >- Number of tenants this account has connected to in the last 7 days, if MAW is enabled. link_day30_count: type: integer example: 8 description: >- Number of tenants this account has connected to in the last 30 days, if MAW is enabled. link_day90_count: type: integer example: 12 description: >- Number of tenants this account has connected to in the last 90 days, if MAW is enabled. link_day180_count: type: integer example: 12 description: >- Number of tenants this account has connected to in the last 180 days, if MAW is enabled. link_day365_count: type: integer example: 12 description: >- Number of tenants this account has connected to in the last 365 days, if MAW is enabled. link_day730_count: type: integer example: 12 description: >- Number of tenants this account has connected to in the last 730 days, if MAW is enabled. InsightPayload: type: object required: - id - cutoffTime - features properties: id: type: string example: insight-123456789012345678901234567890 cutoffTime: type: string title: Cutoff time for feature calculations. format: date-time example: '2021-04-14T09:30:24Z' description: Date and time features: $ref: '#/components/schemas/ObjectFeature' AllDatapointPayload: type: object properties: identity: $ref: '#/components/schemas/IdentityPayload' rating: $ref: '#/components/schemas/RatingPayload' documents: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/DocumentPayload' incomes: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/IncomePayload' transactions: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/TransactionPayload' employments: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/EmploymentPayload' contributions: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/ContributionPayload' liabilities: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/LiabilityPayload' eincomes: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/EincomePayload' links: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/LinkPayload' insight: $ref: '#/components/schemas/InsightPayload' UserPayload: description: The payload data for user type: object properties: metadata: $ref: '#/components/schemas/UserSession' forms: type: array items: type: object properties: id: type: string description: The form ID example: form-xxxxxxxxxxx name: type: string description: The form name example: Personal Information data: type: object description: The form data accounts: type: array items: type: object properties: id: type: string description: The account ID example: a-xxxxxxxxxxx providerId: type: string description: The provider ID example: nbi_ph payload: $ref: '#/components/schemas/AllDatapointPayload' archives: type: array items: type: object properties: id: type: string description: The archive ID example: archive-xxxxxxxxxxx fileType: type: string description: The file type example: payslip payload: $ref: '#/components/schemas/AllDatapointPayload' UserPayloadGetResponse: type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' description: The response code requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' description: The response message data: $ref: '#/components/schemas/UserPayload' CommonResponse: title: CommonResponse type: object required: - code - requestId properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' description: '' TokenPostResponse: title: Token Post Response properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Token' x-examples: {} ConsentTemplate: properties: id: description: Unique id for this consent template type: string createdAt: format: date-time type: string example: '2021-04-14T09:30:24Z' consentType: type: string maxLength: 200 minLength: 1 example: Terms and Conditions title: type: string maxLength: 200 minLength: 1 example: Terms and Conditions version: type: string maxLength: 64 minLength: 1 example: 1.0.0 consentMethod: type: string maxLength: 200 minLength: 0 example: I agree to the terms and conditions consentText: type: string maxLength: 65535 minLength: 1 example: ConsentTemplateListResponseData: properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: items: $ref: '#/components/schemas/ConsentTemplate' type: array type: object ConsentTemplateListResponse: properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/ConsentTemplateListResponseData' title: ConsentTemplatesListResponse type: object x-examples: {} ConsentTemplateCreateRequest: properties: consentType: type: string description: The type of consent template, e.g. Terms and Conditions maxLength: 200 minLength: 1 example: Terms and Conditions title: type: string description: >- The name of the consent document that will be visible to end users if you choose to make it visible. maxLength: 200 minLength: 1 example: Terms and Conditions version: type: string description: The version of the consent template maxLength: 64 minLength: 1 example: 1.0.0 consentMethod: type: string description: The method of consent maxLength: 200 minLength: 0 example: I agree to the terms and conditions consentText: type: string description: The content of the consent template maxLength: 65535 minLength: 1 example: required: - consentType - version - consentText ConsentTemplateCreateResponse: type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/ConsentTemplate' RefWebhookEventType: title: RefWebhookEventType description: Event Type which will be sent as a notification via webhook type: string enum: - USER_CREATED - ACCOUNT_CREATED - ACCOUNT_CONNECTED - ACCOUNT_DISCONNECTED - ACCOUNT_FAILED - TASK_STARTED - TASK_FINISHED - ACCOUNT_SYNC_TASK_FINISHED - ARCHIVE_STARTED - ARCHIVE_ANALYZED - ARCHIVE_REVOKED - ARCHIVE_FAILED - INVITE_INVITED - INVITE_LINKED - IDENTITY_ADDED - RATING_ADDED - TRANSACTIONS_ADDED - DOCUMENTS_ADDED - DOCUMENTS_UPDATED - EMPLOYMENTS_ADDED - EMPLOYMENTS_UPDATED - INCOMES_ADDED - INCOMES_UPDATED - CONTRIBUTIONS_ADDED - CONTRIBUTIONS_UPDATED - EINCOMES_ADDED - EINCOMES_UPDATED - LIABILITIES_ADDED - LIABILITIES_UPDATED - INSIGHT_ADDED - LINK_ADDED - VERIFICATION_STARTED - VERIFICATION_COMPLETED - RECORD_CREATED - RECORD_COMPLETED - USER_SESSION_COMPLETED - USER_SESSION_RESET - ALL_EVENTS example: ACCOUNT_CONNECTED Webhook: 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-tags: - Webhooks properties: id: $ref: '#/components/schemas/RefObjectID' createdAt: $ref: '#/components/schemas/RefDateTime' name: type: string description: Name of the webhook endpoint example: Event Notification Postback url: type: string description: URL of webhook, must begin with https:// example: https://webhook.clienturl.xyz secret: type: string description: >- The key that will be used to generate HMAC-SHA512 hex digest value in the Smile-Signature header. example: a little secret eventTypes: type: array description: Special events that you want to subscribe to items: $ref: '#/components/schemas/RefWebhookEventType' active: type: boolean default: true description: >- Set to true or false depending on if you would like to enable this webhook or not includePayload: type: boolean default: false description: >- Whether to put all datapoints' payload into the events(TASK_FINISHED_EVENT, ACCOUNT_SNYC_TASK_FINISHED_EVENT) updatedAt: $ref: '#/components/schemas/RefDateTime' required: - id - createdAt - name - url - eventTypes - active - updatedAt WebhookListResponse: title: WebhookListResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Webhook' WebhookPostRequest: title: WebhookPostRequest type: object properties: name: type: string minLength: 1 maxLength: 200 description: Name of the webhook endpoint example: Event Notification Postback url: type: string minLength: 1 maxLength: 500 description: URL of webhook, must begin with https:// example: https://webhook.clienturl.xyz eventTypes: type: array items: $ref: '#/components/schemas/RefWebhookEventType' active: type: boolean description: Whether to set this webhook active to received events includePayload: type: boolean default: false description: >- Whether to put all datapoints' payload into the events(TASK_FINISHED, ACCOUNT_SNYC_TASK_FINISHED) secret: type: string description: >- The key that will be used to generate HMAC-SHA512 hex digest value in the Smile-Signature header. example: a little secret minLength: 1 maxLength: 64 required: - name - url - eventTypes - active - secret WebhookPostResponse: title: WebhookPostResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Webhook' WebhookGetResponse: title: WebhookGetResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Webhook' WebhookDeleteResponse: title: WebhookDeleteResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' x-examples: {} TaskType: type: string description: Task type enum: - LINK_ACCOUNT - ANALYZE_ARCHIVE - CLASSIFY_ARCHIVE - UPDATE_ACCOUNT RefSourceType: type: string nullable: true title: Ref-Source-Type example: Account enum: - ACCOUNT - UPLOAD - ARCHIVE - SOCIAL_SECURITY description: Source Type ObjectReferenceMetadata: title: Reference Metadata type: object description: Metadata related to account-specific data properties: itemCreatedAt: $ref: '#/components/schemas/RefDateTime' createdAt: $ref: '#/components/schemas/RefDateTime' accountId: type: string deprecated: true description: The accountId of this object sourceId: type: string description: The ACCOUNT or ARCHIVE ID associated with this object sourceType: $ref: '#/components/schemas/RefSourceType' userId: type: string description: The user ID associated with this object providerId: type: string description: The provider ID associated with this object required: - createdAt - itemCreatedAt - sourceId - sourceType - userId - providerId Task: type: object required: - id - type - startedAt - status - metadata properties: id: type: string description: Task id type: $ref: '#/components/schemas/TaskType' startedAt: $ref: '#/components/schemas/RefDateTime' finishedAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: Task status enum: - Started - Finished datapoints: type: array description: The datapoints saved when the task finished items: $ref: '#/components/schemas/RefDatapoint' metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' TaskListResponse: title: Task List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Task' TaskGetResponse: title: Task Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Task' AccountConnectionStatus: type: string enum: - PENDING - AWAITING_MFA - ERROR - CONNECTED - DISCONNECTED description: Account connection status example: CONNECTED AccountMonitorStatus: type: string enum: - ACTIVE - USER_ACTION_REQUIRED - UNSUPPORTED - CUSTOMER_DISABLED description: Account CDS status example: ACTIVE AccountErrorCode: type: string enum: - ACCOUNT_DISABLED - ACCOUNT_INACCESSIBLE - ACCOUNT_INCOMPLETE - ACCOUNT_LOCKED - AUTH_REQUIRED - EXPIRED_CREDENTIALS - INVALID_ACCOUNT_TYPE - INVALID_AUTH - INVALID_CREDENTIALS - INVALID_MFA - MFA_TIMEOUT - SERVICE_UNAVAILABLE - SYSTEM_ERROR - TOS_REQUIRED - UNSUPPORTED_AUTH_TYPE - UNSUPPORTED_MFA_METHOD - null description: Error code example: ACCOUNT_DISABLED nullable: true Account: title: Account type: object description: Account of end-user from a particular employment data provider. x-tags: - Accounts x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' providerId: grab userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 connectionStatus: ERROR connection: status: ERROR errorCode: ACCOUNT_DISABLED errorMessage: Account is disabled updatedAt: '2021-04-14T09:30:24Z' monitorStatus: ACTIVE monitor: stust: ACTIVE updatedAt: '2021-04-14T09:30:24Z' properties: id: $ref: '#/components/schemas/RefObjectID' createdAt: $ref: '#/components/schemas/RefDateTime' providerId: type: string example: grab description: ID of the data provider userId: type: string description: User ID associated with this account example: tenant-5c1a2e8678e3494eba303ad1afa54ee8 connectionStatus: $ref: '#/components/schemas/AccountConnectionStatus' monitorStatus: $ref: '#/components/schemas/AccountMonitorStatus' monitor: type: object required: - status properties: status: $ref: '#/components/schemas/AccountMonitorStatus' updatedAt: $ref: '#/components/schemas/RefDateTime' connection: type: object required: - status - updatedAt properties: status: $ref: '#/components/schemas/AccountConnectionStatus' errorCode: $ref: '#/components/schemas/AccountErrorCode' errorMessage: type: string description: Error message example: Account is disabled nullable: true updatedAt: $ref: '#/components/schemas/RefDateTime' required: - id - createdAt - providerId - userId - connectionStatus - connection - monitorStatus - monitor AccountListResponse: title: Account List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Account' x-examples: {} AccountGetResponse: title: Account Get Response properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Account' x-examples: {} ObjectReferenceMetadata2: title: Reference Metadata2 type: object description: Metadata related to account-payload data properties: sourceId: type: string description: The ACCOUNT or ARCHIVE ID associated with this object sourceType: $ref: '#/components/schemas/RefSourceType' userId: type: string description: The user ID associated with this object providerId: type: string description: The provider ID associated with this object required: - sourceId - sourceType - userId - providerId AccountPayload: required: - metadata properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata2' identity: $ref: '#/components/schemas/IdentityPayload' rating: $ref: '#/components/schemas/RatingPayload' documents: type: array items: $ref: '#/components/schemas/DocumentPayload' incomes: type: array items: $ref: '#/components/schemas/IncomePayload' transactions: type: array items: $ref: '#/components/schemas/TransactionPayload' employments: type: array items: $ref: '#/components/schemas/EmploymentPayload' contributions: type: array items: $ref: '#/components/schemas/ContributionPayload' liabilities: type: array items: $ref: '#/components/schemas/LiabilityPayload' eincomes: type: array items: $ref: '#/components/schemas/EincomePayload' links: type: array items: $ref: '#/components/schemas/LinkPayload' insight: $ref: '#/components/schemas/InsightPayload' AccountPayloadGetResponse: title: Account Get Payload Response properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/AccountPayload' x-examples: {} ExportExtensionType: type: string description: The type of the export enum: - PDF - CSV AccountExportGenerateRequest: type: object required: - exportExtensionType properties: exportExtensionType: $ref: '#/components/schemas/ExportExtensionType' AccountExport: type: object required: - id - accountId - exportExtensionType - createdAt - downloadUrl - md5 properties: accountId: type: string description: The particular account ID id: type: string description: The unique ID of this export downloadUrl: type: string description: >- The url which can download the export. This url will become invalid after account revoked or more than 60 days ago. exportExtensionType: $ref: '#/components/schemas/ExportExtensionType' md5: type: string description: >- You can use this value to check whether the file is modified. Smile use Md5 algorithm to generate the value createdAt: $ref: '#/components/schemas/RefDateTime' AccountExportGenerateResponse: type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/AccountExport' InviteStatus: type: string enum: - INVITED - EMAIL_OPENED - LANDING_PAGE_OPENED - WINK_WIDGET_OPENED - LINKED - REVOKED description: Status of the invite Invite: title: Invite type: object description: Invitation for a user to share their data. x-tags: - Invites x-examples: Example: id: inv-b2c5e816-65ad-4130-819d-db89acc5869a createdAt: '2021-04-14T09:30:24Z' fullName: George Cimafranca Palomero, Jr firstName: George lastName: Palomero email: gpalomero1234@smileapi.io templateId: tpl-b2c5e816-65ad-4130-819d-db89acc5869a winkTemplateId: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d userId: tenant-17bbf36498de4d68a0d4f86c7b62f69f status: INVITED updatedAt: '2021-04-14T09:30:24Z' invitedAt: '2021-04-14T09:30:24Z' linkedAt: '2021-04-14T09:30:24Z' inviteLandingPageUrl: https://user.getsmileapi.com/invite-user/xx-xxxxxx?token=xxxxxxxxx properties: id: $ref: '#/components/schemas/RefObjectID' createdAt: $ref: '#/components/schemas/RefDateTime' fullName: type: string example: George Cimafranca Palomero, Jr description: The full name of the invited user firstName: type: string example: George description: The first name of the invited user lastName: type: string example: Palomero description: The last name of the invited user email: example: gpalomero1234@smileapi.io description: The email address of the invited user format: email type: string templateId: type: string description: The template ID used in the invitation example: tpl-b2c5e816-65ad-4130-819d-db89acc5869a winkTemplateId: type: string description: The Wink template ID used in the invitation example: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d userId: type: string description: The user ID for this invitation example: tenantId-b2c5e816-65ad-4130-819d-db89acc5869a status: $ref: '#/components/schemas/InviteStatus' updatedAt: $ref: '#/components/schemas/RefDateTime' invitedAt: $ref: '#/components/schemas/RefDateTime' linkedAt: $ref: '#/components/schemas/RefDateTime' inviteLandingPageUrl: type: string description: >- URL of the unique landing page for the invited user to connect their accounts required: - id - createdAt - fullName - email - templateId - userId - status - updatedAt - invitedAt - linkedAt InviteListResponse: title: InviteListResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Invite' x-examples: {} InvitePostRequest: title: InvitePostRequest type: object description: '' required: - email - fullName - templateId properties: fullName: type: string minLength: 1 maxLength: 200 example: George Cimafranca Palomero, Jr description: The full name of the person to be invited firstName: type: string minLength: 1 maxLength: 64 description: The first name of the person to be invited example: George lastName: type: string minLength: 1 maxLength: 64 description: The last name of the person to be invited example: Palomero email: type: string minLength: 1 maxLength: 200 example: gpalomero1234@smileapi.io description: Email of the person to be invited format: email templateId: type: string minLength: 1 maxLength: 64 description: The template ID to be used in the invite example: tpl-b2c5e816-65ad-4130-819d-db89acc5869a winkTemplateId: type: string minLength: 1 maxLength: 64 description: The Wink template ID used in the invitation example: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d InvitePostResponse: title: InvitePostResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Invite' x-examples: {} InviteGetResponse: title: InviteGetResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Invite' InviteLog: type: object description: Invite status change log x-examples: Example: id: invl-b2c5e816-65ad-4130-819d-db89acc5869a inviteId: inv-b2c5e816-65ad-4130-819d-db89acc5869a createdAt: '2021-04-14T09:30:24Z' inviteStatus: WINK_WIDGET_OPENED userId: tenant-17bbf36498de4d68a0d4f86c7b62f69f required: - id - inviteId - userId - inviteStatus - createdAt properties: id: $ref: '#/components/schemas/RefObjectID' inviteId: type: string description: the reference invite ID inviteStatus: $ref: '#/components/schemas/InviteStatus' userId: type: string createdAt: $ref: '#/components/schemas/RefDateTime' InviteLogListResponse: title: InviteLogListResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/InviteLog' x-examples: {} InviteTemplate: 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: replies@xyz.co 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: $ref: '#/components/schemas/RefObjectID' name: type: string description: Template name example: Email Template v1 company: type: object required: - name - logoUrl properties: name: type: string example: XYZ Bank description: >- Company name that it will appear in the invite landing page and any invitation message logoUrl: type: string example: https://xyzbank.co/logo.png 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 example: XYZ Bank replyAddress: type: string description: >- Reply-to address that will be shown when replying to an invite email example: replies@xyz.co format: email subject: type: string description: Subject that it will appear in the email message example: Please connect your work account to share your data with us body: type: string description: Text that it will appear in email message example: >- 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: type: object required: - header - description - button properties: header: type: string description: Header text that will appear in the landing page example: Share your employment and income data with us at ${companyName} description: type: string description: Description of the landing page example: >- 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: type: string description: Text that it will appear in the landing page example: START NOW successPage: type: object required: - header - description - button properties: header: type: string description: Header text that will appear in the success page example: >- Thank you for sharing your employment and income data with us at ${companyName} description: type: string description: >- Description of the success page after an account has been linked or data has been uploaded example: The process was successful! Please wait for us to get in touch! button: type: string description: Text that it will appear in the landing page example: Connect another account required: - id - name - company - email - landingPage - successPage InviteTemplateListResponse: title: InviteTemplateListResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/InviteTemplate' InviteTemplatePostRequest: type: object properties: name: type: string description: Template name example: Email Template v1 minLength: 1 maxLength: 64 company: type: object required: - name - logoUrl properties: name: type: string minLength: 1 maxLength: 200 example: XYZ Bank description: >- Company name that it will appear in the invite landing page and email or sms message logoUrl: type: string minLength: 1 maxLength: 200 example: https://xyzbank.co/logo.png 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 minLength: 1 maxLength: 200 description: Sender name that it will appear in the email message example: XYZ Bank replyAddress: type: string minLength: 1 maxLength: 200 description: >- Reply-to address that will be shown when replying to an invite email example: replies@xyz.co format: email subject: type: string minLength: 1 maxLength: 200 description: Subject that it will appear in the email message example: Please connect your work account to share your data with us body: type: string minLength: 1 maxLength: 5000 description: Text that it will appear in email message example: >- 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: type: object required: - header - description - button properties: header: type: string minLength: 1 maxLength: 200 description: Header text that will appear in the landing page example: >- 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. description: type: string minLength: 1 maxLength: 5000 description: Description of the landing page example: Share your employment and income data with us at ${companyName} button: type: string minLength: 1 maxLength: 200 description: Text that it will appear in the landing page example: START NOW successPage: type: object required: - header - description - button properties: header: type: string minLength: 1 maxLength: 200 description: Header text that will appear in the success page example: The process was successful! Please wait for us to get in touch! description: type: string minLength: 1 maxLength: 5000 description: >- Description of the success page after an account has been linked or data has been uploaded example: >- Thank you for sharing your employment and income data with us at ${companyName} button: type: string minLength: 1 maxLength: 200 description: Text that it will appear in the landing page example: Connect another account required: - name - company - email - landingPage - successPage title: InviteTemplatePostRequest description: '' InviteTemplatePostResponse: title: InviteTemplatePostResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/InviteTemplate' InviteTemplateGetResponse: title: InviteTemplateGetResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/InviteTemplate' InviteTemplateUpdateRequest: type: object properties: name: type: string minLength: 1 maxLength: 64 description: Template name example: Email Template v1 company: type: object required: - name - logoUrl properties: name: type: string minLength: 1 maxLength: 200 example: XYZ Bank description: >- Company name that it will appear in the invite landing page and email or sms message logoUrl: type: string minLength: 1 maxLength: 200 example: https://xyzbank.co/logo.png 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 minLength: 1 maxLength: 200 description: Sender name that it will appear in the email message example: XYZ Bank replyAddress: type: string minLength: 1 maxLength: 200 description: >- Reply-to address that will be shown when replying to an invite email example: replies@xyz.co format: email subject: type: string minLength: 1 maxLength: 200 description: Subject that it will appear in the email message example: Please connect your work account to share your data with us body: type: string minLength: 1 maxLength: 5000 description: Text that it will appear in email message example: >- 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 granting you a loan. It will be a quick process and should take no more than a few minutes of your time. landingPage: type: object required: - header - description - button properties: header: type: string minLength: 1 maxLength: 200 description: Header text that will appear in the landing page example: >- We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for granting you a loan. It will be a quick process and should take no more than a few minutes of your time. description: type: string minLength: 1 maxLength: 5000 description: Description of the landing page example: Share your employment and income data with us at ${companyName} button: type: string minLength: 1 maxLength: 200 description: Text that it will appear in the landing page example: START NOW successPage: type: object required: - header - description - button properties: header: type: string minLength: 1 maxLength: 200 description: Header text that will appear in the success page example: The process was successful! Please wait for us to get in touch! description: type: string minLength: 1 maxLength: 5000 description: >- Description of the success page after an account has been linked or data has been uploaded example: >- Thank you for sharing your employment and income data with us at ${companyName} button: type: string minLength: 1 maxLength: 200 description: Text that it will appear in the landing page example: Connect another account required: - name - company - email - landingPage - successPage title: InviteTemplateUpdateRequest description: '' InviteTemplateUpdateResponse: title: InviteTemplateUpdateResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/InviteTemplate' description: '' InviteTemplateDeleteResponse: title: InviteTemplateDeleteResponse type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' description: '' FileTypeId: title: FileTypeId type: string description: Upload file type. You can get all types from `/fileTypes` api example: PAYSLIP RawFile: title: RawFile type: object description: >- Scanned or photographed document or form uploaded by the user to share hard copy employment and income information. File size limit is 15 MB. x-examples: {} x-internal: false x-tags: - Uploads properties: id: $ref: '#/components/schemas/RefObjectID' createdAt: $ref: '#/components/schemas/RefDateTime' name: type: string example: Screen Shot 2021-04-14 at 5.30.24 PM description: File name subType: type: string example: PERSONAL_INFORMATION description: Type of document uploaded nullable: true size: type: integer description: File size in kilobytes example: 3048 format: type: string enum: - PDF - PNG - JPG - JPEG example: PNG description: File type (only JPEG, PNG, PDF, or JPG formats are supported) url: type: string description: URL to access the file. URL will expire after 60 days example: >- https://file.smileapi.io/tenants/smileapi/users/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg required: - id - createdAt - name - subType - size - format - url ArchiveClassification: type: object required: - fileType properties: fileType: type: string enum: - PAYSLIP - TAX_DOCUMENT - EMPLOYMENT_CERTIFICATE - BANK_STATEMENT - COMPANY_ID - CLEARANCE_NBI - GOVERNMENT_ID - TELCO_BILL - ELECTRICITY_BILL - WATER_BILL - OTHERS RefDate: type: string format: date description: The date, yyyy-MM-dd example: '2000-01-21' ArchivePayslipAnalysis: title: Payslip Analysis type: object properties: startDate: $ref: '#/components/schemas/RefDate' endDate: $ref: '#/components/schemas/RefDate' payDate: $ref: '#/components/schemas/RefDate' currency: $ref: '#/components/schemas/RefCurrency' grossAmount: type: number description: Gross amount netAmount: type: number description: Net amount employerName: type: string description: Employer name employeeName: type: string description: Employee name ssNumber: type: string description: Employee's Social Security (SS) Number philHealthNumber: type: string description: Employee's National Health Identification Number taxNumber: type: string description: Employee's Tax Identification Number pagIbigNumber: type: string description: Employee's National housing provident fund MID Number ArchiveTaxDocumentAnalysis: title: Tax Document Analysis type: object properties: startDate: $ref: '#/components/schemas/RefDate' endDate: $ref: '#/components/schemas/RefDate' grossAmount: type: number description: Gross amount baseAmount: type: number description: Base amount employerName: type: string employeeName: type: string description: Employee name taxNumber: type: string description: Employee's Tax Identification Number ArchiveNbiClearanceDocumentAnalysis: title: NBI clearance Document Analysis type: object properties: expireDate: $ref: '#/components/schemas/RefDate' dateOfBirth: $ref: '#/components/schemas/RefDate' firstName: type: string description: First name lastName: type: string description: Last name middleName: type: string description: Middle name nbiIdNumber: type: string description: NBI Clearance Document Number address: type: string description: Address maritalStatus: $ref: '#/components/schemas/RefMaritalStatus' gender: $ref: '#/components/schemas/RefGender' citizenship: type: string description: Citizenship remark: type: string description: Remarks included in the document ArchiveTelcoBillAnalysis: type: object properties: fullName: type: string description: Full name firstName: type: string description: First name lastName: type: string description: Last name middleName: type: string description: Middle name accountNumber: type: string description: Account number address: type: string description: Address startDate: type: string format: date description: Period start date, in YYYY-MM-DD format endDate: type: string format: date description: Period end date, in YYYY-MM-DD format statementDate: type: string format: date description: Statement date, in YYYY-MM-DD format statementNumber: type: string description: Statement number dueDate: type: string format: date description: Due date, in YYYY-MM-DD format paymentDate: type: string format: date description: Payment date, in YYYY-MM-DD format dueAmount: type: number description: Due amount vatAmount: type: number description: Vat amount adjustmentAmount: type: number description: Adjustment amount currentBillAmount: type: number description: Current bill amount balanceAmount: type: number description: Balance amount previousDueAmount: type: number description: Previous due amount currency: $ref: '#/components/schemas/RefCurrency' emailAddress: type: string description: Email address phoneNumber: type: string description: Phone number supplier: type: string description: Supplier name ArchiveElectricityBillAnalysis: type: object properties: fullName: type: string description: Full name firstName: type: string description: First name lastName: type: string description: Last name middleName: type: string description: Middle name accountNumber: type: string description: Account number address: type: string description: Address startDate: type: string format: date description: Period start date, in YYYY-MM-DD format endDate: type: string format: date description: Period end date, in YYYY-MM-DD format statementDate: type: string format: date description: Statement date, in YYYY-MM-DD format dueDate: type: string format: date description: Due date, in YYYY-MM-DD format paymentDate: type: string format: date description: Payment date, in YYYY-MM-DD format dueAmount: type: number description: Due amount vatAmount: type: number description: Vat amount currentBillAmount: type: number description: Current bill amount balanceAmount: type: number description: Balance amount previousDueAmount: type: number description: Previous due amount currency: $ref: '#/components/schemas/RefCurrency' emailAddress: type: string description: Email address phoneNumber: type: string description: Phone number statementNumber: type: string description: Statement number currentPeriodUsage: type: number description: Current period usage previousReading: type: number description: Previous period usage presentReading: type: number description: Present period usage supplier: type: string description: Supplier name ArchiveWaterBillAnalysis: type: object properties: fullName: type: string description: Full name firstName: type: string description: First name lastName: type: string description: Last name middleName: type: string description: Middle name accountNumber: type: string description: Account number address: type: string description: Address startDate: type: string format: date description: Period start date, in YYYY-MM-DD format endDate: type: string format: date description: Period end date, in YYYY-MM-DD format statementDate: type: string format: date description: Statement date, in YYYY-MM-DD format dueDate: type: string format: date description: Due date, in YYYY-MM-DD format paymentDate: type: string format: date description: Payment date, in YYYY-MM-DD format dueAmount: type: number description: Due amount vatAmount: type: number description: Vat amount currentBillAmount: type: number description: Current bill amount balanceAmount: type: number description: Balance amount previousDueAmount: type: number description: Previous due amount currency: $ref: '#/components/schemas/RefCurrency' emailAddress: type: string description: Email address phoneNumber: type: string description: Phone number statementNumber: type: string description: Statement number currentPeriodUsage: type: number description: Current period usage previousReading: type: number description: Previous period usage presentReading: type: number description: Present period usage supplier: type: string description: Supplier name ArchiveEmploymentCertificateAnalysis: type: object properties: employerName: type: string description: Name of the company or business employing the individual fullName: type: string description: Name of the employee the CoE is for firstName: type: string description: First name middleName: type: string description: Middle name lastName: type: string description: Last name employeeIdNumber: type: string description: >- Any ID number of the employee found in the document (optional) - may be employee ID, may be any government ID employeeIdType: type: string description: Type of ID if found; required if employeeIdNumber is found position: type: string description: Position of the employee if found department: type: string description: Department of the employee if found employmentStatus: type: string description: Employment status of the employee if found startDate: type: string format: date description: >- Start date of the employee's employment with the company, in YYYY-MM-DD format endDate: type: string format: date description: >- End date of the employee's employment with the company, if found, in YYYY-MM-DD format salaryAmount: type: number description: Salary amount salaryTerm: type: string description: Salary term currency: $ref: '#/components/schemas/RefCurrency' description: ISO 4217 currency code purpose: type: string description: Purpose of the certificate of employment remarks: type: string description: Any additional remarks that may be provided issueDate: type: string format: date description: >- Date when the certificate of employment was issued, in YYYY-MM-DD format signatoryName: type: string description: Full name of the signatory signatoryPosition: type: string description: Position of the signatory ArchiveAnalysis: deprecated: true allOf: - $ref: '#/components/schemas/ArchivePayslipAnalysis' - $ref: '#/components/schemas/ArchiveTaxDocumentAnalysis' - $ref: '#/components/schemas/ArchiveNbiClearanceDocumentAnalysis' - $ref: '#/components/schemas/ArchiveTelcoBillAnalysis' - $ref: '#/components/schemas/ArchiveElectricityBillAnalysis' - $ref: '#/components/schemas/ArchiveWaterBillAnalysis' - $ref: '#/components/schemas/ArchiveEmploymentCertificateAnalysis' ArchivePayslipExtraction: type: object required: - fileType properties: fileType: type: string analysis: $ref: '#/components/schemas/ArchivePayslipAnalysis' ArchiveTaxDocumentExtraction: type: object required: - fileType properties: fileType: type: string analysis: $ref: '#/components/schemas/ArchiveTaxDocumentAnalysis' ArchiveNbiClearanceDocumentExtraction: type: object required: - fileType properties: fileType: type: string analysis: $ref: '#/components/schemas/ArchiveNbiClearanceDocumentAnalysis' ArchiveTelcoBillExtraction: type: object required: - fileType properties: fileType: type: string analysis: $ref: '#/components/schemas/ArchiveTelcoBillAnalysis' ArchiveElectricityBillExtraction: type: object required: - fileType properties: fileType: type: string analysis: $ref: '#/components/schemas/ArchiveElectricityBillAnalysis' ArchiveWaterBillExtraction: type: object required: - fileType properties: fileType: type: string analysis: $ref: '#/components/schemas/ArchiveWaterBillAnalysis' ArchiveEmploymentCertificateExtraction: type: object required: - fileType properties: fileType: type: string analysis: $ref: '#/components/schemas/ArchiveEmploymentCertificateAnalysis' ArchiveExtraction: oneOf: - $ref: '#/components/schemas/ArchivePayslipExtraction' - $ref: '#/components/schemas/ArchiveTaxDocumentExtraction' - $ref: '#/components/schemas/ArchiveNbiClearanceDocumentExtraction' - $ref: '#/components/schemas/ArchiveTelcoBillExtraction' - $ref: '#/components/schemas/ArchiveElectricityBillExtraction' - $ref: '#/components/schemas/ArchiveWaterBillExtraction' - $ref: '#/components/schemas/ArchiveEmploymentCertificateExtraction' discriminator: propertyName: fileType mapping: PAYSLIP: '#/components/schemas/ArchivePayslipExtraction' TAX_DOCUMENT: '#/components/schemas/ArchiveTaxDocumentExtraction' CLEARANCE_NBI: '#/components/schemas/ArchiveNbiClearanceDocumentExtraction' TELCO_BILL: '#/components/schemas/ArchiveTelcoBillExtraction' ELECTRICITY_BILL: '#/components/schemas/ArchiveElectricityBillExtraction' WATER_BILL: '#/components/schemas/ArchiveWaterBillExtraction' EMPLOYMENT_CERTIFICATE: '#/components/schemas/ArchiveEmploymentCertificateExtraction' ArchiveValidationResult: type: object required: - resultCode properties: resultCode: type: string enum: - PASSED - FAILED - NO_DATA score: type: number description: Validation score. 0-100. resultMessage: type: string description: Validation result message. ArchiveValidation: type: object required: - fileType properties: fileType: type: string description: Archive file type metadata: $ref: '#/components/schemas/ArchiveValidationResult' computation: $ref: '#/components/schemas/ArchiveValidationResult' identity: $ref: '#/components/schemas/ArchiveValidationResult' location: $ref: '#/components/schemas/ArchiveValidationResult' Archive: title: Archive type: object description: Collection of files. 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/users/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg classification: null analysis: null x-tags: - Archives properties: id: $ref: '#/components/schemas/RefObjectID' createdAt: $ref: '#/components/schemas/RefDateTime' providerId: type: string example: user-provided description: >- ID of the data provider, 'user-provided' if files are provided by the user, or 'tenant-provided' if files are provided via API userId: type: string description: User ID associated with this archive example: tenant-5c1a2e8678e3494eba303ad1afa54ee8 type: $ref: '#/components/schemas/FileTypeId' state: type: object required: - status - updatedAt properties: status: type: string example: STARTED enum: - STARTED - ANALYZED - UNSUPPORTED - ERROR - REVOKED description: Archive status errorCode: type: string description: Error code enum: - MISSING_MANDATARY_FIELD - MISSING_MANDATORY_FIELD - INVALID_FIELD_FORMAT - SYSTEM_ERROR - null nullable: true errorMessage: type: string description: Error message nullable: true updatedAt: $ref: '#/components/schemas/RefDateTime' rawFiles: description: Collection of files type: array items: $ref: '#/components/schemas/RawFile' classification: $ref: '#/components/schemas/ArchiveClassification' analysis: $ref: '#/components/schemas/ArchiveAnalysis' extraction: $ref: '#/components/schemas/ArchiveExtraction' validation: $ref: '#/components/schemas/ArchiveValidation' required: - id - createdAt - providerId - userId - type - state - rawFiles ArchiveListResponse: title: Archive List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Archive' FileSubtype: type: string enum: - PAYSLIP - PERSONAL_INFORMATION - EMPLOYMENT_INFORMATION - TAX_PAYMENT - COMPANY_ID_FRONT - COMPANY_ID_BACK - CARD_FRONT - CARD_BACK FileObject: type: object required: - fileContent - fileExtensionType properties: fileSubtype: $ref: '#/components/schemas/FileSubtype' fileName: type: string description: >- raw file name. If null, then Smile will use the file name from the fileType. fileExtensionType: type: string description: raw file type enum: - PDF - PNG - JPG - JPEG fileContent: type: string description: Archive file content, use base64 of file byte data ArchiveCreateRequest: type: object required: - files properties: userId: type: string description: >- User ID associated with this archive. If null, then Smile will create a new user associated with this archive fileType: $ref: '#/components/schemas/FileTypeId' rawFiles: type: array minItems: 1 items: $ref: '#/components/schemas/FileObject' ArchiveCreateResponse: title: Archive Create Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Archive' description: Create Archive Response ArchiveGetResponse: title: Archive Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Archive' description: '' ArchiveClassifyRequest: type: object properties: userId: type: string description: >- User ID associated with this archive. If null, then Smile will create a new user associated with this archive rawFiles: type: array minItems: 1 items: $ref: '#/components/schemas/FileObject' ArchiveClassifyResponse: type: object title: Archive Classify Response properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Archive' ArchivePayslipRawFileUploadRequest: type: object required: - userId - fileContent - fileExtensionType properties: userId: type: string fileExtensionType: type: string description: raw file type enum: - PDF - PNG - JPG - JPEG fileContent: type: string description: Payslip file content, use base64 of file byte data ArchiveResponse: title: Archive Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Archive' description: '' ArchivePayslip: type: object properties: startDate: type: string format: date description: Start date of the payslip period, in YYYY-MM-DD format endDate: type: string format: date description: End date of the payslip period, in YYYY-MM-DD format payDate: type: string format: date description: Pay date of the payslip, in YYYY-MM-DD format currency: $ref: '#/components/schemas/RefCurrency' grossAmount: type: number description: Gross amount netAmount: type: number description: Net amount employerName: type: string description: Employer name employeeName: type: string description: Employee name ssNumber: type: string description: Employee's Social Security (SS) Number philHealthNumber: type: string description: Employee's National Health Identification Number taxNumber: type: string description: Employee's Tax Identification Number pagIbigNumber: type: string description: Employee's National housing provident fund MID Number matchResult: type: object properties: employeeNameAndIdentificationNumberMatchScore: type: integer maximum: 100 minimum: 0 description: >- The match score of the employee's name and all identification numbers. If Smile can not verify it or you disabled verify feature, this value will be null. If mutilple identification numbers have a match score, take the lowest match score. employeeNameAndSsNumberMatchScore: type: integer maximum: 100 minimum: 0 description: >- The match score of the employee name and SS Number. If Smile can not verify it or you disabled verify feature, this value will be null. employeeNameAndPagIbigNumberMatchScore: type: integer maximum: 100 minimum: 0 description: >- The match score of the employee name and National housing provident fund number. If Smile can not verify it or you disabled verify feature, this value will be null. employeeNameAndPhilHealthNumberMatchScore: type: integer maximum: 100 minimum: 0 description: >- The match score of the employee name and National Health number. If Smile can not verify it or you disabled verify feature, this value will be null. employeeNameAndTaxNumberMatchScore: type: integer maximum: 100 minimum: 0 description: >- The match score of the employee name and tax ID number. If Smile can not verify it or you disabled verify feature, this value will be null. ArchivePayslipMetaData: type: object required: - metadata properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' ArchivePayslipPredictionQueryResponseData: allOf: - $ref: '#/components/schemas/ArchivePayslip' - $ref: '#/components/schemas/ArchivePayslipMetaData' ArchivePayslipPredictionQueryResponse: title: Archive Payslip Prediction Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/ArchivePayslipPredictionQueryResponseData' description: '' ArchivePayslipPredictionsListResponse: title: Archive Payslip Predictions List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/ArchivePayslipPredictionQueryResponseData' x-examples: {} ArchivePayslipManualResultSendRequest: type: object required: - archiveId - validFile properties: archiveId: type: string validFile: type: boolean description: The file is payslip or not checkedFields: type: array description: Which fields already checked manually. items: type: string data: type: object properties: startDate: type: string format: date description: start date of the payslip endDate: type: string format: date description: end date of the payslip currency: $ref: '#/components/schemas/RefCurrency' grossAmount: type: number description: Base amount netAmount: type: number description: Base amount employerName: type: string employeeName: type: string description: Employee name payDate: type: string format: date description: pay date of the payslip ssNumber: type: string description: Employee' Social Security (SS) Number philHealthNumber: type: string description: Employee' National Health Identification Number taxNumber: type: string description: Employee' Tax Identification Number pagIbigNumber: type: string description: Employee' National housing provident fund MID Number Upload: 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/users/smileapi-17bbf36498de4d68a0d4f86c7b62f69f/files/file-17bbf36498de4d68a0d4f86c7b62f69f.jpeg x-tags: - Uploads properties: id: $ref: '#/components/schemas/RefObjectID' createdAt: $ref: '#/components/schemas/RefDateTime' providerId: type: string example: user-provided description: >- ID of the data provider, 'user-provided' if files are provided by the user, or 'tenant-provided' if files are provided via API userId: type: string description: User ID associated with this archive example: tenant-5c1a2e8678e3494eba303ad1afa54ee8 type: $ref: '#/components/schemas/FileTypeId' state: type: object required: - status - updatedAt properties: status: type: string example: STARTED enum: - STARTED - ANALYZED - UNSUPPORTED - ERROR - REVOKED description: Upload status errorCode: type: string description: Error code enum: - MISSING_MANDATARY_FIELD - MISSING_MANDATORY_FIELD - INVALID_FIELD_FORMAT - SYSTEM_ERROR - null nullable: true errorMessage: type: string description: Error message nullable: true updatedAt: $ref: '#/components/schemas/RefDateTime' rawFiles: description: Collection of files type: array items: $ref: '#/components/schemas/RawFile' required: - id - createdAt - providerId - userId - type - state - rawFiles UploadListResponse: title: Upload List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Upload' UploadGetResponse: title: Upload Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Upload' description: '' FileType: title: FileType type: object description: File types that are available for upload. x-examples: Example: logoUrl: >- https://cdn.smileapi.io/image/provider-logo/v20210813064500/SOCIAL_SECURITY.png type: SOCIAL_SECURITY typeLabel: SOCIAL SECURITY Records active: true enabled: true ocr: true supported: - IDENTITIES - DOCUMENTS - EMPLOYMENTS x-tags: - File Types properties: logoUrl: type: string description: URL to the file type image example: >- https://cdn.smileapi.io/image/provider-logo/v20210813064500/SOCIAL_SECURITY.png type: $ref: '#/components/schemas/FileTypeId' typeLabel: type: string description: Upload file type label example: SOCIAL SECURITY Records active: type: boolean description: Indicates whether upload for file type is working enabled: type: boolean description: >- Indicates whether whether upload of file type is enabled or access is allowed for the client ocr: type: boolean description: Whether OCR for file type is supported supported: type: array description: The datapoints that the provider could support items: type: string description: Datapoint enum: - IDENTITIES - TRANSACTIONS - RATINGS - EMPLOYMENTS - DOCUMENTS - INCOMES - CONTRIBUTIONS - EINCOMES - LIABILITIES - NONE required: - logoUrl - type - typeLabel - active - enabled - ocr - supported FileTypeListResponse: title: FileType List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/FileType' Identity: type: object title: Identity description: >- The stored identity information of the user from an employment data provider. x-examples: Example: id: i-17bbf36498de4d68a0d4f86c7b62f69f fullName: George Cimafranca Palomero, Jr firstName: George middleName: Cimafranca lastName: Palomero suffix: Jr gender: Male dob: '1970-08-24' maritalStatus: Married countryResidence: PH citizenship: Citizen photoUrl: https://cdn.smileapi.io/image/avatar/v20211115191600/george.jpg referenceId: null profileUrl: null emails: - address: gpalomero1234@yahoo.com type: Primary phones: - number: '+639559991234' type: Mobile socialProfiles: - socialUrl: https://www.facebook.com/gpalomero type: Facebook addresses: - fullAddress: 12 Maybunga St, Barangay Paraiso, Pasig City, NCR, 1600, PH line1: 12 Maybunga St line2: Barangay Paraiso city: Pasig City region: NCR zip: '1600' country: PH latitude: '14.573454' longitude: '121.085042' type: Primary metadata: createdAt: '2021-04-14T09:30:24Z' itemCreatedAt: '2021-04-14T09:30:26Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork x-tags: - Identities allOf: - $ref: '#/components/schemas/IdentityPayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' required: - id - fullName - emails - phones - socialProfiles - addresses - metadata IdentityListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Identity' IdentityListResponse: title: Identity List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/IdentityListData' x-examples: {} IdentityGetResponse: title: Identity Get Response properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Identity' x-examples: {} Rating: title: Rating type: object description: >- The stored performance ratings of the user in the employment data provider. x-internal: false x-examples: Example: id: r-17bbf36498de4d68a0d4f86c7b62f69f currentRating: 90 maxRating: 100 calculatedPercentage: 90 reviewsReceived: 12 likesReceived: 8 jobsCompleted: 12 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork x-tags: - Ratings allOf: - $ref: '#/components/schemas/RatingPayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' required: - id - metadata RatingListResponse: title: Rating List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Rating' RatingGetResponse: title: Rating Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Rating' Document: title: Document type: object x-internal: false description: >- The stored document-related information of the user from an employment data provider. x-examples: Example: id: d-17bbf36498de4d68a0d4f86c7b62f69f name: Facebook Social Media Marketing Professional Certificate docId: ABCD123456 documentType: IDENTIFICATION status: VALID issueDate: '2007-08-24' expiryDate: '2010-08-24' fileUrl: >- https://images.credly.com/size/680x680/images/c4a900b7-8d1b-4e8f-a572-347985eeaa5c/Coursera_Badge__1_.png remarks: NO RECORD ON FILE metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork x-tags: - Documents allOf: - $ref: '#/components/schemas/DocumentPayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' required: - id - name - metadata DocumentListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Document' DocumentListResponse: title: Document List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/DocumentListData' DocumentGetResponse: title: Document Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Document' Employment: 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 employerNumber: ER-654321 employer: ABC Corporation status: Permanent startDate: '2016-02-24' endDate: '2019-08-24' reportedDate: '2019-08-25' metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: UPLOAD userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: abccorp x-tags: - Employments allOf: - $ref: '#/components/schemas/EmploymentPayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' required: - id - startDate - metadata EmploymentListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Employment' EmploymentListResponse: title: Employment List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/EmploymentListData' EmploymentGetResponse: title: Employment Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Employment' Income: title: Income type: object description: >- The stored income information of the user from an employment data provider. x-examples: Example: id: inc-17bbf36498de4d68a0d4f86c7b62f69f workItem: null employer: ABC Corporation startDate: '2021-06-01' endDate: '2021-06-15' currency: PHP frequency: Monthly baseAmount: 8500 grossAmount: 10000 netAmount: 7820.25 metadata: createdAt: '2021-06-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: UPLOAD userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: user-provided x-internal: false x-tags: - Incomes allOf: - $ref: '#/components/schemas/IncomePayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' required: - id - startDate - currency - metadata IncomeListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Income' IncomeListResponse: title: Income List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/IncomeListData' IncomeGetResponse: title: Income Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Income' Consent: type: object required: - consentedAt - consentedWith properties: type: type: string description: >- The consent flag key, the consent content should be sent to Smile previously example: Terms and Conditions version: type: string description: The version of this consent example: 1.0.0 consentedAt: $ref: '#/components/schemas/RefDateTime' consentedWith: type: string description: The short sentences display on the consent page. example: I agree to the terms and conditions consentTemplateId: type: string description: >- The related consent template id, you can get it from Smile Developer Portal or /consentTemplates endpoint. IncomeEstimatorPostRequest: type: object required: - consent - templateId - emailAddress - countryCode properties: consent: $ref: '#/components/schemas/Consent' templateId: type: string description: >- Fixed template ID for this request. The value must be `tpl-incomeestimator-001`. enum: - tpl-incomeestimator-001 example: tpl-incomeestimator-001 emailAddress: type: string format: email description: The email address of the subject. example: gpalomero1234@smileapi.io countryCode: $ref: '#/components/schemas/RefCountry' IncomeEstimatorIncome: type: object required: - monthlyMin - monthlyMax - currency - tier properties: monthlyMin: type: number description: The estimated minimum monthly income. example: 50000 monthlyMax: type: number description: The estimated maximum monthly income. example: 100000 currency: $ref: '#/components/schemas/RefCurrency' tier: type: string description: >- A convenience label for presenting the estimated income tier in a user interface. Use `probability` as the primary decisioning signal. enum: - LOW - MIDDLE - HIGH example: HIGH IncomeEstimatorResult: type: object required: - income - probability - certainty - modelVersion properties: income: $ref: '#/components/schemas/IncomeEstimatorIncome' probability: type: number minimum: 0 maximum: 1 description: >- The raw probability produced by the model that the subject is a High earner. Use this value as the primary decisioning signal. example: 0.7388 certainty: type: string description: >- A categorical measure of how far `probability` is from the decision boundary of 0.5. A higher certainty means the probability is farther from 0.5; this field is not another probability. enum: - HIGH - MEDIUM - LOW example: MEDIUM modelVersion: type: string description: The version of the model used to produce the result. example: 1.0.0 IncomeEstimator: type: object required: - id - createdAt - status - requestMeta properties: id: type: string description: The unique ID of the IncomeEstimator. example: ind-1234567890 createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: The current status of the IncomeEstimator. enum: - PROCESSING - ERROR - COMPLETED resultCode: type: string description: The final result code of the IncomeEstimator. enum: - SUCCESS - NO_DATA - SYSTEM_ERROR - SERVICE_UNAVAILABLE resultMessage: type: string description: A detailed description of the final result of the IncomeEstimator. requestMeta: $ref: '#/components/schemas/IncomeEstimatorPostRequest' result: $ref: '#/components/schemas/IncomeEstimatorResult' IncomeEstimatorListResponse: title: IncomeEstimator List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/IncomeEstimator' IncomeEstimatorPostResponse: title: IncomeEstimator Post Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/IncomeEstimator' IncomeEstimatorGetResponse: title: IncomeEstimator Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/IncomeEstimator' Contribution: title: Contribution x-stoplight: id: ymth27j2l09a4 type: object description: >- The social security insurance contribution made by, or in behalf, of a user as recorded by the employment data provider. x-examples: Example: id: 17bbf36498de4d68a0d4f86c7b62f69f date: '2021-04-30' currency: PHP amount: 1375 referenceId: PA9634415 metadata: createdAt: '2021-04-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: example_id x-tags: - Contributions allOf: - $ref: '#/components/schemas/ContributionPayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' ContributionListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Contribution' ContributionListResponse: title: Contribution List Response x-stoplight: id: xqq606vnqa1nk type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/ContributionListData' ContributionGetResponse: title: Contribution Get Response x-stoplight: id: 9r9jv3d46jvrw type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Contribution' Liability: title: Liability type: object description: The liabilities of the user from an employment data provider. x-examples: Example: id: lia-123abc456def789abc123def456abc78 type: Salary Loan referenceId: SL201601011234567 startDate: '2016-07-05' firstAmortizationDate: '2016-09-01' endDate: '2017-08-01' amortizationFrequency: Monthly currency: PHP loanAmount: 16000 amortizationAmount: 738.32 outstandingBalance: 25599.76 nextPaymentAmount: 732.38 overduePaymentAmount: 0 metadata: createdAt: '2021-06-14T09:30:24Z' sourceId: a-123abc456def789abc123def456abc78 sourceType: ACCOUNT userId: tenantId-123abc456def789abc123def456abc78 providerId: abccorp x-internal: false x-tags: - Liabilities allOf: - $ref: '#/components/schemas/LiabilityPayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' required: - id - type - startDate - loanAmount - currency - amortizationFrequency - metadata LiabilityListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Liability' LiabilityListResponse: title: Liability List Response type: object allOf: - $ref: '#/components/schemas/CommonResponse' - properties: data: $ref: '#/components/schemas/LiabilityListData' LiabilityGetResponse: title: Liability Get Response type: object allOf: - $ref: '#/components/schemas/CommonResponse' - properties: data: $ref: '#/components/schemas/Liability' Transaction: 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: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: upwork allOf: - $ref: '#/components/schemas/TransactionPayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' required: - id - date - currency - amount - metadata TransactionListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Transaction' TransactionListResponse: title: Transaction List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/TransactionListData' x-examples: {} TransactionGetResponse: title: Transaction Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Transaction' x-examples: {} Form: title: Form type: object x-internal: false description: The stored form information of the user from an wink site. x-examples: Example: id: form-17bbf36498de4d68a0d4f86c7b62f69f createdAt: '2021-04-14T09:30:24Z' name: Personal Information userId: tenant-5c1a2e8678e3494eb winkSiteId: ws-17bbf36498de4d68a0d4f86c7b62f69f winkSiteSessionId: wss-17bbf36498df69fe4d68a0d4f86c7b62 reference: form_1 data: firstName: John lastName: Doe email: john.doe@abc.com x-tags: - Forms properties: id: $ref: '#/components/schemas/RefObjectID' createdAt: $ref: '#/components/schemas/RefDateTime' name: type: string description: The name of the form. example: Personal Information nullable: true maxLength: 255 userId: type: string description: The ID of the user who submitted the form. example: tenant-5c1a2e8678e3494eb winkSiteId: type: string description: The ID of the wink site where the form was submitted. example: ws-17bbf36498de4d68a0d4f86c7b62f69f winkSiteSessionId: type: string description: The ID of the wink site session where the form was submitted. example: wss-17bbf36498df69fe4d68a0d4f86c7b62 reference: type: string description: The reference of the form. example: form_1 data: type: object description: The data submitted by the user. additionalProperties: type: object required: - id - createdAt - winkSiteId - winkSiteSessionId - userId - reference - data FormListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Form' FormListResponse: title: Form List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/FormListData' FormGetResponse: title: Form Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Form' Eincome: title: Eincome type: object description: >- The stored eincome information of the user from an employment data provider. x-examples: Example: id: einc-17bbf36498de4d68a0d4f86c7b62f69f month: 2021-06 currency: PHP amount: 8500 metadata: createdAt: '2021-06-14T09:30:24Z' sourceId: a-17bbf36498de4d68a0d4f86c7b62f69f sourceType: ACCOUNT userId: tenant-5c1a2e8678e3494eba303ad1afa54ee8 providerId: example_id x-internal: false x-tags: - Estimated Incomes allOf: - $ref: '#/components/schemas/EincomePayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' required: - id - month - currency - baseAmount - amount - metadata EincomeListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Eincome' EincomeListResponse: title: Enhanced Income List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/EincomeListData' EincomeGetResponse: title: Enhanced Income Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Eincome' Insight: title: Insight type: object allOf: - $ref: '#/components/schemas/InsightPayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' InsightListResponse: title: Insight List Response type: object allOf: - $ref: '#/components/schemas/CommonResponse' - properties: data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Insight' InsightGetResponse: title: Insight Get Response type: object allOf: - $ref: '#/components/schemas/CommonResponse' - properties: data: $ref: '#/components/schemas/Insight' VerificationIdType: type: string VerificationId: type: object required: - idType - idNumber properties: idType: $ref: '#/components/schemas/VerificationIdType' idSubType: type: string description: >- If idType = prclicense_ph, subtype should be one of the PrcProfessionEnum value. example: CERTIFIED PUBLIC ACCOUNTANT idNumber: type: string description: The ID number example: '1234567890' VerificationCreateRequest: type: object required: - consent properties: firstName: type: string example: John description: First Name middleName: type: string example: Doe description: Middle Name lastName: type: string example: Smith description: Last Name suffix: type: string example: Jr description: Suffix fullName: type: string example: John Doe Smith Jr description: Full Name additionalData: type: object properties: email: type: string description: Email Address example: john.doe@smile.com phone: type: string example: 6391234567890 dob: $ref: '#/components/schemas/RefDate' gender: $ref: '#/components/schemas/RefGender' address: type: string example: 123 Main St, Anytown, CA 12345 description: The address you want to verify employer: type: string example: Google description: Employer name employmentStatus: type: string description: Employment status enum: - EMPLOYED - UNEMPLOYED - SELF-EMPLOYED - GIG - RETIRED ids: type: array items: $ref: '#/components/schemas/VerificationId' consent: $ref: '#/components/schemas/Consent' VerificationIdMatchResult: type: object required: - idNumber - idType - matches properties: idNumber: type: string idType: type: string idSubtype: type: string matches: type: boolean VerificationContactMatchResult: type: object properties: value: type: string description: The value of the contact matches: type: boolean description: >- Full match result. If request without this field or Smile do not support to match this field, then the value is null. disposable: type: boolean description: >- Disposable email/phone. If request without this field or Smile do not support to match this field, then the value is null. deliverable: type: boolean description: >- Deliverable email/phone. If request without this field or Smile do not support to match this field, then the value is null. active: type: boolean description: >- Active email/phone. If request without this field or Smile do not support to match this field, then the value is null. provider: type: string description: The provider of the contact freeProvider: type: boolean description: If the provider is free provider. VerificationResult: type: object required: - finalMatches - names properties: finalMatches: type: boolean description: The final match result names: type: object properties: firstNameMatches: type: boolean description: >- First name fuzzy match result. If request without firstName or Smile do not support to match this field, then the value is null. lastNameMatches: type: boolean description: >- First name fuzzy match result. If request without lastName or Smile do not support to match this field, then the value is null. middleNameMatches: type: boolean description: >- Middle name fuzzy match result. If request without middleName or Smile do not support to match this field, then the value is null. fullNameMatches: type: boolean description: >- Full name fuzzy match result. If request without fullName or Smile do not support to match this field, then the value is null. additionalData: type: object properties: ids: type: array items: $ref: '#/components/schemas/VerificationIdMatchResult' dobMatches: type: boolean description: >- Dob full match result. If request without dob or Smile do not support to match this field, then the value is null. genderMatches: type: boolean description: >- Gender full match result. If request without gender or Smile do not support to match this field, then the value is null. phoneMatches: $ref: '#/components/schemas/VerificationContactMatchResult' emailMatches: $ref: '#/components/schemas/VerificationContactMatchResult' addressMatches: type: boolean description: >- Address fuzzy match result. If request without address or Smile do not support to match this field, then the value is null. Verification: type: object required: - id - createdAt - status - updatedAt properties: id: type: string description: The ID of the verification createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: The status of the verification enum: - PROCESSING - COMPLETED - ERROR updatedAt: $ref: '#/components/schemas/RefDateTime' errorMessage: type: string description: Error message when the status is error requestMeta: $ref: '#/components/schemas/VerificationCreateRequest' result: $ref: '#/components/schemas/VerificationResult' VerificationListResponse: type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Verification' VerificationCreateResponse: type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Verification' VerificationGetResponse: type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Verification' ObjectSignalRefResult: type: object title: Object-Signal-Ref-result properties: events_marketing_day30_institution_count: type: integer example: 0 description: >- Number of institutions with marketing promotion events in the last 30 days events_application_reception_day30: type: integer example: 1 description: Number of application reception events in the last 30 days events_application_reception_day30_institution_count: type: integer example: 9 description: >- Number of institutions with application reception events in the last 30 days events_application_approval_day30: type: integer example: 3 description: Number of application approval events in the last 30 days events_loan_disbursement_day30: type: integer example: 9 description: Number of loan disbursement events in the last 30 days events_loan_disbursement_day30_institution_count: type: integer example: 0 description: >- Number of institutions with loan disbursement events in the last 30 days events_repayment_reminder_day30: type: integer example: 9 description: Number of repayment reminder events in the last 30 days events_repayment_reminder_day30_institution_count: type: integer example: 9 description: >- Number of institutions with repayment reminder events in the last 30 days events_successful_repayment_day30: type: integer example: 9 description: Number of successful repayment events in the last 30 days events_successful_repayment_day30_institution_count: type: integer example: 9 description: >- Number of institutions with successful repayment events in the last 30 days events_overdue_day30: type: integer example: 9 description: Number of overdue events in the last 30 days events_overdue_day30_institution_count: type: integer example: 9 description: Number of institutions with overdue events in the last 30 days events_overdue_day30_amount: type: integer example: 9 description: Amount of overdue events in the last 30 days events_debt_day30_amount: type: integer example: 9 description: Amount of debt events in the last 30 days events_overdue_day30_days: type: integer example: 9 description: Number of days of overdue events in the last 30 days events_marketing_day90_institution_count: type: integer example: 9 description: >- Number of institutions with marketing promotion events in the last 90 days events_application_reception_day90: type: integer example: 9 description: Number of application reception events in the last 90 days events_loan_disbursement_day90: type: integer example: 9 description: Number of loan disbursement events in the last 90 days events_loan_disbursement_day90_institution_count: type: integer example: 9 description: >- Number of institutions with loan disbursement events in the last 90 days events_overdue_day90: type: integer example: 9 description: Number of overdue events in the last 90 days events_overdue_day90_institution_count: type: integer example: 0 description: Number of institutions with overdue events in the last 90 days events_overdue_day90_amount: type: integer example: 9 description: Amount of overdue events in the last 90 days events_debt_day90_amount: type: integer example: 1 description: Amount of debt events in the last 90 days events_overdue_day90_days: type: integer example: 4 description: Number of days of overdue events in the last 90 days events_marketing_day180_institution_count: type: integer example: 9 description: >- Number of institutions with marketing promotion events in the last 180 days events_application_reception_day180: type: integer example: 9 description: Number of application reception events in the last 180 days events_loan_disbursement_day180: type: integer example: 9 description: Number of loan disbursement events in the last 180 days events_loan_disbursement_day180_institution_count: type: integer example: 9 description: >- Number of institutions with loan disbursement events in the last 180 days events_overdue_day180: type: integer example: 9 description: Number of overdue events in the last 180 days events_overdue_day180_institution_count: type: integer example: null description: Number of institutions with overdue events in the last 180 days events_overdue_day180_amount: type: integer example: 9 description: Amount of overdue events in the last 180 days events_overdue_day180_days: type: integer example: 0 description: Number of days of overdue events in the last 180 days events_loan_disbursement_days_since_last: type: integer example: 9 description: Number of days since the last loan disbursement event events_successful_repayment_days_since_last: type: integer example: 4 description: Number of days since the last successful repayment event events_overdue_days_since_last: type: integer example: 1 description: Number of days since the last overdue event Signal: type: object required: - id - createdAt - status - requestMeta properties: id: type: string description: Unique ID for the Signal Request createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: Current status of the Signal Request enum: - PROCESSING - ERROR - COMPLETED resultCode: type: string description: Final result of the Signal Request enum: - SUCCESS - NO_DATA - SYSTEM_ERROR - SERVICE_UNAVAILABLE resultMessage: type: string description: Longer description of the final result of the Signal Request requestMeta: type: object properties: phone: type: string description: Subject's mobile number provided in the request example: '+639559991234' consent: $ref: '#/components/schemas/Consent' result: $ref: '#/components/schemas/ObjectSignalRefResult' SignalListResponse: title: Signal list Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Signal' SignalPostRequest: type: object required: - consent - phone properties: phone: type: string description: >- Subject's mobile number. Must start with country code i.e. +639559991234, and no leading zeros example: '+639559991234' consent: $ref: '#/components/schemas/Consent' SignalPostResponse: title: Signal Post Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Signal' SignalGetResponse: title: Signal Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/Signal' SignalType: type: string description: Indicates which API variant handled the request. enum: - Signal1 - Signal2 - Signal3 BetaSignal3Tpl1PostRequest: type: object required: - fullName - phone - curp - idType - idNumber - templateId - consent properties: emailAddress: type: string format: email fullName: type: string description: Subject's full name. `Required`. example: John Doe phone: type: string description: >- Subject's mobile number. `Required`. Must start with country code i.e. 529178912345, and no leading zeros. MD5‑encrypted input is accepted with the format `MD5(countryCode + mobileNumber)` i.e. `MD5(529559991234)`. example: '529559991234' curp: type: string description: >- Subject's CURP (Clave Única de Registro de Población). `Required`. Must be a valid Mexico CURP. example: DOEJ800101HDFXXX01 nss: type: string description: Mexico's social security number (NSS). `Optional`. templateId: type: string description: Fixed to `tpl-sgn003002`. example: tpl-sgn003002 consent: $ref: '#/components/schemas/Consent' SignalIdType: type: string description: Subject's ID type. `Required`. example: PID enum: - PID BetaSignal3Tpl2PostRequest: type: object required: - fullName - mobileNumber - idType - idNumber - templateId - consent properties: fullName: type: string description: Subject's full name. `Required`. example: John Doe mobileNumber: type: string description: >- Subject's mobile number. `Required`. Must start with country code i.e. 669178912345, and no leading zeros. MD5‑encrypted input is accepted with the format `MD5(countryCode + mobileNumber)` i.e. `MD5(669178912345)`. example: '669178912345' idType: $ref: '#/components/schemas/SignalIdType' description: Subject's ID type. `Required`. idNumber: type: string description: >- Subject's ID number. `Required`. Must be a valid ID number corresponding to the idType. example: '1234567890123' templateId: type: string description: Fixed to `tpl-social-securities-signal-th`. example: tpl-social-securities-signal-th consent: $ref: '#/components/schemas/Consent' BetaSignal2PostRequest: type: object required: - consent - templateId - phone properties: phone: type: string description: >- Subject's mobile number. Must start with country code i.e. 639178912345, and no leading zeros. MD5-encrypted input is accepted with the format `MD5(countryCode + mobileNumber)` i.e. `MD5(529559991234)`. example: '639559991234' templateId: type: string description: >- Generate by smile internal. Customer should ask smile to provide the special templateId. If templateId is null, Smile will request the default signals set, same as the alpha result. example: tpl-sgn002001 consent: $ref: '#/components/schemas/Consent' countryCode: $ref: '#/components/schemas/RefCountry' BetaSignalPostRequest1: type: object required: - consent - templateId - phone properties: phone: type: string description: >- Subject's mobile number. Must start with country code i.e. +639559991234, and no leading zeros example: '+639559991234' templateId: type: string description: >- Generate by smile internal. Customer should ask smile to provide the special templateId. If templateId is null, Smile will request the default signals set, same as the alpha result. example: signalTpl-cb19dbc4d13b985674bd5f20bfeee7e8 consent: $ref: '#/components/schemas/Consent' countryCode: $ref: '#/components/schemas/RefCountry' BetaSignalPostRequest2: allOf: - $ref: '#/components/schemas/BetaSignalPostRequest1' BetaSignalPostRequest3: allOf: - $ref: '#/components/schemas/BetaSignalPostRequest1' BetaSignalPostRequest4: allOf: - $ref: '#/components/schemas/BetaSignalPostRequest1' BetaSignalPostRequest5: allOf: - $ref: '#/components/schemas/BetaSignalPostRequest1' BetaSignalPostRequest6: allOf: - $ref: '#/components/schemas/BetaSignalPostRequest1' BetaSignalRequestMeta: oneOf: - $ref: '#/components/schemas/BetaSignal3Tpl1PostRequest' - $ref: '#/components/schemas/BetaSignal3Tpl2PostRequest' - $ref: '#/components/schemas/BetaSignal2PostRequest' - $ref: '#/components/schemas/BetaSignalPostRequest1' - $ref: '#/components/schemas/BetaSignalPostRequest2' - $ref: '#/components/schemas/BetaSignalPostRequest3' - $ref: '#/components/schemas/BetaSignalPostRequest4' - $ref: '#/components/schemas/BetaSignalPostRequest5' - $ref: '#/components/schemas/BetaSignalPostRequest6' discriminator: propertyName: templateId mapping: tpl-sgn003002: '#/components/schemas/BetaSignal3Tpl1PostRequest' tpl-social-securities-signal-th: '#/components/schemas/BetaSignal3Tpl2PostRequest' tpl-sgn002001: '#/components/schemas/BetaSignal2PostRequest' tpl-sgn003001: '#/components/schemas/BetaSignalPostRequest1' signalTpl-cb19dbc4d13b985674bd5f20bfeee7e8: '#/components/schemas/BetaSignalPostRequest2' signalTpl-f250f305c3bf0aa690cca93ef0f0fb03: '#/components/schemas/BetaSignalPostRequest3' signalTpl-f6b74d81a4807f4c01e6a920920775ad: '#/components/schemas/BetaSignalPostRequest4' signalTpl-7a01659636c119ca4566308effd05d06: '#/components/schemas/BetaSignalPostRequest5' signalTpl-e5ba74fe8089fe44eeeafb68991b1e70: '#/components/schemas/BetaSignalPostRequest6' BetaSignalItem: type: object required: - name - value - valueType properties: name: type: string description: Unique Name to the item value: type: string description: Value of the item valueType: type: string enum: - STRING - NUMBER - BOOLEAN BetaSignal: type: object required: - id - createdAt - status - requestMeta properties: id: type: string description: Unique ID for the Beta Signal Request createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: Current status of the Signal Request enum: - PROCESSING - ERROR - COMPLETED resultCode: type: string description: Final result of the Signal Request enum: - SUCCESS - NO_DATA - SYSTEM_ERROR - SERVICE_UNAVAILABLE resultMessage: type: string description: Longer description of the final result of the Signal Request signalType: $ref: '#/components/schemas/SignalType' requestMeta: $ref: '#/components/schemas/BetaSignalRequestMeta' items: type: array items: $ref: '#/components/schemas/BetaSignalItem' BetaSignalListResponse: title: Beta Signal list Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/BetaSignal' BetaSignalPostRequest: oneOf: - $ref: '#/components/schemas/BetaSignalPostRequest1' - $ref: '#/components/schemas/BetaSignalPostRequest2' - $ref: '#/components/schemas/BetaSignalPostRequest3' - $ref: '#/components/schemas/BetaSignalPostRequest4' - $ref: '#/components/schemas/BetaSignalPostRequest5' - $ref: '#/components/schemas/BetaSignalPostRequest6' discriminator: propertyName: templateId mapping: tpl-sgn003001: '#/components/schemas/BetaSignalPostRequest1' signalTpl-cb19dbc4d13b985674bd5f20bfeee7e8: '#/components/schemas/BetaSignalPostRequest2' signalTpl-f250f305c3bf0aa690cca93ef0f0fb03: '#/components/schemas/BetaSignalPostRequest3' signalTpl-f6b74d81a4807f4c01e6a920920775ad: '#/components/schemas/BetaSignalPostRequest4' signalTpl-7a01659636c119ca4566308effd05d06: '#/components/schemas/BetaSignalPostRequest5' signalTpl-e5ba74fe8089fe44eeeafb68991b1e70: '#/components/schemas/BetaSignalPostRequest6' BetaSignalPostResponse: title: BetaSignal Post Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/BetaSignal' BetaSignalGetResponse: title: Beta Signal Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/BetaSignal' BetaSignal3PostRequest: oneOf: - $ref: '#/components/schemas/BetaSignal3Tpl1PostRequest' - $ref: '#/components/schemas/BetaSignal3Tpl2PostRequest' discriminator: propertyName: templateId mapping: tpl-sgn003002: '#/components/schemas/BetaSignal3Tpl1PostRequest' tpl-social-securities-signal-th: '#/components/schemas/BetaSignal3Tpl2PostRequest' AlphaFootprintTplEmailPostRequest1: type: object required: - consent - templateId - emailAddress properties: emailAddress: type: string description: >- The email address of the subject. It must be a valid email address. `Required` for tpl-ftp005001. example: gpalomero1234@smileapi.io countryCode: $ref: '#/components/schemas/RefCountry' templateId: type: string description: >- Fixed to `tpl-email-footprint` (or legacy `tpl-ftp005001`, deprecated). example: tpl-email-footprint footprintItemsTimeout: type: integer minimum: 1 maximum: 30 description: >- Timeout in seconds for footprint items. If exceeded, returns completed footprint items, others items' values will be null. example: 5 consent: $ref: '#/components/schemas/Consent' AlphaFootprintTplMobilePostRequest1: type: object required: - consent - templateId - mobileNumber properties: mobileNumber: type: string description: >- Subject's mobile number. `Required`. Must start with country code i.e. 639559991234, and no leading zeros. example: '639559991234' countryCode: $ref: '#/components/schemas/RefCountry' templateId: type: string description: >- Fixed to `tpl-mobile-footprint` (or legacy `tpl-ftp005002`, deprecated). example: tpl-mobile-footprint footprintItemsTimeout: type: integer minimum: 1 maximum: 30 description: >- Timeout in seconds for footprint items. If exceeded, returns completed footprint items, others items' values will be null. example: 10 consent: $ref: '#/components/schemas/Consent' AlphaFootprintTplScorePostRequest: type: object required: - consent - templateId - emailAddress - mobileNumber - countryCode properties: emailAddress: type: string description: >- The email address of the subject. It must be a valid email address. `Required` for tpl-score-footprint. example: gpalomero1234@smileapi.io mobileNumber: type: string description: >- Subject's mobile number. `Required`. Must start with country code i.e. 639559991234, and no leading zeros. example: '639559991234' countryCode: $ref: '#/components/schemas/RefCountry' templateId: type: string description: Fixed to `tpl-score-footprint`. example: tpl-score-footprint footprintItemsTimeout: type: integer minimum: 1 maximum: 30 description: >- Timeout in seconds for footprint items. If exceeded, returns completed footprint items, others items' values will be null. example: 5 consent: $ref: '#/components/schemas/Consent' AlphaFootprintTplEmailPostRequest2: allOf: - $ref: '#/components/schemas/AlphaFootprintTplEmailPostRequest1' AlphaFootprintTplMobilePostRequest2: allOf: - $ref: '#/components/schemas/AlphaFootprintTplMobilePostRequest1' AlphaFootprintTplEmailPostRequest3: allOf: - $ref: '#/components/schemas/AlphaFootprintTplEmailPostRequest1' AlphaFootprintPostRequest: oneOf: - $ref: '#/components/schemas/AlphaFootprintTplEmailPostRequest1' - $ref: '#/components/schemas/AlphaFootprintTplEmailPostRequest2' - $ref: '#/components/schemas/AlphaFootprintTplEmailPostRequest3' - $ref: '#/components/schemas/AlphaFootprintTplMobilePostRequest1' - $ref: '#/components/schemas/AlphaFootprintTplMobilePostRequest2' - $ref: '#/components/schemas/AlphaFootprintTplScorePostRequest' discriminator: propertyName: templateId mapping: tpl-email-footprint: '#/components/schemas/AlphaFootprintTplEmailPostRequest1' tpl-mobile-footprint: '#/components/schemas/AlphaFootprintTplMobilePostRequest1' tpl-score-footprint: '#/components/schemas/AlphaFootprintTplScorePostRequest' tpl-ftp005001: '#/components/schemas/AlphaFootprintTplEmailPostRequest2' tpl-ftp005002: '#/components/schemas/AlphaFootprintTplMobilePostRequest2' footprintTpl-61e10d070e07a4ea96e9430668d4bb9f: '#/components/schemas/AlphaFootprintTplEmailPostRequest3' AlphaFootprintItem: type: object required: - name - value - valueType properties: name: type: string description: A unique name for the item. value: type: string description: The value associated with the item. valueType: type: string enum: - STRING - NUMBER - BOOLEAN AlphaFootprint: type: object required: - id - createdAt - status - requestMeta properties: id: type: string description: The unique ID for the Alpha Footprint. createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: The current status of the Footprint. enum: - PROCESSING - ERROR - COMPLETED resultCode: type: string description: The final result of the Footprint. enum: - SUCCESS - NO_DATA - SYSTEM_ERROR - SERVICE_UNAVAILABLE resultMessage: type: string description: A detailed description of the final result of the Footprint. requestMeta: $ref: '#/components/schemas/AlphaFootprintPostRequest' items: type: array items: $ref: '#/components/schemas/AlphaFootprintItem' AlphaFootprintListResponse: title: Alpha Footprint List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/AlphaFootprint' AlphaFootprintPostResponse: title: Alpha Footprint Post Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/AlphaFootprint' AlphaFootprintGetResponse: title: Alpha Footprint Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/AlphaFootprint' Link: type: object required: - id - endDate - metadata allOf: - $ref: '#/components/schemas/LinkPayload' - properties: metadata: $ref: '#/components/schemas/ObjectReferenceMetadata' LinkListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/Link' LinkListResponse: type: object allOf: - $ref: '#/components/schemas/CommonResponse' - properties: data: $ref: '#/components/schemas/LinkListData' LinkGetResponse: type: object allOf: - $ref: '#/components/schemas/CommonResponse' - properties: data: $ref: '#/components/schemas/Link' AlphaMawPostRequest: type: object required: - consent - templateId - mobileNumber - countryCode properties: mobileNumber: type: string description: >- Subject's mobile number. Must start with country code i.e. 639559991234, and no leading zeros example: '639559991234' countryCode: $ref: '#/components/schemas/RefCountry' templateId: type: string description: >- Generated internally by Smile. You can request the specific templateId from Smile. example: tpl-maw002001 consent: $ref: '#/components/schemas/Consent' AlphaMawItem: type: object required: - platformId - source - date - level properties: date: $ref: '#/components/schemas/RefDate' level: type: string description: >- The level of the item. 1 - whitelist 2 - secondary whitelist, 3 - normal, 4 - greylist, 5 - blacklist platformId: type: string description: Unique ID for the platform. duration: type: string description: The duration of the item. It will have value if source is seat. source: type: string description: 'The source of the item. Possible values are: seat, voice, sms.' platformTags: type: array default: [] items: type: string description: >- A tag associated with the item. Possible values are: finance, other, etc. AlphaMaw: type: object required: - id - createdAt - status - requestMeta properties: id: type: string description: The unique ID for the Alpha Maw. createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: The current status of the Maw. enum: - PROCESSING - ERROR - COMPLETED resultCode: type: string description: The final result of the Maw. enum: - SUCCESS - NO_DATA - SYSTEM_ERROR - SERVICE_UNAVAILABLE resultMessage: type: string description: A detailed description of the final result of the Maw. requestMeta: $ref: '#/components/schemas/AlphaMawPostRequest' items: type: array items: $ref: '#/components/schemas/AlphaMawItem' AlphaMawListResponse: title: Alpha Maw List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/AlphaMaw' AlphaMawPostResponse: title: Alpha Maw Post Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/AlphaMaw' AlphaMawGetResponse: title: Alpha Maw Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/AlphaMaw' BetaMaw2PostRequest1: type: object required: - consent - templateId - mobileNumber - countryCode properties: mobileNumber: type: string description: >- Subject's mobile number. Must start with country code i.e. 639178912345, and no leading zeros. MD5‑encrypted input is accepted with the format `MD5(countryCode + mobileNumber)` i.e. `MD5(529559991234)`. example: '639559991234' countryCode: $ref: '#/components/schemas/RefCountry' templateId: type: string description: >- Fixed to `tpl-maw002001`. You can request the specific templateId from Smile if need. example: tpl-maw002001 consent: $ref: '#/components/schemas/Consent' BetaMaw2PostRequest2: type: object required: - consent - templateId - mobileNumber - countryCode properties: mobileNumber: type: string description: >- Subject's mobile number. Must start with country code i.e. 639178912345, and no leading zeros. MD5‑encrypted input is accepted with the format `MD5(countryCode + mobileNumber)` i.e. `MD5(529559991234)`. example: '639559991234' countryCode: $ref: '#/components/schemas/RefCountry' templateId: type: string description: >- Fixed to `mawTpl-bfc93eb72d24860bf62429a1dd06708d`. You can request the specific templateId from Smile if need. consent: $ref: '#/components/schemas/Consent' BetaMaw2PostRequest: oneOf: - $ref: '#/components/schemas/BetaMaw2PostRequest1' - $ref: '#/components/schemas/BetaMaw2PostRequest2' discriminator: propertyName: templateId mapping: tpl-maw002001: '#/components/schemas/BetaMaw2PostRequest1' mawTpl-bfc93eb72d24860bf62429a1dd06708d: '#/components/schemas/BetaMaw2PostRequest2' MawType: type: string description: The type of the Maw. enum: - MAW2 - MAW3 MawIdType: type: string description: Subject's ID type. `Required`. example: NATIONAL_ID enum: - NATIONAL_ID - SSS - UMID - TIN - PRC - PHILHEALTH - PASSPORT - DRIVER_LICENSE - PHILSYS BetaMaw3Tpl1PostRequest: type: object required: - consent - templateId - fullName - idNumber - idType - mobileNumber - countryCode properties: mobileNumber: type: string description: >- Subject's mobile number. `Required`. Must start with country code i.e. 529559991234, and no leading zeros. MD5‑encrypted input is accepted with the format `MD5(countryCode + mobileNumber)` i.e. `MD5(529559991234)`. example: '529559991234' fullName: type: string description: Subject's full name. `Required`. example: George Smith idNumber: type: string description: Subject's ID number. `Required`. Must be a valid Mexico CURP. example: ZAZD801124MBSYQN13 idType: $ref: '#/components/schemas/MawIdType' gaid: type: string description: >- Subject's Google Ad ID. `Optional`. If provided will returned the items that are related to the Google Ad ID. example: 00000000-0000-0000-0000-000000000000 countryCode: $ref: '#/components/schemas/RefCountry' templateId: type: string description: Fixed to `tpl-maw004001`. example: tpl-maw004001 consent: $ref: '#/components/schemas/Consent' BetaMaw3Tpl2PostRequest: type: object required: - consent - templateId - gaid properties: gaid: type: string description: Subject's Google Ad ID. `Required`. example: 00000000-0000-0000-0000-000000000000 templateId: type: string description: Fixed to `tpl-maw004002`. example: tpl-maw004002 consent: $ref: '#/components/schemas/Consent' BetaMaw3Tpl3PostRequest: type: object required: - consent - templateId - fullName - idNumber - idType - mobileNumber - countryCode properties: mobileNumber: type: string description: >- Subject's mobile number. `Required`. Must start with country code i.e. 639559991234, and no leading zeros. MD5‑encrypted input is accepted with the format `MD5(countryCode + mobileNumber)` i.e. `MD5(639559991234)`. example: '639559991234' fullName: type: string description: Subject's full name. `Required`. example: George Smith idNumber: type: string description: >- Subject's ID number. `Required`. Must be a valid Philippines ID number, it supports SSS，UMID，TIN，PRC，PHILHEALTH，PHILSYS，PASSPORT，DRIVER_LICENSE. example: '456123789' idType: $ref: '#/components/schemas/MawIdType' gaid: type: string description: Subject's Google Ad ID. `Optional`. example: 00000000-0000-0000-0000-000000000000 countryCode: $ref: '#/components/schemas/RefCountry' templateId: type: string description: Fixed to `tpl-maw004003`. example: tpl-maw004003 consent: $ref: '#/components/schemas/Consent' BetaMawRequestMeta: oneOf: - $ref: '#/components/schemas/BetaMaw2PostRequest' - $ref: '#/components/schemas/BetaMaw2PostRequest2' - $ref: '#/components/schemas/BetaMaw3Tpl1PostRequest' - $ref: '#/components/schemas/BetaMaw3Tpl2PostRequest' - $ref: '#/components/schemas/BetaMaw3Tpl3PostRequest' discriminator: propertyName: templateId mapping: tpl-maw002001: '#/components/schemas/BetaMaw2PostRequest1' tpl-maw004001: '#/components/schemas/BetaMaw3Tpl1PostRequest' tpl-maw004002: '#/components/schemas/BetaMaw3Tpl2PostRequest' tpl-maw004003: '#/components/schemas/BetaMaw3Tpl3PostRequest' mawTpl-bfc93eb72d24860bf62429a1dd06708d: '#/components/schemas/BetaMaw2PostRequest2' BetaMaw2Item: type: object required: - platformId - source - date - level properties: date: $ref: '#/components/schemas/RefDate' level: type: string description: >- The level of the item. 1 - whitelist 2 - secondary whitelist, 3 - normal, 4 - greylist, 5 - blacklist platformId: type: string description: Unique ID for the platform. duration: type: string description: The duration of the item. It will have value if source is seat. source: type: string description: 'The source of the item. Possible values are: seat, voice, sms.' platformTags: type: array default: [] items: type: string description: >- A tag associated with the item. Possible values are: finance, other, etc. BetaMaw3Item: type: object required: - name - value - valueType properties: name: type: string description: A unique name for the item. value: type: string description: The value associated with the item. valueType: type: string enum: - STRING - NUMBER - BOOLEAN BetaMaw: type: object required: - id - createdAt - status - requestMeta properties: id: type: string description: The unique ID for the Beta Maw. createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: The current status of the Maw. enum: - PROCESSING - ERROR - COMPLETED resultCode: type: string description: The final result of the Maw. enum: - SUCCESS - NO_DATA - SYSTEM_ERROR - SERVICE_UNAVAILABLE resultMessage: type: string description: A detailed description of the final result of the Maw. type: $ref: '#/components/schemas/MawType' requestMeta: $ref: '#/components/schemas/BetaMawRequestMeta' maw2Items: type: array items: $ref: '#/components/schemas/BetaMaw2Item' maw3Items: type: array items: $ref: '#/components/schemas/BetaMaw3Item' BetaMawPostResponse: title: Beta Maw Post Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/BetaMaw' BetaMaw3PostRequest: oneOf: - $ref: '#/components/schemas/BetaMaw3Tpl1PostRequest' - $ref: '#/components/schemas/BetaMaw3Tpl2PostRequest' - $ref: '#/components/schemas/BetaMaw3Tpl3PostRequest' discriminator: propertyName: templateId mapping: tpl-maw004001: '#/components/schemas/BetaMaw3Tpl1PostRequest' tpl-maw004002: '#/components/schemas/BetaMaw3Tpl2PostRequest' tpl-maw004003: '#/components/schemas/BetaMaw3Tpl3PostRequest' BetaMawListResponse: title: Beta Maw List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/BetaMaw' BetaMawGetResponse: title: Beta Maw Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/BetaMaw' AlphaValidationResult: type: object required: - type - matchScore properties: type: type: string enum: - BankAccount matchScore: type: integer format: int32 minimum: 0 maximum: 100 description: >- Match score describing how closely the supplied data matches the record. example: 100 matchScoreDescription: type: string description: >- Qualitative description of the match score (Strong Match, Partial Match, Weak Match). ValidationIdType: type: string description: The identification type associated with the account holder. example: NATIONAL_ID enum: - NATIONAL_ID - REGISTRATION_ID AlphaValidationValidateBankAccountRequest: type: object required: - name - consent properties: name: type: string description: Personal name of the account holder. example: George idType: $ref: '#/components/schemas/ValidationIdType' idNumber: type: string description: >- The identification number associated with the account holder. Some countries require an identification number. example: '1234567890' countryCode: $ref: '#/components/schemas/RefCountry' bic: type: string description: >- Swift BIC, either 8 or 11 characters. Must have either countryCode or bic example: DEUTDEFF iban: type: string description: >- International Bank Account Number. Must have either iban or accountNumber. example: AT610904300234573201 accountNumber: type: string description: Local bank account number. Must have either iban or accountNumber. example: '0123456789' templateId: type: string description: >- Generated internally by Smile. Customers should request the specific templateId from Smile. If this value is null, Smile will use the default value `tpl-vld006001`. example: tpl-vld006001 default: tpl-vld006001 consent: $ref: '#/components/schemas/Consent' AlphaValidation: type: object required: - id - createdAt - status - resultCode - requestMeta properties: id: type: string description: Unique identifier assigned to the validation. example: maw-00d49fe7b5834ba79474cb1373998ff3 createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: The current status of the Maw. enum: - PROCESSING - ERROR - COMPLETED resultCode: type: string description: The final result of the Maw. enum: - SUCCESS - NO_DATA - SYSTEM_ERROR - SERVICE_UNAVAILABLE resultMessage: type: string description: Detailed message describing resultCode. nullable: true result: $ref: '#/components/schemas/AlphaValidationResult' requestMeta: $ref: '#/components/schemas/AlphaValidationValidateBankAccountRequest' AlphaValidationListResponse: title: Alpha Validation List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/AlphaValidation' AlphaValidationCreateResponse: title: Alpha Validation Create Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/AlphaValidation' AlphaValidationGetResponse: title: Alpha Validation Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/AlphaValidation' AlphaBlacklist1PostRequest2: type: object required: - consent - mobileNumber properties: mobileNumber: type: string description: >- Subject's mobile number. Must start with country code i.e. 639559991234, and no leading zeros example: '639559991234' countryCode: $ref: '#/components/schemas/RefCountry' templateId: type: string description: >- Fixed templateId for this request. Value must be `blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e`. example: blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e default: blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e applicationDate: type: string format: date description: >- Smile will query the data that before this date. The format is yyyy-MM-dd. example: '2023-01-21' consent: $ref: '#/components/schemas/Consent' AlphaBlacklist1PostRequest1: type: object required: - consent - mobileNumber properties: mobileNumber: type: string description: >- Subject's mobile number. Must start with country code i.e. 639559991234, and no leading zeros example: '639559991234' countryCode: $ref: '#/components/schemas/RefCountry' templateId: type: string description: Fixed templateId for this request. Value must be `tpl-blk002001`. example: tpl-blk002001 default: tpl-blk002001 applicationDate: type: string format: date description: >- Smile will query the data that before this date. The format is yyyy-MM-dd. example: '2023-01-21' consent: $ref: '#/components/schemas/Consent' AlphaBlacklist2PostRequest1: type: object description: Alpha Blacklist Post Request2. required: - consent - mobileNumber - countryCode - idType - idNumber - templateId properties: mobileNumber: type: string description: >- Subject's mobile number. Must start with country code i.e. 639559991234, and no leading zeros example: '639559991234' idType: type: string description: >- The type of ID. If countryCode is PH, this value must be one of the following: NATIONAL_ID, SSS, UMID, TIN, PRC, PHILHEALTH, PASSPORT, DRIVER_LICENSE, VOTER_ID, POSTAL_ID. default: NATIONAL_ID enum: - NATIONAL_ID - SSS - UMID - TIN - PRC - PHILHEALTH - PASSPORT - DRIVER_LICENSE - VOTER_ID - POSTAL_ID idNumber: type: string description: Subject's ID number. example: '123456789012' countryCode: $ref: '#/components/schemas/RefCountry' description: The country code of the ID. Only supported for PH, ID, MX. templateId: type: string description: >- Fixed templateId for this request. Value must be `tpl-blacklist-007001` example: tpl-blacklist-007001 default: tpl-blacklist-007001 consent: $ref: '#/components/schemas/Consent' AlphaBlacklistPostRequest: oneOf: - $ref: '#/components/schemas/AlphaBlacklist1PostRequest1' - $ref: '#/components/schemas/AlphaBlacklist1PostRequest2' - $ref: '#/components/schemas/AlphaBlacklist2PostRequest1' discriminator: propertyName: templateId mapping: blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e: '#/components/schemas/AlphaBlacklist1PostRequest2' tpl-blk002001: '#/components/schemas/AlphaBlacklist1PostRequest1' tpl-blacklist-007001: '#/components/schemas/AlphaBlacklist2PostRequest1' AlphaBlacklist: type: object required: - id - createdAt - status - requestMeta properties: id: type: string description: The unique ID for the Blacklist. createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: The current status of the Blacklist. enum: - PROCESSING - ERROR - COMPLETED resultCode: type: string description: The final result of the Blacklist. enum: - SUCCESS - SYSTEM_ERROR - SERVICE_UNAVAILABLE resultMessage: type: string description: A detailed description of the final result of the Blacklist. type: type: string description: The type of Blacklist. enum: - BLACKLIST1 - BLACKLIST2 requestMeta: $ref: '#/components/schemas/AlphaBlacklistPostRequest' result: type: object title: Blacklist Result properties: hit: type: boolean description: Whether the Blacklist is a hit or not. dates: type: array description: The list of dates. items: $ref: '#/components/schemas/RefDate' AlphaBlacklistListResponse: title: Alpha Blacklist List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/AlphaBlacklist' AlphaBlacklist1PostRequest: oneOf: - $ref: '#/components/schemas/AlphaBlacklist1PostRequest1' - $ref: '#/components/schemas/AlphaBlacklist1PostRequest2' discriminator: propertyName: templateId mapping: blacklistTpl-f29e992a970f4dbbbf9df3cdfec4cd4e: '#/components/schemas/AlphaBlacklist1PostRequest2' tpl-blk002001: '#/components/schemas/AlphaBlacklist1PostRequest1' AlphaBlacklistPostResponse: title: Alpha Blacklist Post Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/AlphaBlacklist' AlphaBlacklistGetResponse: title: Alpha Blacklist Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/AlphaBlacklist' SocialSecurityResult: type: object required: - fullName - curp - nss - reportDate - employerName - employerRegistration - gender - contributionDays - contributionBaseAmount - currency properties: fullName: type: string description: Full name of the person curp: type: string description: CURP (Clave Única de Registro de Población) nss: type: string description: NSS (Número de Seguridad Social) reportDate: type: string format: date description: Date of the social security report employerName: type: string description: Name of the employer employerRegistration: type: string description: Employer registration number state: type: string description: State where contributions are made contributionDays: type: integer description: Number of contribution days contributionBaseAmount: type: number description: Base amount for contributions currency: $ref: '#/components/schemas/RefCurrency' SocialSecurityRequestMeta: type: object required: - emailAddress - fullName - mobileNumber - curp - templateId - consent properties: emailAddress: type: string format: email description: Email address of the subject example: john.doe@example.com fullName: type: string description: Full name of the subject example: John Doe mobileNumber: type: string description: >- Subject's mobile number. `Required`. Must start with country code i.e. 529178912345, and no leading zeros. MD5‑encrypted input is accepted with the format `MD5(countryCode + mobileNumber)` i.e. `MD5(529559991234)`. example: '529559991234' curp: type: string description: CURP (Clave Única de Registro de Población) example: DOEJ800101HDFXXX01 templateId: type: string description: The template ID to use for the verification. example: tpl-sss003001 consent: $ref: '#/components/schemas/Consent' SocialSecurity: title: Social Security type: object description: >- The stored social security information of the user from a social security data provider. required: - id - createdAt - status - requestMeta - result properties: id: $ref: '#/components/schemas/RefObjectID' createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: The current status of the Social Security record. enum: - PROCESSING - ERROR - COMPLETED resultCode: type: string description: The final result of the Social Security process. enum: - SUCCESS - NO_DATA - SYSTEM_ERROR - INVALID_PARAMETERS - SERVICE_UNAVAILABLE resultMessage: type: string description: A detailed description of the final result. result: $ref: '#/components/schemas/SocialSecurityResult' requestMeta: $ref: '#/components/schemas/SocialSecurityRequestMeta' SocialSecurityListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/SocialSecurity' SocialSecurityListResponse: title: Social Security List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/SocialSecurityListData' SocialSecurityPostRequest: type: object required: - emailAddress - fullName - mobileNumber - curp - templateId - consent properties: emailAddress: type: string format: email description: Email address of the subject fullName: type: string description: Full name of the subject mobileNumber: type: string description: >- Subject's mobile number. `Required`. Must start with country code i.e. 529178912345, and no leading zeros. MD5‑encrypted input is accepted with the format `MD5(countryCode + mobileNumber)` i.e. `MD5(529559991234)`. example: '529559991234' curp: type: string description: CURP (Clave Única de Registro de Población) example: DOEJ800101HDFXXX01 templateId: type: string description: The template ID to use for the verification. example: tpl-sss003001 consent: $ref: '#/components/schemas/Consent' SocialSecurityPostResponse: title: Social Security Post Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/SocialSecurity' SocialSecurityGetResponse: title: Social Security Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/SocialSecurity' schemas-SocialSecurityResult: type: object required: - fullName - curp - nss - reportDate - employerName - employerRegistration - gender - contributionDays - contributionBaseAmount - currency properties: fullName: type: string description: Full name of the person curp: type: string description: CURP (Clave Única de Registro de Población) nss: type: string description: NSS (Número de Seguridad Social) payMark: type: boolean nullable: true description: >- Indicates the most recent contribution payment status. TRUE means paid; null means unknown. reportDate: type: string format: date description: Date of the social security report employerName: type: string description: Name of the employer employerRegistration: type: string description: Employer registration number state: type: string description: State where contributions are made contributionDays: type: integer description: Number of contribution days contributionBaseAmount: type: number description: Base amount for contributions currency: $ref: '#/components/schemas/RefCurrency' schemas-SocialSecurityPostRequest: type: object required: - fullName - mobileNumber - curp - templateId - consent properties: emailAddress: type: string format: email description: Email address to receive the report. example: john.doe@example.com fullName: type: string description: Full name of the person example: John Doe mobileNumber: type: string description: >- Subject's mobile number. `Required`. Must start with country code i.e. 529178912345, and no leading zeros. MD5‑encrypted input is accepted with the format `MD5(countryCode + mobileNumber)` i.e. `MD5(529559991234)`. example: '529559991234' curp: type: string description: CURP (Clave Única de Registro de Población) example: DOEJ800101HDFXXX01 nss: type: string description: Mexico's social security number (NSS). Required for MX template. templateId: type: string description: The template ID to use for the request. example: tpl-sss003002 consent: $ref: '#/components/schemas/Consent' schemas-SocialSecurity: title: Social Security type: object description: >- The stored social security information of the user from a social security data provider. required: - id - createdAt - status - requestMeta - result properties: id: $ref: '#/components/schemas/RefObjectID' createdAt: $ref: '#/components/schemas/RefDateTime' status: type: string description: The current status of the Social Security record. enum: - PROCESSING - ERROR - COMPLETED resultCode: type: string description: The final result of the Social Security process. enum: - SUCCESS - NO_DATA - SYSTEM_ERROR - INVALID_PARAMETERS - SERVICE_UNAVAILABLE resultMessage: type: string description: A detailed description of the final result. result: $ref: '#/components/schemas/schemas-SocialSecurityResult' requestMeta: $ref: '#/components/schemas/schemas-SocialSecurityPostRequest' schemas-SocialSecurityListData: type: object properties: nextCursor: $ref: '#/components/schemas/ObjectNextCursor' items: type: array items: $ref: '#/components/schemas/schemas-SocialSecurity' schemas-SocialSecurityListResponse: title: Social Security List Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/schemas-SocialSecurityListData' schemas-SocialSecurityPostResponse: title: Social Security Post Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/schemas-SocialSecurity' schemas-SocialSecurityGetResponse: title: Social Security Get Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: $ref: '#/components/schemas/schemas-SocialSecurity' EmployerRegistration: title: Employer Registration type: object required: - number - organization properties: number: type: string description: Registration Number organization: type: string description: Registering body or organization date: $ref: '#/components/schemas/RefDate' scope: type: string description: Registration Scope status: type: string description: Registration Status enum: - Registered - Suspended - Revoked - Dissolved - Delinquent EmployerSource: title: Employer Source type: string enum: - SEC - DTI - SERP - Facebook - LinkedIn EmployerBasic: title: Employer Basic type: object properties: businessName: type: string description: Business Name registrations: type: array items: $ref: '#/components/schemas/EmployerRegistration' matchPercentage: type: integer description: Match Percentage, 100 = exact match, 0 = no match. sources: type: array items: $ref: '#/components/schemas/EmployerSource' verificationStatus: type: string description: >- Verification Status. If the data source is an authoritative source, the status will be VERIFIED. Otherwise, UNVERIFIED. enum: - VERIFIED - UNVERIFIED EmployerBasicQueryResponse: title: Employer Basic Query Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: array items: $ref: '#/components/schemas/EmployerBasic' EmployerContactPerson: title: Employer Contact Person type: object properties: contactName: type: string description: Contact Name position: type: string description: Position contactEmail: type: string description: Contact Email contactPhone: type: string description: Contact Phone EmployerLicense: title: Employer License type: object required: - licenseNumber - licenseType properties: licenseNumber: type: string description: License Number licenseType: type: string description: License Type licenseIssuedDate: $ref: '#/components/schemas/RefDate' licenseStatus: type: string description: License Status Employer: title: Employer type: object required: - businessName properties: businessName: type: string description: Business Name shortName: type: string description: Short Name registrations: type: array items: $ref: '#/components/schemas/EmployerRegistration' businessAddress: $ref: '#/components/schemas/RefAddress' isicCode: type: string description: International Standard Industrial Classification Code isicSector: type: string description: Sector psicCode: type: string description: Philippine Standard Industrial Classification code psicIndustry: type: string description: Industry contactPersons: type: array items: $ref: '#/components/schemas/EmployerContactPerson' licenses: type: array items: $ref: '#/components/schemas/EmployerLicense' EmployerQueryResponse: title: Employer Query Response type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: array items: $ref: '#/components/schemas/Employer' RefWebhookEventVersion: title: RefWebhookEventVersion description: Event schema's major version type: number example: 1 TaskStartedEventData: type: object properties: userId: type: string description: The user ID. sourceId: type: string description: The source ID . sourceType: $ref: '#/components/schemas/RefSourceType' taskType: type: string description: The task type. Please refer /tasks/{id} API to get all types providers: type: array description: The providers this account associated to items: type: string description: Provider id required: - userId - sourceId - sourceType - taskType - providers TaskFinishedEventData: type: object properties: userId: type: string description: The user ID. sourceId: type: string description: The source ID . sourceType: $ref: '#/components/schemas/RefSourceType' taskType: type: string description: The task type. Please refer /tasks/{id} API to get all types status: type: string description: The task status. enum: - SUCCEEDED - FAILED errorCode: type: string description: If status = FAILURE, this field has value. providers: type: array description: The providers this account associated to items: type: string description: Provider id datapoints: type: array items: $ref: '#/components/schemas/RefDatapoint' payload: $ref: '#/components/schemas/AllDatapointPayload' required: - userId - sourceId - sourceType - providers - datapoints - data SmileCommonEvent: type: object required: - id - version - type - createdAt properties: id: $ref: '#/components/schemas/RefObjectID' version: $ref: '#/components/schemas/RefWebhookEventVersion' type: $ref: '#/components/schemas/RefWebhookEventType' createdAt: $ref: '#/components/schemas/RefDateTime' RecordType: type: string nullable: true title: Record Type example: SOCIAL_SECURITY enum: - SOCIAL_SECURITY description: Source Type RecordCreatedEventData: type: object properties: recordId: type: string description: The record ID . recordType: $ref: '#/components/schemas/RecordType' required: - recordId - recordType SocialSecurityCompletedEventData: type: object properties: recordId: type: string description: The record ID . recordType: type: string description: The record type. Please refer to RecordType enum status: type: string description: The task status. enum: - COMPLETED - ERROR resultCode: type: string description: The final result of the Social Security process. enum: - SUCCESS - NO_DATA - SYSTEM_ERROR - SERVICE_UNAVAILABLE resultMessage: type: string description: A detailed description of the final result. payload: $ref: '#/components/schemas/SocialSecurity' required: - recordId - recordType - status RecordCompletedEventData: oneOf: - $ref: '#/components/schemas/SocialSecurityCompletedEventData' discriminator: propertyName: recordType mapping: SOCIAL_SECURITY: '#/components/schemas/SocialSecurityCompletedEventData' securitySchemes: basicAuth: type: http scheme: basic parameters: cursor: name: cursor in: query required: false schema: type: string description: >- Uses the filter values of the previous page to determine the next set of items. size: name: size in: query schema: type: integer example: 50 minimum: 1 maximum: 150 default: 10 description: The number of objects you want returned in a collection. id: name: id in: path schema: type: string minLength: 1 maxLength: 200 description: ID of the specific object in the collection. required: true userId: name: userId in: query required: false schema: type: string description: Filter to those associated with a particular user ID. sourceId: name: sourceId in: query required: false schema: type: string description: >- Filter to those associated with a particular source ID. If we query the link account data, the sourceId is the accountId, If we query the archive data, then the sourceId is the archiveId startDate: schema: type: string format: date example: '2021-04-01' in: query name: startDate description: Filter by creation date, start of date range (YYYY-MM-DD) endDate: schema: type: string format: date example: '2021-04-21' in: query name: endDate description: Filter by creation date, end of date range (YYYY-MM-DD) accountId: name: accountId in: query required: false schema: type: string description: Filter to those associated with a particular account ID. deprecated: true responses: Standard-Errors: description: Standard error response content: application/json: schema: type: object properties: code: $ref: '#/components/schemas/ObjectMetadataRefCode' message: $ref: '#/components/schemas/ObjectMetadataRefMessage' requestId: $ref: '#/components/schemas/ObjectMetadataRefRequestID' data: type: object security: - basicAuth: []