Kyc API

Kyc API endpoints (8 endpoints). Supports both read and write operations.

Available Operations:

• startVerification - startVerification
• getStatus - getStatus
• getKYCStatus - getKYCStatus
• getHistory - getHistory
• isVerified - isVerified
• webhook - webhook
• getDocumentTypes - getDocumentTypes
• getAlerts - getAlerts

Authentication

Most endpoints require authentication. See Authentication for details.

Endpoints

Queries

kyc.getStatus

Type: Query (read-only)

Response

Returns the requested data. See TypeScript types for full response shape.

---

kyc.getKYCStatus

Type: Query (read-only)

Response

Returns the requested data. See TypeScript types for full response shape.

---

kyc.getHistory

Type: Query (read-only)

Response

Returns the requested data. See TypeScript types for full response shape.

---

kyc.isVerified

Type: Query (read-only)

Response

Returns the requested data. See TypeScript types for full response shape.

---

kyc.getDocumentTypes

Type: Query (read-only)

Response

Returns the requested data. See TypeScript types for full response shape.

---

kyc.getAlerts

Type: Query (read-only)

Response

Returns the requested data. See TypeScript types for full response shape.

---

Mutations

kyc.startVerification

Type: Mutation (write)

Response

Returns the requested data. See TypeScript types for full response shape.

---

kyc.webhook

Type: Mutation (write)

Response

Returns the requested data. See TypeScript types for full response shape.

---