Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Platform Doc Status Inquiry

Enterprise SOAP API > API by Reference > Platform Services > Platform Doc Status Inquiry

Platform Document Status Inquiry

Platform Document Status Inquiry is a jXchange service designed to allow consumers to request document type delivery via OFI instead of jX message payload when image sizes exceed the jX threshold (3MB).

Message Flow

In jXchange, the Platform Document Status Inquiry service uses a typical exchange of MType messages to allow consumers to request document type delivery via OFI instead of jX message payload when image sizes exceed the jX threshold (3 MB).

Primary Request

The consumer forwards the PltfmDocStatInqRq_MType message to the service provider. The message contains the following simple element:

  • PltfmDocStatId

Primary Response

The service provider returns the PltfmDocStatInqRs_MType message to the consumer. The message contains the following simple elements:

  • DocRqStat
  • DocRqStatCmnt
  • OFIFileName
  • PltfmDocStatId

Platform Document Status Inquiry Behavior

The Platform Document Status Inquiry service behavior is as follows.

Platform Document Inquiry returns the document set or individual document requested by the consumer.

The Document Instance Identifier (DocInstcId) is an optional element, as in many cases, there is only one instance of a document. Consider using a default value in this message instead of blank or empty.

Platform Document Inquiry Request (PltfmDocInqRq_MType) Documented Choice

Use (PltfmId) to request new account opening documents after an account has been boarded via PltfmAppAdd. PltfmId returns in PltfmAppAddRs.

Use (TrnRcptId) to request the Notice of Action Taken (NOAT) or other documents defining adverse action. TrnRcptId returns in PltfmEntityValidateRs.

Documented Filter

A consumer submits only the (DocSetCode) to retrieve all documents included in a document set.

Or, the consumer submits DocSetCode, DocId, and DocInstncId to retrieve a single document from a document set.

If OFIRsDlvryType in the request is true, then OFIFileName is provided in the response to tell the consumer how to get their requested document(s).

If documents are not ready to be delivered in the OFI File at the time of the response, then OFIFileName is blank in PltfmDocInqRs and PltfmDocStatId is delivered in the response. This tells the consumer to call PltfmDocStatInq, where they can determine when docs are ready and obtain the OFIFileName when DocRqStat comes back as Cmplt.

When a consumer submits a PltfmDocInq request, the provider has the following options:

  • If Operational File Integration Response Delivery Type (OFIRsDlvryType) is false, the provider can provide the PltfmDocArray (images) if less than 3 MB.
  • If Operational File Integration Response Delivery Type (OFIRsDlvryType) is false and PltfmDocArray (images) exceeds 3 MB, the provider can respond with a fault indicating they cannot support the request because of the message size.
  • If Operational File Integration Response Delivery Type (OFIRsDlvryType) is true, and the Operational File Integration File Name (OFIFileName) is available, the provider can return the (OFIFileName) in the response.
  • If Operational File Integration Response Delivery Type (OFIRsDlvryType) is true and the Operational File Integration File Name (OFIFileName) is not available, the provider returns the Platform Document Status Identifier (PltfmDocStatId) in the response. PltfmDocStatId serves as the service ticket to track delivery of the OFIFileName through a new message PltfmDocStatInq/LnPltfmDocStatInq.

The provider is not bound to deliver a response in the manner requested by the consumer, as the consumer has no knowledge of the size of the document set they are requesting.

The provider publishes Enterprise Event 50030 upon delivery of the OFI File to the OFI processor.

ODI/OFI publishes Enterprise Event 50040 upon verified receipt of the OFI File from data provider.

The consumer listening for 50040 then receives notification that an OFI file is available to them.

Adhere to OFI architectural guidelines.

PltfmDocStatInqRq_MType

PltfmDocStatInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

PltfmDocStatId
The identification to use to find the status of a statement or other document request.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType
Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

PltfmDocStatInqRs_MType

PltfmDocStatInqRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

Note: Use the PltfmDocLoc element to identify the name or location of requested platform documents.
DocRqStatCmnt
A comment related to the status of a statement or other document.
DocRqStat
The statement or other document request status. Canonical values are:
  • Cmplt - Complete
  • Err - Error
  • Proc - Processing
  • Wait - Waiting

The default value is Cmplt.

OFIFileName
The name of the file delivered to OFI.
PltfmDocDlvryCode
The code identifying how platform documents are to be returned to a consumer.
PltfmDocLoc
The location of a document.
PltfmDocStatId
The identification to use to find the status of a statement or other document request.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType
jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The Soap Header Fault error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.
Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Jan 24 2022