---
title: "Get KYC state"
method: GET
path: "/api/kyc/state"
tags: ["kyc"]
---

# Get KYC state

`GET /api/kyc/state`

Returns kyc state of the user with the provided phone number, also returns supported documents for KYC submission

## Query parameters

- `phoneNumber` string
- `email` string

## Response `200`

Successful response

- KycStateResponse
  - `kycUrl` string — URL to the KYC form
  - `offrampKycRules` unknown[]
    - unknown
  - `onrampKycRules` unknown[]
    - unknown
  - `passedKyc` boolean — Indicates if the user has passed KYC
  - `kycStatus` 'initiated' | 'approved' | 'rejected' | 'invalid' — Status of the last KYC

---

[API](https://skmtc.dev/fonbnk/apis/fonbnk-on-ramp-api.md) · [All operations](https://skmtc.dev/fonbnk/apis/fonbnk-on-ramp-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fonbnk/fonbnk-on-ramp-api/revisions/bae5de6fca88/schema)