Listar todas las Validaciones de Email

Endpoint

GET https://api.verifik.co/v2/email-validations

Este servicio recupera un listado de todas las validaciones de email con filtrado y paginación opcionales. Puedes filtrar por proyecto, estado, tipo y otros parámetros para encontrar validaciones específicas.

Encabezados

Content-Type

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

Authorization

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

Parámetros de Consulta

page

Tipo: Number
Requerido: No

Número de página para la paginación (por defecto: 1).

limit

Tipo: Number
Requerido: No

Cantidad de registros por página (por defecto: 10, máx.: 100).

project

Tipo: String
Requerido: No

Filtra por ID de proyecto.

status

Tipo: String
Requerido: No

Filtra por estado: new, sent, validated, expired, failed.

type

Tipo: String
Requerido: No

Filtra por tipo: validation, login, onboarding, oneTimeLink.

email

Tipo: String
Requerido: No

Filtra por dirección de email.

populates[]

Tipo: String
Requerido: No

Arreglo opcional de datos relacionados a incluir. Opciones disponibles: client, project, projectFlow.

Solicitud

Node.js

import axios from "axios";

const options = {
    method: "GET",
    url: "https://api.verifik.co/v2/email-validations",
    params: {
        page: 1,
        limit: 10,
        status: "validated",
        type: "validation",
        "populates[]": ["client", "project"],
    },
    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/email-validations?page=1&limit=10&status=validated&type=validation&populates[]=client&populates[]=project", 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/email-validations', [
  'headers' => [
    'Content-Type': 'application/json',
    'Authorization' => 'Bearer <your_token>',
  ],
  'query' => [
    'page' => 1,
    'limit' => 10,
    'status' => 'validated',
    'type' => 'validation',
    'populates[]' => ['client', 'project']
  ]
]);

echo $response->getBody();

Go

package main

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

func main() {
	url := "https://api.verifik.co/v2/email-validations?page=1&limit=10&status=validated&type=validation&populates[]=client&populates[]=project"

	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": "email_validation_123456789",
            "client": {
                "_id": "client_123456789",
                "name": "Example Client",
                "email": "client@example.com"
            },
            "project": {
                "_id": "project_123456789",
                "name": "Example Project",
                "description": "Example project description"
            },
            "status": "validated",
            "email": "user@example.com",
            "type": "validation",
            "validationMethod": "verificationCode",
            "expiresAt": "2024-01-15T11:30:00Z",
            "attempts": 1,
            "maxAttempts": 3,
            "createdAt": "2024-01-15T10:30:00Z",
            "updatedAt": "2024-01-15T10:32:00Z",
            "validatedAt": "2024-01-15T10:32:00Z"
        }
    ],
    "pagination": {
        "page": 1,
        "limit": 10,
        "total": 1,
        "pages": 1
    },
    "signature": {
        "dateTime": "April 11, 2023 12:25 PM",
        "message": "Certified by Verifik.co"
    }
}

400

{
    "success": false,
    "error": "Invalid query parameters",
    "code": "INVALID_PARAMETERS"
}

Características

• Listado completo: Recupera todas las validaciones de email de tu cuenta
• Paginación: Soporte para paginación con control de página y límite
• Filtrado avanzado: Filtra por proyecto, estado, tipo y dirección de email
• Población de datos: Incluye información relacionada como datos de cliente y proyecto
• Múltiples estados: Filtra por estado (new, sent, validated, expired, failed)
• Múltiples lenguajes: Soporte para JavaScript, Python, PHP y Swift
• Información detallada: Incluye intentos, límites y marcas de tiempo de validación