Business - Transcript Request

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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.

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, if opted as part of payload.

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.
{
    "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)
    
    "business_tin": string, // Required. Business EIN
    "business_mobile_number": string, // Optional. Business Telephone Number
    "business_name": string, // Optional. Business Name.
    "business_designation": string, // Optional. The designation of the Business Personel who is providing the consent.
    "business_type": string, // Optional. Business Classification.
    
    "login_required": boolean, // Default True. if login is required to complete the link. Requires last 6 digits of EIN 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]
    }],
		"send_consent_pdf_to_self": boolean,
		"allow_customer_to_receive_consent_pdf": boolean
}
{
    "success_message": string,
    "data": {
        "hosted_link": string,
        "request_id": integer
    },
    "success": boolean
}
{
    "first_name": "John", 
    "last_name": "Doe",
    "email": "[email protected]",
    
    "business_tin": "222222222",
    "business_mobile_number": "2342344535",
    "business_name": "MyCompany LLC", 
      
    "webhook_urls": ["https://webhook-endpoint.com"],
    "required_forms": [{
      "forms": [
        "1040",
        "1120"
      ],
      "form_type": "account_transcript",
      "tax_periods": [
        "2020",
        "2021",
        "2022"
      ]
    },
    {
      "form_type": "tax_return_transcript",
      "forms": [
        "1120S",
        "1120H"
      ],
      "tax_periods": [
        "2022",
        "2023"
      ]
    }
	],
	"send_consent_pdf_to_self": true,
	"allow_customer_to_receive_consent_pdf": true
}
{
    "success_message": "Your request is submitted.",
    "data": {
        "hosted_link": "https://app1.compliancely.com/hosted/template/21ff28162012d74XXXXXXXXXXXXXXXXXXXX",
        "request_id": 3301
    },
    "success": true
}
Key NamePossible 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'
business_type'partnership', 'trust/estate', 'c-corporation', 's-corporation', 'limited-liability-company', 'individual/sole-proprietor-or-single-member-llc'
required_formsList 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[].formsEx: liancely provides an . For more information on applicable forms, click here
required_forms[].tax_periodsAccount Transcript (ACTR) & Wage and Income (WAID) - Current tax year + prior 9 tax years
All other transcripts - Current tax year + Prior 3 tax years
Ex: d, name, email address. or a successful AP

Body Params
webhook_urls
array of strings

Optional

webhook_urls
string
length ≤ 512

Optional

string
required
length between 1 and 100
string
required
length between 1 and 100
string
required
length between 1 and 100
string
length ≤ 255
string
length ≤ 255
string
length ≤ 100
string
length ≤ 5
string
enum
string
length ≤ 9
string
length ≤ 10
string
length ≤ 100
string
length ≤ 100
string
length ≤ 100
boolean
required_forms
array of objects
required_forms
boolean
boolean
boolean
string
length ≤ 100
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json