Create Client Link

cURL

curl --request POST \
  --url https://api.trychart.com/client-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "settings": {
    "flowType": "full",
    "transcripts": {
      "ACTR": [
        "<string>"
      ],
      "RECA": [
        "<string>"
      ],
      "WAID": [
        "<string>"
      ],
      "VENF": [
        "<string>"
      ],
      "W2": [
        "<string>"
      ],
      "1095-A": [
        "<string>"
      ],
      "NOTICE": [
        "<string>"
      ]
    },
    "prefillData": {
      "personalInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "ssn": "123456789"
      },
      "businessInfo": {
        "name": "Test, Inc.",
        "taxId": "123456789",
        "type": "S-Corporation",
        "phone": "1112223344",
        "title": "Chief Executive Officer"
      },
      "address": {
        "street": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94101",
        "other": "Apt 1"
      }
    }
  }
}
'

{
  "url": "https://dashboard.trychart.com/c/1234567890",
  "id": "cm3tj5p2g000e674soxr2brbl"
}

POST

client-links

cURL

curl --request POST \
  --url https://api.trychart.com/client-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "settings": {
    "flowType": "full",
    "transcripts": {
      "ACTR": [
        "<string>"
      ],
      "RECA": [
        "<string>"
      ],
      "WAID": [
        "<string>"
      ],
      "VENF": [
        "<string>"
      ],
      "W2": [
        "<string>"
      ],
      "1095-A": [
        "<string>"
      ],
      "NOTICE": [
        "<string>"
      ]
    },
    "prefillData": {
      "personalInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "ssn": "123456789"
      },
      "businessInfo": {
        "name": "Test, Inc.",
        "taxId": "123456789",
        "type": "S-Corporation",
        "phone": "1112223344",
        "title": "Chief Executive Officer"
      },
      "address": {
        "street": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94101",
        "other": "Apt 1"
      }
    }
  }
}
'

{
  "url": "https://dashboard.trychart.com/c/1234567890",
  "id": "cm3tj5p2g000e674soxr2brbl"
}

Authorizations

Authorization

string

header

required

Please use base64 encoded client_id:client_secret. You can use this command to generate the base64 encoded string: echo -n 'client_id:client_secret' | base64

Body

application/json

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

Show child attributes

settings.flowType

enum<string>

Available options:

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

settings.transcripts

object

Show child attributes

settings.transcripts.ACTR

string[]

Minimum string length: 4

settings.transcripts.RECA

string[]

Minimum string length: 4

settings.transcripts.WAID

string[]

Minimum string length: 4

settings.transcripts.VENF

string[]

Minimum string length: 4

settings.transcripts.W2

string[]

Minimum string length: 4

settings.transcripts.1095-A

string[]

Minimum string length: 4

settings.transcripts.NOTICE

string[]

Minimum string length: 4

settings.prefillData

object

Show child attributes

settings.prefillData.personalInfo

object

Show child attributes

settings.prefillData.personalInfo.firstName

string

required

Alpha string value with a limit of 50 characters. Only hyphens (-) and spaces are allowed as special characters.

Required string length: 1 - 50

Example:

"John"

settings.prefillData.personalInfo.lastName

string

required

Alpha string value with a limit of 50 characters. Only hyphens (-) and spaces are allowed as special characters.

Required string length: 1 - 50

Example:

"Doe"

settings.prefillData.personalInfo.ssn

string

Full SSN of the taxpayer. Required for non-business form 8821 submissions.

Required string length: 9

Example:

"123456789"

settings.prefillData.businessInfo

object

Show child attributes

settings.prefillData.businessInfo.name

string

required

Minimum string length: 1

Example:

"Test, Inc."

settings.prefillData.businessInfo.taxId

string

required

EIN or SSN of the taxpayer

Required string length: 9

Example:

"123456789"

settings.prefillData.businessInfo.type

enum<string>

required

Available options:

S-Corporation,

C-Corporation,

Sole Proprietorship,

Partnerships

settings.prefillData.businessInfo.phone

string

required

Example:

"1112223344"

settings.prefillData.businessInfo.title

enum<string>

required

Available options:

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

Example:

"Chief Executive Officer"

settings.prefillData.address

object

Show child attributes

settings.prefillData.address.street

string

required

Minimum string length: 1

Example:

"123 Main St"

settings.prefillData.address.city

string

required

Minimum string length: 1

Example:

"San Francisco"

settings.prefillData.address.state

string

required

Minimum string length: 1

Example:

"CA"

settings.prefillData.address.zip

string

required

Minimum string length: 1

Example:

"94101"

settings.prefillData.address.other

string

Example:

"Apt 1"

Response

201 - application/json

IRS 8821 Form Submission Response

url

string

required

Example:

"https://dashboard.trychart.com/c/1234567890"

string

required

Example:

"cm3tj5p2g000e674soxr2brbl"

Upload Signed Form 8821 Create Access Token

⌘I

Records

Taxpayer

IRS Forms

Client Links

Management

Create Client Link

Authorizations

Body

Response