Request for Transcript of Tax

Overview

Use the Request for Transcript of Tax APIs to retrieve/update the Request for Transcript of Tax records/forms in Encompass. The data provided can be used to order services for IRS Tax Requests (forms 4506-C, 4506-T, and/or 8821). These IRS forms authorize the Lender to access tax return transcript data for borrowers, co-borrowers, or other individuals or entities via the Income Verification Express Service (IVES).

Request for Transcript of Tax Template Settings

In Encompass Settings, admins can configure Request for Transcript of Tax templates for each type of transcript request form (4506-C, 4506-T, and/or 8821). These enable you to add data to the loan about the IVES Participants, Third Party Designees, and tax years being requested.

Refer to the following pages in Encompass Developer Connect for more information about the Request for Transcript of Tax templates:

Use V3 Get List of Transcript of Tax Templates to get a list of available Transcript of Tax Templates.
Use V3 Get Transcript of Tax Template to retrieve the configured settings for a specific Transcript of Tax Template, by template ID.

Adding a Request for Transcript of Tax Template to a Loan

The pre-configured Transcript of Tax Template data can be copied from Encompass Settings and applied to the Tax Transcript Request form using one of the following methods:

Manually copy the response payload from V3 Get Transcript of Tax Template, and then apply those configured properties and values to the request payload of the V3 Update Request for Transcript of Tax API.
Using the V3 Update Loan API call and including the following query parameters to automatically copy the template data to the loan:
- templateType=transcriptRequest
- templatePath={{templatePath}} of the Request for Transcript of Tax template

Managing Request for Transcript of Tax Data

The V3 Update Request for Transcript of Tax API enables you to input all required information to request tax return transcripts for the given borrower, co-borrower, borrower pair, or other individuals or entities. The API enables you to add, update, delete, reorder, or replace Request for Transcript of Tax collection data on the loan.

See the following notes regarding each path parameter:

Path Parameter	Note
loanId	Unique identifier of the loan.
applicationId	Unique identifier of the Application, or Borrower Pair, in the loan that the Request for Transcript of Taxes are associated with.

See the following notes regarding each 'action' query parameter value:

Action Value	Note
add	Do not provide “id”. It will be automatically generated.
update	The “id” is required to update the appropriate Request for Transcript of Tax collection record. Only properties that are provided in the request are updated.
delete	The “id” of the Request for Transcript of Tax collection record that you want to delete is the only property required.
reorder	Reorders the existing collection of Request for Transcript of Tax collection record. All Request for Transcript of Tax collection record “id’s” must be provided in the payload, in the order you want them, starting with the Request for Transcript of Tax collection record you want to appear first, and then so on.
replace	Replaces all Request for Transcript of Tax records in the collection with the Request for Transcript of Tax collection record provided in the request payload (i.e., deletes existing collection and then replaces it with the new collection provided in the request). New “id’s” are generated for the replaced Request for Transcript of Tax collection records.

The Request for Transcript of Tax APIs do not have template query parameters for adding Request for Transcript of Tax templates. See Adding a Request for Transcript of Tax Template to a Loan.

Retrieving Request for Transcript of Tax Data

Use the V3 Get Request for Transcript of Tax API to retrieve all Request for Transcript of Tax records on the loan.