TRtrychart

POST /client-links

Create a custom client link.

Request

  • Base URL
    https://api.trychart.com
  • Auth
    HTTP bearer

Request body

metadataobject

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.

Example request

{
  "settings": {
    "prefillData": {
      "personalInfo": {
        "firstName": "John",
        "lastName": "Doe",
        "ssn": "123456789"
      },
      "businessInfo": {
        "name": "Test, Inc.",
        "taxId": "123456789",
        "phone": "1112223344",
        "title": "Chief Executive Officer"
      },
      "address": {
        "street": "123 Main St",
        "other": "Apt 1",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94101"
      }
    }
  }
}

Response

IRS 8821 Form Submission Response

urlstring required
idstring required

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.