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

# Create a user

> Creates a new user object for partner verification workflows.

<Note>
  Set `external_metadata.suppress_verification` to `true` for banking and document verification workflows.
</Note>


## OpenAPI

````yaml openAPI/verifications-partners.yaml post /partners/v2/users
openapi: 3.0.0
info:
  title: Partner Verifications API
  version: 1.0.0
  description: |
    Order payroll, banking, and document-based income verifications.
servers: []
security:
  - basicAuth: []
paths:
  /partners/v2/users:
    post:
      summary: Create a user
      description: Creates a new user object for partner verification workflows.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartnerUserCreateRequest'
            example:
              client: 39096494-45c8-4fd8-9454-3d1cb2d62db7
              first_name: Jane
              last_name: Doe
              ssn: 000-00-0000
              email: jane@example.com
              phone_number: '+15555555555'
              address:
                city: New York
                line1: 123 Main St
                line2: null
                state: NY
                country: US
                postal_code: null
              birth_date:
                year: 1990
                month: 1
                day: 13
              external_id: null
              external_metadata:
                suppress_verification: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerCreateUserResponse'
              example:
                user_token: <SECRET>
                id: 7a614711-066f-4b6b-b319-4c6236b5acc1
components:
  schemas:
    PartnerUserCreateRequest:
      type: object
      properties:
        client:
          type: string
          format: uuid
          description: |
            ID of the client on whose behalf the user is created.

            <Info>
            Provided to you by your Argyle Customer Success manager.
            </Info>
        first_name:
          type: string
          description: User first name.
        last_name:
          type: string
          description: User last name.
        email:
          type: string
          description: User email address.
        phone_number:
          type: string
          description: User phone number. E.164 international format recommended.
        ssn:
          type: string
          description: User Social Security number.
        address:
          $ref: '#/components/schemas/PartnerAddress'
        birth_date:
          $ref: '#/components/schemas/PartnerBirthDate'
        external_metadata:
          type: object
          description: Additional metadata for internal partner workflows.
          additionalProperties: true
          properties:
            suppress_verification:
              type: boolean
              description: Set to `true` for banking and document verification workflows.
        open_banking:
          $ref: '#/components/schemas/PartnerOpenBanking'
        external_id:
          type: string
          nullable: true
          description: External identifier for your internal mapping.
      required:
        - client
    PartnerCreateUserResponse:
      type: object
      description: Response returned after creating a partner user.
      properties:
        user_token:
          type: string
          description: Token associated with the created user.
        id:
          type: string
          format: uuid
          description: Unique ID of the user.
    PartnerAddress:
      type: object
      description: Address of the user.
      properties:
        city:
          type: string
          description: Name of the city, town, district, or similar regional entity.
        line1:
          type: string
          description: Address-Line 1, usually street address or P.O. Box information.
        line2:
          type: string
          nullable: true
          description: Address-Line 2, usually the apartment or unit number.
        state:
          type: string
          description: State, county, province, region, or equivalent.
        country:
          type: string
          description: Two-letter country code (ISO 3166-1 alpha-2 format).
        postal_code:
          type: string
          nullable: true
          description: Zip code, or equivalent.
    PartnerBirthDate:
      type: object
      description: Date of birth in year-month-day format.
      properties:
        year:
          type: integer
          description: Birth year (1900 or later).
        month:
          type: integer
          description: Birth month (between 1 and 12).
        day:
          type: integer
          description: Birth day (between 1 and 31).
    PartnerOpenBanking:
      type: object
      description: Banking-specific user metadata.
      properties:
        end_user:
          $ref: '#/components/schemas/PartnerOpenBankingEndUser'
    PartnerOpenBankingEndUser:
      type: object
      description: Contains details about the person or entity making the lending decision.
      properties:
        name:
          type: string
          description: Name of the lender or entity.
        address:
          type: string
          description: >-
            Street address or P.O. Box information (include apartment or unit
            numbers).
        city:
          type: string
          description: Name of the city, town, district, or similar regional entity.
        state:
          type: string
          description: State, county, province, region, or equivalent.
        zip:
          type: string
          description: Zip code, or equivalent.
        phone:
          type: string
          description: Phone number of the lender or entity.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Username = api_key_id, Password = api_key_secret

````