Phone Verification Report

Our Phone Verification process performs comprehensive validation of user phone numbers through OTP (One-Time Passcode) verification and risk assessment. This guide explains the structure and contents of a phone verification report.

Report Structure

The verification report is returned as a JSON object containing a phone object with the following key sections:

• Verification Status: Overall status of the phone verification
• Phone Details: Information about the verified phone number
• Risk Assessment: Analysis of potential risks associated with the phone number
• Verification History: Details about verification attempts
• Verification Metadata: Additional verification details and timestamps

Core Response Fields

interface PhoneVerificationResponse {
  phone: {
    status: 'Approved' | 'Declined' | 'In Review' | 'Not Finished';
    phone_number_prefix: string; // The prefix of the phone number, e.g. "+34" for Spain numbers
    phone_number: string; // The phone number without the prefix
    full_number: string; // The complete international format of the phone number in E.164 format
    country_code: string; // The country code of the phone number in ISO 3166-1 alpha-2 format
    country_name: string; // The full name of the country associated with the phone number
    carrier: {
      name: string;
      type: 'mobile' | 'landline' | 'voip' | 'unknown';
    };
    is_disposable: boolean;
    is_virtual: boolean;
    verification_method: 'sms' | 'whatsapp' | 'viber' | 'telegram' | 'call'; // sms, whatsapp, viber, telegram, call
    verification_attempts: number;
    verified_at: string;          // ISO 8601 timestamp
    warnings: {
      risk: string;
      additional_data: string | null;
      log_type: 'information' | 'warning' | 'error';
      short_description: string;
      long_description: string;
    }[];
  }
}

Response Fields

Verification Status

• status: The overall status of the phone verification (Options: "Approved", "Declined", "In Review", "Not Finished")

Phone Information

• phone_number: The phone number without the country code
• country_code: The international dialing code (e.g., "1", "44", "34")
• full_number: The complete international format of the phone number
• country_iso3: The ISO 3166-1 alpha-3 code of the country associated with the phone number
• country_name: The full name of the country associated with the phone number

Carrier Information

• carrier: Information about the telecommunications provider:
  • name: The name of the carrier or service provider
  • type: The type of phone service (Options: "mobile", "landline", "voip", "unknown")

Risk Assessment

• is_disposable: Boolean indicating whether the number is identified as a disposable/temporary number
• is_virtual: Boolean indicating whether the number is identified as a virtual or VoIP number

Verification Details

• verification_method: The method used to deliver the verification code
• verification_attempts: The number of verification attempts made

Verification Metadata

• warnings: Array of warning objects with detailed information about verification issues
• verified_at: Timestamp of when the verification was successfully completed

Sample JSON Response

{
  "phone": {
    "status": "Approved",
    "country_code": "+1",
    "phone_number": "5551234567",
    "full_number": "+15551234567",
    "country_iso3": "USA",
    "country_name": "United States",
    "carrier": {
      "name": "T-Mobile",
      "type": "mobile"
    },
    "is_disposable": false,
    "is_virtual": false,
    "verification_method": "sms",
    "verification_attempts": 1,
    "warnings": [],
    "verified_at": "2024-07-28T06:47:35.654321Z"
  }
}