Veri-Tax Order API Web Service

Veri-Tax Order API

Click here for a complete list of operations.

CreateVOEOrder

This method is used to create and submit an order. For VOE orders.

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/CreateVOEOrder"

<?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>
    <CreateVOEOrder xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <login>string</login>
      <password>string</password>
      <referenceNumber>string</referenceNumber>
      <Applicant>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <SSN>string</SSN>
        <Address>string</Address>
        <City>string</City>
        <State>string</State>
        <Zip>string</Zip>
        <Phone>string</Phone>
        <DOB>string</DOB>
        <Employer>
          <TypeVoe>Verbal or Written</TypeVoe>
          <Title>string</Title>
          <Department>string</Department>
          <IsCurrent>boolean</IsCurrent>
          <Self>boolean</Self>
          <CompanyName>string</CompanyName>
          <AddressLine>string</AddressLine>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Phone>string</Phone>
          <Comment>string</Comment>
        </Employer>
        <ApplicantForm>base64Binary</ApplicantForm>
      </Applicant>
      <ccEmailList>string</ccEmailList>
    </CreateVOEOrder>
  </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>
    <CreateVOEOrderResponse xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <CreateVOEOrderResult>
        <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>
      </CreateVOEOrderResult>
    </CreateVOEOrderResponse>
  </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>
    <CreateVOEOrder xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <login>string</login>
      <password>string</password>
      <referenceNumber>string</referenceNumber>
      <Applicant>
        <FirstName>string</FirstName>
        <LastName>string</LastName>
        <SSN>string</SSN>
        <Address>string</Address>
        <City>string</City>
        <State>string</State>
        <Zip>string</Zip>
        <Phone>string</Phone>
        <DOB>string</DOB>
        <Employer>
          <TypeVoe>Verbal or Written</TypeVoe>
          <Title>string</Title>
          <Department>string</Department>
          <IsCurrent>boolean</IsCurrent>
          <Self>boolean</Self>
          <CompanyName>string</CompanyName>
          <AddressLine>string</AddressLine>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Phone>string</Phone>
          <Comment>string</Comment>
        </Employer>
        <ApplicantForm>base64Binary</ApplicantForm>
      </Applicant>
      <ccEmailList>string</ccEmailList>
    </CreateVOEOrder>
  </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>
    <CreateVOEOrderResponse xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <CreateVOEOrderResult>
        <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>
      </CreateVOEOrderResult>
    </CreateVOEOrderResponse>
  </soap12:Body>
</soap12:Envelope>