Skip to main content

检索手机验证

端点​

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

此服务使用唯一标识符检索特定的手机验证记录。响应包含手机验证过程的全部详情，包括状态、OTP 信息以及关联的项目数据。此端点适用于检查手机验证的当前状态，或检索详情以用于审计。

请求头​

Content-Type​

类型： String
必需： 必需
值： application/json

Authorization​

类型： String
必需： 必需
值： Bearer {YOUR_ACCESS_TOKEN}

路径参数​

id​

类型： String
必需： 是

您要检索的手机验证的唯一标识符。

查询参数​

populates[]​

类型： String
必需： 否

可选。要在响应中包含的相关对象列表。可用选项：client、project、projectFlow。

请求​

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

响应​

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

功能​

  • 按 ID 检索：使用唯一 ID 获取特定手机验证
  • 完整信息：包含验证过程的全部详情
  • 关联数据：客户端、项目与项目流程信息
  • 详细状态：当前状态、尝试次数、限制与时间戳
  • 配置：重定向 URL、webhook 与安全配置
  • 国家代码：完整的国家代码与号码信息
  • 多语言：支持 JavaScript、Python、PHP 和 Swift
  • 错误处理：针对不同场景的详细错误响应