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

# refreshUserKycStatus

> ⚠️ WARNING: Sandbox Only Method. Pleaee do not include this in production flows

### Required inputs:
- `userId`: The ID of the test employee.

### Response:
Check that `success` is `true` and `kycStatus` is `passed` before continuing with workflows that require verified identity. A completed request does not guarantee approval.

### Notes:
- If verification has not passed, check the returned message and confirm that onboarding information is complete. Use random, synthetic SSNs to avoid conflicts with other sandbox identities.
- User kyc may take some time, please wait and re-attempt if the status does not flip the first time.
- If the status will not flip after some time, please reach out to support.



## OpenAPI

````yaml POST /sandbox/refreshUserKycStatus
openapi: 3.1.0
info:
  title: Default module
  description: |
    Webhook events emitted when a company's KYB status is created or changes.

    Rollfi sends these requests to the webhook URL configured for the client.
    Consumers should return a successful 2xx response after accepting the event.
  version: 1.0.0
servers: []
security: []
tags:
  - name: Admin Portal
  - name: TimeOff Admin
  - name: TimeTracking Admin
  - name: TimeOff User
  - name: TimeTracking User
  - name: TimeTracking Reports
  - name: TimeOff Reports
  - name: Pay Schedule Webhooks
  - name: Pay Period Webhooks
  - name: Employee Bank Account Webhooks
  - name: Employee KYC Webhooks
  - name: Company Bank Account Webhooks
  - name: Company Webhooks
  - name: Employee Status Webhooks
  - name: Sandbox
paths:
  /sandbox/refreshUserKycStatus:
    post:
      tags:
        - Sandbox
      summary: refreshUserKycStatus
      description: >-
        ⚠️ WARNING: Sandbox Only Method. Pleaee do not include this in
        production flows


        ### Required inputs:

        - `userId`: The ID of the test employee.


        ### Response:

        Check that `success` is `true` and `kycStatus` is `passed` before
        continuing with workflows that require verified identity. A completed
        request does not guarantee approval.


        ### Notes:

        - If verification has not passed, check the returned message and confirm
        that onboarding information is complete. Use random, synthetic SSNs to
        avoid conflicts with other sandbox identities.

        - User kyc may take some time, please wait and re-attempt if the status
        does not flip the first time.

        - If the status will not flip after some time, please reach out to
        support.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                method:
                  type: string
                  default: refreshUserKycStatus
                userId:
                  type: string
                  format: uuid
                  description: The ID of the sandbox employee.
              required:
                - method
                - userId
            example:
              method: refreshUserKycStatus
              userId: c4e7b290-1a63-4f85-b902-6d38a1e5f047
      responses:
        '200':
          description: >-
            The current verification result or an error response. Check the
            response body rather than relying on the HTTP status alone.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  kycStatus:
                    type: string
                    description: >-
                      The employee's KYC status. A value of passed indicates
                      successful verification.
                  message:
                    type: string
                  error:
                    type:
                      - object
                      - string
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
              examples:
                '1':
                  summary: Success
                  value:
                    success: true
                    kycStatus: passed
                    message: Employee kyc status is passed.
          headers: {}
      deprecated: false
      security: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.