Skip to main content
POST
Phone Risk Score
For a usage description of the Phone Risk Score Service, please refer to the Phone Risk Score page.

Endpoint

POST /phone-service/phoneRiskScore

Swagger

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth. Valid for 60 minutes.

Body

application/json
phoneNumber
string
required

The phone number to check, including country code (E.164).

Example:

"+436501234567"

accountLifecycleEvent
enum<string>
required

The action being evaluated.

Available options:
create,
sign-in,
transact,
update,
delete
Example:

"create"

externalId
string

Customer-generated ID echoed in the response.

Example:

"1234567890"

originatingIp
string

End user's IP address (IPv4 or IPv6). Do not send your server IP.

Example:

"192.168.1.1"

deviceId
string

Case-sensitive device ID.

Example:

"1234567890"

accountId
string

Case-sensitive account ID.

Example:

"1234567890"

emailAddress
string

Case-sensitive email address.

Example:

"test@example.com"

Response

Successfully retrieved phone risk score.

status
boolean
required

Indicates if the API request was successful.

data
object
required