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

# Verify company TIN

> Verify the company name and federal tax ID through Middesk before saving the company profile attestation.



## OpenAPI

````yaml /api/creditor.openapi.yaml post /account-profile/company/verify-tin
openapi: 3.1.0
info:
  title: YouNegotiate Creditor API
  version: '2.0'
  description: >-
    Stateless API endpoints for creditor portal authentication and account
    access.
servers:
  - url: https://api.creditor.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public creditor domain system and health endpoints.
  - name: Authentication
    description: Creditor registration, login, password, and email verification endpoints.
  - name: Account Settings
    description: >-
      Authenticated creditor profile, contact, operating-hours, and
      profile-image endpoints.
  - name: Account Profile
    description: >-
      Creditor onboarding profile, membership, billing, and setup status
      endpoints.
  - name: Setup Wizard
    description: >-
      Creditor setup wizard status, required-step completion, and optional-step
      completion.
  - name: Dashboard
    description: Creditor dashboard work queues and performance widgets.
  - name: Import / Export
    description: >-
      Creditor consumer import upload sessions, queued imports, history,
      downloads, and failed-row files.
  - name: Membership Settings
    description: >-
      Creditor membership dashboard, plan changes, payment method, cancellation,
      special-plan inquiry, and over-limit retry endpoints.
  - name: Merchant Account
    description: >-
      Existing merchant processor credentials, Tilled onboarding, and merchant
      application endpoints.
  - name: Header Profiles
    description: >-
      CSV header profile upload, mapping, download, and setup wizard completion
      endpoints.
  - name: SFTP Connections
    description: >-
      Creditor-managed SFTP connection profiles for imports, exports, and setup
      wizard completion.
  - name: Sub Accounts
    description: >-
      Creditor-managed sub account list, export, create, update, and delete
      endpoints.
  - name: Pay Terms Offers
    description: >-
      Creditor-managed master, sub-account, group, and group-sub-account Pay
      Terms endpoints.
  - name: Individual Custom Offers
    description: Creditor individual custom offer list endpoints.
  - name: Negotiations
    description: >-
      Creditor negotiation work queues, including notice responses and offer
      review counts.
  - name: Communications / CFPB Validation Letter
    description: >-
      CFPB Validation Letter tables, secure EcoLetter send/resend, CSV export,
      and print/download actions.
  - name: Communications / EcoLetter Template
    description: >-
      Creditor EcoLetter template management for secure eLetter communications
      and campaigns.
  - name: Communications / Groups
    description: >-
      Creditor communication group management for dynamic consumer targeting and
      campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Creditor EcoLetter campaign scheduling, quote, immediate send, and
      delivery queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Creditor campaign tracker reporting, refresh, and consumer export
      endpoints.
  - name: Consumer Profiles
    description: Creditor Consumer Profiles list, filter options, and CSV export endpoints.
  - name: Terms & Conditions
    description: Creditor-managed master and sub-account Terms & Conditions templates.
  - name: About Us & Contact
    description: Creditor-managed company About Us content shown to consumers.
  - name: Logo & Links
    description: >-
      Creditor-managed master and sub-account personalized logo colors, size,
      and consumer link metadata.
  - name: Users
    description: >-
      Master creditor user management, invitations, and account deletion
      endpoints.
paths:
  /account-profile/company/verify-tin:
    post:
      tags:
        - Account Profile
      summary: Verify company TIN
      description: >-
        Verify the company name and federal tax ID through Middesk before saving
        the company profile attestation.
      operationId: creditorVerifyCompanyTin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyCompanyTinRequest'
            example:
              company_name: ABC Collections
              fed_tax_id: '123456789'
              address: 123 Market Street
              address2: Suite 400
              city: San Francisco
              state: CA
              zip: '94105'
      responses:
        '200':
          description: TIN verification completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TinVerificationResponse'
              examples:
                verified:
                  summary: Verified
                  value:
                    message: TIN is verified!
                    data:
                      company_name: ABC Collections
                      fed_tax_id: '123456789'
                      is_verified_tin: true
                      middesk_business_id: business_123
                      verification_status: verified
                      modal: null
                mismatch:
                  summary: Business information mismatch
                  value:
                    message: We couldn't verify your business information.
                    data:
                      company_name: ABC Collections
                      fed_tax_id: '123456789'
                      is_verified_tin: false
                      middesk_business_id: business_123
                      verification_status: mismatch
                      modal:
                        tone: danger
                        title: Business Verification Required
                        heading: We couldn't verify your business information
                        messages:
                          - >-
                            The legal business name and federal tax
                            identification number you entered do not match a
                            legally formed business entity in our verification
                            system.
                          - >-
                            To protect consumers and maintain trust across the
                            YouNegotiate community, business verification is
                            required before a member account can be created.
                          - >-
                            Please review your information and try again.
                            Verification may not be complete if the legal name
                            does not exactly match IRS records or if the EIN /
                            TIN was entered incorrectly.
                        action_label: Edit Business Information
                        provider_message: null
                processing:
                  summary: Verification still processing
                  value:
                    message: >-
                      TIN verification is processing. Please check again
                      shortly.
                    data:
                      company_name: ABC Collections
                      fed_tax_id: '123456789'
                      is_verified_tin: false
                      middesk_business_id: business_123
                      verification_status: processing
                      modal:
                        tone: processing
                        title: Business Verification Processing
                        heading: Your business verification is still processing
                        messages:
                          - >-
                            Middesk accepted the verification request and is
                            waiting for the final TIN match result.
                          - >-
                            This is not a failed verification. It usually means
                            the provider needs a little more time to finish
                            processing.
                          - >-
                            Please check again in a few minutes. If Middesk
                            sends a verified webhook before then, we will update
                            your account automatically.
                        action_label: Got it
                        provider_message: null
                unavailable:
                  summary: Provider unavailable
                  value:
                    message: Unable to verify TIN at this time. Please try again later.
                    data:
                      company_name: ABC Collections
                      fed_tax_id: '123456789'
                      is_verified_tin: false
                      middesk_business_id: null
                      verification_status: unavailable
                      modal:
                        tone: danger
                        title: Business Verification Unavailable
                        heading: We couldn't complete the verification check
                        messages:
                          - >-
                            The third-party verification service did not return
                            a complete verification result.
                          - >-
                            Your information has not been marked as failed.
                            Please try again in a few minutes.
                          - >-
                            If this continues, contact support so we can review
                            the provider response.
                        action_label: Close
                        provider_message: Provider returned an incomplete response.
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    VerifyCompanyTinRequest:
      type: object
      required:
        - company_name
        - fed_tax_id
      properties:
        company_name:
          type: string
          minLength: 3
          maxLength: 50
        fed_tax_id:
          type: string
          pattern: ^\d{9}$
          description: >-
            Federal tax ID. Hyphens are accepted by the backend and normalized
            before validation.
        address:
          type: string
          nullable: true
          maxLength: 255
        address2:
          type: string
          nullable: true
          maxLength: 255
        city:
          type: string
          nullable: true
          maxLength: 255
        state:
          type: string
          nullable: true
          minLength: 2
          maxLength: 2
        zip:
          type: string
          nullable: true
          maxLength: 10
    TinVerificationResponse:
      type: object
      required:
        - message
        - data
      properties:
        message:
          type: string
          example: TIN is verified!
        data:
          type: object
          required:
            - company_name
            - fed_tax_id
            - is_verified_tin
            - middesk_business_id
            - verification_status
            - modal
          properties:
            company_name:
              type: string
            fed_tax_id:
              type: string
            is_verified_tin:
              type: boolean
            middesk_business_id:
              type: string
              nullable: true
              description: >-
                Middesk business ID stored for webhook completion when Middesk
                finishes processing asynchronously.
            verification_status:
              type: string
              enum:
                - verified
                - mismatch
                - processing
                - unavailable
            modal:
              oneOf:
                - $ref: '#/components/schemas/TinVerificationModal'
              nullable: true
    TinVerificationModal:
      type: object
      required:
        - tone
        - title
        - heading
        - messages
        - action_label
        - provider_message
      properties:
        tone:
          type: string
          enum:
            - danger
            - processing
        title:
          type: string
        heading:
          type: string
        messages:
          type: array
          items:
            type: string
        action_label:
          type: string
        provider_message:
          type: string
          nullable: true
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````