V3 Update Request for Transcript of Tax

patch

https://api.elliemae.com/encompass/v3/loans/{loanId}/applications/{applicationId}/tax4506Ts

Use this API to update the Request for Transcript of Tax form collections in Encompass. The data provided can be used to order services for IRS Tax Transcript Requests (forms 4506-C, 4506-T, and/or 8821).

Usage Notes

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 response from V3 Get Transcript of Tax Template and apply using the PATCH/encompass/v3/loans/{loanId}/applications/{applicationId}/tax4506Ts endpoint.
Using the V3 Update Loan API including the templateType=transcriptRequest and templatePath={{templatePath}} of the Request for Transcript of Tax template query parameters to copy template data.

For more information, see the Request for Transcript of Tax Knowledge Article.

This API added with the 25.3 release of Encompass.

Path Params

loanId

string

required

The unique identifier assigned to the loan.

applicationId

string

required

The unique application ID.

Query Params

action

string

Use to indicate the type of change being performed. Valid values: add, update, delete, reorder, replace

lockId

string

Lock ID used to lock loan.

includeEmpty

boolean

Indicates if fields with empty entities should be returned in the response payload since they are excluded by default.

Body Params

Patch Request for Transcript of Tax form.

string

System-generated, unique identifier of the Request for Transcript of Tax record ID.

altId

string

Create Only. ServiceToServiceOnly

accountTranscript

boolean

IRS Transcript - Account Transcript

address

string

IRS - Current Addr

authorizedSignor

string

IRS4506 Record - Tax Form for Borr/Co-Borr/Both.
ENUMS: Borrower, CoBorrower, Both

authorizedSignorSpouse

string

IRS4506 Record - Tax Form for Borr/Co-Borr/Both.
ENUMS: Borrower, CoBorrower, Both

city

string

IRS - Current City

costForEachPeriod

integer

IRS - Fee Per Yr/Period

currentFirst

string

IRS - Current Name First

currentLast

string

IRS - Current Name Last

first

string

IRS - First Name

formsSeriesTranscript

boolean

True indicates IRS Transcript - Form W-2/1099/1098/5498. Default is False.

historyId

string

IRS4506 Record ID. [RetrieveOnly]

ifTaxRecordNotFound

boolean

True indicates IRS - Refund to Third Party. Default is False.

irs4506C

boolean

True indicates use IRS 4506-C. Default is False.

irs4506CPrintVersion

string

IRS 4506-C Print Version.
ENUMS: Oct2022, Sep2020

last

string

IRS - Last Name

lastUpdatedDate

string

IRS4506 Record - Last Updated Date

lastUpdatedHistory

integer

IRS4506 Record - Last Updated History Record

lastUpdatedTime

string

IRS4506 Record - Last Updated Time

notifiedIrsIdentityTheftIndicator

boolean

True indicates IRS - Identified IRS Identity Theft. Default is False.

numberOfPeriods

integer

IRS - # Tax Periods Requested

person

string

IRS - Tax Form for Borr/Co-Borr/Both.
ENUMS: Borrower, CoBorrower, Both, Other

recordOfAccount

boolean

IRS Transcript - Record of Account

requestorPhoneNumber

string

IRS - Taxpayer Phone

requestYear1

string

IRS - Yr/Period Requested 1

requestYear2

string

IRS - Yr/Period Requested 2

requestYear3

string

IRS - Yr/Period Requested 3

requestYear4

string

IRS - Yr/Period Requested 4

requestYear5

string

IRS - Yr/Period Requested 5

requestYear6

string

IRS - Yr/Period Requested 6

requestYear7

string

IRS - Yr/Period Requested 7

requestYear8

string

IRS - Yr/Period Requested 8

returnAddress

string

IRS - Return Addr

returnCity

string

IRS - Return City

returnState

string

IRS - Return State

returnTranscript

boolean

IRS Transcript - Return Transcript

returnZip

string

IRS - Return Zip

selectedRecordNumber

string

IRS - Selected Record Number. [RetrieveOnly]

sendAddress

string

IRS - Send Return to Addr

sendCity

string

IRS - Send Return to City

sendFirst

string

IRS - Send Return to First Name

sendLast

string

IRS - Send Return to Last Name

sendPhone

string

IRS - Send Return to Phone

sendState

string

IRS - Send Return to State

sendZip

string

IRS - Send Return to Zip

spouseFirst

string

IRS - Spouse First Name

spouseLast

string

IRS - Spouse Last Name

spouseSsn

string

IRS - Second SSN/Empl ID #

spouseUseEin

boolean

True indicates IRS - Second SSN/Empl ID Format #. Default is False.

ssn

string

IRS - First SSN/Empl ID #

state

string

IRS - Current State

taxFormNumber

string

IRS - Tax Return Requested Descr

theseCopiesMustBeCertified

boolean

True indicates IRS - Copies Certified required. Default is False.

totalCost

integer

IRS - Total Cost

useEin

boolean

True indicates IRS - First SSN/Empl ID Format #. Default is False.

useWellsFargoRules

boolean

True indicates use IRS4506 Record - Default to Wells Fargo Rules. Default is False.

verificationOfNonfiling

boolean

True indicates IRS Transcript - Verif of Nonfiling. Default is False.

zip

string

IRS - Current Zip

signatoryAttestation

boolean

True indicates IRS - Signatory Attestation. Default is False.

signatoryAttestationT

boolean

True indicates IRS 4506T - Signatory Attestation. Default is False.

requestorTitle

string

IRS - Taxpayer Title.
ENUMS: CEO, CFO, Managing Member, Member Manager, Owner, Partner, Partnership, President, Secretary, Treasurer, Vice President

middleInitial

string

IRS - Middle Initial

spouseMiddleInitial

string

IRS - Spouse Middle Initial

previousFirstName

string

IRS Previous Record - First Name

previousMiddleInitial

string

IRS Previous Record - Middle Initial

previousLastName

string

IRS Previous Record - Last Name

spousePreviousFirst

string

IRS Previous Record - Spouse First Name

spousePreviousMiddleInitial

string

IRS Previous Record - Spouse Middle Initial

spousePreviousLast

string

IRS Previous Record - Spouse Last Name

sorMailboxId

string

IRS - SOR Mailbox ID

customerFileNumber

string

IRS - Customer File Number

uniqueIdentifierNumber

string

IRS - Unique Identifier Number

clientName

string

IRS - Client Name

clientPhone

string

IRS - Client Phone

clientAddress

string

IRS - Client Address

clientCity

string

IRS - Client City

clientState

string

IRS - Client State

clientZip

string

IRS - Client Zip

firstWageOrIncomeForm

string

IRS - 7a First Wage or Income Form

secondWageOrIncomeForm

string

IRS - 7a Second Wage or Income Form

thirdWageOrIncomeForm

string

IRS - 7a Third Wage or Income Form

firstTaxpayer

boolean

True indicates IRS - 7b First Taxpayer. Default is False.

secondTaxpayer

boolean

True indicates IRS - 7b Second Taxpayer. Default is False.

firstAuthorizedRepSigning

boolean

True indicates IRS - First Authorized Representative Signing. Default is False.

secondAuthorizedRepSigning

boolean

True indicates IRS - Second Authorized Representative Signing. Default is False.

formVersion

string

Classic Tax Form Transcript Requested to be sent to the IRS.
ENUMS: 4506-COct2022, 4506-CSept2020, 4506-T

planNumber

string

IRS4506 T Record - Plan Number

cafOrRetentionRevocationAuthorization

string

IRS4506 T Record - Specific Use is Not on CAF or Retention/Revocation of Prior Tax Info Authorization.
ENUMS: "4. Specific Use Not CAF", "5. Retention/Revocation Auth"

designeeName1

string

IRS4506 T Record - Designee Name 1

designeeAddress1

string

IRS4506 T Record - Designee Address 1

designeeCity1

string

IRS4506 T Record - Designee City 1

designeeState1

string

IRS4506 T Record - Designee State 1

designeeZip1

string

IRS4506 T Record - Designee Zip 1

designeeNoticesCommunicationsSent1

boolean

True indicates IRS4506 T Record - Designee Notices and Communications are Sent 1. Default is False.

designeeCafNumber1

string

IRS4506 T Record - Designee CAF Number 1

designeePtin1

string

IRS4506 T Record - Designee PTIN 1

designeePhone1

string

IRS4506 T Record - Designee Phone Number 1

designeeFax1

string

IRS4506 T Record - Designee Fax Number 1

designeeNewAddress1

boolean

True indicates IRS4506 T Record - Designee has new Address 1. Default is False.

designeeNewPhone1

boolean

True indicates IRS4506 T Record - Designee has new Phone 1. Default is False.

designeeNewFax1

boolean

True indicates IRS4506 T Record - Designee has new Fax 1. Default is False.

designeeName2

string

IRS4506 T Record - Designee Name 2

designeeAddress2

string

IRS4506 T Record - Designee Address 2

designeeCity2

string

IRS4506 T Record - Designee City 2

designeeState2

string

IRS4506 T Record - Designee State 2

designeeZip2

string

IRS4506 T Record - Designee Zip 2

designeeNoticesCommunicationsSent2

boolean

True indicates IRS4506 T Record - Designee Notices and Communications are Sent 2. Default is False.

designeeCafNumber2

string

IRS4506 T Record - Designee CAF Number 2

designeePtin2

string

IRS4506 T Record - Designee PTIN 2

designeePhone2

string

IRS4506 T Record - Designee Phone Number 2

designeeFax2

string

IRS4506 T Record - Designee Fax Number 2

designeeNewAddress2

boolean

True indicates IRS4506 T Record - Designee has new Address 2. Default is False.

designeeNewPhone2

boolean

True indicates IRS4506 T Record - Designee has new Phone 2. Default is False.

designeeNewFax2

boolean

True indicates IRS4506 T Record - Designee has new Fax 2. Default is False.

designeeName3

string

IRS4506 T Record - Designee Name 3

designeeAddress3

string

IRS4506 T Record - Designee Address 3

designeeCity3

string

IRS4506 T Record - Designee City 3

designeeState3

string

IRS4506 T Record - Designee State 3

designeeZip3

string

IRS4506 T Record - Designee Zip 3

designeeNoticesCommunicationsSent3

boolean

True indicates IRS4506 T Record - Designee Notices and Communications are Sent 3. Default is False.

designeeCafNumber3

string

IRS4506 T Record - Designee CAF Number 3

designeePtin3

string

IRS4506 T Record - Designee PTIN 3

designeePhone3

string

IRS4506 T Record - Designee Phone Number 3

designeeFax3

string

IRS4506 T Record - Designee Fax Number 3

designeeNewAddress3

boolean

True indicates IRS4506 T Record - Designee has new Address 3. Default is False.

designeeNewPhone3

boolean

True indicates IRS4506 T Record - Designee has new Phone 3. Default is False.

designeeNewFax3

boolean

True indicates IRS4506 T Record - Designee has new Fax 3. Default is False.

designeeName4

string

IRS4506 T Record - Designee Name 4

designeeAddress4

string

IRS4506 T Record - Designee Address 4

designeeCity4

string

IRS4506 T Record - Designee City 4

designeeState4

string

IRS4506 T Record - Designee State 4

designeeZip4

string

IRS4506 T Record - Designee Zip 4

designeeNoticesCommunicationsSent4

boolean

True indicates IRS4506 T Record - Designee Notices and Communications are Sent 4. Default is False.

designeeCafNumber4

string

IRS4506 T Record - Designee CAF Number 4

designeePtin4

string

IRS4506 T Record - Designee PTIN 4

designeePhone4

string

IRS4506 T Record - Designee Phone Number 4

designeeFax4

string

IRS4506 T Record - Designee Fax Number 4

designeeNewAddress4

boolean

True indicates IRS4506 T Record - Designee has new Address 4. Default is False.

designeeNewPhone4

boolean

True indicates IRS4506 T Record - Designee has new Phone 4. Default is False.

designeeNewFax4

boolean

True indicates IRS4506 T Record - Designee has new Fax 4. Default is False.

designeeName5

string

IRS4506 T Record - Designee Name 5

designeeAddress5

string

IRS4506 T Record - Designee Address 5

designeeCity5

string

IRS4506 T Record - Designee City 5

designeeState5

string

IRS4506 T Record - Designee State 5

designeeZip5

string

IRS4506 T Record - Designee Zip 5

designeeNoticesCommunicationsSent5

boolean

True indicates IRS4506 T Record - Designee Notices and Communications are Sent 5. Default is False.

designeeCafNumber5

string

IRS4506 T Record - Designee CAF Number 5

designeePtin5

string

IRS4506 T Record - Designee PTIN 5

designeePhone5

string

IRS4506 T Record - Designee Phone Number 5

designeeFax5

string

IRS4506 T Record - Designee Fax Number 5

designeeNewAddress5

boolean

True indicates IRS4506 T Record - Designee has new Address 5. Default is False.

designeeNewPhone5

boolean

True indicates IRS4506 T Record - Designee has new Phone 5. Default is False.

designeeNewFax5

boolean

True indicates IRS4506 T Record - Designee has new Fax 5. Default is False.

typeofTax1

string

IRS4506 T Record - Type of Tax Information 1.
ENUMS: Income, Employment, Payroll, Excise, Estate, Gift, Civil Penalty, Sec. 4980H Payments

taxFormNumber1

string

IRS4506 T Record - Tax Form Number 1.
ENUMS: 1040, 941, 720

yearsOrPeriods1

string

IRS4506 T Record - Years or Periods 1

specificTaxMatters1

string

IRS4506 T Record - Specific Tax Matters 1

typeofTax2

string

IRS4506 T Record - Type of Tax Information 2.
ENUMS: Income, Employment, Payroll, Excise, Estate, Gift, Civil Penalty, Sec. 4980H Payments

yearsOrPeriods2

string

IRS4506 T Record - Tax Form Number 2

taxFormNumber2

string

IRS4506 T Record - Years or Periods 2.
ENUMS: 1040, 941, 720

specificTaxMatters2

string

IRS4506 T Record - Specific Tax Matters 2

typeofTax3

string

IRS4506 T Record - Type of Tax Information 3.
ENUMS: Income, Employment, Payroll, Excise, Estate, Gift, Civil Penalty, Sec. 4980H Payments

taxFormNumber3

string

IRS4506 T Record - Tax Form Number 3.
ENUMS: 1040, 941, 720

yearsOrPeriods3

string

IRS4506 T Record - Years or Periods 3

specificTaxMatters3

string

IRS4506 T Record - Specific Tax Matters 3

Headers

Authorization

string

required

Bearer token. 

Responses

400

Bad Request

403

Forbidden

404

Not Found

Language

URL

Loading…

Response

Choose an example:

application/json

200Success