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

# Submit KYC application data



## OpenAPI

````yaml openapi.yaml post /partner/v1/kyc/applications
openapi: 3.1.0
info:
  title: Machines Cash API
  version: 0.3.0
  description: >
    API for KYC, cards, encryption, balances, deposits, transactions, and
    withdrawals.

    All responses use a consistent envelope by default: { ok, data, summary,
    errors[], next }.

    Set X-Open-Responses: 1 to receive Open Responses-style response objects.
servers:
  - url: https://api.machines.cash
    description: production
  - url: https://dev-api.machines.cash
    description: sandbox
security: []
tags:
  - name: users
  - name: sessions
  - name: kyc
  - name: kycValues
  - name: agreements
  - name: cards
  - name: encryption
  - name: balances
  - name: deposits
  - name: transactions
  - name: withdrawals
paths:
  /partner/v1/kyc/applications:
    parameters:
      - $ref: '#/components/parameters/OpenResponses'
      - $ref: '#/components/parameters/OpenResponsesCallId'
    post:
      tags:
        - kyc
      summary: Submit KYC application data
      operationId: api.kyc.submit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KycApplicationCreateRequest'
            example:
              firstName: John
              lastName: Smith
              birthDate: '1990-01-01'
              nationalId: '123456789'
              countryOfIssue: US
              email: jsmith@example.com
              address:
                line1: 123 Main St
                line2: Unit 4
                city: New York
                region: NY
                postalCode: '10001'
                countryCode: US
              occupation: 49-3023
              annualSalary: <40k
              accountPurpose: everyday spend
              expectedMonthlyVolume: under $1k
              phoneCountryCode: '1'
              phoneNumber: '4155551234'
      responses:
        '201':
          description: KYC application submitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KycApplicationResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - Session: []
components:
  parameters:
    OpenResponses:
      name: X-Open-Responses
      in: header
      required: false
      schema:
        type: string
        enum:
          - '1'
          - 'true'
      description: >-
        Return Open Responses-compatible output when set (replaces the default
        response envelope).
    OpenResponsesCallId:
      name: X-Open-Responses-Call-Id
      in: header
      required: false
      schema:
        type: string
        minLength: 1
      description: >-
        Tool call id used for function_call_output items when Open Responses
        mode is enabled.
  schemas:
    KycApplicationCreateRequest:
      type: object
      additionalProperties: false
      required:
        - firstName
        - lastName
        - birthDate
        - nationalId
        - countryOfIssue
        - email
        - address
        - occupation
        - annualSalary
        - accountPurpose
        - expectedMonthlyVolume
      properties:
        firstName:
          type: string
          maxLength: 50
        lastName:
          type: string
          maxLength: 50
        birthDate:
          type: string
          description: YYYY-MM-DD
          example: '1990-01-01T00:00:00.000Z'
        nationalId:
          type: string
        countryOfIssue:
          type: string
          minLength: 2
          maxLength: 2
          description: ISO-3166-1 alpha-2 country code (e.g., US). Case-insensitive.
          example: US
        email:
          type: string
          format: email
          example: jsmith@example.com
        address:
          $ref: '#/components/schemas/KycAddress'
        phoneCountryCode:
          type: string
          maxLength: 3
          description: Country calling code digits only (e.g., 1).
          example: '1'
        phoneNumber:
          type: string
          maxLength: 15
          description: Phone number digits only (include area code).
          example: '4155551234'
        occupation:
          type: string
          description: SOC occupation code (e.g., 49-3023). See GET /kyc/values.
          example: 49-3023
        annualSalary:
          type: string
          enum:
            - <40k
            - 50k–99k
            - 100k–149k
            - 150k+
          example: <40k
        accountPurpose:
          type: string
          enum:
            - everyday spend
            - subscriptions
            - business expenses
            - testing
            - other
          example: everyday spend
        expectedMonthlyVolume:
          type: string
          enum:
            - under $1k
            - $1k–$5k
            - $5k–$20k
            - $20k+
          example: under $1k
    KycApplicationResponse:
      type: object
      additionalProperties: false
      required:
        - ok
        - data
        - summary
        - errors
      properties:
        ok:
          type: boolean
          const: true
        data:
          $ref: '#/components/schemas/KycApplication'
        summary:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
        next:
          $ref: '#/components/schemas/NextHint'
    KycAddress:
      type: object
      additionalProperties: false
      required:
        - line1
        - city
        - region
        - postalCode
        - countryCode
      properties:
        line1:
          type: string
          example: 123 Main St
        line2:
          type: string
          example: Unit 4
        city:
          type: string
          example: New York
        region:
          type: string
          example: NY
        postalCode:
          type: string
          example: '10001'
        countryCode:
          type: string
          minLength: 2
          maxLength: 2
          description: ISO-3166-1 alpha-2 country code (e.g., US). Case-insensitive.
          example: US
    KycApplication:
      type: object
      additionalProperties: false
      required:
        - status
        - isTermsOfServiceAccepted
      properties:
        status:
          $ref: '#/components/schemas/KycStatus'
        reason:
          type:
            - string
            - 'null'
        completionLink:
          type:
            - string
            - 'null'
        externalVerificationLink:
          type:
            - string
            - 'null'
        isActive:
          type:
            - boolean
            - 'null'
        isTermsOfServiceAccepted:
          type: boolean
    ErrorDetail:
      type: object
      additionalProperties: false
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: invalid_request
        message:
          type: string
          example: missing required field
        field:
          type: string
          description: Optional field name that caused the error.
    NextHint:
      type: object
      additionalProperties: false
      properties:
        pollAfterMs:
          type: integer
          minimum: 0
        suggestedTool:
          type: string
        suggestedArgs:
          type: object
          additionalProperties: true
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - ok
        - summary
        - errors
      properties:
        ok:
          type: boolean
          const: false
        summary:
          type: string
          example: invalid request
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetail'
        next:
          $ref: '#/components/schemas/NextHint'
    KycStatus:
      type: string
      enum:
        - not_submitted
        - pending
        - approved
        - denied
        - locked
        - canceled
        - needs_information
        - needs_verification
        - manual_review
  responses:
    BadRequest:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    Session:
      type: http
      scheme: bearer
      bearerFormat: JWT

````