---
title: "Create Footprint"
method: POST
path: "/alpha/footprints"
tags: ["Footprints (Alpha)"]
---

# Create Footprint

`POST /alpha/footprints`

## Create a **Footprint** object.  
This endpoint requires the following mandatory parameters:  
- `consent`  
- `templateId`  

In addition, you must provide **either** `emailAddress` **or** `mobileNumber` — these two are **mutually exclusive**.

### Supported Templates

| Template ID     | Input Type    | Required Parameters                     |
|-----------------|---------------|-----------------------------------------|
| `tpl-ftp005001` | Email address | `consent`, `templateId`, `emailAddress` |
| `tpl-ftp005002` | Mobile number | `consent`, `templateId`, `mobileNumber` |

### Field Rules

- For `tpl-ftp005001`, `emailAddress` must be provided and `mobileNumber` must be omitted.  
- For `tpl-ftp005002`, `mobileNumber` must be provided and `emailAddress` must be omitted.  
- `emailAddress` and `mobileNumber` **cannot** be used together in the same request.

### Sandbox Test Values

| Template ID     | Test Input                                 | Expected Response      |
|-----------------|--------------------------------------------|------------------------|
| `tpl-ftp005001` | `emailAddress = gpalomero1234@smileapi.io` | `resultCode = SUCCESS` |
| `tpl-ftp005002` | `mobileNumber = 639559991234`              | `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.

## Request body

- AlphaFootprintPostRequest
  - `emailAddress` string — The email address of the subject. It must be a valid email address.
  - `mobileNumber` string — Subject's mobile number. Must start with country code i.e. 639178912345, and no leading zeros
  - `templateId` string, required — Generated internally by Smile. Customers should request the specific templateId from Smile.
  - `consent` Consent, required
    - `type` string — The consent flag key, the consent content should be sent to Smile previously
    - `version` string — The version of this consent
    - `consentedAt` string, date-time, required — Date and time
    - `consentedWith` string, required — The short sentences diplay on the consent page.
    - `consentTemplateId` string — The releated consent template id, you can get it from Smile Developer Portal or /consentTemplates endpoint.

## Response `200`

OK

- AlphaFootprintPostResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED' — Request status code
  - `message` string — Message response to the request
  - `requestId` string — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` AlphaFootprint
    - `id` string, required — The unique ID for the Alpha Footprint.
    - `createdAt` string, date-time, required — Date and time
    - `status` 'PROCESSING' | 'ERROR' | 'COMPLETED', required — The current status of the Footprint.
    - `resultCode` 'SUCCESS' | 'NO_DATA' | 'SYSTEM_ERROR' | 'SERVICE_UNAVAILABLE' — The final result of the Footprint.
    - `resultMessage` string — A detailed description of the final result of the Footprint.
    - `requestMeta` object, required
      - `emailAddress` string — The email address of the subject provided in the request.
      - `mobileNumber` string — Subject's mobile number. Must start with country code i.e. 639178912345, and no leading zeros
      - `templateId` string — Generated internally by Smile. Customers should request the specific templateId from Smile.
      - `consent` Consent
        - `type` string — The consent flag key, the consent content should be sent to Smile previously
        - `version` string — The version of this consent
        - `consentedAt` string, date-time, required — Date and time
        - `consentedWith` string, required — The short sentences diplay on the consent page.
        - `consentTemplateId` string — The releated consent template id, you can get it from Smile Developer Portal or /consentTemplates endpoint.
    - `items` AlphaFootprintItem[]
      - `name` string, required — A unique name for the item.
      - `value` string, required — The value associated with the item.
      - `valueType` 'STRING' | 'NUMBER' | 'BOOLEAN', required

## Changes

- **2025-06-06** (v1) `cf742a9348f6` — 3 info
  - added the new optional request property `mobileNumber`
  - the request property `emailAddress` became optional
  - added the optional property `data/requestMeta/mobileNumber` to the response with the `200` status
- **2025-02-10** (v1) `f4b9331626c3` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/smileapi/apis/smile-api/changes/alpha/footprints/post.md)

---

[API](https://skmtc.dev/smileapi/apis/smile-api.md) · [All operations](https://skmtc.dev/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smileapi/smile-api/revisions/2e8500e069bb/schema)