Fraud Detection

Fraud Detection is designed to give information which can help to identify phone numbers associated with fraud for application integrations. This API is currently in Beta.

This API will be sunset on November 23, 2025, and will no longer be available after that date.

To detect SIM Swap, please migrate to the Identity Insights API.

Baixar a especificação OpenAPI
Operações disponíveis

Check for Fraud

Make fraud check requests with a phone number by checking SIM swap status.

posthttps://api.nexmo.com/v2/ni

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Corpo da solicitação
Tipo de conteúdo
application/json

type
string
Obrigatório
exemplophone

Accepted value is “phone” when a phone number is provided.

Deve ser uma das seguintes opções:phone
phone
string
Obrigatório
exemplo447009000000

A single phone number that you need insight about in the E.164 format. Don't use a leading + or 00 when entering a phone number, start with the country code, e.g. 447700900000.

insights
array
Obrigatório

The insight you require. Must be: sim_swap.

Valores disponíveis:
sim_swap

Exemplo Solicitação

{
   "type": "phone",
   "phone": "447009000000",
   "insights": [
      "sim_swap"
   ]
}
{
   "type": "phone",
   "phone": "447009000000",
   "insights": [
      "sim_swap"
   ]
}

Respostas
Tipo de conteúdo
application/json

OK

request_id
string
Obrigatório
exemplo3f92ed75-e624-4503-abbd-a93d6b442571

Unique UUID for this request for reference.

type
string
Obrigatório
exemplophone

The type of lookup used in the request. Currently always phone.

phone
object
Obrigatório

An object containing the phone number that was used in the fraud check.

phone
string
Obrigatório
exemplo16197363066

The phone number used in the fraud check operation(s).

sim_swap
object

The result of the sim_swap insight operation. If successful, it will return swapped: true if the sim was swapped in the last 7 days.

The sim_swap object will only be returned if you specified sim_swap as a value in the insights array when the request was made.

status
string
Obrigatório
exemplocompleted

The status of the sim_swap call.

Deve ser uma das seguintes opções:completedfailed
swapped
boolean
exemplotrue

true if the sim was swapped in the last 7 days, false otherwise. Returned only if the sim swap check succeeds.

reason
string
exemploMobile Network Operator Not Supported

The reason for a sim swap error response. Returned only if the sim swap check fails.

Exemplo Resposta

{
   "request_id": "3f92ed75-e624-4503-abbd-a93d6b442571",
   "type": "phone",
   "phone": {
      "phone": "16197363066"
   },
   "sim_swap": {
      "status": "completed",
      "swapped": false
   }
}