Document API | Administrative - SOAP

The Document Service provides clients the ability to upload substantiation documents to POS and manual claim transactions.

Service Web Methods

The following is a list of methods that is provided by the Employer Service.

  • SubmitDocument - used to upload a document to a POS and manual claim transactions.
  • SubmitParticipantClaimDocument - used to upload a document to a claim that has not been adjudicated

Service Assumptions/Business Rules

The Employer Service makes the following assumptions as well as enforces the following business rules.

  • Clients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus Technologies and the administrator.
  • Clients shall format SOAP messages in a Document/Literal format over HTTPS.
  • Clients shall have already created a valid user ID and password.
  • Clients shall have a valid session ID after being authenticated by the system. The session ID needs to be passed in the proper manner as described in the Account Manager Service Guide.
  • If the administrator uses the same user ID and password for all of their clients, the administrator is responsible for managing the security of the data.
  • Clients should validate data before submitting a request to this Service. This facilitates better performance and accurate processing on both systems.
  • Clients shall not attempt to use this service for batch processing of large amounts of data. The service is designed for synchronous calls that send or retrieve small chunks of data. If batch processing is required, then the EDI process should be used.
  • If any method fails, the service returns a SOAP fault describing the problem.

SubmitDocument

This method is used to upload a document to a POS and manual claim transactions

History

The SubmitDocument methods are listed below:

Request Messages

  • SubmitDocumentRequest

Response Messages

  • SubmitDocumentResponse

SubmitDocument Request/Response Messages

The SubmitDocument method requires the following request and response messages (input and output data).

The table below includes the following request messages:

  • SubmitDocumentRequest

Request Body

  • EmployeeID String required
    Employee ID associated with POS or manual claim transaction
    First Available Version: SubmitDocumentRequest
  • EmployerId String required
    Employer ID associated with POS or manual claim transaction
    First Available Version: SubmitDocumentRequest
  • FileBase64 String required
    File contents represented as Base64 string
    First Available Version: SubmitDocumentRequest
  • FileName String required
    File name including extension
    First Available Version: SubmitDocumentRequest
  • SettlementDate String required
    Must be in format YYYYMMDD
    First Available Version: SubmitDocumentRequest
  • SettlementSequenceNumber String required
    WCA settlement sequence number associated with POS or manual claim transaction
    First Available Version: SubmitDocumentRequest
  • TpaId String required
    A unique identifer for your administrator instance, generated by WCA when the instance was first set up.
    First Available Version: SubmitDocumentRequest

The table below includes the following request messages:

  • SubmitDocumentResponse

Response Body

  • DocumentID String
    Unique identified for document
    First Available Version: SubmitDocumentResponse
  • FileName String
    Document file name
    First Available Version: SubmitDocumentResponse
  • SettlementDate String
    Settlement date for POS or manual claim transaction
    First Available Version: SubmitDocumentResponse
  • SettlementSequenceNumber String
    Settlement sequence number for POS or manual claim transaction
    First Available Version: SubmitDocumentResponse

Example of a SubmitDocument SOAP request message

Example Request Body 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:mbi="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers"
    xmlns:doc="http://bensoft.metavante.com/WebServices/Services/Document"
    xmlns:ns="http://bensoft.metavante.com/WebServices/Messages/Document/Request/2015/08/">
    <soapenv:Header>
        <mbiSessionHeader>
            <mbi:MBISessionID>jkjn0vedgzzzz3yzoek5001l</mbi:MBISessionID>
        </mbiSessionHeader>
    </soapenv:Header>
    <soapenv:Body>
        <doc:SubmitDocument>
            <doc:request>
                <ns:EmployeeId>EMPLOYEE</ns:EmployeeId>
                <ns:EmployerId>EMPLOYER</ns:EmployerId>
                <ns:FileBase64>/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAIBAQIBAQICAgICAgICAwUDAwMDAwYEBAMFBwYHBwcG
                BwcICQsJCAgKCAcHCg0KCgsMDAwMBwkODw0MDgsMDAz/2wBDAQICAgMDAwYDAwYMCAcIDAwMDAwM
                DAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCACBAWcDASIA
                AhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQA
                AAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3
                ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWm
                p6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEA
                AwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSEx
                BhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElK
                U1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3
                uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD9/KKK
                KACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAoooo
                AKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAoorz39qD9qv4e/sXfBrUviB8UPFOn+EP
                COklEuL+6V5Mu5wkccUatJLIx6JGrMcHA4NTKcYrmk7IcYuTtFXZ6FRXwB/xFG/sKf8ARcv/ACzP
                EH/yDR/xFG/sKf8ARcv/ACzPEH/yDVCPv+ivkD4C/wDBfb9jn9pHUL218N/tAeBrWew8oOniN5/D
                2Wf+h++P/wD4PNI/+VlcWAVShTnT/mcr+ac+dfp812368Y4VqkZ9lH71Hlf6/f3PAP8AiOc/6td/
                8yR/966P+I5z/q13/wAyR/8Aeuvf/wDiCp/ZZ/6H74//APg80j/5WUf8QVP7LP8A0P3x/wD/AAea
                R/8AKytzE9X/AOCJP/BxNYf8FifjT4v8DyfCm4+G+p+GdGTW7eUeIxrMV9F5ywyKx+y25jZTJER9
                4MC33do3fpRXxJ/wS1/4IIfBb/gkh8RvE3iv4dat8QNe1zxRpyaVNP4n1C1ufslusglZYRb20AG9
                ljLFtx/drjb82ftutqrp8sOTe2vrd/pb5mVP2nNPn2vp6WX63P5Df+Dpz/lOH8X/APrhon/pnsq/
                e7/g1u/5QdfBr/f1r/0831UP+ChH/Bsr8AP+CkX7UOsfFvxn4i+K2g+J9ft7aC+i8P6tZQ2cxt4V
                gSTZcWc7K3loina4X5AdoJJP11+w5+xn4Q/4J9/st+FfhH4Ek1ifwz4SjmS1m1W5W4vLhpp5J5ZJ
                XVEUs0krn5UVRnAAArLAP2OBeHn8V4/hzf5o3zB+2xEKkNkl+EOX8z1mv5J/+DsX/lNX4+/7A+jf
                +kEVf1sV+fH/AAUZ/wCDa34B/wDBTX9pS6+KnjbXvij4f8TX9hb2N4nhzVrOG1uhApRJGS4tJyH2
                bVOxlUhAdu4sTyV6MpVac1tFu/zTRtRqRjCpF9VZf+BRf6Gf/wAGp/8AyhJ+GP8A2ENa/wDTnc1+
                i9ePfsG/sR+Df+Cdn7Lnhz4SeA5tbufDfhoztDcavcpcXty807zyPI6IiZLyHhEUAAcV7DXqY2rG
                rWlOG3/APPwtOUKdpb3b+9t/qFFFFcp0BRRRQBx37RH/ACb/AOOf+xev/wD0mkr+HT9k/wD5Om+G
                v/Y1aX/6VxV/df4j8P2nizw9faVfxefY6lbyWlzHuK+ZHIpV1yCCMgkZBBr8sfht/wAGeP7Lnww+
                Lug+L7PxT8a7qXw/q9vq8Gm3WuaebKVoZllWF9lgsxiJUKcSh9vRweaMB+6zBYmfw+5/5LJt/mGN
                /e4GVCPxe9/5Mkl+R+rdFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRR
                QAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFA
                BRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAF
                FFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUU
                UUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAFFFFABRRR
                QAUUUUAFFFFABRRRQAUUUUAFFFFAH//Z</ns:FileBase64>
                <ns:FileName>Receipt.jpg</ns:FileName>
                <ns:SettlementDate>20151026</ns:SettlementDate>
                <ns:SettlementSequenceNumber>30000000</ns:SettlementSequenceNumber>
                <ns:TpaId>T99999</ns:TpaId>
            </doc:request>
        </doc:SubmitDocument>
    </soapenv:Body>
</soapenv:Envelope>

Example of a SubmitDocument SOAP response message:

Example Response Body 
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
     <MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
       <MessageId>urn:uuid:9006138c-d722-4bea-zzzz-0c51d815aae4</MessageId>
    </MBIMessageIdHeader>
  </s:Header>
  <s:Body>
    <SubmitDocumentResponse xmlns="http://bensoft.metavante.com/WebServices/Services/Document">
      <SubmitDocumentResult xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Document/Response/2015/08/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
        <a:DocumentId>f5f9a416dcb443e0009954638df705cc</a:DocumentId>
        <a:FileName>Receipt.jpg</a:FileName>
        <a:SettlementDate>20151026</a:SettlementDate>
        <a:SettlementSequenceNumber>30000000</a:SettlementSequenceNumber>
      </SubmitDocumentResult>
    </SubmitDocumentResponse>
  </s:Body>
</s:Envelope>

Example Client Code

The following is an example of the client code (using a .NET proxy class for accessing the service) used when adding an employer using the SubmitDocument web method.

C# 
try
{
    // Create the session SOAP header in order to pass the Document Service
    // the client’s current session id.
    mbiSessionHeader = new DocumentServiceNameSpace.MBISessionHeader();
    // Create proxy object for the Document Service
    proxy = new DocumentServiceNameSpace.DocumentService();
    // Create request message for method call (input parameters)
    request = new DocumentServiceNameSpace.SubmitDocument();
    // Set the input parameters
    request.EmployeeID = _ EmployeeID.Text;
    request. EmployerID = _ EmployerID.Text;
    request.FileName = _ FileName.Text;
    request.SettlementDate = _ SettlementDate.Text;
    request. SettlementSequenceNumber= _ SettlementSequenceNumber.Text;
    request.TpaId = _tpaId.Text;
    //File data will need to be converted to Base64 prior to this
    request.FileBase64 = _ FileBase64.Text;
    // session ID returned from login method
    mbiSessionHeader.MBISessionID = _sessionId.Text;
    proxy.MBISessionHeaderValue = mbiSessionHeader;
    // Call the method
    response = proxy.SubmitDocument(request);
    MessageBox.Show("Finished.");
}

SubmitParticipantClaimDocument

This method is used to upload a document to a claim that has not been adjudicated.

History

The SubmitParticipantClaimDocument methods are listed below:

Request Messages

  • SubmitParticipantClaimDocumentRequest

Response Messages

  • SubmitParticipantClaimDocumentResponse

SubmitParticipantClaimDocument Request/Response Messages

The SubmitParticipantClaimDocument method requires the following request and response messages (input and output data).

The table below includes the following request messages:

  • SubmitParticipantClaimDocumentRequest

Request Body

  • DocumentID String
    Unique identifier for the document
    First Available Version: SubmitParticipantClaimDocumentRequest
  • FileName String
    Document file name
    First Available Version: SubmitParticipantClaimDocumentRequest
  • SettlementDate String (YYYYMMDD)
    Settlement date for POS or manual claim transaction
    First Available Version: SubmitParticipantClaimDocumentRequest
  • SettlementSequenceNumber String
    Settlement sequence number for POS or manual claim transaction
    First Available Version: SubmitParticipantClaimDocumentRequest

The table below includes the following request messages:

  • SubmitParticipantClaimDocumentResponse

Response Body

  • DocumentID String
    Unique identified for document
    First Available Version: SubmitParticpantClaimDocumentResponse
  • FileName String
    Document file name
    First Available Version: SubmitParticpantClaimDocumentResponse
  • UniqueClaimId String
    Unique identifier for claim.
    First Available Version: SubmitParticpantClaimDocumentResponse

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...