get https://api.sumsub.com/resources/checks/latest?type=PHONE_CONFIRMATION
Overview
Use this method to retrieve phone confirmation check results.
Response explained
The response represents a singleton list of checks.
Root variables
The root variables are the core check result data items. Some of them may include nested attributes and element fields.
Field | Type | Description |
---|---|---|
answer | String | Check answer:
|
checkType | String | Indicates this is the PHONE_CONFIRMATION check type. |
createdAt | Date | Date and time (UTC) of the latest phone confirmation check result. |
id | String | Unique identifier of the check. |
phoneConfirmationCheckInfo | Object | Includes specific phone check parameters with check results. |
phoneConfirmationCheckInfo
attributes
phoneConfirmationCheckInfo
attributesThe following table explains the phoneConfirmationCheckInfo
attributes that represent the check results of the provided phone number in accordance with specific parameters.
Field | Type | Description |
---|---|---|
firstSeenAt | Date | Date and time the phone number was first used somewhere to identify its owner. For example, as a login on a web site. |
confirmedViaOtp | String | Indicates if the phone number is confirmed by the applicant via OTP (One Time Password).GREEN means that the applicant received a confirmation code on the phone and confirmed it via SDK, null if not. |
blacklisted | String | Indicates whether the provided phone number is included in the known global blocklists.
|
riskLevel | String | Indicates a verdict made by the system according to the check results and internal logic.
|
nonDisposable | String | Indicates whether the provided phone number is a disposable one and might disappear once used.
|
webRegistrationsExist | String | Indicates if the phone number is used for registration on websites.
|
active | String | Indicates if the phone number is acquired, activated by a user, and ready to receive calls.
|
valid | String | Indicates if the phone number exists and is valid.
|
nonVirtual | String | Indicates if the phone number is virtual — linked to an online account with a provider, as opposed to a specific location.
|
phone | String | Phone number. |
profiles | Array of strings | Information on profiles created for social networks, services, and other platforms using the provided phone number. |
riskLabels | Array of strings | A list of phone risk labels assigned by the system according to the check results and internal logic. |
Available phone risk labels
The following table explains possible phone risk labels assigned in accordance with the check results.
Risk label | Description |
---|---|
mediumRisk | Medium-risk phone number. A verdict made by the system according to the check results and internal logic. |
highRisk | High-risk phone number. A verdict made by the system according to the check results and internal logic. |
virtual | Virtual phone that allows a user to make calls through the internet and is not associated with a physical location. |
noWebRegistrations | Phone number registration on websites is not detected. |
disposable | Disposable phone number that usually disappears once used. |
Response example
{
"checks": [
{
"answer": "GREEN",
"checkType": "PHONE_CONFIRMATION",
"createdAt": "2022-08-25 12:00:43",
"id": "01735091-e1d4-4744-99ac-000000000000",
"phoneConfirmationCheckInfo": {
"firstSeenAt": null,
"confirmedViaOtp": null,
"blacklisted": "GREEN",
"riskLevel": "YELLOW",
"nonDisposable": "YELLOW",
"webRegistrationsExist": "YELLOW",
"active": "YELLOW",
"valid": "YELLOW",
"nonVirtual": "YELLOW",
"phone": "+111 111 111 111",
"profiles": null,
"riskLabels": null
}
}
]
}