Verificar API

La API Verify le permite confirmar que puede ponerse en contacto con un usuario en un número específico, para que pueda:

• Contacte con sus usuarios en cualquier momento, asegurándose de que tiene su número de teléfono correcto.
• Protección contra el fraude y el spam, impidiendo que un usuario cree varias cuentas.
• Añadir una capa adicional de seguridad para ayudar a confirmar la identidad de un usuario cuando desee realizar determinadas actividades.

Cómo funciona

La verificación es un proceso en dos fases que requiere dos llamadas a la API:

Solicitud de verificación

1. Un usuario se registra en su servicio a través de su aplicación o sitio web y proporciona un número de teléfono.

2. Para confirmar que el usuario tiene acceso al número con el que se ha registrado, su aplicación realiza una llamada de API a la aplicación Punto final de la solicitud de verificación.

3. La API Verify genera un código PIN, con una clave asociada request_id.

   En algunos casos, puede proporcionar su propio código PIN. Póngase en contacto con su gestor de Account.

4. A continuación, la API Verify intenta enviar este PIN al usuario. El formato (SMS o texto a voz (TTS)) y el tiempo de estos intentos están definidos por la opción flujo de trabajo. Si el usuario no vuelve a visitar su aplicación o sitio web para introducir el PIN que ha recibido, la solicitud de verificación terminará por agotarse. De lo contrario, deberá verificar el número introducido mediante una comprobación de verificación.

Verificación

5. El usuario recibe el PIN y lo introduce en su aplicación.

6. Su aplicación realiza una llamada a la API del Punto final del control de verificaciónpasando en el request_id y el PIN introducido por el usuario.

7. La API Verify comprueba que el PIN introducido coincide con el enviado y devuelve el resultado a su aplicación.

Primeros pasos

El siguiente ejemplo muestra cómo iniciar el proceso de verificación enviando un código de verificación a un usuario. Para saber cómo validar el código que proporciona el usuario y realizar otras operaciones, consulte la sección Fragmentos de código.

curl GET "https://api.nexmo.com/verify/json?api_key=$VONAGE_API_KEY&api_secret=$VONAGE_API_SECRET&number=$VERIFY_NUMBER&brand=AcmeInc"

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

val client = Vonage {
    apiKey(VONAGE_API_KEY)
    apiSecret(VONAGE_API_SECRET)
}

val response = client.verifyLegacy.verify(VERIFY_NUMBER, VERIFY_BRAND_NAME)
if (response.status == VerifyStatus.OK) {
    println("Verification sent. Request ID: ${response.requestId}")
}
else {
    println("Error: ${response.errorText}")
}

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

implementation 'com.vonage:server-sdk:9.3.1'

VonageClient client = VonageClient.builder()
        .apiKey(VONAGE_API_KEY)
        .apiSecret(VONAGE_API_SECRET)
        .build();

VerifyResponse response = client.getVerifyClient().verify(VERIFY_NUMBER, VERIFY_BRAND_NAME);

if (response.getStatus() == VerifyStatus.OK) {
    System.out.printf("RequestID: %s", response.getRequestId());
}
else {
    System.out.printf("ERROR! %s: %s", response.getStatus(), response.getErrorText());
}

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Install-Package Vonage

using System.Threading.Tasks;
using Vonage.Verify;
using Vonage;

var credentials = Credentials.FromApiKeyAndSecret(vonageApiKey, vonageApiSecret);

var request = new VerifyRequest() { Brand = brandName, Number = recipientNumber };

composer require vonage/client

$basic  = new \Vonage\Client\Credentials\Basic(VONAGE_API_KEY, VONAGE_API_SECRET);
$client = new \Vonage\Client(new \Vonage\Client\Credentials\Container($basic));

$request = new \Vonage\Verify\Request(NUMBER, BRAND_NAME);

// choose PIN length (4 or 6)
$request->setCodeLength(4);

// set locale
$request->setCountry('de');

$response = $client->verify()->start($request);

echo "Started verification, `request_id` is " . $response->getRequestId();

pip install vonage python-dotenv

from vonage import Auth, Vonage
from vonage_verify_legacy import StartVerificationResponse, VerifyRequest

client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))

request = VerifyRequest(number=VERIFY_NUMBER, brand='AcmeInc')

response: StartVerificationResponse = client.verify_legacy.start_verification(request)
print(response)

gem install vonage

Guías

• Verify Guía de migración: Esta guía le ayudará a migrar de Verify Legacy a Verify.
• Autenticación: Autenticación con Verify API
• Verify Idiomas: Idiomas disponibles para la V2 de la API Verify
• Verificar el flujo de trabajo de la API: Verificar el flujo de trabajo de la API
• Gestión de plantillas: Cómo usar la administración de plantillas para enviar mensajes OTP personalizados con Vonage Verify API
• Verificar los Webhooks de la API: Una guía sobre los webhooks y cómo pueden utilizarse con la API de Verify.
• Autenticación silenciosa: Autenticación silenciosa con la API Verify de Vonage
• Verify Sistema antifraude: Sistema antifraude de Verify
• Operadora virtual para autenticación silenciosa: Una introducción al uso de la función Operadora virtual dentro de Vonage Network APIs Playground con la autenticación silenciosa
• API de desbloqueo de red: Conoce qué es la API de desbloqueo de red de Vonage y cómo usarla.

Fragmentos de código

• Actualizar un fragmento de plantilla
• Actualizar una plantilla
• Anular una solicitud de verificación
• Comprobar un código de verificación
• Crear un fragmento de plantilla
• Crear una plantilla
• Eliminar un fragmento de plantilla
• Eliminar una plantilla
• Enviar solicitud de verificación (con opción alternativa)
• Enviar solicitud de verificación mediante autenticación silenciosa
• Enviar solicitud de verificación mediante SMS
• Enviar solicitud de verificación por correo electrónico
• Enviar solicitud de verificación por voz (TTS)
• Enviar solicitud de verificación por WhatsApp
• Fragmentos de plantillas de listas
• Obtener un fragmento de plantilla
• Obtener una plantilla
• Plantillas de listas

Casos prácticos

Lecturas complementarias

• Verificar la referencia API
• Implementación de la API Verify con Node.js
• Utilizar la API Verify en aplicaciones iOS
• Utilizar la API Verify en aplicaciones Android