post
https://app1.compliancely.com/api/v1/transcript/individual/
Compliancely provides an option to pre-fill the taxpayer's data using this API endpoint. The minimum information required to create a request is first name, last name, and email address.
On a successful API call, the response includes a request_id. The taxpayer receives a consent link; this endpoint does not return a hosted link.
Note:
- All the fields marked as optional below are optional only for generating the link. The 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.
Request
{
"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": true, // Default true. If login is required to complete the link. Requires last 6 digits of SSN to proceed.
"send_consent_link_to_taxpayer": false, // 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"]
}
],
"information_scope": ["string"],
"customer_attestation_confirmed": true
}Response
{
"success_message": "string",
"data": {
"request_id": 0
},
"success": true
}Sample Request
{
"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"]
}
],
"information_scope": "full",
"customer_attestation_confirmed": true
}Success Response
{
"success_message": "We have received your request. Taxpayer will receive a consent link soon to give the consent.",
"data": {
"request_id": 3301
},
"success": true
}Field choices
| 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. |
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. 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: ["2020", "2021", "2022"]. |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…