Veri-Tax Order API Web Service

Veri-Tax Order API

Click here for a complete list of operations.

CreateEsign4506Order

This method is used to create and submit an order. For 4506-T orders, you may include a signed 4506-T form.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /vt.service/PublicAPI/vtservice.asmx HTTP/1.1
Host: secure.veri-tax.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx/CreateEsign4506Order"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateEsign4506Order xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <login>string</login>
      <password>string</password>
      <type>F1040 or W2 or TFV or F1065 or F1120 or F1040PlusWages or SSA89 or SSNMatch or SSNDeluxe or SSNComplete or EVOE or F1120S</type>
      <TranscriptType>string</TranscriptType>
      <loanNumber>string</loanNumber>
      <SSN>string</SSN>
      <firstName>string</firstName>
      <middleInitial>string</middleInitial>
      <lastName>string</lastName>
      <address>string</address>
      <city>string</city>
      <state>string</state>
      <zipCode>string</zipCode>
      <previousAddress>string</previousAddress>
      <previousCity>string</previousCity>
      <previousState>string</previousState>
      <previousZip>string</previousZip>
      <DOB>string</DOB>
      <gender>string</gender>
      <years>
        <int>int</int>
        <int>int</int>
      </years>
      <orderNote>string</orderNote>
      <uploadedForm>base64Binary</uploadedForm>
      <eSignOption>Option0 or Option1 or Option2</eSignOption>
      <EmailAddress1>string</EmailAddress1>
      <EmailAddress2>string</EmailAddress2>
      <zipFilePassword>string</zipFilePassword>
      <title>string</title>
      <fiscalEndDateMonth>December or November or October or September or August or July or June or May or April or March or February or January</fiscalEndDateMonth>
      <ccEmailList>string</ccEmailList>
    </CreateEsign4506Order>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CreateEsign4506OrderResponse xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <CreateEsign4506OrderResult>
        <ifSucceed>boolean</ifSucceed>
        <errorCode>Success or AuthenticationFailed or AuthorizationFailed or InvalidArgument or InternalError or OrderDoesNotExist or InvalidOperation or ValueOutOfRange</errorCode>
        <errorMessage>string</errorMessage>
        <orderId>int</orderId>
      </CreateEsign4506OrderResult>
    </CreateEsign4506OrderResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /vt.service/PublicAPI/vtservice.asmx HTTP/1.1
Host: secure.veri-tax.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateEsign4506Order xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <login>string</login>
      <password>string</password>
      <type>F1040 or W2 or TFV or F1065 or F1120 or F1040PlusWages or SSA89 or SSNMatch or SSNDeluxe or SSNComplete or EVOE or F1120S</type>
      <TranscriptType>string</TranscriptType>
      <loanNumber>string</loanNumber>
      <SSN>string</SSN>
      <firstName>string</firstName>
      <middleInitial>string</middleInitial>
      <lastName>string</lastName>
      <address>string</address>
      <city>string</city>
      <state>string</state>
      <zipCode>string</zipCode>
      <previousAddress>string</previousAddress>
      <previousCity>string</previousCity>
      <previousState>string</previousState>
      <previousZip>string</previousZip>
      <DOB>string</DOB>
      <gender>string</gender>
      <years>
        <int>int</int>
        <int>int</int>
      </years>
      <orderNote>string</orderNote>
      <uploadedForm>base64Binary</uploadedForm>
      <eSignOption>Option0 or Option1 or Option2</eSignOption>
      <EmailAddress1>string</EmailAddress1>
      <EmailAddress2>string</EmailAddress2>
      <zipFilePassword>string</zipFilePassword>
      <title>string</title>
      <fiscalEndDateMonth>December or November or October or September or August or July or June or May or April or March or February or January</fiscalEndDateMonth>
      <ccEmailList>string</ccEmailList>
    </CreateEsign4506Order>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CreateEsign4506OrderResponse xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <CreateEsign4506OrderResult>
        <ifSucceed>boolean</ifSucceed>
        <errorCode>Success or AuthenticationFailed or AuthorizationFailed or InvalidArgument or InternalError or OrderDoesNotExist or InvalidOperation or ValueOutOfRange</errorCode>
        <errorMessage>string</errorMessage>
        <orderId>int</orderId>
      </CreateEsign4506OrderResult>
    </CreateEsign4506OrderResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /vt.service/PublicAPI/vtservice.asmx/CreateEsign4506Order?login=string&password=string&type=string&TranscriptType=string&loanNumber=string&SSN=string&firstName=string&middleInitial=string&lastName=string&address=string&city=string&state=string&zipCode=string&previousAddress=string&previousCity=string&previousState=string&previousZip=string&DOB=string&gender=string&years=string&years=string&orderNote=string&uploadedForm=string&uploadedForm=string&eSignOption=string&EmailAddress1=string&EmailAddress2=string&zipFilePassword=string&title=string&fiscalEndDateMonth=string&ccEmailList=string HTTP/1.1
Host: secure.veri-tax.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AddNewOrderResult xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
  <ifSucceed>boolean</ifSucceed>
  <errorCode>Success or AuthenticationFailed or AuthorizationFailed or InvalidArgument or InternalError or OrderDoesNotExist or InvalidOperation or ValueOutOfRange</errorCode>
  <errorMessage>string</errorMessage>
  <orderId>int</orderId>
</AddNewOrderResult>