Compliancely provides an option to pre-fill the vendor data in the widget link 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 vendor.
Note: The data ingested through this API call are non-editable by the vendor while providing the consent.
{
"template_id": string, // Required
"workflow": "individual/business", // 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 if workflow is individual (SSN)
"individual_mobile_number": string, // Required if workflow is individual and the feature is tax transcript
"business_tin": string, // Required if workflow is business (EIN)
"business_name": string, // Required if workflow is business
"login_required": boolean // Default True. if login is required to complete the link. Requires last 6digits of TIN to proceed.
"webhook_urls": [string], // Optional. But recommended
}
{
"success_message": string,
"data": {
"hosted_link": string,
"request_id": integer
},
"success": boolean
}
{
}
{
}
The templated_id represents the template we have configured under a widget. You can get the template_id from the portal (here). Or You can use 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' |