Phone Unlock Status API
Poll the status of a personal phone unlock request.
ENDPOINTS
POST /api/v1/businessContact/contact/phone/status
Request parameters
person_id
string
The person ID to check unlock status for
- Required:
Yes - Example:
5a1b2c3d4e5f000000000001
Request Example
{ "person_id": "5a1b2c3d4e5f000000000001" }
curl https://api.tradedata.io/api/v1/businessContact/contact/phone/status \
-H "Authorization: Bearer yourTokenHere" \
-H "Content-Type: application/json" \
-d '{"person_id": "5a1b2c3d4e5f000000000001"}'
import requests
response = requests.post(
"https://api.tradedata.io/api/v1/businessContact/contact/phone/status",
headers={
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
json={"person_id": "5a1b2c3d4e5f000000000001"},
)
print(response.json())
const response = await fetch(
"https://api.tradedata.io/api/v1/businessContact/contact/phone/status",
{
method: "POST",
headers: {
"Authorization": "Bearer yourTokenHere",
"Content-Type": "application/json",
},
body: JSON.stringify({ person_id: "5a1b2c3d4e5f000000000001" }),
}
);
const data = await response.json();
<?php
$ch = curl_init("https://api.tradedata.io/api/v1/businessContact/contact/phone/status");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer yourTokenHere",
"Content-Type: application/json",
],
CURLOPT_POSTFIELDS => json_encode([
"person_id" => "5a1b2c3d4e5f000000000001",
]),
]);
echo curl_exec($ch);
Response parameters
data.status
string
Current unlock status
- Example:
locked
| Value | Meaning |
|---|---|
locked | Phone is locked — either no unlock has been requested, or the unlock is still in progress |
unlocked | Unlock succeeded, phoneNumbers is populated |
failed | Callback was received but no valid phone number was returned |
data.phoneNumbers
array<string>
Phone number list. Only present when status is unlocked
- Example:
["+6555500000"]
Response Example — locked
{
"code": 200,
"data": { "status": "locked" },
"msg": "OK"
}
Response Example — unlocked
{
"code": 200,
"data": {
"status": "unlocked",
"phoneNumbers": ["+6555500000", "+6555500001"]
},
"msg": "OK"
}
Response Example — failed
{
"code": 200,
"data": { "status": "failed" },
"msg": "OK"
}
Polling guidance
Poll at 5–10 second intervals. The callback typically arrives within 30–120 seconds. Stop polling once status is unlocked or failed.