@autional/api-verification

Autional Verification API — auto-generated TypeScript client from verification-service (30 functions).

Auto-generated by python sdk/scripts/generate-api-packages.py. Do not edit by hand.

Functions

| Function | Method | Path | Description | |----------|--------|------|-------------| | getAdminVerifications(client, params?) | GET | /admin/verifications | 查询认证列表 | | getAdminVerificationsExport(client, params?) | GET | /admin/verifications/export | 导出认证记录 | | deleteAdminVerificationsGuardians(client, data: RemoveGuardianRequest) | DELETE | /admin/verifications/guardians | 管理员解除监护关系 | | getAdminVerificationsGuardians(client, params?) | GET | /admin/verifications/guardians | 管理员查询监护关系 | | getAdminVerificationsProviders(client, params?) | GET | /admin/verifications/providers | 列出提供方配置 | | postAdminVerificationsProviders(client, data: CreateProviderConfigRequest) | POST | /admin/verifications/providers | 创建提供方配置 | | deleteAdminVerificationsProvidersByProviders(client, providerConfigId: string) | DELETE | /admin/verifications/providers/{provider_config_id} | 删除提供方配置 | | getAdminVerificationsProvidersByProviders(client, providerConfigId: string) | GET | /admin/verifications/providers/{provider_config_id} | 获取提供方配置详情 | | putAdminVerificationsProvidersByProviders(client, providerConfigId: string, data: UpdateProviderConfigRequest) | PUT | /admin/verifications/providers/{provider_config_id} | 更新提供方配置 | | getAdminVerificationsStats(client) | GET | /admin/verifications/stats | 获取认证统计 | | getAdminVerificationsByVerifications(client, verificationId: string) | GET | /admin/verifications/{verification_id} | 获取认证详情 | | postAdminVerificationsManualReviewByVerifications(client, verificationId: string, data: ManualReviewRequest) | POST | /admin/verifications/{verification_id}/manual-review | 转入人工审核 | | postAdminVerificationsOverrideByVerifications(client, verificationId: string, data: OverrideRequest) | POST | /admin/verifications/{verification_id}/override | 人工覆盖认证状态 | | postAdminVerificationsResetByVerifications(client, verificationId: string) | POST | /admin/verifications/{verification_id}/reset | 重置重试计数 | | postAdminVerificationsResolveReviewByVerifications(client, verificationId: string, data: ResolveReviewRequest) | POST | /admin/verifications/{verification_id}/resolve-review | 解决人工审核 | | postVerificationConsent(client, data: GrantConsentRequest, params?) | POST | /verification/consent | 授权同意 | | deleteVerificationGuardians(client, data: RemoveGuardianRequest) | DELETE | /verification/guardians | 解除监护关系 | | postVerificationGuardians(client, data: CreateGuardianRequest) | POST | /verification/guardians | 创建监护关系 | | getVerificationGuardiansMinors(client) | GET | /verification/guardians/minors | 获取我的被监护人列表 | | putVerificationGuardiansByGuardians(client, guardianId: string, data: UpdateGuardianRequest) | PUT | /verification/guardians/{guardian_id} | 更新监护关系 | | postVerificationGuardiansConsentByGuardians(client, guardianId: string, data: GuardianConsentRequest) | POST | /verification/guardians/{guardian_id}/consent | 监护人授权同意 | | postVerificationGuardiansVerifyByGuardians(client, guardianId: string) | POST | /verification/guardians/{guardian_id}/verify | 监护人身份验证 | | postVerificationLivenessBegin(client, data: BeginLivenessRequest) | POST | /verification/liveness/begin | 开始活体检测 | | postVerificationLivenessVerify(client, data: CompleteLivenessRequest) | POST | /verification/liveness/verify | 完成活体检测 | | getVerificationMe(client) | GET | /verification/me | 获取我的认证状态 | | getVerificationMeDetail(client) | GET | /verification/me/detail | 获取我的认证详情 | | getVerificationMinorsGuardians(client, params?) | GET | /verification/minors/guardians | 获取未成年用户的监护人列表 | | putVerificationMinorsProtection(client, data: SetMinorProtectionRequest) | PUT | /verification/minors/protection | 设置未成年人保护配置 | | postVerificationOcr(client, data: SubmitOCRRequest) | POST | /verification/ocr | 提交OCR识别 | | postVerificationVerify(client, data: SubmitVerificationRequest, params?) | POST | /verification/verify | 提交身份核验 |

Install

npm install @autional/core @autional/api-verification

Quick Start

import { Autional, browserPlatform } from '@autional/core';
import { getVerificationMe } from '@autional/api-verification';

const autional = new Autional({
  appId: 'my-app',
  issuer: 'https://auth.example.com', // your Autional server URL
  platform: browserPlatform,
});
await autional.initialize();

// 返回值已由 ApiClient 解包为载荷（不是 { code, data, message } 信封）
const result = await getVerificationMe(autional.api);
console.log(result);

Conventions

• Every function takes the ApiClient as its first argument (autional.api).
• Field names convert automatically: camelCase at the call site, snake_case on the wire.
• Return values are unwrapped payloads, not { code, data, message } envelopes.

See the root SDK README for tokens, refresh, and OAuth flows.