Smile Social Securities (Beta) API
The Social Securities (Beta) API from Smile — 2 operation(s) for social securities (beta).
The Social Securities (Beta) API from Smile — 2 operation(s) for social securities (beta).
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-social-securities-beta-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 Social Securities (Beta) 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: Social Securities (Beta)
paths:
/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:
tpl-sss003002:
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:
tpl-sss003002:
value:
code: OK
message: Success!
requestId: cc528375-f115-4af0-a697-43f51e084cb3
data:
id: ss-e47c89890660439d861e08b05b27a7fb
createdAt: '2026-08-18T06:32:43Z'
status: PROCESSING
resultCode: SUCCESS
resultMessage: query success
result:
fullName: George Cimafranca Palomero, Jr
curp: DOEJ800102HDFXXX02
nss: '12345678901'
payMark: null
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
nss: '12345678901'
templateId: tpl-sss003002
consent:
type: Terms And Conditions
version: '1'
consentedAt: '2021-04-14T09:30:24Z'
consentedWith: I agree to the terms and conditions.
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:
tpl-sss003002:
value:
code: OK
message: Success!
requestId: cc528375-f115-4af0-a697-43f51e084cb3
data:
nextCursor: null
items:
- id: ss-e47c89890660439d861e08b05b27a7fb
createdAt: '2026-08-18T06:32:43Z'
status: PROCESSING
resultCode: SUCCESS
resultMessage: query success
result:
fullName: George Cimafranca Palomero, Jr
curp: DOEJ800102HDFXXX02
nss: '12345678901'
payMark: null
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
nss: '12345678901'
templateId: tpl-sss003002
consent:
type: Terms And Conditions
version: '1'
consentedAt: '2021-04-14T09:30:24Z'
consentedWith: I agree to the terms and conditions.
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:
tpl-sss003002:
value:
code: OK
message: Success!
requestId: cc528375-f115-4af0-a697-43f51e084cb3
data:
id: ss-e47c89890660439d861e08b05b27a7fb
createdAt: '2026-08-18T06:32:43Z'
status: PROCESSING
resultCode: SUCCESS
resultMessage: query success
result:
fullName: George Cimafranca Palomero, Jr
curp: DOEJ800102HDFXXX02
nss: '12345678901'
payMark: null
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
nss: '12345678901'
templateId: tpl-sss003002
consent:
type: Terms And Conditions
version: '1'
consentedAt: '2021-04-14T09:30:24Z'
consentedWith: I agree to the terms and conditions.
consentTemplateId: null
components:
schemas:
schemas-SocialSecurityListData:
type: object
properties:
nextCursor:
$ref: '#/components/schemas/ObjectNextCursor'
items:
type: array
items:
$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'
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'
ObjectNextCursor:
title: ObjectNextCursor
type: string
example: '1259723474'
description: The next cursor value that can be used in the following query.
x-internal: false
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'
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
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'
RefObjectID:
type: string
title: Object ID
description: Unique ID of this object
example: 17bbf36498de4d68a0d4f86c7b62f69f
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
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
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'
ObjectMetadataRefMessage:
type: string
title: ObjectMetadataRefMessage
description: Message response to the request
example: Success
x-internal: false
RefDateTime:
type: string
title: Date and Time string
format: date-time
example: '2021-04-14T09:30:24Z'
description: Date and time
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.
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
- 'null'
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'
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