Skip to main content

Lister toutes les Phone Validations

Endpoint

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

Ce service récupère une liste de toutes les validations téléphoniques avec filtrage et pagination optionnels. Vous pouvez filtrer par projet, statut, type et d'autres paramètres pour trouver des validations téléphoniques spécifiques.

Headers

`Content-Type`

Type: String
Required: Required
Value: application/json

`Authorization`

Type: String
Required: Required
Value: Bearer {YOUR_ACCESS_TOKEN}

Query Parameters

`page`

Type: Number
Required: No

Numéro de page pour la pagination (défaut : 1).

`limit`

Type: Number
Required: No

Nombre d'enregistrements par page (défaut : 10, max : 100).

`project`

Type: String
Required: No

Filtrer par ID de projet.

`status`

Type: String
Required: No

Filtrer par statut : new, sent, validated, failed.

`type`

Type: String
Required: No

Filtrer par type : validation, login, onboarding.

`countryCode`

Type: String
Required: No

Filtrer par indicatif pays.

`phone`

Type: String
Required: No

Filtrer par numéro de téléphone.

`populates[]`

Type: String
Required: No

Tableau optionnel de données associées à inclure. Options disponibles : client, project, projectFlow.

Request

Node.js
Python
PHP
Go

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.verifik.co/v2/phone-validations',
  params: {
    page: 1,
    limit: 10,
    status: 'validated',
    type: 'validation',
    countryCode: '+1',
    '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);
}

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?page=1&limit=10&status=validated&type=validation&countryCode=%2B1&populates[]=client&populates[]=project", headers=headers)

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

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

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.verifik.co/v2/phone-validations', [
  'headers' => [
    'Content-Type' => 'application/json',
    'Authorization' => 'Bearer <your_token>',
  ],
  'query' => [
    'page' => 1,
    'limit' => 10,
    'status' => 'validated',
    'type' => 'validation',
    'countryCode' => '+1',
    'populates[]' => ['client', 'project']
  ]
]);

echo $response->getBody();

package main

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

func main() {
	url := "https://api.verifik.co/v2/phone-validations?page=1&limit=10&status=validated&type=validation&countryCode=%2B1&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))
}

Response

200
400

{
  "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"
      },
      "status": "validated",
      "countryCode": "+1",
      "phone": "1234567890",
      "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"
  }
}

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

Fonctionnalités

Liste complète : Récupère toutes les validations téléphoniques de votre compte
Pagination : Prise en charge de la pagination avec contrôle de page et de limite
Filtrage avancé : Filtrer par projet, statut, type, indicatif pays et numéro de téléphone
Population des données : Inclure des informations associées telles que les données client et projet
Plusieurs états : Filtrer par statut (new, sent, validated, failed)
Indicatifs pays : Filtrage spécifique par indicatif international
Plusieurs langages : Prise en charge de JavaScript, Python, PHP et Swift
Informations détaillées : Inclut les tentatives, limites et horodatages de validation

Endpoint
Request
Response
Fonctionnalités