Phone Number
You can use the Phone module by defining the phoneNumber that you want to check to your request.
Last updated
You can use the Phone module by defining the phoneNumber that you want to check to your request.
Last updated
Method
URL
POST
$synapses/v1/account/screening
Header
Value
Content-Type
application/json
Authorization
Bearer YOUR_API_KEY
Field
Type
Description
phoneNumber
(Required)
String
Phone number with national code (e.g. 6281234567890)
phoneReportStartDate
Date
Get user reports history from date
phoneReportEndDate
Date
Get user reports history to date
Field
Type
Description
fullName
String
Phone number full name
phoneNumber
String
Phone number
providerName
String
Provider name
providerType
String
Provider type (e.g. Simpati)
countryName
String
Country name
countryCode
String
Country code
nationalNumber
String
National number
regionName
String
Region name
isPossibleNumber
Boolean
Return true when it's a possible number (e.g. it has the right number of digits
isValidNumber
Boolean
Return true when it's a valid number (e.g. it's in an assigned exchange)
isTrustedProvider
Boolean
Return true when the provider is trusted
reportCount
Int
The number of fraud reports related to the phone numbers
reportScore
Float
Accumulated total report score
isWhitelist
Boolean
Phone number whitelist status
isBlacklist
Boolean
Phone number blacklist status
score
Float
(-100 to 100)
Total accumulated credibility score of the phone number