Smile Verification API
The Verification API from Smile — 2 operation(s) for verification.
The Verification API from Smile — 2 operation(s) for verification.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/getsmileapi:getsmileapi-verification-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Smile Verification 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
security:
- basicAuth: []
tags:
- name: Verification
paths:
/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
middleName: Cimafranca
lastName: Palomero
suffix: Jr.
fullName: George Cimafranca Palomero Jr.
additionalData:
dob: '1970-08-24'
gender: Male
ids:
- idType: tin_ph
idSubType: null
idNumber: '123456789'
consent:
type: Terms And Conditions
version: 1
consentedWith: I agree to the terms and conditions.
consentedAt: '2021-04-14T09:30:24Z'
consentTemplateId: null
result: null
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
description: '## Request a Verification object.
This endpoint requires `consent` and the identity information to verify.
Place `idType`, `idSubType`, and `idNumber` in `additionalData.ids`. The
Sandbox field `dateOfBirth` maps to `additionalData.dob`, and `gender` maps to
`additionalData.gender`.
### Supported Sandbox ID Types
| ID Type | Available Test Fields |
|-----------------|--------------------------------------------------------------------------------------------------|
| `tin_ph` | `fullName`, `firstName`, `middleName`, `lastName`, `suffix`, `idNumber`, `gender`, `dateOfBirth` |
| `pagibig_ph` | `fullName`, `idNumber` |
| `prclicense_ph` | `fullName`, `idSubType`, `idNumber`, `dateOfBirth` |
| `nbi_ph` | `fullName`, `idNumber` |
### Sandbox Test Values
| ID Type | Parameter | Value |
|-----------------|---------------|----------------------------------|
| `tin_ph` | `idType` | `tin_ph` |
| `tin_ph` | `fullName` | `George Cimafranca Palomero Jr.` |
| `tin_ph` | `firstName` | `George` |
| `tin_ph` | `middleName` | `Cimafranca` |
| `tin_ph` | `lastName` | `Palomero` |
| `tin_ph` | `suffix` | `Jr.` |
| `tin_ph` | `idNumber` | `123456789` |
| `tin_ph` | `gender` | `Male` |
| `tin_ph` | `dateOfBirth` | `1970-08-24` |
| `pagibig_ph` | `idType` | `pagibig_ph` |
| `pagibig_ph` | `fullName` | `George Cimafranca Palomero Jr.` |
| `pagibig_ph` | `idNumber` | `123456789012` |
| `prclicense_ph` | `idType` | `prclicense_ph` |
| `prclicense_ph` | `fullName` | `George Cimafranca Palomero Jr.` |
| `prclicense_ph` | `idSubType` | `CRIMINOLOGIST` |
| `prclicense_ph` | `idNumber` | `0123456` |
| `prclicense_ph` | `dateOfBirth` | `1970-08-24` |
| `nbi_ph` | `idType` | `nbi_ph` |
| `nbi_ph` | `fullName` | `George Cimafranca Palomero Jr.` |
| `nbi_ph` | `idNumber` | `ABC123DEF4-56GHI789J` |
Use one Sandbox record per Verification request. For inputs outside these test
values, the Sandbox may not return a matched verification result.'
tags:
- Verification
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VerificationCreateRequest'
examples:
Example:
value:
firstName: George
middleName: Cimafranca
lastName: Palomero
suffix: Jr.
fullName: George Cimafranca Palomero Jr.
additionalData:
dob: '1970-08-24'
gender: Male
ids:
- idType: tin_ph
idSubType: null
idNumber: '123456789'
consent:
type: Terms And Conditions
version: 1
consentedWith: I agree to the terms and conditions.
consentedAt: '2021-04-14T09:30:24Z'
consentTemplateId: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/VerificationCreateResponse'
examples:
Example:
value:
code: OK
message: Success
requestId: 5b79399a-6852-4234-bb0e-ad472648282d
data:
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
middleName: Cimafranca
lastName: Palomero
suffix: Jr.
fullName: George Cimafranca Palomero Jr.
additionalData:
dob: '1970-08-24'
gender: Male
ids:
- idType: tin_ph
idSubType: null
idNumber: '123456789'
consent:
type: Terms And Conditions
version: 1
consentedWith: I agree to the terms and conditions.
consentedAt: '2021-04-14T09:30:24Z'
consentTemplateId: null
result: null
operationId: create-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-6852-4234-bb0e-ad472648282d
createdAt: '2021-04-14T09:30:24Z'
updatedAt: '2021-04-14T09:30:24Z'
status: PROCESSING
errorMessage: null
requestMeta:
firstName: George
middleName: Cimafranca
lastName: Palomero
suffix: Jr.
fullName: George Cimafranca Palomero Jr.
additionalData:
dob: '1970-08-24'
gender: Male
ids:
- idType: tin_ph
idSubType: null
idNumber: '123456789'
consent:
type: Terms And Conditions
version: 1
consentedWith: I agree to the terms and conditions.
consentedAt: '2021-04-14T09:30:24Z'
consentTemplateId: null
result: null
operationId: get-verification
description: Get verification by ID.
components:
schemas:
VerificationCreateRequest:
type: object
required:
- consent
properties:
firstName:
type: string
example: George
description: First Name
middleName:
type: string
example: Cimafranca
description: Middle Name
lastName:
type: string
example: Palomero
description: Last Name
suffix:
type: string
example: Jr.
description: Suffix
fullName:
type: string
example: George Cimafranca Palomero 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:
allOf:
- $ref: '#/components/schemas/RefDate'
example: '1970-08-24'
gender:
allOf:
- $ref: '#/components/schemas/RefGender'
example: Male
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'
VerificationId:
type: object
required:
- idType
- idNumber
properties:
idType:
allOf:
- $ref: '#/components/schemas/VerificationIdType'
example: tin_ph
idSubType:
type: string
description: If idType = prclicense_ph, subtype should be one of the PrcProfessionEnum value.
example: CRIMINOLOGIST
idNumber:
type: string
description: The ID number
example: '123456789'
RefDate:
type: string
format: date
description: The date, yyyy-MM-dd
example: '2000-01-21'
VerificationIdType:
type: string
enum:
- tin_ph
- pagibig_ph
- prclicense_ph
- nbi_ph
example: tin_ph
Consent:
type: object
required:
- consentedAt
- consentedWith
properties:
type:
type: string
description: The internal name of your consent document (e.g. "Terms and Conditions" or "Privacy Policy"); your own reference label
example: Terms and Conditions
version:
type: string
description: Your internal version identifier for this consent document (e.g. "1.0.0")
example: 1.0.0
consentedAt:
allOf:
- $ref: '#/components/schemas/RefDateTime'
description: The date and time the subject accepted your consent document, typically when they tapped "I agree" in your app. Not the time of this API call. Use ISO 8601 format, e.g. "2024-04-14T09:30:24Z"
consentedWith:
type: string
description: The exact text of the button or checkbox the user clicked to give consent, e.g. "I agree to the Terms and Conditions"
example: I agree to the terms and conditions
consentTemplateId:
type: string
description: ID of a stored Consent Template. Retrieve from the Developer Portal or GET /consentTemplates. Overrides any inline fields above when provided.
ObjectMetadataRefMessage:
type: string
title: ObjectMetadataRefMessage
description: Message response to the request
example: Success
x-internal: false
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.
VerificationCreateResponse:
type: object
properties:
code:
$ref: '#/components/schemas/ObjectMetadataRefCode'
message:
$ref: '#/components/schemas/ObjectMetadataRefMessage'
requestId:
$ref: '#/components/schemas/ObjectMetadataRefRequestID'
data:
$ref: '#/components/schemas/Verification'
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'
VerificationIdMatchResult:
type: object
required:
- idNumber
- idType
- matches
properties:
idNumber:
type: string
idType:
type: string
idSubtype:
type: string
matches:
type: boolean
RefGender:
type: string
title: GenderEnum
enum:
- Male
- Female
- Non-binary
- null
example: Male
description: Gender
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
RefDateTime:
type: string
title: Date and Time string
format: date-time
example: '2021-04-14T09:30:24Z'
description: Date and time
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'
VerificationGetResponse:
type: object
properties:
code:
$ref: '#/components/schemas/ObjectMetadataRefCode'
message:
$ref: '#/components/schemas/ObjectMetadataRefMessage'
requestId:
$ref: '#/components/schemas/ObjectMetadataRefRequestID'
data:
$ref: '#/components/schemas/Verification'
ObjectNextCursor:
title: ObjectNextCursor
type: string
example: '1259723474'
description: The next cursor value that can be used in the following query.
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
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.
parameters:
id:
name: id
in: path
schema:
type: string
minLength: 1
maxLength: 200
description: ID of the specific object in the collection.
required: true
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.
securitySchemes:
basicAuth:
type: http
scheme: basic
x-provenance:
method: searched
source: https://docs.getsmileapi.com/reference
harvested: '2026-10-20'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://docs.getsmileapi.com/reference/create-alpha-blacklist.md
- https://docs.getsmileapi.com/reference/create-alpha-footprint.md
- https://docs.getsmileapi.com/reference/create-alpha-income-estimator.md
- https://docs.getsmileapi.com/reference/create-alpha-maw.md
- https://docs.getsmileapi.com/reference/create-alpha-signal.md
- https://docs.getsmileapi.com/reference/create-and-classify-archive.md
- https://docs.getsmileapi.com/reference/create-archive.md
- https://docs.getsmileapi.com/reference/create-beta-maw2.md
- https://docs.getsmileapi.com/reference/create-beta-maw3.md
- https://docs.getsmileapi.com/reference/create-beta-signal.md
- https://docs.getsmileapi.com/reference/create-beta-signal2.md
- https://docs.getsmileapi.com/reference/create-beta-signal3.md
- https://docs.getsmileapi.com/reference/create-beta-social-security.md
- https://docs.getsmileapi.com/reference/create-consent-template.md
- https://docs.getsmileapi.com/reference/create-invite-template.md
- https://docs.getsmileapi.com/reference/create-invite.md
- https://docs.getsmileapi.com/reference/create-token-1.md
- https://docs.getsmileapi.com/reference/create-user-1.md
- https://docs.getsmileapi.com/reference/create-verification.md
- https://docs.getsmileapi.com/reference/create-webhook.md
- https://docs.getsmileapi.com/reference/delete-account.md
- https://docs.getsmileapi.com/reference/delete-archive.md
- https://docs.getsmileapi.com/reference/delete-consent-template.md
- https://docs.getsmileapi.com/reference/delete-invite-template.md
- https://docs.getsmileapi.com/reference/delete-webhook.md
- https://docs.getsmileapi.com/reference/disable-account-monitor.md
- https://docs.getsmileapi.com/reference/generate-account-export.md
- https://docs.getsmileapi.com/reference/get-account-1.md
- https://docs.getsmileapi.com/reference/get-account-payload.md
- https://docs.getsmileapi.com/reference/get-alpha-blacklist.md
- https://docs.getsmileapi.com/reference/get-alpha-footprint.md
- https://docs.getsmileapi.com/reference/get-alpha-form.md
- https://docs.getsmileapi.com/reference/get-alpha-income-estimator.md
- https://docs.getsmileapi.com/reference/get-alpha-maw.md
- https://docs.getsmileapi.com/reference/get-alpha-signal.md
- https://docs.getsmileapi.com/reference/get-archive.md
- https://docs.getsmileapi.com/reference/get-beta-maw.md
- https://docs.getsmileapi.com/reference/get-beta-signal.md
- https://docs.getsmileapi.com/reference/get-beta-social-security.md
- https://docs.getsmileapi.com/reference/get-contribution.md
- https://docs.getsmileapi.com/reference/get-document-1.md
- https://docs.getsmileapi.com/reference/get-eincomes.md
- https://docs.getsmileapi.com/reference/get-employment-1.md
- https://docs.getsmileapi.com/reference/get-feature-insight.md
- https://docs.getsmileapi.com/reference/get-identity-1.md
- https://docs.getsmileapi.com/reference/get-income-1.md
- https://docs.getsmileapi.com/reference/get-invite-template.md
- https://docs.getsmileapi.com/reference/get-invite.md
- https://docs.getsmileapi.com/reference/get-liabilities.md
- https://docs.getsmileapi.com/reference/get-link.md
- https://docs.getsmileapi.com/reference/get-provider-1.md
- https://docs.getsmileapi.com/reference/get-rating-1.md
- https://docs.getsmileapi.com/reference/get-task.md
- https://docs.getsmileapi.com/reference/get-transaction-1.md
- https://docs.getsmileapi.com/reference/get-user-1.md
- https://docs.getsmileapi.com/reference/get-user-session-payload.md
- https://docs.getsmileapi.com/reference/get-verification.md
- https://docs.getsmileapi.com/reference/get-webhook.md
- https://docs.getsmileapi.com/reference/list-accounts-1.md
- https://docs.getsmileapi.com/reference/list-alpha-blacklists.md
- https://docs.getsmileapi.com/reference/list-alpha-footprints.md
- https://docs.getsmileapi.com/reference/list-alpha-forms.md
- https://docs.getsmileapi.com/reference/list-alpha-income-estimators.md
- https://docs.getsmileapi.com/reference/list-alpha-maws.md
- https://docs.getsmileapi.com/reference/list-alpha-signals.md
- https://docs.getsmileapi.com/reference/list-archives.md
- https://docs.getsmileapi.com/reference/list-beta-maws.md
- https://docs.getsmileapi.com/reference/list-beta-signals.md
- https://docs.getsmileapi.com/reference/list-beta-social-securities.md
- https://docs.getsmileapi.com/reference/list-consent-templates.md
- https://docs.getsmileapi.com/reference/list-contributions.md
- https://docs.getsmileapi.com/reference/list-documents-1.md
- https://docs.getsmileapi.com/reference/list-eincomes.md
- https://docs.getsmileapi.com/reference/list-employments-1.md
- https://docs.getsmileapi.com/reference/list-file-types.md
- https://docs.getsmileapi.com/reference/list-identities-1.md
- https://docs.getsmileapi.com/reference/list-incomes-1.md
- https://docs.getsmileapi.com/reference/list-insights.md
- https://docs.getsmileapi.com/reference/list-invite-log.md
- https://docs.getsmileapi.com/reference/list-invite-templates.md
- https://docs.getsmileapi.com/reference/list-invites.md
- https://docs.getsmileapi.com/reference/list-liabilities.md
- https://docs.getsmileapi.com/reference/list-links.md
- https://docs.getsmileapi.com/reference/list-providers.md
- https://docs.getsmileapi.com/reference/list-ratings-1.md
- https://docs.getsmileapi.com/reference/list-tasks.md
- https://docs.getsmileapi.com/reference/list-transactions-1.md
- https://docs.getsmileapi.com/reference/list-users-1.md
- https://docs.getsmileapi.com/reference/list-verifications.md
- https://docs.getsmileapi.com/reference/list-webhooks.md
- https://docs.getsmileapi.com/reference/reset-user-session.md
- https://docs.getsmileapi.com/reference/update-invite-template.md
merge:
pages: 92
deduped: 1153
conflicts_kept_first: 0