---
title: "Get KYC Status"
method: GET
path: "/api/v1/users/:userId/kyc/status"
tags: ["Banking"]
---

# Get KYC Status

`GET /api/v1/users/:userId/kyc/status`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/users/:userId/kyc/status`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/users/:userId/kyc/status/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the current KYC verification status for a user. Returns null if no KYC application has been submitted for the user. Use this endpoint to check the progress of a user's identity verification.

## Path parameters

- `userId` string, uuid, required: The unique identifier for the user

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Response `200`

KYC status retrieved successfully. Returns the current verification status or null if no application exists.

- GetKycStatusResponse, nullable
  - `data` Kyc, required: KYC verification status for a user
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'Kyc', required
    - `attributes` object, required
      - `status` 'Approved' | 'AwaitingDocuments' | 'Denied' | 'ManualReview' | 'NotStarted' | 'Pending' | 'Unknown', required: The current status of the user's KYC verification
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)