Create Client Link
Create a custom client link.
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",
"other": "Apt 1",
"city": "San Francisco",
"state": "CA",
"zip": "94101"
}
}
}
}'{
"url": "https://dashboard.trychart.com/c/1234567890",
"id": "cm3tj5p2g000e674soxr2brbl"
}Authorizations
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
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.
full, personal, business, irs-8821, irs-online-account, irs-8821-personal, irs-8821-business, irs-online-account-business, full-irs-online-account, full-irs-online-account-business, tax-prep Alpha string value with a limit of 50 characters. Only hyphens (-) and spaces are allowed as special characters.
1 - 50"John"
Alpha string value with a limit of 50 characters. Only hyphens (-) and spaces are allowed as special characters.
1 - 50"Doe"
Full SSN of the taxpayer. Required for non-business form 8821 submissions.
9"123456789"
1"Test, Inc."
EIN or SSN of the taxpayer
9"123456789"
S-Corporation, C-Corporation, Sole Proprietorship, Partnerships "1112223344"
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 "Chief Executive Officer"
1"123 Main St"
1"San Francisco"
1"CA"
1"94101"
"Apt 1"
Was this page helpful?
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",
"other": "Apt 1",
"city": "San Francisco",
"state": "CA",
"zip": "94101"
}
}
}
}'{
"url": "https://dashboard.trychart.com/c/1234567890",
"id": "cm3tj5p2g000e674soxr2brbl"
}