PrivyPrivy
Sign in
  • Documentation
Back to Documentation
B2B Telco APIs
OverviewChangelog
Phone Active
Phone Match
    v1
    v2
    v3
      Phone Match v3QuickstartEnvironmentsAuthenticationRequest FieldsMatch ResultsErrors
Phone Location Verification
Phone Income Score
API Explorer
powered by Zudoku
Sign in
v3

Match Results

A successful Phone Match v3 request returns HTTP 200.

FieldTypeDescription
codeintegerHTTP-aligned result code.
statusstringsuccess.
client_transaction_idstringThe submitted transaction_id.
dataobjectmatch results for the number.
balanceintegerRemaining balance or postpaid usage representation.
transaction_idstringPrivy's transaction identifier.
messagestringphone match verification successful.

Data object

FieldTypeDescription
phonestringNormalized mobile number.
operatorstringDetected mobile operator.
matchbooleantrue when the number and NIK are associated; otherwise false.
Code
{ "code": 200, "status": "success", "client_transaction_id": "match-v3-001", "data": { "phone": "628171234567", "operator": "XL, Axis, and Smartfren", "match": true }, "balance": 100, "transaction_id": "019c1234-5678-7abc-8def-0123456789ab", "message": "phone match verification successful" }
Last modified on October 23, 2026
Request FieldsErrors
On this page
  • Data object
JSON