> ## Documentation Index
> Fetch the complete documentation index at: https://gnosispay-feat-v2-auth-module.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Onboarding Status

> Get the current onboarding status for the authenticated user. Returns a tagged union indicating the current step and any required actions.



## OpenAPI

````yaml https://gp-auth-module.prod.gnosispay.com/openapi.json get /user/onboarding
openapi: 3.0.0
info:
  version: 1.0.0
  title: SIWE Authentication API
  description: Sign In With Ethereum authentication service
servers:
  - url: https://gp-auth-module.prod.gnosispay.com
    description: API server
security: []
paths:
  /user/onboarding:
    get:
      tags:
        - User
      summary: Get Onboarding Status
      description: >-
        Get the current onboarding status for the authenticated user. Returns a
        tagged union indicating the current step and any required actions.
      responses:
        '200':
          description: Onboarding status retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingStatus'
        '401':
          description: Unauthorized - Invalid JWT payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Core API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - Bearer: []
components:
  schemas:
    OnboardingStatus:
      oneOf:
        - type: object
          properties:
            status:
              type: string
              enum:
                - action_accept_tos
            terms:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                  currentVersion:
                    type: string
                  name:
                    type: string
                  url:
                    type: string
                    nullable: true
                  accepted:
                    type: boolean
                  acceptedVersion:
                    type: string
                    nullable: true
                  acceptedAt:
                    type: string
                    nullable: true
                    format: date-time
                required:
                  - type
                  - currentVersion
                  - name
                  - url
                  - accepted
                  - acceptedVersion
                  - acceptedAt
          required:
            - status
            - terms
        - type: object
          properties:
            status:
              type: string
              enum:
                - waiting_kyc_setup
          required:
            - status
        - type: object
          properties:
            status:
              type: string
              enum:
                - action_complete_kyc
            webSdkUrl:
              type: string
          required:
            - status
            - webSdkUrl
        - type: object
          properties:
            status:
              type: string
              enum:
                - kyc_manual_review
            comments:
              type: string
              nullable: true
          required:
            - status
            - comments
        - type: object
          properties:
            status:
              type: string
              enum:
                - action_kyc_resubmission_requested
            webSdkUrl:
              type: string
            comments:
              type: string
              nullable: true
          required:
            - status
            - webSdkUrl
            - comments
        - type: object
          properties:
            status:
              type: string
              enum:
                - action_complete_sof
            questions:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  question:
                    type: string
                  answers:
                    type: array
                    items:
                      type: string
                required:
                  - id
                  - question
                  - answers
            version:
              type: number
          required:
            - status
            - questions
            - version
        - type: object
          properties:
            status:
              type: string
              enum:
                - action_create_account
          required:
            - status
        - type: object
          properties:
            status:
              type: string
              enum:
                - waiting_account_setup
          required:
            - status
        - type: object
          properties:
            status:
              type: string
              enum:
                - rejected
            reason:
              type: string
            rejectLabels:
              type: array
              nullable: true
              items:
                type: string
            comments:
              type: string
              nullable: true
          required:
            - status
            - reason
        - type: object
          properties:
            status:
              type: string
              enum:
                - completed
          required:
            - status
    Error:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: string
      required:
        - success
        - error

````