Recuperar una Validación de Teléfono

Endpoint

GET https://api.verifik.co/v2/phone-validations/{id}

Este servicio recupera un registro específico de validación de teléfono usando su identificador único. La respuesta incluye todos los detalles sobre el proceso de validación, incluyendo estado, información del OTP y datos del proyecto asociado. Este endpoint es útil para verificar el estado actual de una validación de teléfono o recuperar detalles para fines de auditoría.

Encabezados

Content-Type

Tipo: String
Requerido: Sí
Valor: application/json

Authorization

Tipo: String
Requerido: Sí
Valor: Bearer {YOUR_ACCESS_TOKEN}

Parámetros de Ruta

id

Tipo: String
Requerido: Sí

El identificador único de la Validación de Teléfono que deseas recuperar.

Parámetros de Consulta

populates[]

Tipo: String
Requerido: No

Opcional. Una lista de objetos relacionados a incluir en la respuesta. Opciones disponibles: client, project, projectFlow.

Solicitud

Node.js

import axios from "axios";

const options = {
    method: "GET",
    url: "https://api.verifik.co/v2/phone-validations/phone_validation_123456789",
    params: {
        "populates[]": ["client", "project", "projectFlow"],
    },
    headers: {
        "Content-Type": "application/json",
        Authorization: "Bearer <your_token>",
    },
};

try {
    const { data } = await axios.request(options);
    console.log(data);
} catch (error) {
    console.error(error);
}

Python

import http.client

conn = http.client.HTTPSConnection("api.verifik.co")

headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <your_token>'
}

conn.request("GET", "/v2/phone-validations/phone_validation_123456789?populates[]=client&populates[]=project&populates[]=projectFlow", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.verifik.co/v2/phone-validations/phone_validation_123456789', [
  'headers' => [
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer <your_token>',
  ],
  'query' => [
    'populates[]' => ['client', 'project', 'projectFlow']
  ]
]);

echo $response->getBody();

Go

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api.verifik.co/v2/phone-validations/phone_validation_123456789?populates[]=client&populates[]=project&populates[]=projectFlow"

	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "Bearer <your_token>")

	client := &http.Client{}
	res, _ := client.Do(req)
	defer res.Body.Close()

	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

Respuesta

200

{
    "success": true,
    "data": {
        "_id": "phone_validation_123456789",
        "client": {
            "_id": "client_123456789",
            "name": "Example Client",
            "email": "client@example.com"
        },
        "project": {
            "_id": "project_123456789",
            "name": "Example Project",
            "description": "Example project description"
        },
        "projectFlow": {
            "_id": "flow_123456789",
            "name": "Example Flow",
            "type": "onboarding"
        },
        "status": "validated",
        "countryCode": "+1",
        "phone": "1234567890",
        "type": "validation",
        "validationMethod": "verificationCode",
        "verificationCode": "123456",
        "expiresAt": "2024-01-15T11:30:00Z",
        "redirectUrl": "https://example.com/success",
        "webhookUrl": "https://example.com/webhook",
        "requires2FA": false,
        "ipAddress": "192.168.1.1",
        "attempts": 1,
        "maxAttempts": 3,
        "createdAt": "2024-01-15T10:30:00Z",
        "updatedAt": "2024-01-15T10:32:00Z",
        "validatedAt": "2024-01-15T10:32:00Z"
    },
    "signature": {
        "dateTime": "April 11, 2023 12:25 PM",
        "message": "Certified by Verifik.co"
    }
}

404

{
    "success": false,
    "error": "Phone validation not found",
    "code": "PHONE_VALIDATION_NOT_FOUND"
}

Características

• Recuperación por ID: Obtén una validación de teléfono específica usando su ID único
• Información completa: Incluye todos los detalles del proceso de validación
• Datos relacionados: Información de cliente, proyecto y flujo del proyecto
• Estado detallado: Estado actual, intentos, límites y marcas de tiempo
• Configuración: URLs de redirección, webhooks y configuraciones de seguridad
• Códigos de país: Información completa de código de país y número
• Múltiples lenguajes: Soporte para JavaScript, Python, PHP y Swift
• Manejo de errores: Respuestas de error detalladas para distintos escenarios