API Documentation

AccountChek SOAP - REST Migration Guide

This guide focuses on a direct SOAP to REST migration for VOA.

While this guide is focused on VOA for a direct migration from SOAP, our REST API also supports additional AccountChek services like VOIE so other workflows we link to in this guide will reflect that. While it’s possible to add handling for other AccountChek services later, we recommend trying to implement all services if possible while doing your migration work.

Table of Contents

  1. Documentation
  2. Using the LOS (Borrower Not Present) Flow
  3. Using the POS (Borrower Present) Flow
  4. lite to full VOA Upgrade Path
  5. Appendix

Documentation

NOTE In the SOAP API, the unique identifier is the VOD_ID, but in the REST API the unique identifier is the orderId. These fields look very similar as they are both GUIDs, but they are completely different fields.

Using the LOS (Borrower Not Present) Flow

SOAP API

  1. Create the AccountChek Order and Send Borrower Email using one of the paths listed below:
    • CreateVODARequest6 - This creates a new VODA (VOA) request and fires off an email to the Borrower. See Appendix 1.1.
  2. (Optional) Check the status of the VOA
    • GetStatus - Once the Borrower clicks submit; the report generation process will begin. See Appendix 1.4. To get the status of the VOA, you can use either this call or leverage post backs through our webhook.
  3. (Optional) Get the Basic Account Info
    • GetAccountInfo - This call will allow you to retrieve basic, high-level information to the Borrower before the full report data is returned. This data is populated after the status code of 510 is set. See Appendix 1.5.
  4. Get VOA Reports
    • GetReportList2 - Returns a list of reports generated for an order. See Appendix 1.6.
  5. Get VOA Report
    • GetReport2 - This call allows you to retrieve specific account and report data. See Appendix 1.7.
  6. (Optional) Resend Email to Borrower
    • ResendVODAEmail - This call resends the enrollment email to the Borrower, with a new enrollment link. See Appendix 1.8.
  7. (Optional) Send an Email Reminder to Borrower
    • SendReminderEmail - This sends a reminder email to the Borrower if they have not yet enrolled. See Appendix 1.9.
  8. (Optional) Get the Login URL for the Borrower
    • GetLoginURL_VOD_ID - Gets the Borrower Login URL for the AccountChek Order. See Appendix 1.10.

REST API

For a more detailed documentation workflow for REST, see the LOS Workflow as well as the Verifier API Specifications.

  1. Create the AccountChek Order and Send Borrower Email. The SOAP API CreateVODARequest6 has been split up into multiple requests.
    1. POST to /v1/accountchekorders providing the proper JSON in the request body and your unique AccountChek-assigned IntegratorId as a custom HTTP header (more info on integratorIdimplementation). For an example of JSON, see Appendix 2.1.
    2. POST to /v1/accountchekorders/{orderId}/voa providing the proper JSON in the request body. For an example of JSON, see Appendix 2.2. The orderId variable in the path is the id provided in a successful response from the previous POST request.
    3. PATCH to /v1/accountchekorders/{orderId} providing the proper JSON in the request body. For an example of JSON, see Appendix 2.3.
  2. Check the status of the VOA
    • GET to /v1/accountchekorders/{orderId}/voa to get the VOA for the AccountChekOrder See Appendix 2.4. The response will be the VOA as a JSON object with a status field.
  3. Get the Basic Account Info
    • GET to /v1/accountchekorders/{orderId}/voa/lite to get an array of LiteAccountInfo object as a JSON array. See Appendix 2.5.
  4. Get VOA Reports
    • GET to /v1/accountchekorders/{orderId}/voa/reports to get an array of Report objects as a JSON array. See Appendix 2.6.
  5. Get VOA Report
    1. GET to /v1/accountchekorders/{orderId}/voa/reports/{reportId} to get a Report object as a JSON object. See Appendix 2.7.
    2. GET to /v1/accountchekorders/{orderId}/voa/reports/{reportId}/summary. This endpoint will return the report data for the accounts the Borrower linked, either as a JSON object or a PDF. See our documentation site for the JSON Schema
      • To get a JSON response, set the Accept Header to application/json.
      • To get a PDF response, set the Accept Header to application/pdf.
  6. (Optional) Create New Report
    • POST to /v1/accountchekorders/{orderId}/voa/reports to create a new report. See Appendix 2.9.

Using the POS (Borrower Present) Flow

SOAP API

  1. Create the AccountChek Order
    • InitiateVOA - This will also create a VOA for the AccountChek Order and will produce an SSO. See Appendix 1.2.
  2. Display the enrollment app for the borrower
    1. Widget
      • GetEnrollmentWidget - The following call will produce JavaScript/HTML with an embedded limited-life SSO URL. As such, if the call is made and the Borrower does not enter the widget within a specific timespan, the call will have to be made again. See Appendix 1.11.
    2. Windowed
      • Use the SSO URL as returned by InitiateVOA to display the borrower enrollment in a full browser window.
    3. IFrame
      • Use the SSO URL as returned by InitiateVOA to display the borrower enrollment in an IFRAME. Append the query string parameter &widget=1 to the SSO URL to remove the full web application chrome from the display. Implementer is responsible for controlling the visibility of the IFrame.
  3. (Optional) Check the status of the VOA
    • GetStatus - Once the Borrower clicks submit; the report generation process will begin. See Appendix 1.4. To get the status of the VOA, you can use either this call or leverage post backs through our webhook.
  4. (Optional) Get the Basic Account Info
    • GetAccountInfo - This call will allow you to retrieve basic, high-level information to the Borrower before the full report data is returned. See Appendix 1.5.
  5. Get VOA Reports
    • GetReportList2 - Returns a list of reports generated for an order. See Appendix 1.6.
  6. Get VOA Report
    • GetReport2 - This call allows you to retrieve specific account and report data. See Appendix 1.7.

REST API

For a more detailed documentation workflow for REST, see the POS Workflow as well as the Verifier API Specifications.

  1. Create the AccountChek Order. The SOAP API CreateVODARequest6 has been split up into multiple requests. To not send the Borrower an email, provide a dummy email address with the initial AccountChek Order creation.
    1. POST to /v1/accountchekorders providing the proper JSON in the request body and your unique AccountChek-assigned IntegratorId as a custom HTTP header (more info on integratorIdimplementation). For an example of JSON, see Appendix 2.1.
    2. POST to /v1/accountchekorders/{orderId}/voa providing the proper JSON in the request body. For an example of JSON, see Appendix 2.2. The orderId variable in the path is the id provided in a successful response from the previous POST request.
    3. PATCH to /v1/accountchekorders/{orderId} providing the proper JSON in the request body. For an example of JSON, see Appendix 2.3.
  2. Display TOS to the Borrower.
    • Details on language and links are listed on our more detailed POS workflow in the Include the TOS section.
  3. Get the Borrower Enrollment Widget and embed it into the application.
    • GET to /v1/accountchekorders/{orderId}/enrollmentWidget. This request will return Javascript/HTML in the request body. See Appendix 2.10. You will need to embed this into your application and style it.
  4. Check the status of the VOA
    • GET to /v1/accountchekorders/{orderId}/voa to get the VOA for the AccountChekOrder. See Appendix 2.4. The response will be the VOA as a JSON object with a status field.
  5. Get the Basic Account Info
    • GET to /v1/accountchekorders/{orderId}/voa/lite to get an array of LiteAccountInfo object as a JSON object. See Appendix 2.5.
  6. Get VOA Reports
    • GET to /v1/accountchekorders/{orderId}/voa/reports to get an array of Report objects as a JSON object. See Appendix 2.6.
  7. Get VOA Report
    1. GET to /v1/accountchekorders/{orderId}/voa/reports/{reportId} to get a Report object as a JSON object. See Appendix 2.7.
    2. GET to /v1/accountchekorders/{orderId}/voa/reports/{reportId}/summary. This endpoint will return the report data for the accounts the Borrower linked, either as a JSON object or a PDF. See our documentation site for the JSON Schema
      • To get a JSON response, set the Accept Header to application/json.
      • To get a PDF response, set the Accept Header to application/pdf.
  8. (Optional) Create New Report
    • POST to /v1/accountchekorders/{orderId}/voa/reports to create a new report. See Appendix 2.9.

lite to full VOA Upgrade Path

SOAP API - Widget Flow

  1. Create a lite AccountChek Order request for a VOA.
    • InitiateSnap - See Appendix 1.13.
  2. Upgrade a lite AccountChek Order to a full order.
    • UpgradeToVoa - See Appendix 1.14.

REST API

  1. Create the AccountChek Order. The SOAP API CreateVODARequest6 has been split up into multiple requests. To not send the Borrower an email, provide a dummy email address with the initial AccountChek Order creation.
    1. POST to /v1/accountchekorders providing the proper JSON in the request body. For an example of JSON, see Appendix 2.1.
    2. POST to /v1/accountchekorders/{orderId}/voa providing the proper JSON in the request body. For an example of JSON, see Appendix 2.2. With this initial creation of the VOA request, you will need to provide the requestType as lite in order for this VOA to be a lite report. The orderId variable in the path is the id provided in a successful response from the previous POST request.
  2. Upgrade a lite VOA to a full report.
    • PUT to /v1/accountchekorders/{orderId}/voa providing the proper JSON in the request body. For an example of the JSON, see Appendix 2.2.

Appendix

  1. XML/SOAP API
    1. CreateVODARequest6
      • Request
       <?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>
         <CreateVODARequest6 xmlns="http://tempuri.org/">
             <verifierCompany>string</verifierCompany>
             <verifierFirstName>string</verifierFirstName>
             <verifierLastName>string</verifierLastName>
             <verifierEmail>string</verifierEmail>
             <referenceNumber>string</referenceNumber>
             <firstName>string</firstName>
             <lastName>string</lastName>
             <email>string</email>
             <mobilePhone>string</mobilePhone>
             <employerName>string</employerName>
             <reportType>string</reportType>
             <accountMonitoring>string</accountMonitoring>
             <accountCount>string</accountCount>
             <accountList>string</accountList>
             <last4SSN>string</last4SSN>
             <reserveAmount>string</reserveAmount>
             <notificationChannel>string</notificationChannel>
             <orderNumber>string</orderNumber>
             <dbString>string</dbString>
         </CreateVODARequest6>
     </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
         <CreateVODARequest6Response xmlns="http://tempuri.org/">
             <CreateVODARequest6Result>boolean</CreateVODARequest6Result>
             <VOD_ID>string</VOD_ID>
             <errorMessage>string</errorMessage>
             <loginURL>string</loginURL>
         </CreateVODARequest6Response>
     </soap12:Body>
 </soap12:Envelope>
    2. InitiateVOA
      • Request
       <?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>
         <InitiateVOA xmlns="http://tempuri.org/">
             <verificationKey>string</verificationKey>
             <returnURL>string</returnURL>
             <notificationURL>string</notificationURL>
             <referenceNumber>string</referenceNumber>
             <firstName>string</firstName>
             <lastName>string</lastName>
             <employerName>string</employerName>
             <daysBack>string</daysBack>
         </InitiateVOA>
     </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
         <InitiateVOAResponse xmlns="http://tempuri.org/">
             <InitiateVOAResult>boolean</InitiateVOAResult>
             <VOD_ID>string</VOD_ID>
             <ssoURL>string</ssoURL>
             <errorMessage>string</errorMessage>
         </InitiateVOAResponse>
     </soap12:Body>
 </soap12:Envelope>
    3. SetVOAEmail
      • Request
       <?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>
         <SetVOAEmail xmlns="http://tempuri.org/">
             <vodid>guid</vodid>
             <email>string</email>
             <last4SSN>string</last4SSN>
         </SetVOAEmail>
     </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
         <SetVOAEmailResponse xmlns="http://tempuri.org/">
             <SetVOAEmailResult>boolean</SetVOAEmailResult>
             <loginURL>string</loginURL>
             <errMsg>string</errMsg>
         </SetVOAEmailResponse>
     </soap12:Body>
 </soap12:Envelope>
    4. GetStatus
      • Request
       <?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>
         <GetStatus xmlns="http://tempuri.org/">
             <VOD_ID>string</VOD_ID>
         </GetStatus>
     </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
         <GetStatusResponse xmlns="http://tempuri.org/">
             <GetStatusResult>boolean</GetStatusResult>
             <VODStatus>int</VODStatus>
             <fiList>
                 <FIStatus>
                     <FIName>string</FIName>
                     <FIID>string</FIID>
                     <Enrollment>string</Enrollment>
                     <LastHarvest>dateTime</LastHarvest>
                 </FIStatus>
                 <FIStatus>
                     <FIName>string</FIName>
                     <FIID>string</FIID>
                     <Enrollment>string</Enrollment>
                     <LastHarvest>dateTime</LastHarvest>
                 </FIStatus>
             </fiList>
         </GetStatusResponse>
     </soap12:Body>
 </soap12:Envelope>
    5. GetAccountInfo
      • Request
       <?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>
         <GetAccountInfo xmlns="http://tempuri.org/">
             <verificationKey>string</verificationKey>
             <VOD_ID>string</VOD_ID>
         </GetAccountInfo>
     </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
         <GetAccountInfoResponse xmlns="http://tempuri.org/">
             <GetAccountInfoResult>boolean</GetAccountInfoResult>
             <fiAccountList>
                 <FIAccountInfo>
                     <FIName>string</FIName>
                     <AccountID>string</AccountID>
                     <AccountType>string</AccountType>
                     <FIAccountType>string</FIAccountType>
                     <FIPlanName>string</FIPlanName>
                     <FIAccountClassification>string</FIAccountClassification>
                     <AccountNumber>string</AccountNumber>
                     <AccountName>string</AccountName>
                     <BalanceDate>dateTime</BalanceDate>
                     <Balance>double</Balance>
                     <AccountHolder>string</AccountHolder>
                     <SiteID>string</SiteID>
                 </FIAccountInfo>
                 <FIAccountInfo>
                     <FIName>string</FIName>
                     <AccountID>string</AccountID>
                     <AccountType>string</AccountType>
                     <FIAccountType>string</FIAccountType>
                     <FIPlanName>string</FIPlanName>
                     <FIAccountClassification>string</FIAccountClassification>
                     <AccountNumber>string</AccountNumber>
                     <AccountName>string</AccountName>
                     <BalanceDate>dateTime</BalanceDate>
                     <Balance>double</Balance>
                     <AccountHolder>string</AccountHolder>
                     <SiteID>string</SiteID>
                 </FIAccountInfo>
             </fiAccountList>
             <errorMessage>string</errorMessage>
         </GetAccountInfoResponse>
     </soap12:Body>
 </soap12:Envelope>
    6. GetReportList2
      • Request
       <?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>
         <GetReportList2 xmlns="http://tempuri.org/">
             <VOD_ID>string</VOD_ID>
         </GetReportList2>
     </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
         <GetReportList2Response xmlns="http://tempuri.org/">
             <GetReportList2Result>boolean</GetReportList2Result>
             <reportlist>
                 <ReportInfo>
                     <ExtensionData />
                     <ReportDate>dateTime</ReportDate>
                     <ReportID>int</ReportID>
                     <ReportUnique>guid</ReportUnique>
                     <RequestID>guid</RequestID>
                 </ReportInfo>
                 <ReportInfo>
                     <ExtensionData />
                     <ReportDate>dateTime</ReportDate>
                     <ReportID>int</ReportID>
                     <ReportUnique>guid</ReportUnique>
                     <RequestID>guid</RequestID>
                 </ReportInfo>
             </reportlist>
         </GetReportList2Response>
     </soap12:Body>
 </soap12:Envelope>
    7. GetReport2
      • Request
       <?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>
         <GetReport2 xmlns="http://tempuri.org/">
           <VOD_ID>string</VOD_ID>
           <reportID>string</reportID>
           <reissueKey>string</reissueKey>
         </GetReport2>
     </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
         <GetReport2Response xmlns="http://tempuri.org/">
           <GetReport2Result>boolean</GetReport2Result>
           <AssetReport>base64Binary</AssetReport>
           <jsonReport>string</jsonReport>
           <errorMessage>string</errorMessage>
         </GetReport2Response>
     </soap12:Body>
 </soap12:Envelope>
    8. ResendVODAEmail
      • Request
       <?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>
         <ResendVODAEmail xmlns="http://tempuri.org/">
             <VOD_ID>string</VOD_ID>
             <newEmail>string</newEmail>
         </ResendVODAEmail>
     </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
         <ResendVODAEmailResponse xmlns="http://tempuri.org/">
             <ResendVODAEmailResult>boolean</ResendVODAEmailResult>
         </ResendVODAEmailResponse>
     </soap12:Body>
 </soap12:Envelope>
    9. SendReminderEmail
      • Request
       <?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>
         <SendReminderEmail xmlns="http://tempuri.org/">
             <vodid>guid</vodid>
             <daysActive>int</daysActive>
         </SendReminderEmail>
     </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
         <SendReminderEmailResponse xmlns="http://tempuri.org/">
             <SendReminderEmailResult>boolean</SendReminderEmailResult>
         </SendReminderEmailResponse>
     </soap12:Body>
 </soap12:Envelope>
    10. GetLoginURL_VOD_ID
      • Request
      <?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>
    <GetLoginURL_VOA_ID xmlns="http://tempuri.org/">
      <vodid>guid</vodid>
    </GetLoginURL_VOA_ID>
  </soap12:Body>
</soap12:Envelope>
      • Response
      <?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>
    <GetLoginURL_VOA_IDResponse xmlns="http://tempuri.org/">
      <GetLoginURL_VOA_IDResult>string</GetLoginURL_VOA_IDResult>
    </GetLoginURL_VOA_IDResponse>
  </soap12:Body>
</soap12:Envelope>
    11. GetEnrollmentWidget
      • Request
      <?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>
    <GetEnrollmentWidget xmlns="http://tempuri.org/">
      <verificationKey>string</verificationKey>
      <VOD_ID>string</VOD_ID>
      <maxWidth>string</maxWidth>
      <maxHeight>string</maxHeight>
    </GetEnrollmentWidget>
  </soap12:Body>
</soap12:Envelope>
      • Response
      <?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>
    <GetEnrollmentWidgetResponse xmlns="http://tempuri.org/">
      <GetEnrollmentWidgetResult>boolean</GetEnrollmentWidgetResult>
      <widget>string</widget>
      <errorMessage>string</errorMessage>
    </GetEnrollmentWidgetResponse>
  </soap12:Body>
</soap12:Envelope>
    12. GetSSOUrl
      • Request
      <?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>
    <GetSSOURL xmlns="http://tempuri.org/">
      <verificationKey>string</verificationKey>
      <VOD_ID>string</VOD_ID>
      <returnURL>string</returnURL>
      <UsageType>string</UsageType>
      <notificationURL>string</notificationURL>
    </GetSSOURL>
  </soap12:Body>
</soap12:Envelope>
      • Response
      <?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>
    <GetSSOURLResponse xmlns="http://tempuri.org/">
      <GetSSOURLResult>boolean</GetSSOURLResult>
      <ssoURL>string</ssoURL>
      <errorMessage>string</errorMessage>
      <orderStatus>string</orderStatus>
    </GetSSOURLResponse>
  </soap12:Body>
</soap12:Envelope>
    13. InitiateSnap
      • Request
      <?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>
    <InitiateSnap xmlns="http://tempuri.org/">
      <verificationKey>string</verificationKey>
      <returnURL>string</returnURL>
      <notificationURL>string</notificationURL>
      <referenceNumber>string</referenceNumber>
      <firstName>string</firstName>
      <lastName>string</lastName>
      <employerName>string</employerName>
      <daysBack>string</daysBack>
    </InitiateSnap>
  </soap12:Body>
</soap12:Envelope>
      • Response
      <?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>
    <InitiateSnapResponse xmlns="http://tempuri.org/">
      <InitiateSnapResult>boolean</InitiateSnapResult>
      <VOD_ID>string</VOD_ID>
      <ssoURL>string</ssoURL>
      <errorMessage>string</errorMessage>
    </InitiateSnapResponse>
  </soap12:Body>
</soap12:Envelope>
    14. UpgradeToVoa
      • Request
      <?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>
    <UpgradeToVOA xmlns="http://tempuri.org/">
      <verificationKey>string</verificationKey>
      <VOD_ID>string</VOD_ID>
    </UpgradeToVOA>
  </soap12:Body>
</soap12:Envelope>
      • Response
      <?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>
    <UpgradeToVOAResponse xmlns="http://tempuri.org/">
      <UpgradeToVOAResult>boolean</UpgradeToVOAResult>
      <errorMessage>string</errorMessage>
    </UpgradeToVOAResponse>
  </soap12:Body>
</soap12:Envelope>
  2. JSON/REST API
    1. POST /v1/accountchekorders
      • Request
       {
     "email": "user@example.com",
     "last4SSN": "string",
     "referenceNumber": "string",
     "firstName": "string",
     "lastName": "string",
     "phoneNumber": "string",
     "notificationUrl": "http://example.com",
     "returnUrl": "http://example.com",
     "employerName": "string"
 }
      • Response
       {
     "email": "user@example.com",
     "last4SSN": "string",
     "referenceNumber": "string",
     "firstName": "string",
     "lastName": "string",
     "phoneNumber": "string",
     "notificationUrl": "http://example.com",
     "returnUrl": "http://example.com",
     "employerName": "string",
     "id": "string",
     "created": "2019-07-16T21:14:34Z",
     "isArchived": false,
     "status": "building",
     "loginUrl": "http://example.com",
     "daysRemaining": 0,
     "employmentVerificationRequested": true
 }
    2. POST /v1/accountchekorders/{orderId}/voa
      • Request
       {
     "requestType": "lite",
     "accountMonitoring": 0,
     "expectedAccounts": [
         {
             "accountNumber": "string",
             "fiName": "string",
             "nickName": "string"
         }
     ]
 }
      • Response
       {
     "requestType": "lite",
     "accountMonitoring": 0,
     "expectedAccounts": [
         {
             "accountNumber": "string",
             "fiName": "string",
             "nickName": "string"
         }
     ],
     "status": 500
 }
    3. PATCH /v1/accountchekorders/{orderId}
      • Request
       {
     "status": "opened"
 }
      • Response
       {
     "email": "user@example.com",
     "last4SSN": "string",
     "referenceNumber": "string",
     "firstName": "string",
     "lastName": "string",
     "phoneNumber": "string",
     "notificationUrl": "http://example.com",
     "returnUrl": "http://example.com",
     "employerName": "string",
     "id": "string",
     "created": "2019-07-16T21:14:34Z",
     "isArchived": false,
     "status": "building",
     "loginUrl": "http://example.com",
     "daysRemaining": 0,
     "employmentVerificationRequested": true
 }
    4. GET /v1/accountchekorders/{orderId}/voa
      • Response
       {
     "requestType": "lite",
     "accountMonitoring": 0,
     "expectedAccounts": [
         {
             "accountNumber": "string",
             "fiName": "string",
             "nickName": "string"
         }
     ],
     "status": 500
 }
    5. GET /v1/accountchekorders/{orderId}/voa/lite
      • Response
       [
     {
         "accountId": "string",
         "accountType": "DDA",
         "accountName": "string",
         "accountNumber": "string",
         "accountHolder": "string",
         "fiName": "string",
         "fiAccountType": "string",
         "fiPlanName": "string",
         "balance": 0,
         "balanceDate": "2019-07-16T21:14:34Z"
     }
 ]
    6. GET /v1/accountchekorders/{orderId}/voa/reports
      • Response
       [
     {
         "id": "string",
         "employerName": "string",
         "daysBack": 0,
         "accountIds": [
             "string"
         ],
         "dataHarvested": true,
         "currentAsOfDate": "2019-07-16T21:14:34Z",
         "historyStartDate": "2019-07-16T21:14:34Z",
         "requestDate": "2019-07-16T21:14:34Z",
         "reportDate": "2019-07-16T21:14:34Z",
         "requestorName": "string",
         "requestorCompanyName": "string",
         "status": 400
     }
 ]
    7. GET /v1/accountchekorders/{orderId}/voa/reports/{reportId}
      • Response
       {
     "id": "string",
     "employerName": "string",
     "daysBack": 0,
     "accountIds": [
         "string"
     ],
     "dataHarvested": true,
     "currentAsOfDate": "2019-07-16T21:14:34Z",
     "historyStartDate": "2019-07-16T21:14:34Z",
     "requestDate": "2019-07-16T21:14:34Z",
     "reportDate": "2019-07-16T21:14:34Z",
     "requestorName": "string",
     "requestorCompanyName": "string",
     "status": 400
 }
    8. POST /v1/accountchekorders/{orderId}/voa/reports/{reportId}/regenerate
      • Request
       {
     "newestHarvestUsed": true,
     "daysBack": 0,
     "accountIds": [
         "string"
     ]
 }
      • Response
       {
     "id": "string",
     "employerName": "string",
     "daysBack": 0,
     "accountIds": [
         "string"
     ],
     "dataHarvested": true,
     "currentAsOfDate": "2019-07-16T21:14:34Z",
     "historyStartDate": "2019-07-16T21:14:34Z",
     "requestDate": "2019-07-16T21:14:34Z",
     "reportDate": "2019-07-16T21:14:34Z",
     "requestorName": "string",
     "requestorCompanyName": "string",
     "status": 400
 }
    9. POST /v1/accountchekorders/{orderId}/voa/reports
      • Request
       {
     "employerName": "string",
     "daysBack": 0,
     "accountIds": [
         "string"
     ],
     "dataHarvested": true
 }
      • Response
       {
     "id": "string",
     "employerName": "string",
     "daysBack": 0,
     "accountIds": [
         "string"
     ],
     "dataHarvested": true,
     "currentAsOfDate": "2019-07-16T21:14:34Z",
     "historyStartDate": "2019-07-16T21:14:34Z",
     "requestDate": "2019-07-16T21:14:34Z",
     "reportDate": "2019-07-16T21:14:34Z",
     "requestorName": "string",
     "requestorCompanyName": "string",
     "status": 400
 }
    10. GET /v1/accountchekorders/{orderId}/enrollmentWidget
      • Response
      <script language="javascript">
    const iframeId = 'AccountChekIFRAME';
const ready = fn => {
if (document.readyState !== 'loading') fn();
else document.addEventListener('DOMContentLoaded', fn);};
const closeACFrame = event => {
const {data: message } = event;
if (typeof message !== 'string') return;
if (!message.includes('close')) return;
const iframe = document.getElementById(iframeId);
iframe?.parentNode?.removeChild(iframe);
if (typeof AC_Complete === 'function') AC_Complete();};
const baseScriptMain = () => {
window.addEventListener('message', closeACFrame);};
ready(baseScriptMain);
</script>
<div id="frameWrap" style="position:relative; border:0; ">
    <img id="loader1" style=" position:absolute;    left:40%;    top:35%;   padding:25px;" src="https://cdn.accountchek.com/cdn/widget-loader.gif" width="32" height="32" aria-hidden="true"/><iframe
        id="AccountChekIFRAME"
        src="https://redirect.accountchek.net/Account/Login?ssokey=57d450f8-54ae-4f63-9e3f-ae1f00651e97&widget=1"
        style=" height: 100%;    width: 100%;    margin:0;    padding:0;    border:0;"></iframe></div>
<script language="javascript">
    const closeSpinScriptMain = () => {
const iframe = document.getElementById(iframeId);
iframe?.addEventListener('load', () => {
const loader = document.getElementById('loader1');
if (loader) loader.style.visibility = 'hidden';});};
ready(closeSpinScriptMain);
</script>
    11. GET /v1/accountchekorders/{orderId}/ssoURL
      • Response
      {
    "url": "http://example.com"
}
  3. Other SOAP API - The following is a list of report generation calls supported through the SOAP API, each with different parameters. New reports/report refreshes can be accomplished using them.
    1. GenerateReport - This call will asynchronously generate a report for all accounts shared on an order.
      • Request
       <?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>
     <GenerateReport xmlns="http://tempuri.org/">
       <VOD_ID>string</VOD_ID>
     </GenerateReport>
   </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
     <GenerateReportResponse xmlns="http://tempuri.org/">
       <GenerateReportResult>boolean</GenerateReportResult>
     </GenerateReportResponse>
   </soap12:Body>
 </soap12:Envelope>
    2. GenerateReport2 - This call will generate a report and allow you to set a specific daysData history.
      • Request
       <?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>
     <GenerateReport2 xmlns="http://tempuri.org/">
       <VOD_ID>string</VOD_ID>
       <daysData>string</daysData>
       <OverrideTransactionHistory>string</OverrideTransactionHistory>
     </GenerateReport2>
   </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
     <GenerateReport2Response xmlns="http://tempuri.org/">
       <GenerateReport2Result>boolean</GenerateReport2Result>
       <errorMessage>string</errorMessage>
     </GenerateReport2Response>
   </soap12:Body>
 </soap12:Envelope>
    3. GenerateReport3 - Generate a new report for the order – selectable days of data and the ability to pass a custom list of accounts. To retrieve the list of accounts, please see GetAccountInfo.
      • Request
       <?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>
     <GenerateReport3 xmlns="http://tempuri.org/">
       <verificationKey>string</verificationKey>
       <VOD_ID>string</VOD_ID>
       <daysData>string</daysData>
       <fiAccountList>
         <string>string</string>
         <string>string</string>
       </fiAccountList>
       <OverrideTransactionHistory>string</OverrideTransactionHistory>
     </GenerateReport3>
   </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
     <GenerateReport3Response xmlns="http://tempuri.org/">
       <GenerateReport3Result>boolean</GenerateReport3Result>
       <errorMessage>string</errorMessage>
       <reportID>guid</reportID>
     </GenerateReport3Response>
   </soap12:Body>
 </soap12:Envelope>
    4. GenerateReport4 - Generate a new report for the order – selectable days of data, fresh harvest flag, override history flag, and the ability to pass a customer list of accounts. To retrieve the list of accounts, please see GetAccountInfo.
      • Request
       <?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>
     <GenerateReport4 xmlns="http://tempuri.org/">
       <verificationKey>string</verificationKey>
       <VOD_ID>string</VOD_ID>
       <daysData>string</daysData>
       <fiAccountList>
         <string>string</string>
         <string>string</string>
       </fiAccountList>
       <doFreshHarvest>boolean</doFreshHarvest>
       <OverrideTransactionHistory>string</OverrideTransactionHistory>
     </GenerateReport4>
   </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
     <GenerateReport4Response xmlns="http://tempuri.org/">
       <GenerateReport4Result>boolean</GenerateReport4Result>
       <errorMessage>string</errorMessage>
       <reportID>guid</reportID>
     </GenerateReport4Response>
   </soap12:Body>
 </soap12:Envelope>
    5. EndAccountRefresh - Ends Account Refresh Period Early.
      • Request
       <?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>
     <EndAccountRefresh xmlns="http://tempuri.org/">
       <vodid>guid</vodid>
       <bNotifyBorrower>boolean</bNotifyBorrower>
     </EndAccountRefresh>
   </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
     <EndAccountRefreshResponse xmlns="http://tempuri.org/">
       <EndAccountRefreshResult>boolean</EndAccountRefreshResult>
     </EndAccountRefreshResponse>
   </soap12:Body>
 </soap12:Envelope>
    6. CancelVODAOrder - Cancel a specific VOA Order.
      • Request
       <?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>
     <CancelVODAOrder xmlns="http://tempuri.org/">
       <VOD_ID>string</VOD_ID>
       <bArchive>boolean</bArchive>
     </CancelVODAOrder>
   </soap12:Body>
 </soap12:Envelope>
      • Response
       <?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>
     <CancelVODAOrderResponse xmlns="http://tempuri.org/">
       <CancelVODAOrderResult>boolean</CancelVODAOrderResult>
     </CancelVODAOrderResponse>
   </soap12:Body>
 </soap12:Envelope>
Client Testing (CTE) Domains
  • https://verifierapi.accountchek.net
  • https://validatorapi.accountchek.net
Production Domains
  • https://verifierapi.accountchek.com
  • https://validatorapi.accountchek.com
AccountChek Statuses