Verify API [obsoleto]

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 de Verify genera un código PIN, con un request_id.

   En determinadas circunstancias, es posible introducir su propio código PIN; póngase en contacto con su gestor de cuentas.

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 tu aplicación.

6. Su aplicación realiza una llamada a la API del Punto final de verificación, pasando por 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 \

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

client = Vonage::Client.new(
  api_key: VONAGE_API_KEY,
  api_secret: VONAGE_API_SECRET
)

response = client.verify.request(
  number: VERIFY_NUMBER,
  brand: VERIFY_BRAND_NAME
)

Guías

• Paquete de protección de Vonage para Okta: Esta guía te explica cómo conectar tu tenant de Okta a Vonage Verify mediante Vonage Protection Suite para Okta, lo que garantiza que las contraseñas de un solo uso (OTP) se envíen por SMS o por voz.
• Verify las prácticas recomendadas de seguridad de la API: Asegura la integración de la API de Vonage Verify siguiendo las mejores prácticas en materia de verificación del lado del servidor, vinculación del `request_id`, limitación de tasa y gestión de sesiones.
• Cómo utilizar el agente predeterminado de Vonage Verify RCS: Utiliza el agente predeterminado de Vonage Verify RCS para enviar contraseñas de un solo uso a través de RCS; no es necesario registrar el agente ni obtener la autorización del operador. Disponible de inmediato en los países compatibles para todos los clientes de Verify V2.
• 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
• Autenticación silenciosa avanzada: Autenticación silenciosa avanzada con la API Vonage Verify
• Requisitos de registro de autenticación silenciosa por país: Requisitos de registro de autenticación silenciosa por país
• Verify Sistema antifraude: El sistema antifraude de Verify
• Operadora virtual para Silent Auth y Silent Auth Advanced: Introducción al uso de la función «Operador virtual» en el Registro de red de Vonage con las opciones «Silent Auth» y «Silent Auth Advanced»
• API de desbloqueo de red: Descubre qué es la API de desbloqueo de red de Vonage y cómo utilizarla.

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 SMS
• Enviar solicitud de verificación mediante voz (TTS)
• Enviar solicitud de verificación por correo electrónico
• Enviar solicitud de verificación por WhatsApp
• Enviar una solicitud de verificación mediante la autenticación silenciosa
• 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 de Android