Recuperar uma Validação de Telefone

Endpoint

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

Este serviço recupera um registro específico de validação de telefone usando seu identificador único. A resposta inclui todos os detalhes sobre o processo de validação de telefone, incluindo status, informações do OTP e dados do projeto associado. Este endpoint é útil para verificar o status atual de uma validação de telefone ou recuperar detalhes para fins de auditoria.

Headers

Content-Type

Type: String
Required: Required
Value: application/json

Authorization

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

Path Parameters

id

Type: String
Required: Yes

O identificador único da Validação de Telefone que você deseja recuperar.

Query Parameters

populates[]

Type: String
Required: No

Opcional. Uma lista de objetos relacionados a incluir na resposta. Opções disponíveis: client, project, projectFlow.

Request

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))
}

Response

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"
}

Recursos

• Recuperação por ID: Obtenha uma validação de telefone específica usando seu ID único
• Informações completas: Inclui todos os detalhes do processo de validação
• Dados relacionados: Informações de cliente, projeto e fluxo de projeto
• Status detalhado: Status atual, tentativas, limites e timestamps
• Configuração: URLs de redirecionamento, webhooks e configurações de segurança
• Códigos de país: Informações completas de código de país e número
• Vários idiomas: Suporte a JavaScript, Python, PHP e Swift
• Tratamento de erros: Respostas de erro detalhadas para diferentes cenários