Blacklists

The Blacklist API checks whether a subject's mobile number appears in Smile's blacklist data sources for a given country. A blacklist hit indicates that the mobile number has been associated with adverse events — such as fraud, delinquency, or defaulted obligations — recorded by financial institutions and other participating data providers in the Smile Network.

Blacklist checks are synchronous: results are returned immediately in the API response, with no need for webhooks or polling.

Smile Blacklist is currently in Alpha.

How a Blacklist Check Works

1. Submit a Blacklist request using the POST /alpha/blacklists endpoint. At minimum, provide the subject's mobileNumber and a valid consent object.

2. Receive the result synchronously. The API returns the full Blacklist object in the response body, including a result.hit boolean and a list of dates on which blacklist events were recorded for this mobile number.

3. Evaluate the result. If result.hit is true, the subject's mobile number was found on the blacklist. The result.dates array contains the dates on which the blacklist entries were recorded, which you can use to assess the recency and frequency of adverse events.

📘

About applicationDate

applicationDate is an optional field. When provided, Smile queries blacklist data recorded before that date, allowing you to perform point-in-time evaluations. If omitted, the check is evaluated against the current date, which is the recommended behavior for real-time screening.

Supported Markets

If you require blacklist screening for other markets, contact your Smile account manager for available templates and the corresponding templateId.

The Blacklist Objects

Request Object

This is the object you send when creating a Blacklist check.

Blacklist Object

This is the object returned in the response.

Result Object

Blacklist Statuses

Result Codes

📘

Billing Note

Blacklist checks are billed on request for both SUCCESS and NO_DATA result codes. Only the POST /alpha/blacklists endpoint is counted for billing — List and Get requests are not charged.

Sample Blacklist data

{
  "id": "blacklist-e35d521ef8f147c4aa01b7c1af85aaf7",
  "createdAt": "2021-04-14T09:30:24Z",
  "status": "COMPLETED",
  "resultCode": "SUCCESS",
  "resultMessage": "Success!",
  "requestMeta": {
    "mobileNumber": "639559991234",
    "countryCode": "PH",
    "applicationDate": "2021-04-14",
    "templateId": "tpl-blk002001",
    "consent": {
      "type": "Terms And Conditions",
      "version": "1.0.0",
      "consentedWith": "I agree to the terms and conditions.",
      "consentedAt": "2021-04-14T09:30:24Z",
      "consentTemplateId": null
    }
  },
  "result": {
    "hit": true,
    "dates": [
      "2021-04-14",
      "2021-03-14",
      "2021-02-14"
    ]
  }
}

Sandbox Testing

Use the following values to trigger a blacklist hit in the Sandbox environment. All other valid mobile number and country code combinations will return resultCode: SUCCESS with hit: false.

Endpoints