Veri-Tax Order API Web Service

Veri-Tax Order API

Click here for a complete list of operations.

GetVOAByID

This method is used to retrieve a VOA order by Order ID. for VOA Order

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

<?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>
    <GetVOAByID xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <login>string</login>
      <password>string</password>
      <orderID>int</orderID>
    </GetVOAByID>
  </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>
    <GetVOAByIDResponse xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <GetVOAByIDResult>
        <errorMessage>string</errorMessage>
        <errorCode>Success or AuthenticationFailed or AuthorizationFailed or InvalidArgument or InternalError or OrderDoesNotExist or InvalidOperation or ValueOutOfRange</errorCode>
        <VOAorderDetail>
          <orderNumber>int</orderNumber>
          <Status>Received or InProgress or Completed or Rejected or Canceled or Monitoring</Status>
          <orderDate>dateTime</orderDate>
          <loanNumber>string</loanNumber>
          <SSN>string</SSN>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <BusinessName>string</BusinessName>
          <ContactFirstName>string</ContactFirstName>
          <ContactLastName>string</ContactLastName>
          <Email>string</Email>
          <MonthlyIncome>string</MonthlyIncome>
          <EmployerName>string</EmployerName>
          <AccountMonitoring>string</AccountMonitoring>
          <ReserveAmount>string</ReserveAmount>
          <AccountCheckStatus>string</AccountCheckStatus>
          <LastGeneratedon>dateTime</LastGeneratedon>
          <AdditionalInfo>string</AdditionalInfo>
          <FinantialInsituteList>
            <FIStructure xsi:nil="true" />
            <FIStructure xsi:nil="true" />
          </FinantialInsituteList>
          <OrderTypeVoa>Individual or Business</OrderTypeVoa>
          <History>
            <HistoryItemVOA xsi:nil="true" />
            <HistoryItemVOA xsi:nil="true" />
          </History>
        </VOAorderDetail>
      </GetVOAByIDResult>
    </GetVOAByIDResponse>
  </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>
    <GetVOAByID xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <login>string</login>
      <password>string</password>
      <orderID>int</orderID>
    </GetVOAByID>
  </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>
    <GetVOAByIDResponse xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
      <GetVOAByIDResult>
        <errorMessage>string</errorMessage>
        <errorCode>Success or AuthenticationFailed or AuthorizationFailed or InvalidArgument or InternalError or OrderDoesNotExist or InvalidOperation or ValueOutOfRange</errorCode>
        <VOAorderDetail>
          <orderNumber>int</orderNumber>
          <Status>Received or InProgress or Completed or Rejected or Canceled or Monitoring</Status>
          <orderDate>dateTime</orderDate>
          <loanNumber>string</loanNumber>
          <SSN>string</SSN>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <BusinessName>string</BusinessName>
          <ContactFirstName>string</ContactFirstName>
          <ContactLastName>string</ContactLastName>
          <Email>string</Email>
          <MonthlyIncome>string</MonthlyIncome>
          <EmployerName>string</EmployerName>
          <AccountMonitoring>string</AccountMonitoring>
          <ReserveAmount>string</ReserveAmount>
          <AccountCheckStatus>string</AccountCheckStatus>
          <LastGeneratedon>dateTime</LastGeneratedon>
          <AdditionalInfo>string</AdditionalInfo>
          <FinantialInsituteList>
            <FIStructure xsi:nil="true" />
            <FIStructure xsi:nil="true" />
          </FinantialInsituteList>
          <OrderTypeVoa>Individual or Business</OrderTypeVoa>
          <History>
            <HistoryItemVOA xsi:nil="true" />
            <HistoryItemVOA xsi:nil="true" />
          </History>
        </VOAorderDetail>
      </GetVOAByIDResult>
    </GetVOAByIDResponse>
  </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/GetVOAByID?login=string&password=string&orderID=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"?>
<GetVOAOrderResult xmlns="https://secure.veri-tax.com/soap/PublicAPI/vtservice.asmx">
  <errorMessage>string</errorMessage>
  <errorCode>Success or AuthenticationFailed or AuthorizationFailed or InvalidArgument or InternalError or OrderDoesNotExist or InvalidOperation or ValueOutOfRange</errorCode>
  <VOAorderDetail>
    <orderNumber>int</orderNumber>
    <Status>Received or InProgress or Completed or Rejected or Canceled or Monitoring</Status>
    <orderDate>dateTime</orderDate>
    <loanNumber>string</loanNumber>
    <SSN>string</SSN>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <BusinessName>string</BusinessName>
    <ContactFirstName>string</ContactFirstName>
    <ContactLastName>string</ContactLastName>
    <Email>string</Email>
    <MonthlyIncome>string</MonthlyIncome>
    <EmployerName>string</EmployerName>
    <AccountMonitoring>string</AccountMonitoring>
    <ReserveAmount>string</ReserveAmount>
    <AccountCheckStatus>string</AccountCheckStatus>
    <LastGeneratedon>dateTime</LastGeneratedon>
    <AdditionalInfo>string</AdditionalInfo>
    <FinantialInsituteList>
      <FIStructure>
        <FIId>int</FIId>
        <FIName>string</FIName>
        <ReportDate>dateTime</ReportDate>
      </FIStructure>
      <FIStructure>
        <FIId>int</FIId>
        <FIName>string</FIName>
        <ReportDate>dateTime</ReportDate>
      </FIStructure>
    </FinantialInsituteList>
    <OrderTypeVoa>Individual or Business</OrderTypeVoa>
    <History>
      <HistoryItemVOA>
        <Date>dateTime</Date>
        <Message>string</Message>
        <MessageType>System or CustomerService or Client or Problem or Internal or Wholesale or SSMHubMessage</MessageType>
      </HistoryItemVOA>
      <HistoryItemVOA>
        <Date>dateTime</Date>
        <Message>string</Message>
        <MessageType>System or CustomerService or Client or Problem or Internal or Wholesale or SSMHubMessage</MessageType>
      </HistoryItemVOA>
    </History>
  </VOAorderDetail>
</GetVOAOrderResult>