Scoring

Validate phone numbers and retrieve additional information

Changed on

This method serves as an additional layer of protection in your system for validating phone numbers. It not only checks the syntax but also assesses the likelihood of the phone number being valid and operational.

By incorporating this scoring into your workflow, you can enhance fraud detection, reduce invalid inputs, and improve the overall quality of data captured.

get/score/phone/{phone}

Request

  • Base URL
    https://v2.greipapi.com
  • URL
    https://v2.greipapi.com/score/phone/{phone}
  • Auth
    HTTP bearer

Path parameters

phonestring required

Query parameters

country_codestring required
formatstring
Example:JSON

The format command is used to get a response in a specific format.

modestring
Example:test

The mode command is used to in the development stage to simulate the integration process before releasing it to the production environment.

Expected values: live, or test.

sourcestring
user_idstring
Example:UID-12345

The user_id query parameter identifies requests from specific users for monitoring in the Events page. See the user identifier options page for details.

Response

OK

successboolean required
dataobject required

Endpoint-specific payload.

execution_msinteger required

Example response

{
  "success": true,
  "execution_ms": 42
}

Changes