Create Blacklist2

post

https://sandbox.smileapi.io/v1/alpha/blacklists/requestBlacklist2

Create a Blacklist2 object.

This endpoint requires the following input parameters:
consent, mobileNumber, templateId, and countryCode.

idType and idNumber are supported identity fields for the Blacklist2 template and should be provided when available.

Supported Template

Template ID	Region	Required Parameters
`tpl-blacklist-007001`	PH (default)	`consent`, `mobileNumber`, `countryCode`, `templateId`

Field Rules

templateId must be tpl-blacklist-007001.
countryCode is required.
For countryCode = PH, idType must be one of: NATIONAL_ID, SSS, UMID, TIN, PRC, PHILHEALTH, PASSPORT, DRIVER_LICENSE, VOTER_ID, or POSTAL_ID.

Sandbox Test Values

Parameter	Value	Expected Response
`templateId`	`tpl-blacklist-007001`
`mobileNumber`	`639559991234`
`countryCode`	`PH`
`idType`	`TIN`
`idNumber`	`4561234567`	`resultCode = SUCCESS`, `hit = true`

For all other valid input combinations, the response will return:
resultCode = SUCCESS, but hit = false.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Alpha Blacklist Post Request2.

mobileNumber

string

required

Subject's mobile number. Must start with country code i.e. 639559991234, and no leading zeros

idType

string

enum

required

Defaults to NATIONAL_ID

The type of ID. If countryCode is PH, this value must be one of the following: NATIONAL_ID, SSS, UMID, TIN, PRC, PHILHEALTH, PASSPORT, DRIVER_LICENSE, VOTER_ID, POSTAL_ID.

idNumber

string

required

Subject's ID number.

countryCode

string | null

enum

required

The country code of the ID. Only supported for PH, ID, MX.

templateId

string

required

Defaults to tpl-blacklist-007001

Fixed templateId for this request. Value must be tpl-blacklist-007001

consent

object

required

Response

200OK