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

# Create user

> Register a user with Push



## OpenAPI

````yaml /openapi.yaml post /user
openapi: 3.0.1
info:
  title: Push API
  version: 0.0.1
servers:
  - url: https://api.pushcash.com
    description: Production API
  - url: https://sandbox.pushcash.com
    description: Sandbox API used for developing an integration with Push
security:
  - bearer: []
tags:
  - name: user
  - name: tokenization
  - name: authorization
  - name: intent
  - name: dispute
  - name: refund
  - name: accounts
  - name: transactions
  - name: transfer
paths:
  /user:
    post:
      tags:
        - user
      summary: Create user
      description: Register a user with Push
      operationId: createUser
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserRequest'
      responses:
        '200':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUserResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    CreateUserRequest:
      type: object
      description: The request format to create a user with Push
      example:
        name:
          first: Alfred
          last: Hitchcock
        email: alfred@imdb.com
        address:
          address_line_1: 1609 10th Ave
          locality: Bodega Bay
          administrative_area: CA
          postal_code: '94923'
          country: US
        date_of_birth: '1899-08-13'
        government_id:
          type: passport
          last4: '7349'
        phone_number: (555) 681-3485
        tag: 4c8e6b4f
        identity_verified: true
      properties:
        name:
          $ref: '#/components/schemas/Name'
        address:
          $ref: '#/components/schemas/Address'
        email:
          type: string
          description: The email address for the user
        phone_number:
          type: string
          description: The phone number for the user
        date_of_birth:
          type: string
          format: date
          description: The user's date of birth
        government_id:
          $ref: '#/components/schemas/GovernmentIssuedID'
        tag:
          type: string
          description: >
            A tag or identifier to associate with the user object. We recommend
            setting this value to the id or primary key of the user database
            record.
        identity_verified:
          type: boolean
          description: >
            Indicates whether the user's identity has been verified by the
            operator.

            For use-cases where KYC is required, this field must be set to
            `true`.
      required:
        - name
        - email
        - date_of_birth
        - government_id
        - address
        - identity_verified
    CreateUserResponse:
      type: object
      description: The response format for creating a user with Push
      properties:
        id:
          type: string
          description: Push's identifier assigned to the user
      required:
        - id
    error:
      description: Description of the error encountered from the API request
      type: object
    Name:
      type: object
      description: The legal name of the user
      example:
        first: Alfred
        last: Hitchcock
      properties:
        first:
          description: The person's given name
          type: string
        last:
          description: The person's family name
          type: string
      required:
        - first
        - last
    Address:
      type: object
      description: The address of the user's primary location
      example:
        address_line_1: 1609 10th Ave
        locality: Bodega Bay
        administrative_area: CA
        postal_code: '94923'
        country: US
      properties:
        address_line_1:
          type: string
          description: The first line for the address
        locality:
          type: string
          description: The city or township
        administrative_area:
          type: string
          description: The state as a two-character code (e.g., CA, WA, TN, AL).
        postal_code:
          type: string
          description: The postal code, following the format XXXXX or XXXXX-XXXX.
        country:
          type: string
          description: The country
      required:
        - address_line_1
        - locality
        - administrative_area
        - postal_code
        - country
    GovernmentIssuedID:
      type: object
      example:
        type: drivers_license
        last4: Y7B9
        state: OR
      properties:
        type:
          type: string
          description: The type of government-issued ID
          enum:
            - drivers_license
            - passport
            - state_id
            - military_id
            - ssn
        last4:
          type: string
          description: The last 4 characters of the ID or number
        state:
          type: string
          minLength: 2
          maxLength: 2
          description: >-
            The 2-letter code for the state in which the ID was issued. Only
            required if the ID is a driver's license or state ID.
      required:
        - type
        - last4
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````