> ## Documentation Index
> Fetch the complete documentation index at: https://docs.proof.community/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /widget/users/{id}/kyc-status

> Check the identity-verification status of a user

Returns the identity-verification status for one of your users.

## Path parameters

<ParamField path="partner_user_id" type="string" required>
  Your internal user identifier.
</ParamField>

## Headers

<ParamField header="Authorization" type="string" required>
  Bearer token. Format: `Bearer <client_token>`.
</ParamField>

## Response

<ResponseField name="partner_user_id" type="string">
  Your internal user identifier (echo of the request).
</ResponseField>

<ResponseField name="status" type="string">
  One of `not_started`, `pending`, `verified`, `failed`. See [KYC](/on-off-ramp/kyc).
</ResponseField>

## Statuses

| Status        | Meaning                                                             |
| ------------- | ------------------------------------------------------------------- |
| `not_started` | The user has never opened the widget or has not submitted documents |
| `pending`     | Documents submitted; under review                                   |
| `verified`    | Verification passed; the user can transact                          |
| `failed`      | Verification failed; the user must retry inside the widget          |

## Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl https://DOMAIN/widget/users/user-123/kyc-status \
    -H "Authorization: Bearer <client_token>"
  ```

  ```javascript JavaScript theme={null}
  const kyc = await fetch(
    "https://DOMAIN/widget/users/user-123/kyc-status",
    { headers: { "Authorization": "Bearer <client_token>" } }
  ).then(r => r.json());

  if (kyc.status === "verified") {
    showWidget();
  } else {
    showMessage("Please complete identity verification");
  }
  ```
</CodeGroup>

```json Response theme={null}
{
  "partner_user_id": "user-123",
  "status": "verified"
}
```

## Errors

| HTTP | `error`          | `code`           | Cause                                             |
| ---- | ---------------- | ---------------- | ------------------------------------------------- |
| 401  | `unauthorised`   | `invalid_token`  | Missing or inactive `client_token`                |
| 404  | `not_found`      | `not_found`      | The `partner_user_id` is unknown for your partner |
| 502  | `upstream_error` | `provider_error` | Verification service failed; retry                |