Prembly
GuidesAPI Reference
Identity VerificationGlobal / OthersPhone Global POST
POST
/api/v1/verification/api/phone_global/

Global phone status check

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/verification/api/phone_global/" \  -H "Content-Type: application/json" \  -d '{    "number": "+1234567890"  }'
{  "data": {    "carrier": {      "name": "NULL"    },    "contact": {      "city": "naaa",      "status": {        "code": 2000,        "description": "Request successfully completed"      },      "country": "DE",      "address1": "",      "address2": "",      "address3": "",      "address4": "",      "last_name": "IL",      "first_name": "aajay",      "date_of_birth": null,      "email_address": "",      "state_province": "oou",      "zip_postal_code": ""    },    "location": {      "zip": null,      "city": "Countrywide",      "state": null,      "county": null,      "country": {        "iso2": "DE",        "iso3": "DEU",        "name": "Germany"      },      "time_zone": {        "name": null,        "utc_offset_max": "+1",        "utc_offset_min": "+1"      },      "metro_code": null,      "coordinates": {        "latitude": null,        "longitude": null      }    },    "numbering": {      "original": {        "country_code": "49",        "phone_number": "30901820",        "complete_phone_number": "4930901820"      },      "cleansing": {        "sms": {          "max_length": 10,          "min_length": 10,          "country_code": "49",          "phone_number": "30901820",          "cleansed_code": 100        },        "call": {          "max_length": 10,          "min_length": 10,          "country_code": "49",          "phone_number": "30901820",          "cleansed_code": 100        }      }    },    "phone_type": {      "code": "2",      "description": "MOBILE"    },    "blocklisting": {      "blocked": false,      "block_code": 0,      "block_description": "Not blocked"    }  },  "status": true,  "response_code": "00",  "message": "string",  "billing_info": {    "was_charged": true,    "amount": "string",    "currency": "string"  }}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel

Face Liveliness POST

Verify that image contains a live person (anti-spoofing).

Enrol a face POST

Stores a person's face in one of your galleries under your own `subject_id`, so they can later be authenticated or identified. You must pass `consent: true`, confirming you hold the person's consent to store their face. Keep your own record of that consent; use `consent_reference` to link it. Set `check_liveness` to reject printed or replayed faces at enrolment. Enrolling a `subject_id` that already exists returns `409` unless you send `overwrite: true`, which replaces the stored face. Use **Erase an enrolled face** to remove one permanently. Billed per successful enrolment and debited from the organisation wallet. Failed calls are never charged. Sandbox keys return a sample response and store nothing.