Individual Pre-fill Data on Widget Link

Compliancely provides an option to pre-fill the taxpayer's data using this API endpoint. The minimum information required to create a request is the template_id, name, email address, and workflow.

On a successful API call, a dedicated consent link will be provided in the response. An email will be sent along with a consent link to the taxpayer.

Check the API usage here

📘
Note:

All the fields marked as option below are optional only for generating the link. Taxpayer has to fill all the missing fields while they provide consent.

The data ingested through this API call are non-editable by the taxpayer while providing the consent.

{
    "template_id": string, // Required
    "first_name": string, // Required
    "last_name": string, // Required
    "email": string, // Required
    
    "address1": string, // Optional
    "address2": string, // Optional
    "city": string, // Optional
    "zip5": string, // Optional
    "state": string, // Optional (Should be a valid US State)

    "individual_tin": string, // Required. Individual's SSN.
    "individual_mobile_number": string, // Optional. Individual's Mobile Number
    
    "login_required": boolean, // Default True. if login is required to complete the link. Requires last 6 digits of SSN to proceed.
    "send_consent_link_to_taxpayer": boolean, // Default False. If set to True, Compliancely will send an email with the consent link to the taxpayer.
    "webhook_urls": [string], // Optional.

    "required_forms": [{ //Optional. Maximum 3 forms allowed in the list.
        "form_type":string,
        "forms":[string],
        "tax_periods":[string]
    }]
}

{
    "success_message": string,
    "data": {
        "hosted_link": string,
        "request_id": integer
    },
    "success": boolean
}

{
    "template_id": "3d68d903-147f-xxxx-xxxx-xxxxxxxxxxxx",
    
    "first_name": "John", 
    "last_name": "Doe",
    "email": "[email protected]",
    
    "individual_tin": "222222222",
    "individual_mobile_number": "2342344535",
      
    "webhook_urls": ["https://webhook-endpoint.com"],
    "required_forms": [{
      "forms": [
        "1040",
      ],
      "form_type": "account_transcript",
      "tax_periods": [
        "2020",
        "2021",
        "2022"
      ]
    },
    {
      "form_type": "tax_return_transcript",
      "forms": [
        "1040",
      ],
      "tax_periods": [
        "2022",
        "2023"
      ]
    }
  ]
}

{
    "success_message": "Your request is submitted.",
    "data": {
        "hosted_link": "https://app1.compliancely.com/hosted/template/21ff28162012d74XXXXXXXXXXXXXXXXXXXX",
        "request_id": 3301
    },
    "success": true
}

The templated_id represents the template we have configured under a widget. You can get the template_id from the Get Templates API to see all the templates and their details.

Key Name	Possible choice
state	'alabama', 'alaska', 'arizona', 'arkansas', 'california', 'colorado', 'connecticut', 'district of columbia', 'delaware', 'florida', 'georgia', 'hawaii', 'idaho', 'illinois', 'indiana', 'iowa', 'kansas', 'kentucky', 'louisiana', 'maine', 'maryland', 'massachusetts', 'michigan', 'minnesota', 'mississippi', 'missouri', 'montana', 'nebraska', 'nevada', 'new hampshire', 'new jersey', 'new mexico', 'newyork', 'north carolina', 'north dakota', 'ohio', 'oklahoma', 'oregon', 'pennsylvania', 'rhodeisland', 'south carolina', 'south dakota', 'tennessee', 'texas', 'utah', 'vermont', 'virginia', 'washington', 'west virginia', 'wisconsin', 'wyoming'
required_forms	List of JSON objects. Maximum 3 form entries are allowed. Optional. If not provided, the details configured against the template will be used for the same.
required_forms[].form_type	'civil_penalty', 'record_of_account', 'account_transcript', 'tax_return_transcript', 'wage_and_income', 'verification_of_non_filing'
required_forms[].forms	Ex: [1040, 941, 944, 945]. For more information on applicable forms, click here
required_forms[].tax_periods	Account Transcript (ACTR) & Wage and Income (WAID) - Current tax year + prior 9 tax years All other transcripts - Current tax year + Prior 3 tax years Ex: [2019, 2020, 2021, 2022] or [2019 THRU 2022]

📘Note:

📘
Note: