Copy page

v3

Location Results

A successful Phone Location Verification v3 request returns HTTP 200.

Field	Type	Description
code	integer	HTTP-aligned result code.
status	string	success.
client_transaction_id	string	The submitted transaction_id.
data	object	Location result for the number.
balance	integer	Remaining balance or postpaid usage representation.
transaction_id	string	Privy's transaction identifier.
message	string	phone location verification successful.

Data object

Field	Type	Description
phone	string	Normalized mobile number.
operator	string	Detected mobile operator.
score	string	Provider-specific location score.

Score scales are operator-specific. Do not compare scores between API versions or apply a pass threshold unless Privy has defined one for your integration.

Code
{
    "code": 200,
    "status": "success",
    "client_transaction_id": "location-v3-001",
    "data": {
        "phone": "628171234567",
        "operator": "XL, Axis, and Smartfren",
        "score": "1"
    },
    "balance": 100,
    "transaction_id": "019c1234-5678-7abc-8def-0123456789ab",
    "message": "phone location verification successful"
}