---
title: "POST /client-links"
method: POST
path: "/client-links"
---

# POST /client-links

`POST /client-links`

## Request

- Base URL: `https://api.trychart.com`
- URL: `https://api.trychart.com/client-links`
- Auth: HTTP bearer

Create a custom client link.

## Request body

- ClientLinkInput
  - `metadata` object: Custom metadata identifying external fields about the taxpayer. This is useful for keeping track of external information about the taxpayer such as user IDs from other systems.
  - `settings` object
    - `flowType` 'full' | 'personal' | 'business' | 'irs-8821' | 'irs-online-account' | 'irs-8821-personal' | 'irs-8821-business' | 'irs-8821-no-kyc' | 'irs-8821-no-kyc-personal' | 'irs-8821-no-kyc-business' | 'irs-online-account-business' | 'full-irs-online-account' | 'full-irs-online-account-combined' | 'full-irs-online-account-business' | 'irs-online-verify-first' | 'irs-online-verify-first-business' | 'tax-prep' | 'irs-8821-and-online-account' | 'irs-8821-and-online-account-personal' | 'irs-8821-and-online-account-business'
    - `transcripts` object
      - `ACTR` string[]
      - `RECA` string[]
      - `WAID` string[]
      - `VENF` string[]
      - `W2` string[]
      - `1095-A` string[]
      - `NOTICE` string[]
    - `prefillData` object
      - `personalInfo` PersonalInfoInput
        - `firstName` string, required: Alpha string value with a limit of 50 characters. Only hyphens (-) and spaces are allowed as special characters.
        - `lastName` string, required: Alpha string value with a limit of 50 characters. Only hyphens (-) and spaces are allowed as special characters.
        - `ssn` string: Full SSN of the taxpayer. Required for non-business form 8821 submissions.
      - `businessInfo` BusinessInfoInput
        - `name` string, required
        - `taxId` string, required: EIN or SSN of the taxpayer
        - `type` 'S-Corporation' | 'C-Corporation' | 'Sole Proprietorship' | 'Partnerships', required
        - `phone` string, required
        - `title` 'Managing Member' | 'Partner' | 'Limited Partner' | 'Director' | 'Chief Accounting Officer' | 'Chief Executive Officer' | 'Chief Operating Officer' | 'Chief Financial Officer' | 'President' | 'Vice President' | 'Secretary' | 'Treasurer' | 'Assistant Treasurer' | 'Controller' | 'Owner' | 'Sole Proprietor' | 'Executor' | 'Beneficiary' | 'Trustee' | 'Administrator', required
      - `address` AddressInput
        - `street` string, required
        - `other` string
        - `city` string, required
        - `state` string, required
        - `zip` string, required

## Response `201`

IRS 8821 Form Submission Response

- object
  - `url` string, required
  - `id` string, required

---

[API](https://skmtc.dev/trychart/apis/chart-api.md) - [All operations](https://skmtc.dev/trychart/apis/chart-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trychart/apis/chart-api/revisions/fac67e8a1281?raw)