Create a Phone Social Footprint object

post

https://sandbox.smileapi.io/v1/beta/footprints/requestPhoneSocial

Create a Phone Social 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-footprint-phonesocial`	Mobile number only	`consent`, `templateId`, `mobileNumber`, `countryCode`

Field Rules

mobileNumber must be provided, must start with the country code, and must not contain a leading 0 or a +.
countryCode is required and must be a valid ISO country code.
footprintItemsTimeout is optional, in seconds, between 1 and 30.

Sandbox Test Values

Template ID	Test Input	Expected Response
`tpl-footprint-phonesocial`	`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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

mobileNumber

string

required

Mobile number of the data subject. Required. Must start with the country code, for example 639559991234, and must not contain a leading 0 or a + sign.

countryCode

string | null

enum

required

2 character alpha ISO-3166 codes

templateId

string

required

Fixed to tpl-footprint-phonesocial.

footprintItemsTimeout

integer

1 to 30

Timeout in seconds for waiting for Footprint items. Items completed before the timeout are returned; the remaining items have a null value.

Response

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK