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

# Create User

> Creates a new user account into the platform.

This endpoint enables platforms to:
- Register a new user
- Automatically generate a wallet for the user
- Initialize default settings for the newly created user
- At least one is required: provide either an email or a phone number with country code.



## OpenAPI

````yaml POST /api/platform/users/create
openapi: 3.1.0
info:
  title: paywint
  version: 0.1.0
servers:
  - url: http://localhost:8001
  - url: https://api.pw.wintpay.com
  - url: https://test.pw.wintpay.com
  - url: https://api.sandbox.paywint.com
security: []
paths:
  /api/platform/users/create:
    post:
      tags:
        - Platform Users
      summary: Create User
      description: >-
        Creates a new user account into the platform.


        This endpoint enables platforms to:

        - Register a new user

        - Automatically generate a wallet for the user

        - Initialize default settings for the newly created user

        - At least one is required: provide either an email or a phone number
        with country code.
      operationId: register_platform_user_api_platform_users_create_post
      parameters:
        - name: X-Platform-ID
          in: header
          required: true
          schema:
            type: string
            format: uuid
            description: >-
              Unique platform identifier (UUID). You receive this during
              onboarding. Must be sent with every API request.
            title: X-Platform-Id
          description: >-
            Unique platform identifier (UUID). You receive this during
            onboarding. Must be sent with every API request.
        - name: X-Signature
          in: header
          required: true
          schema:
            type: string
            description: >-
              HMAC-SHA256 request signature for authentication. Use your
              platform secret key to compute it as: `METHOD + PATH + QUERY +
              BODY_HASH`.
            title: X-Signature
          description: >-
            HMAC-SHA256 request signature for authentication. Use your platform
            secret key to compute it as: `METHOD + PATH + QUERY + BODY_HASH`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformUserBase'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse_PlatformUserRead_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PlatformUserBase:
      properties:
        name:
          type: string
          maxLength: 100
          title: Name
          description: Full name of the user
          example: John Doe
        email:
          anyOf:
            - type: string
              maxLength: 100
              format: email
            - type: 'null'
          title: Email
          description: Email address
          example: john.doe@example.com
        phone_country_code:
          anyOf:
            - type: string
              maxLength: 5
            - type: 'null'
          title: Phone Country Code
          description: >-
            International dialing code of the user’s phone number (e.g., +1 for
            US).
          example: '+1'
        phone:
          anyOf:
            - type: string
              maxLength: 15
            - type: 'null'
          title: Phone
          description: User’s local phone number, excluding country code.
          example: '1234567890'
      type: object
      required:
        - name
      title: PlatformUserBase
    CommonResponse_PlatformUserRead_:
      properties:
        success:
          type: boolean
          title: Success
          description: Indicates whether the request was processed successfully.
          default: true
          example: true
        message:
          type: string
          title: Message
          description: >-
            A short, human-readable message describing the result of the
            request.
          default: Success
          example: Operation completed.
        data:
          anyOf:
            - $ref: '#/components/schemas/PlatformUserRead'
            - type: 'null'
          description: The main response payload, if applicable
        queryGeneratedTime:
          anyOf:
            - type: number
            - type: 'null'
          title: Querygeneratedtime
          description: >-
            The Unix timestamp (in seconds) indicating when the response was
            generated.
          default: 1782303609.673092
          example: 1718006400
      type: object
      title: CommonResponse[PlatformUserRead]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlatformUserRead:
      properties:
        user_id:
          type: string
          format: uuid
          title: User Id
          description: UUID of the user
          example: b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4
        name:
          type: string
          title: Name
          example: John Doe
        pw_id:
          type: integer
          title: Pw Id
          description: Integer ID of user in paywint
          example: 111
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
          example: john.doe@example.com
        phone_country_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone Country Code
          description: >-
            International dialing code of the user’s phone number (e.g., +1 for
            US).
          example: '+1'
        phone:
          anyOf:
            - type: string
            - type: 'null'
          title: Phone
          description: User’s local phone number, excluding country code.
          example: '1234567890'
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Timestamp when the user was created
          example: '2025-06-10T18:10:42.000Z'
      type: object
      required:
        - pw_id
      title: PlatformUserRead
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````