---
title: "Get user KYC state"
method: GET
path: "/ramp/kyc"
tags: ["Ramp"]
---

# Get user KYC state

`GET /ramp/kyc`

Returns the Chainrails KYC state and transaction requirements for a user.

## Query parameters

- `provider` 'FONBNK' | 'ONRAMP_MONEY' | 'GUARDARIAN' | 'YELLOW_CARD', required
- `userEmail` string, required
- `countryCode` string, required
- `fiatCurrency` string, required
- `cryptoAmount` number

## Response `200`

KYC state

## Other responses

- `400` — Invalid parameters

## Changes

- **2026-08-12** `dcf19c1bab20` — 1 breaking, 1 info
  - added the new required `query` request parameter `fiatCurrency`
  - added the new enum value `YELLOW_CARD` to the `query` request parameter `provider`
- **2026-07-22** `76a4e00b118d` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/horuslabsio/apis/chainrails-api/changes/ramp/kyc/get.md)

---

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