Accounts6

Archives9

Blacklists (Alpha)4

Consent Templates3

Contributions2

Documents2

Employers2

Employments2

Estimated Incomes2

File Types1

Footprints (Alpha)3

Footprints (Beta)9

Forms (Alpha)2

Identities2

Income Estimators (Alpha)3

Incomes2

Insights2

Invite Templates5

Invites4

Liabilities2

Links2

Maws (Alpha)3

Maws (Beta)4

Providers2

Ratings2

Signals (Alpha)3

Signals (Beta)5

Social Securities (Beta)3

Social Security (Alpha)3

Tasks2

Tokens1

Transactions2

Uploads2

Users5

Validations (Alpha)3

Verification3

Webhooks4

Footprints (Alpha)

Create Footprint

Changed on Sep 14, 2026

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.

post/alpha/footprints

Request

Base URL
https://sandbox.smileapi.io/v1
URL
https://sandbox.smileapi.io/v1/alpha/footprints
Auth
HTTP basic

Request body

Example request

{
  "emailAddress": "gpalomero1234@smileapi.io",
  "countryCode": "PH",
  "templateId": "tpl-email-footprint",
  "footprintItemsTimeout": 5,
  "consent": {
    "type": "Terms and Conditions",
    "version": "1.0.0",
    "consentedAt": "2021-04-14T09:30:24Z",
    "consentedWith": "I agree to the terms and conditions"
  }
}

Response

Request status code

messagestring

Message response to the request

requestIdstring

Unique ID that is added to the body of every response for easy traceability of the request in our logs.

Example response

{
  "code": "OK",
  "message": "Success",
  "requestId": "5b79399a-6852-4234-bb0e-ad472648282d",
  "data": {
    "createdAt": "2021-04-14T09:30:24Z",
    "requestMeta": {
      "emailAddress": "gpalomero1234@smileapi.io",
      "countryCode": "PH",
      "templateId": "tpl-email-footprint",
      "footprintItemsTimeout": 5,
      "consent": {
        "type": "Terms and Conditions",
        "version": "1.0.0",
        "consentedAt": "2021-04-14T09:30:24Z",
        "consentedWith": "I agree to the terms and conditions"
      }
    }
  }
}

Changes

Sep 14, 2026v1a68faef4b017 Revision changes
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ///////// request property allOf list
- breaking
  added to the ///////// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  added to the ///////// request property allOf list
- breaking
  added to the ///// request property allOf list
- breaking
  the ///// request property type changed from string to no type, and format from date-time to no format
- breaking
  the ///////// request property type changed from string to no type, and format from date-time to no format
- breaking
  the ///////// request property type changed from string to no type, and format from date-time to no format
- breaking
  the ///// request property type changed from string to no type, and format from date-time to no format
- breaking
  the ///////// request property type changed from string to no type, and format from date-time to no format
- breaking
  the ///// request property type changed from string to no type, and format from date-time to no format
- breaking
  the /////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////////// response's property type changed from string to no type, and format from date-time to no format for status
- breaking
  the /////// response's property type changed from string to no type, and format from date-time to no format for status
- info
  added to the /////// response property allOf list for the response status
- info
  added to the /////////// response property allOf list for the response status
- info
  added to the /////////// response property allOf list for the response status
- info
  added to the /////// response property allOf list for the response status
- info
  added to the /////////// response property allOf list for the response status
- info
  added to the /////// response property allOf list for the response status
Mar 2, 2026v1541c004ba4b3 Revision changes
- breaking
  the response property ////// became optional for the status
- breaking
  the response property ////////// became optional for the status
- breaking
  the response property ////////// became optional for the status
- breaking
  the response property ////// became optional for the status
- breaking
  the response property ////////// became optional for the status
- info
  the request property //// became optional
- info
  the request property //////// became optional
- info
  the request property //////// became optional
- info
  the request property //// became optional
- info
  the request property //////// became optional

Operation history (7 revisions)