V2.3

openapi: 3.0.0 x-jh: publishing: type: Integration stage: prod isPublic: true group: Synergy name: Document Archiving docURL: https://jkhy.github.io/synergyintegration info: version: v2.3 title: SynergyECM Document Filing description: APIs for Cross-Indexing and Refiling contact: email: SynergyOpenAPI@jackhenry.com security: - BearerAuth: [] paths: '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/documents/{UniqueItemId}': patch: tags: - 'Refile, Cross-index and Deletion APIs' description: Refile an existing document in synergy. This allows for changing some of the metadata and/or the index values associated with a document. At lease one property must be supplied. `Update` operationId: storage-documents-update parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: UniqueItemId in: path description: The Synergy unique item id assigned to a document. required: true schema: type: string - name: If-Match in: header description: Enables optimistic updating with ETag schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/json: schema: allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - allOf: - required: - unqiueItemId allOf: - type: object description: Base for result objects that return a document unique item id. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: |- The unique item id for the document that was just created, modified, or queried. This is a resource id that can be used in other API calls. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 - type: object description: Base result object for a refile operation. additionalProperties: false - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '412': description: Precondition Failed<hr> The client has indicated preconditions in its headers which the server does not meet. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string delete: tags: - 'Refile, Cross-index and Deletion APIs' description: Removes an exising document from Synergy. `Delete` operationId: storage-documents-delete parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: UniqueItemId in: path description: The Synergy unique item id assigned to a document. required: true schema: type: string - name: If-Match in: header description: Enables optimistic updating with ETag schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - allOf: - type: object description: Base for result objects that return a document unique item id. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: |- The unique item id for the document that was just created, modified, or queried. This is a resource id that can be used in other API calls. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 - type: object description: Base result object for a delete document operation. additionalProperties: false - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '204': description: 'No Content<hr> There is no content to send for this request, but the headers may be useful.' headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '412': description: Precondition Failed<hr> The client has indicated preconditions in its headers which the server does not meet. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/documents/{UniqueItemId}/crossIndexDocuments': post: tags: - 'Refile, Cross-index and Deletion APIs' description: Storage Documents Crossindexdocuments `Create` operationId: storage-documents-crossIndexDocuments-create parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: UniqueItemId in: path description: The Synergy unique item id assigned to a document. required: true schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/json: schema: allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 required: - cabinetName - typeName - indexes responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - allOf: - required: - unqiueItemId allOf: - type: object description: Base for result objects that return a document unique item id. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: |- The unique item id for the document that was just created, modified, or queried. This is a resource id that can be used in other API calls. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 - type: object description: Base result object for a refile operation. additionalProperties: false - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '204': description: 'Created, No Content<hr> There is no content to send for this request, but the headers may be useful.' headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/documents/{UniqueItemId}/attachments': get: tags: - Document Attachment APIs description: Gets a list of metadata objects describing the Synergy document attachments associated with the given document. operationId: storage-documents-attachments-list parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: UniqueItemId in: path description: The Synergy unique item id assigned to a document. required: true schema: type: string - name: Audience in: query description: 'Optional query parameter. Limits the results to those attachments whose `Audience` field begins with the supplied value. <br>Example: `.../resource?Audience=SEMANTIK`' required: false schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Document attachment info for a given document attachment query. additionalProperties: false required: - Attachments properties: Document: description: Information about the document to which the attachments belong. allOf: - type: object description: Base for result objects that return a document unique item id. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: |- The unique item id for the document that was just created, modified, or queried. This is a resource id that can be used in other API calls. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 Attachments: type: array description: An array of attachment info for a given document. items: type: object description: Information about a Synergy document attachment. additionalProperties: false required: - AttachmentId - Audience - DataType - DataSize properties: AttachmentId: type: string description: The UUID of the Synergy document attachment. format: uuid minLength: 1 Audience: type: string description: The business use-case for the attachment. minLength: 1 DataType: type: string description: 'The data/file type for the attachment, e.g. `JSON`, `XML`, `TIF`, etc...' minLength: 1 DataSize: type: integer description: The length of the data/file in bytes. format: int32 Description: type: string description: |- Info about the `audience` type. *This will only be populated when the audience is known to Synergy.* nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '304': description: 'Not Modified <hr> The HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a If-None-Match or a If-Modified-Since header.' headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/documents/{UniqueItemId}/attachments/{AttachmentId}/data': get: tags: - Document Attachment APIs description: Storage Documents Attachments `Download` operationId: storage-documents-attachments-download parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: UniqueItemId in: path description: The Synergy unique item id assigned to a document. required: true schema: type: string - name: AttachmentId in: path description: The id of a Synergy document attachment. required: true schema: type: string - name: Range in: header description: 'Http header element that indicates a request for part of a resource. <br> Example: <br>`Range: bytes=<range-start>-<range-end>`' example: bytes=0-999 schema: type: string example: bytes=0-999 - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/octet-stream: schema: type: string format: binary '206': description: 'The HTTP 206 Partial Content success status response code indicates that the request has succeeded and the body contains the requested ranges of data, as described in the `Range` header of the request.' headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/octet-stream: schema: type: string format: binary '304': description: 'Not Modified <hr> The HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a If-None-Match or a If-Modified-Since header.' headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/synergyInstitutions': get: tags: - Storage CTI APIs description: Storage Synergyinstitutions `List` <br> Gets a list of all Synergy defined institutions that are available for the current storage scope. operationId: storage-synergyInstitutions-list parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result object for a Synergy instition query. additionalProperties: false properties: SynergyInstitutionNames: type: array description: 'An array of institution names, as defined in Synergy.' example: - '01' - '02' items: type: string Paging: description: Paging information about the result set. nullable: true allOf: - type: object description: Paging information. additionalProperties: false properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '304': description: 'Not Modified <hr> The HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a If-None-Match or a If-Modified-Since header.' headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/cabinets': get: tags: - Storage CTI APIs description: 'Storage Cabinets `List` <br> Gets a list of all cabinets for the current storage scope. If the SynergyInstitutionName is not specified, the returned list is for all accessible institutions.' operationId: storage-cabinets-list parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: SynergyInstitutionName in: query description: 'The name of an insitution, as defined in Synergy. Note that this is typically not the same as `InstitutionId`.' required: false schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result object for a cabinets query. additionalProperties: false properties: CabinetNames: type: array description: 'An array of cabinet names, as defined in Synergy.' example: - INVOICES - LOANS items: type: string Paging: description: Paging information about the result set. nullable: true allOf: - type: object description: Paging information. additionalProperties: false properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '304': description: 'Not Modified <hr> The HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a If-None-Match or a If-Modified-Since header.' headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/cabinets/{CabinetName}/types': get: tags: - Storage CTI APIs description: 'Storage Cabinets Types `List` <br> Get a list of document types that have been assigned to the given cabinet and storage scope. If the SynergyInstitutionName is not specified, the returned list is for all accessible institutions.' operationId: storage-cabinets-types-list parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: CabinetName in: path description: A Synergy defined cabinet name. required: true schema: type: string - name: SynergyInstitutionName in: query description: 'The name of an insitution, as defined in Synergy. Note that this is typically not the same as `InstitutionId`.' required: false schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result object for a document types query. additionalProperties: false properties: TypeNames: type: array description: 'An array of document type names, as defined in Synergy.' example: - AUTO APPLICATION - SHIPPING INVOICE items: type: string Paging: description: Paging information about the result set. nullable: true allOf: - type: object description: Paging information. additionalProperties: false properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '304': description: 'Not Modified <hr> The HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a If-None-Match or a If-Modified-Since header.' headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/cabinets/{CabinetName}/types/{TypeName}/indexes': get: tags: - Storage CTI APIs description: 'Storage Cabinets Types Indexes `List` <br> Gets a list of index definitions that have been assigned to the given document type and storage scope. If the SynergyInstitutionName is not specified, the returned list is for all accessible institutions.' operationId: storage-cabinets-types-indexes-list parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: CabinetName in: path description: A Synergy defined cabinet name. required: true schema: type: string - name: TypeName in: path description: A Synergy defined document type name. required: true schema: type: string - name: SynergyInstitutionName in: query description: 'The name of an insitution, as defined in Synergy. Note that this is typically not the same as `InstitutionId`.' required: false schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result object for an indexes query. additionalProperties: false properties: Indexes: type: array description: 'An array of index metadata, as defined in Synergy.' items: allOf: - type: object description: Basic information for a Synergy index. additionalProperties: false required: - IndexName - IndexType properties: IndexName: type: string description: |- The name of the index, as defined in Synergy. This will be used in the index assignment. maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexType: type: string description: |- The Synergy data type for the given index. Note that all index assignments should be provided as string values, regardless of the underlying type. maxLength: 20 minLength: 1 example: Numeric IsMultiValue: type: boolean description: |- If true, this index supports multiple assigned values. Otherwise, only a single value can be specified for each index assignment. example: false Length: type: integer description: The maximum value length for the index. format: int32 example: 10 - type: object description: |- Information about an index defined in Synergy including smart indexing info relevant to a given set of classifiers (institution, cabinet, type). additionalProperties: false properties: IsRequired: type: boolean description: |- This is a required index. An error will result if no value is assigned. IsSmartIndexLookup: type: boolean description: |- This index can be used as a Smart Index lookup key. If 'UseForSmartIndexLookup' is specified in the index assignment, Synergy will attempt to automatically populate other index values where 'HasSmartIndexMapping' is true. HasSmartIndexMapping: type: boolean description: |- This index is mapped in the smart index lookup table. See 'IsSmartIndexLookup' for more details. Paging: description: Paging information about the result set. nullable: true allOf: - type: object description: Paging information. additionalProperties: false properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '304': description: 'Not Modified <hr> The HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a If-None-Match or a If-Modified-Since header.' headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/archiveTransactions': post: tags: - Document Archiving APIs description: | ### Begin Archive Transaction Begins an archive transaction for the purpose of importing a new document into Synergy. All metadata for the document is supplied at this stage. File(s) data is provided in subsequent operations, in one of two modes: *ad hoc* or *pre-registered*. - Ad hoc <br> If no file information is provided in this call, then one or more files can be uploaded to the ".../files" collection before the the archive transaction is committed. - Pre-registered <br> An array of file names with their respective sizes can be provided on this initial call. If so, an array of *file Ids* will be returned, and files may then be uploaded (in chunks if necessary) to the .../files/{fileId} route. File data for *all* file Ids must be uploaded prior to committing the archive transaction. Note that the two methods of uploading files are not interchangeable. It is an error to call the ad hoc route when files were pre-registered in the initial call. Finally, after the file(s) data is uploaded, the archive transaction must be committed before it will be filed into Synergy. Upon a successful commit, a unique item Id is returned, and the document is available for immediate retrieval in Synergy. operationId: storage-archiveTransactions-create parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/json: schema: allOf: - allOf: - allOf: - allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 - type: object description: Information for a document filing job. additionalProperties: false properties: OpenVocabularyName: type: string description: |- The optional name of a Synergy Open Vocabulary mapping. If provided, the mapping will be used to map user defined cab, type, and index names to Synergy defined names. maxLength: 80 minLength: 0 nullable: true example: Custom Vocab - type: object description: The document classification and associated index values. additionalProperties: false properties: UseForSmartIndexing: type: array description: |- If the index names in this array are configured in Synergy as Smart Index lookup keys, Synergy will attempt to populate other indexes based on these values. e.g. An account number index value may be used to look up the value of a customer name index. The name(s) in this array, if any, must also be present in the indexes array. maxItems: 100 nullable: true example: - ACCOUNT NUMBER items: type: string maxLength: 80 - type: object description: The document classification and associated index values. additionalProperties: false properties: Files: type: array description: |- Information about the set of files to be uploaded as part of the transaction. If this property is provided, an array of file IDs will be returned in the response. These file IDs can be used in subsequent upload operations for this transaction. Only use this property if the sizes of the files are known ahead of time. maxItems: 100 nullable: true items: allOf: - type: object description: Basic information about a file to be uploaded. additionalProperties: false required: - FileName - FileType - FileSize properties: FileName: type: string description: |- An identifying name for the given file. This value must be unique withing the containing array. maxLength: 256 minLength: 1 FileType: type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' maxLength: 16 minLength: 1 FileSize: type: integer description: 'The size, in bytes, of the given file.' format: int64 maximum: 9223372036854780000 minimum: 1 - type: object description: Basic information about a file to be uploaded. These properties are exclusive to Archive Transactions. additionalProperties: false properties: IsAttachment: type: boolean description: |- If true, this indicates the file should be treated as an attachment, and not part of the page data. There are limited use-cases for this feature, and it should be used only when required. nullable: true AttachmentAudience: type: string description: |- This specifies the use-case for the given attachment. This must be provided for an attachment and must match a predefined value. maxLength: 32 minLength: 0 nullable: true required: - CabinetName - TypeName - Indexes responses: '201': description: Created<hr> The HTTP 201 Created success status response code indicates that the request has succeeded and has led to the creation of a resource. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result object returned after successfully beginning an archive transaction. additionalProperties: false required: - DocumentTransactionId properties: DocumentTransactionId: type: string description: |- The ID for the newly created transaction. Note that this is not the Synergy document ID that will be produced on a successful commit. format: uuid minLength: 1 example: d73da8b1-9dfc-ec11-a292-3cf011584417 FileResponse: type: array description: |- An array of file Ids that have been assigned to file names provided when creating the transaction. maxItems: 100 nullable: true items: type: object description: |- File Ids (associated by FileName) for each file to be uploaded as part of the transaction. additionalProperties: false required: - FileId - FileName properties: FileId: type: string description: The file's id that the caller must be provide when uploading file data. format: uuid minLength: 1 FileName: type: string description: 'The name of the file, as it was provided when beginning the transaction.' maxLength: 265 minLength: 1 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/archiveTransactions/{TransactionId}/files': put: tags: - Document Archiving APIs description: | ### Add Archive File (Ad hoc) Adds a new file to a previously created archive transaction. This route is intended for simple uploading of small files in a single operation. Use it when adding files to a document where file info was not pre-registered in the `Files` property of the document's metadata. If a file Id was acquired when beginning the archive transaction, *do not* use this route to upload it. Instead, use the ".../files/{fileId}" route. One of the following parameters is required when calling this route to determine a file's type: - The `Filename` query parameter, from which the file extension will be used. - The `Content-Type` header, which will be coerced into a file extension. The above is used to determine if the file type (by extension) has been configured in Synergy's upload allow list. If both are provided, the filename extension takes precedence. If neither is provided, or the extension is not in the allow list, an error will result. operationId: storage-archiveTransactions-files parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: DocumentTransactionId in: path description: The id for the document transaction. required: true schema: type: string - name: Content-Type description: 'The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.' in: header required: true schema: type: string default: application/json - name: Content-Range in: header description: 'Http header element that indicates where, in a full body message, a partial message belongs. <br>Example: `Content-Range: bytes <range-start>-<range-end>/<size>`' example: bytes 0-999/* schema: type: string example: bytes 0-999/* - name: Content-Length in: header description: Http header element that indicates the length expressed in bytes. required: true schema: type: integer - name: Digest in: header description: 'If this header is supplied when uploading file data, it will be used for server-side validation, and result in an error if it does not match the received file data. On success, the computed sha-256 digest is always returned in the Digest response header for client-side validation. <br>Syntax: sha&#x2011;256=&lt;base64 encoded digest value>' schema: type: string example: sha-256=w/dKgvrrVRYW940bJibUmhAGb9MTS/74vs8vHabD+V0= - name: If-Match in: header description: Enables optimistic updating with ETag schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' - name: Filename in: query description: 'A filename (no path) *including* the file''s extension. <br>Example: `.../resource?Filename=invoice.pdf`' required: false schema: type: string requestBody: content: application/octet-stream: schema: type: string format: binary responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: ETag: description: Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string default: application/json X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '412': description: Precondition Failed<hr> The client has indicated preconditions in its headers which the server does not meet. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '428': description: Precondition Required<hr> The origin server requires the request to be conditional. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/archiveTransactions/{TransactionId}/files/{FileId}': put: tags: - Document Archiving APIs description: | ### Add Archive File (Pre-registered) Adds data to a file that was previously declared when creating an archive transaction. The file Id in the route is obtained from the `FileResponse` array that is returned when creating the archive transaction with pre-registered file info (the `Files` array property). It is possible to upload partial data, such that a single file can be divided and uploaded over multiple calls. However, the back-end implementation requires that data be uploaded synchronously in consecutive chunks. i.e., you cannot upload two halves of a given file in two concurrent calls. Data arriving out of order will result in an error. If the Content-Range header is present, it must be expressed in bytes. <br>Example: `Content-Range: bytes 0-10000/50000` operationId: storage-archiveTransactions-files-append parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: DocumentTransactionId in: path description: The id for the document transaction. required: true schema: type: string - name: FileId in: path description: 'A file id returned when the archive transaction was created, that corresponds to the filename being uploaded.' required: true schema: type: string - name: Content-Type description: 'The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.' in: header required: true schema: type: string default: application/json - name: Content-Range in: header description: 'Http header element that indicates where, in a full body message, a partial message belongs. <br>Example: `Content-Range: bytes <range-start>-<range-end>/<size>`' example: bytes 0-999/* schema: type: string example: bytes 0-999/* - name: Content-Length in: header description: Http header element that indicates the length expressed in bytes. required: true schema: type: integer - name: Digest in: header description: 'If this header is supplied when uploading file data, it will be used for server-side validation, and result in an error if it does not match the received file data. On success, the computed sha-256 digest is always returned in the Digest response header for client-side validation. <br>Syntax: sha&#x2011;256=&lt;base64 encoded digest value>' schema: type: string example: sha-256=w/dKgvrrVRYW940bJibUmhAGb9MTS/74vs8vHabD+V0= - name: If-Match in: header description: Enables optimistic updating with ETag schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/octet-stream: schema: type: string format: binary responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: ETag: description: Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string default: application/json X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '412': description: Precondition Failed<hr> The client has indicated preconditions in its headers which the server does not meet. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '428': description: Precondition Required<hr> The origin server requires the request to be conditional. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/archiveTransactions/{TransactionId}/state': post: tags: - Document Archiving APIs description: | ### Commit or Rollback Archive Transaction If successfully committed, a unique item Id is returned for a new document that has just been filed in to Synergy, and is available for retrieval. If the transaction is rolled back, the archive transaction, along with any files that have been uploaded for it, are deleted. In either case, the archive transaction is removed and the archive transaction Id becomes invalid. operationId: storage-archiveTransactions-state-create parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: DocumentTransactionId in: path description: The id for the document transaction. required: true schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/json: schema: type: object properties: state: type: string enum: - Commit - Rollback description: |- Change the state of the archive transaction to `Commit` to create a new document in Synergy with the associated files, or `Rollback` to cancel the archive transaction and delete any uploaded files. After a successful call, the archive transaction ID will no longer be valid, regardless of the operation. required: - state responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object properties: uniqueItemId: type: string description: The unique id of the new Synergy document. example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string required: - UniqueItemId` '201': description: Created<hr> The HTTP 201 Created success status response code indicates that the request has succeeded and has led to the creation of a resource. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object properties: uniqueItemId: type: string description: The unique id of the new Synergy document. example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string required: - UniqueItemId` '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/batchtransactions': post: tags: - Batch Creation APIs description: | ### Begin Batch Transaction Begins a batch transaction for the purpose of submitting one or more documents into Synergy for subsequent processing by Synergy Capture. One or more document definitions must be added in subsequent calls, along with subsequent calls to upload file data for each document. Finally, after the file(s) data is uploaded, the batch transaction must be committed before it will be used to create a new Synergy batch. Upon a successful commit, a batch GUID is returned, and the batch is available for subsequent processing in Synergy Capture. operationId: storage-batchtransactions-create parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/json: schema: allOf: - type: object description: Information used when creating a Synergy document batch. additionalProperties: false properties: BatchName: type: string description: |- The optional name that the batch will have, once submitted. This property is descriptive only, and will not impact batch processing. maxLength: 80 nullable: true BatchTemplateName: type: string description: |- The name of the batch template to use when creating a batch. If not specified, the default batch template will be used. Batch templates are defined in Synergy Capture. maxLength: 80 nullable: true BatchRoutingStep: description: |- Optional action to take when the batch transaction is committed. The default, if not specified, is `Acquire`. If the disposition is other than `Acquire`, it must be compatible with the 'steps' defined in the batch template referenced by `BatchTemplateName`. nullable: true allOf: - type: string description: Impacts the action that will be taken once the archive transaction has been committed. x-enumNames: - Acquire - Clean - Index - Ocr - Review - File enum: - Acquire - Clean - Index - Ocr - Review - File responses: '201': description: Created<hr> The HTTP 201 Created success status response code indicates that the request has succeeded and has led to the creation of a resource. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result object returned after successfully beginning a batch transaction. additionalProperties: false required: - BatchTransactionId properties: BatchTransactionId: type: string description: The ID for the newly created batch transaction. format: uuid minLength: 1 example: d73da8b1-9dfc-ec11-a292-3cf011584417 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/batchtransactions/{BatchId}/documents': post: tags: - Batch Creation APIs description: | ### Begin Batch Document Begins a new document definition for the given batch transaction. All metadata for the document is supplied at this stage. File(s) data is provided in subsequent operations, in one of two modes: *ad hoc* or *pre-registered*. - Ad hoc <br> If no file information is provided in this call, then one or more files can be uploaded to the ".../files" collection before the the batch transaction is committed. - Pre-registered <br> An array of file names with their respective sizes can be provided on this initial call. If so, an array of *file Ids* will be returned, and files may then be uploaded (in chunks if necessary) to the ".../files/{fileId}" route. File data for *all* file Ids must be uploaded prior to committing the archive transaction. Note that the two methods of uploading files are not interchangeable. It is an error to call the ad hoc route when files were pre-registered in the initial call. operationId: storage-batchtransactions-documents-create parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: BatchTransactionId in: path description: The id for the batch transaction. required: true schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/json: schema: allOf: - allOf: - allOf: - allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 - type: object description: Information for a document filing job. additionalProperties: false properties: OpenVocabularyName: type: string description: |- The optional name of a Synergy Open Vocabulary mapping. If provided, the mapping will be used to map user defined cab, type, and index names to Synergy defined names. maxLength: 80 minLength: 0 nullable: true example: Custom Vocab - type: object description: The document classification and associated index values. additionalProperties: false properties: UseForSmartIndexing: type: array description: |- If the index names in this array are configured in Synergy as Smart Index lookup keys, Synergy will attempt to populate other indexes based on these values. e.g. An account number index value may be used to look up the value of a customer name index. The name(s) in this array, if any, must also be present in the indexes array. maxItems: 100 nullable: true example: - ACCOUNT NUMBER items: type: string maxLength: 80 - type: object description: The document classification and associated index values. additionalProperties: false properties: Files: type: array description: |- Information about the set of files to be uploaded as part of the transaction. If this property is provided, an array of file IDs will be returned in the response. These file IDs can be used in subsequent upload operations for this transaction. Only use this property if the sizes of the files are known ahead of time. nullable: true items: type: object description: Basic information about a file to be uploaded. additionalProperties: false required: - FileName - FileType - FileSize properties: FileName: type: string description: |- An identifying name for the given file. This value must be unique withing the containing array. maxLength: 256 minLength: 1 FileType: type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' maxLength: 16 minLength: 1 FileSize: type: integer description: 'The size, in bytes, of the given file.' format: int64 maximum: 9223372036854780000 minimum: 1 required: - CabinetName - TypeName - Indexes responses: '201': description: Created<hr> The HTTP 201 Created success status response code indicates that the request has succeeded and has led to the creation of a resource. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result object returned after successfully beginning an archive transaction. additionalProperties: false required: - DocumentTransactionId properties: DocumentTransactionId: type: string description: |- The ID for the newly created transaction. Note that this is not the Synergy document ID that will be produced on a successful commit. format: uuid minLength: 1 example: d73da8b1-9dfc-ec11-a292-3cf011584417 FileResponse: type: array description: |- An array of file Ids that have been assigned to file names provided when creating the transaction. maxItems: 100 nullable: true items: type: object description: |- File Ids (associated by FileName) for each file to be uploaded as part of the transaction. additionalProperties: false required: - FileId - FileName properties: FileId: type: string description: The file's id that the caller must be provide when uploading file data. format: uuid minLength: 1 FileName: type: string description: 'The name of the file, as it was provided when beginning the transaction.' maxLength: 265 minLength: 1 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/batchtransactions/{BatchId}/documents/{DocumentId}/crossindexdocuments': post: tags: - Batch Creation APIs description: | ### Add Batch Cross-Index Document This will add a document definition to the batch that references another document in the batch, but with different indexing and classification. No file data should be uploaded for this document, as cross-indexed documents share the file data of their referenced document. operationId: storage-batchtransactions-documents-crossIndexDocuments-create parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: BatchTransactionId in: path description: The id for the batch transaction. required: true schema: type: string - name: DocumentTransactionId in: path description: The id for the document transaction. required: true schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/json: schema: allOf: - allOf: - allOf: - allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 - type: object description: Information for a document filing job. additionalProperties: false properties: OpenVocabularyName: type: string description: |- The optional name of a Synergy Open Vocabulary mapping. If provided, the mapping will be used to map user defined cab, type, and index names to Synergy defined names. maxLength: 80 minLength: 0 nullable: true example: Custom Vocab - type: object description: The document classification and associated index values. additionalProperties: false properties: UseForSmartIndexing: type: array description: |- If the index names in this array are configured in Synergy as Smart Index lookup keys, Synergy will attempt to populate other indexes based on these values. e.g. An account number index value may be used to look up the value of a customer name index. The name(s) in this array, if any, must also be present in the indexes array. maxItems: 100 nullable: true example: - ACCOUNT NUMBER items: type: string maxLength: 80 - type: object description: The document classification and associated index values. additionalProperties: false properties: Files: type: array description: |- Information about the set of files to be uploaded as part of the transaction. If this property is provided, an array of file IDs will be returned in the response. These file IDs can be used in subsequent upload operations for this transaction. Only use this property if the sizes of the files are known ahead of time. maxItems: 100 nullable: true items: allOf: - type: object description: Basic information about a file to be uploaded. additionalProperties: false required: - FileName - FileType - FileSize properties: FileName: type: string description: |- An identifying name for the given file. This value must be unique withing the containing array. maxLength: 256 minLength: 1 FileType: type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' maxLength: 16 minLength: 1 FileSize: type: integer description: 'The size, in bytes, of the given file.' format: int64 maximum: 9223372036854780000 minimum: 1 - type: object description: Basic information about a file to be uploaded. These properties are exclusive to Archive Transactions. additionalProperties: false properties: IsAttachment: type: boolean description: |- If true, this indicates the file should be treated as an attachment, and not part of the page data. There are limited use-cases for this feature, and it should be used only when required. nullable: true AttachmentAudience: type: string description: |- This specifies the use-case for the given attachment. This must be provided for an attachment and must match a predefined value. maxLength: 32 minLength: 0 nullable: true required: - CabinetName - TypeName - Indexes responses: '201': description: Created<hr> The HTTP 201 Created success status response code indicates that the request has succeeded and has led to the creation of a resource. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result object returned after successfully beginning an archive transaction. additionalProperties: false required: - DocumentTransactionId properties: DocumentTransactionId: type: string description: |- The ID for the newly created transaction. Note that this is not the Synergy document ID that will be produced on a successful commit. format: uuid minLength: 1 example: d73da8b1-9dfc-ec11-a292-3cf011584417 FileResponse: type: array description: |- An array of file Ids that have been assigned to file names provided when creating the transaction. maxItems: 100 nullable: true items: type: object description: |- File Ids (associated by FileName) for each file to be uploaded as part of the transaction. additionalProperties: false required: - FileId - FileName properties: FileId: type: string description: The file's id that the caller must be provide when uploading file data. format: uuid minLength: 1 FileName: type: string description: 'The name of the file, as it was provided when beginning the transaction.' maxLength: 265 minLength: 1 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/batchtransactions/{BatchId}/documents/{DocumentId}/files': put: tags: - Batch Creation APIs description: | ### Add Batch Document File (Ad hoc) Adds a new file to a previously created document in the given batch transaction. This route is intended for simple uploading of small files in a single operation. Use it when adding files to a document where file info was not pre-registered in the `Files` property of the document's metadata. If a file Id was acquired when beginning the document, *do not* use this route to upload it. Instead, use the ".../files/{fileId}" route. One of the following parameters is required when calling this route to determine a file's type: - The `Filename` query parameter, from which the file extension will be used. - The `Content-Type` header, which will be coerced into a file extension. The above is used to determine if the file type (by extension) has been configured in Synergy's upload allow list. If both are provided, the filename extension takes precedence. If neither is provided, or the extension is not in the allow list, an error will result. operationId: storage-batchtransactions-documents-files parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: BatchTransactionId in: path description: The id for the batch transaction. required: true schema: type: string - name: DocumentTransactionId in: path description: The id for the document transaction. required: true schema: type: string - name: Content-Type description: 'The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.' in: header required: true schema: type: string default: application/json - name: Content-Range in: header description: 'Http header element that indicates where, in a full body message, a partial message belongs. <br>Example: `Content-Range: bytes <range-start>-<range-end>/<size>`' example: bytes 0-999/* schema: type: string example: bytes 0-999/* - name: Content-Length in: header description: Http header element that indicates the length expressed in bytes. required: true schema: type: integer - name: Digest in: header description: 'If this header is supplied when uploading file data, it will be used for server-side validation, and result in an error if it does not match the received file data. On success, the computed sha-256 digest is always returned in the Digest response header for client-side validation. <br>Syntax: sha&#x2011;256=&lt;base64 encoded digest value>' schema: type: string example: sha-256=w/dKgvrrVRYW940bJibUmhAGb9MTS/74vs8vHabD+V0= - name: If-Match in: header description: Enables optimistic updating with ETag schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' - name: Filename in: query description: 'A filename (no path) *including* the file''s extension. <br>Example: `.../resource?Filename=invoice.pdf`' required: false schema: type: string requestBody: content: application/octet-stream: schema: type: string format: binary responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: ETag: description: Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string default: application/json X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '412': description: Precondition Failed<hr> The client has indicated preconditions in its headers which the server does not meet. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '428': description: Precondition Required<hr> The origin server requires the request to be conditional. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/batchtransactions/{BatchId}/documents/{DocumentId}/files/{FileId}': put: tags: - Batch Creation APIs description: | ### Add Batch Document File (Pre-registered) Adds data to a file that was previously declared when creating a new document for the given batch transaction. The file Id in the route is obtained from the `FileResponse` array that is returned when creating the archive transaction with pre-registered file info (the `Files` array property). It is possible to upload partial data, such that a single file can be divided and uploaded over multiple calls. However, the back-end implementation requires that data be uploaded synchronously in consecutive chunks. i.e., you cannot upload two halves of a given file in two concurrent calls. Data arriving out of order will result in an error. If the Content-Range header is present, it must be expressed in bytes. <br>Example: `Content-Range: bytes 0-10000/50000` operationId: storage-batchtransactions-documents-files-replace parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: BatchTransactionId in: path description: The id for the batch transaction. required: true schema: type: string - name: DocumentTransactionId in: path description: The id for the document transaction. required: true schema: type: string - name: FileId in: path description: 'A file id returned when the archive transaction was created, that corresponds to the filename being uploaded.' required: true schema: type: string - name: Content-Type description: 'The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.' in: header required: true schema: type: string default: application/json - name: Content-Range in: header description: 'Http header element that indicates where, in a full body message, a partial message belongs. <br>Example: `Content-Range: bytes <range-start>-<range-end>/<size>`' example: bytes 0-999/* schema: type: string example: bytes 0-999/* - name: Content-Length in: header description: Http header element that indicates the length expressed in bytes. required: true schema: type: integer - name: Digest in: header description: 'If this header is supplied when uploading file data, it will be used for server-side validation, and result in an error if it does not match the received file data. On success, the computed sha-256 digest is always returned in the Digest response header for client-side validation. <br>Syntax: sha&#x2011;256=&lt;base64 encoded digest value>' schema: type: string example: sha-256=w/dKgvrrVRYW940bJibUmhAGb9MTS/74vs8vHabD+V0= - name: If-Match in: header description: Enables optimistic updating with ETag schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/octet-stream: schema: type: string format: binary responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: ETag: description: Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string default: application/json X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '412': description: Precondition Failed<hr> The client has indicated preconditions in its headers which the server does not meet. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '428': description: Precondition Required<hr> The origin server requires the request to be conditional. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/batchtransactions/{BatchId}/state': post: tags: - Batch Creation APIs description: | ### Commit or Rollback Batch Transaction If successfully committed, a new batch GUID is returned for a new batch that has just been added to Synergy, and is available for subsequent processing in Synergy Capture. If the transaction is rolled back, the batch transaction, along with any files that have been uploaded for it, are deleted. In either case, the batch transaction is removed and the batch transaction Id becomes invalid. operationId: storage-batchtransactions-state-create parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: BatchTransactionId in: path description: The id for the batch transaction. required: true schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/json: schema: type: object properties: State: type: string enum: - Commit - Rollback description: |- Change the state of the batch transaction to `Commit` to create a new batch in Synergy with the associated documents and files, or `Rollback` to cancel the batch transaction and delete any uploaded files. After a successful call, the batch transaction ID will no longer be valid, regardless of the operation. required: - State responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '201': description: Created<hr> The HTTP 201 Created success status response code indicates that the request has succeeded and has led to the creation of a resource. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result object returned after successfully creating a batch. additionalProperties: false required: - BatchId properties: BatchId: type: string description: The Synergy batch ID assigned to the newly created batch. format: uuid minLength: 1 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/documentstatuses': get: tags: - Document Statuses description: Document Statuses `List` <br> Gets a list of document status names as defined in Synergy. operationId: storage-documentstatuses-list parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result for GetDocumentStatues() additionalProperties: false properties: DocumentStatusNames: type: array description: Document Status names as currently defined in Synergy. items: type: string Paging: description: Paging information about the result set. nullable: true allOf: - type: object description: Paging information. additionalProperties: false properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '304': description: 'Not Modified <hr> The HTTP 304 Not Modified client redirection response code indicates that there is no need to retransmit the requested resources. It is an implicit redirection to a cached resource. This happens when the request method is safe, like a GET or a HEAD request, or when the request is conditional and uses a If-None-Match or a If-Modified-Since header.' headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/storage/v2.3/documents/{UniqueItemId}/status': get: tags: - Document Statuses description: Storage Documents Status `Inquiry` operationId: storage-documents-status-inquire parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: UniqueItemId in: path description: The Synergy unique item id assigned to a document. required: true schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string ETag: description: Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string default: application/json content: application/json: schema: allOf: - type: object description: Optional status information for a document. additionalProperties: false properties: DocumentStatusName: type: string description: |- The current status assigned to a given document. This property will only be available if the document has been assigned an explicit status. maxLength: 80 minLength: 0 Version: description: |- Most recent version information for a given document. This property will only be available when Synergy Version Management is enabled. nullable: true allOf: - type: object description: Most recent version information for a given document. additionalProperties: false properties: VersionNumber: type: integer description: The incrementing version number. format: int32 VersionComment: type: string description: Descriptive text relating to the given version. VersionManagementState: type: string description: |- The current version management state of the document. VersionDate: type: string description: The version time stamp. format: date-time UserName: type: string description: The Synergy user who saved the given version. maxLength: 255 minLength: 0 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string post: tags: - Document Statuses description: Storage Documents Status `Create` operationId: storage-documents-status-create parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: UniqueItemId in: path description: The Synergy unique item id assigned to a document. required: true schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' requestBody: content: application/json: schema: allOf: - type: object description: Information for setting a document's status. additionalProperties: false required: - DocumentStatusName properties: DocumentStatusName: type: string description: The status to assign to the document. maxLength: 80 minLength: 0 responses: '201': description: Created<hr> The HTTP 201 Created success status response code indicates that the request has succeeded and has led to the creation of a resource. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result of a successful document status change request. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: The document for which the status has been changed. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 PreviousDocumentStatusName: type: string description: 'The previous document status, if any. Otherwise this will be an empty string.' maxLength: 80 minLength: 0 CurrentDocumentStatusName: type: string description: 'The current document status, if any (this will be empty after clearing a document status).' maxLength: 80 minLength: 0 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string delete: tags: - Document Statuses description: Storage Documents Status `Delete` operationId: storage-documents-status-delete parameters: - name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' - name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD - name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy - name: UniqueItemId in: path description: The Synergy unique item id assigned to a document. required: true schema: type: string - name: If-Match in: header description: Enables optimistic updating with ETag schema: type: string - name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 - name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string - name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 - name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' responses: '200': description: OK<hr> The HTTP 200 OK success status response code indicates that the request has succeeded. <br>A 200 response is cacheable by default. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: allOf: - type: object description: Result of a successful document status change request. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: The document for which the status has been changed. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 PreviousDocumentStatusName: type: string description: 'The previous document status, if any. Otherwise this will be an empty string.' maxLength: 80 minLength: 0 CurrentDocumentStatusName: type: string description: 'The current document status, if any (this will be empty after clearing a document status).' maxLength: 80 minLength: 0 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '400': description: Bad Request<hr> The server could not understand the request due to invalid syntax. headers: X-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string X-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false X-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string X-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string content: application/json: schema: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string '401': description: 'Unauthorized<hr> Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '403': description: 'Forbidden<hr> The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the clients identity is known to the server.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '404': description: 'Not Found<hr> The server can not find the requested resource. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client.' headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '413': description: Request Too Large<hr> Request entity is larger than limits defined by server. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '422': description: Unprocessed<hr> The request was well-formed but was unable to be followed due to semantic errors. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string '500': description: Generic Internal Error<hr> The server has encountered a situation it doesnt know how to handle. headers: X-Request-ID: description: Returned X-Request-ID schema: type: string default: description: Generic Internal Error headers: X-Request-ID: description: Returned X-Request-ID schema: type: string tags: - name: Storage CTI APIs description: Synergy institution and Cabinet/Type/Index Query APIs. <br> Provides access to Synergy metadata and indexes needed for archiving documents into Synergy. - name: Document Archiving APIs description: 'Synergy document archiving (import/filing) APIs. <br> Provides a process for beginning a document archive transaction with all metadata and indexes, adding files to a document in one or multiple calls, and finally commiting the transaction to import the new document into Synergy.' - name: Batch Creation APIs description: 'APIs for creating batches of *pending* Synergy documents. <br> Batches can later be viewed, edited, and submitted in Synergy Capture, or automatically processed by Synergy ADR.' - name: 'Refile, Cross-index and Deletion APIs' description: 'Synergy Refile (edit), Cross-index (cross-reference), and document deletion APIs. <br> Provides the ability to edit an exisiting document''s metadata, or to create a entirely new document definition that references an existing document''s data.' - name: Document Attachment APIs description: 'APIs to list document attachment information, and to retrieve attachment file data. <br> Document attachments are used for special business/workflow cases, and are not visible within Synergy itself.' servers: - url: 'http:/jx-r.jhacorp.com/api' description: Corporate Test Server - url: 'http:/127.0.0.1/api' description: 'Local Mock Server #1' - url: 'http:/127.0.0.1:8080/api' description: 'Local Mock Server #2' components: securitySchemes: BearerAuth: type: http description: OpenIDConnect JWT Token scheme: bearer bearerFormat: JWT parameters: pInstitutionId: name: InstitutionId in: path description: The identification given to an entity / institution. The URL utilizes this Id for routing. A financial Institution might opt to utilize their routing and transit number. required: true schema: type: string default: '000000000' pInstitutionEnvironment: name: InstitutionEnvironment in: path description: 'Institution Environment. This code identifies the processing environment for which the message is intended. Generally, the environment will be PRODuction, however, various other environments may exist. TESTing environments are common.' required: true schema: type: string default: PROD pProductId: name: ProductId in: path description: 'Product Identifier. This code identifies the Product for which the message is intended. Generally, the Product Id will be in the form of Vendor-Product. However, various other Product Ids may exist. <br>Example:`jha-synergy`' required: true schema: type: string example: jha-synergy pResourceId: name: ResourceId in: path description: The identifier to be used as a key to the resource required: true schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 pOffset: name: Offset in: query description: 'The service offset provided by the API provider <br>Example: `.../resource?Offset=value`' schema: type: string default: '0' pCount: name: Count in: query description: 'The count of records requested <br>Example: `.../resource?Count=value`' schema: type: string default: '0' pStatusType: name: StatusType in: path description: The type of status required: true schema: type: string default: '' pFields: name: Fields in: query description: 'The query of fields, comma separated, for get operations. <br>Example: `.../resource?Fields=field1,field2,field3`' schema: type: string example: 'field1,field2,field3' pRestrictions: name: Restrictions in: query description: 'The query of restrictions <br>Example: `.../resource?Restrictions=value`' schema: type: boolean example: true pSort: name: Sort in: query description: 'Indicating the elements used for sorting and direction [asc, desc], comma separated, for operations that retun a list. <br>Example: `.../resource?Sort=field1:direction,field2:direction,field3:direction`' schema: type: string example: '`.../resource?Sort=field1:asc,field2:desc`' pFilter-Basic: name: Filter in: query description: 'Indicating the elements used for filtering and the match value for each element. Filtering reduces the rows returned and therefore Basic Filtering is appropriate to services that return an array of resources. The default operation is "equal" and the default collation rule is "ignore case" <br>Example: `.../resource?filter=address.state:mo,address.county:green)`' schema: type: string example: '`.../resource?Filter=field1:value1,field2:value2`' pFilter: name: Filter in: query description: 'Indicating the elements used for filtering, the operation (type of evaluation), and the value used for evaluation for each element. Filtering reduces the rows returned and therefore Filtering is appropriate to services that return an array of resources. <br>Format of filter object is `element:operator:value` <br>Operators: eq - equal, ne - not equal, lt - less than, gt - greater than, in - in list, con - contains, gte - greater than or equal, lte - less than or equal, sw - starts with, ew - ends with <br>Collation Rule: i - ignore case (add rule to front of operation: ieq, ine, ilt, igt, iin, icon, igte, ilte, isw, iew) <br>Example: `.../resource?filter=address.state:eq:MO,address.county:eq:Green,customer.lastname:isw:hamm`' schema: type: string example: '`.../resource?Filter=field1:op:value1,field2:op:value2`' pAuthorization: name: Authorization in: header description: 'JWT Token. Represents Callers Authentication Token in the form of a JWT generated by a OAuth 2.0 Identity Provider and conforms to the OpenID Connect specification. See [Security section] for other details. <br>Example `Authorization: bearer <GeneratedOidcJwt>`' required: true schema: type: string example: bearer <GeneratedOidcJwt> pDate: in: header name: Date description: 'Standard http header element for date and time. HTTP headers are represented as RFC 7231 Full Dates. <br>Example `Date: Wed, 21 Oct 2015 07:28:00 GMT`' required: true schema: type: string example: 'Wed, 21 Oct 2015 07:28:00 GMT' pContent-Type: name: Content-Type description: 'The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.' in: header required: true schema: type: string default: application/json pETag: name: ETag in: header description: Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string pIf-Match: name: If-Match in: header description: Enables optimistic updating with ETag schema: type: string pIf-Modified-Since: name: If-Modified-Since in: header description: 'The If-Modified-Since request HTTP header makes the request conditional: the server will send back the requested resource, with a 200 status, only if it has been last modified after the given date. If the request has not been modified since, the response will be a 304 without any body; the Last-Modified response header of a previous request will contain the date of last modification. <br>Example: `<day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT`' schema: type: string example: '<day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT' pX-Request-ID: name: X-Request-ID in: header description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 pX-AuditUserId: name: X-AuditUserId in: header description: 'This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information.' schema: type: string example: InigoMontoya pX-AuditDeviceId: name: X-AuditDeviceId in: header description: This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id or address. schema: type: string example: 192.168.0.101 pX-BusinessCorrelationId: name: X-BusinessCorrelationId in: header description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 pX-WorkflowCorrelationId: name: X-WorkflowCorrelationId in: header description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string example: 123e4567-e89b-12d3-a456-426655440000 pX-AuthenticationUserCredential-optional: name: X-AuthenticationUserCredential in: header description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type default is jwt. <br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>`' schema: type: string example: 'jwt:<GeneratedOidcJwt>' pX-AuthenticationProductCredential: name: X-AuthenticationProductCredential in: header description: 'Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Format is `<type> <token>`. Type default is jwt. <br>Example `X-AuthenticationProductCredential: jwt <GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml <Generatedsaml>`' required: true schema: type: string example: 'jwt:<GeneratedOidcJwt>' pX-Correlation-ID: name: X-Correlation-ID in: header required: true description: Correlation ID for communication-based multi-hop message correlation schema: type: string pX-Messages: name: X-Messages in: header description: Indicating messages/faults/errors returned schema: type: boolean default: false pX-Version: name: X-Version in: header description: Indicating version for the management status service schema: type: string default: false pX-FaultOverride: name: X-FaultOverride in: header description: Determines if all faults should be override schema: type: string default: false pContentRange: name: Content-Range in: header description: 'Http header element that indicates where, in a full body message, a partial message belongs. <br>Example: `Content-Range: bytes <range-start>-<range-end>/<size>`' example: bytes 0-999/* schema: type: string example: bytes 0-999/* pRange: name: Range in: header description: 'Http header element that indicates a request for part of a resource. <br> Example: <br>`Range: bytes=<range-start>-<range-end>`' example: bytes=0-999 schema: type: string example: bytes=0-999 pContentLength: name: Content-Length in: header description: Http header element that indicates the length expressed in bytes. required: true schema: type: integer pDigestSHA256: name: Digest in: header description: 'If this header is supplied when uploading file data, it will be used for server-side validation, and result in an error if it does not match the received file data. On success, the computed sha-256 digest is always returned in the Digest response header for client-side validation. <br>Syntax: sha&#x2011;256=&lt;base64 encoded digest value>' schema: type: string example: sha-256=w/dKgvrrVRYW940bJibUmhAGb9MTS/74vs8vHabD+V0= pLanguage: name: Language in: query description: 'Language of request <br>Example: `.../resource?Language=value`' schema: type: string default: en enum: - en - sp - fr - ch pUniqueItemId: name: UniqueItemId in: path description: The Synergy unique item id assigned to a document. required: true schema: type: string pAttachmentId: name: AttachmentId in: path description: The id of a Synergy document attachment. required: true schema: type: string pSynergyInstitutionName: name: SynergyInstitutionName in: query description: 'The name of an insitution, as defined in Synergy. Note that this is typically not the same as `InstitutionId`.' required: false schema: type: string pCabinetName: name: CabinetName in: path description: A Synergy defined cabinet name. required: true schema: type: string pTypeName: name: TypeName in: path description: A Synergy defined document type name. required: true schema: type: string pIndexName: name: IndexName in: path description: A Synergy defined index name. required: true schema: type: string pDocumentTransactionId: name: DocumentTransactionId in: path description: The id for the document transaction. required: true schema: type: string pAudience: name: Audience in: query description: 'Optional query parameter. Limits the results to those attachments whose `Audience` field begins with the supplied value. <br>Example: `.../resource?Audience=SEMANTIK`' required: false schema: type: string pFilename: name: Filename in: query description: 'A filename (no path) *including* the file''s extension. <br>Example: `.../resource?Filename=invoice.pdf`' required: false schema: type: string pFileId: name: FileId in: path description: 'A file id returned when the archive transaction was created, that corresponds to the filename being uploaded.' required: true schema: type: string pBatchTransactionId: name: BatchTransactionId in: path description: The id for the batch transaction. required: true schema: type: string headers: pContent-Range: description: 'Http header element that indicates where, in a full body message, a partial message belongs. <br> Examples: <br>`Content-Range: <unit> <range-start>-<range-end>/<size>` <br>`Content-Range: <unit> <range-start>-<range-end>/*` <br>`Content-Range: <unit> */<size>`' required: true example: bytes 0-1000/* schema: type: string example: bytes 0-1000/* pContent-Type: description: 'The Content-Type entity header is used to indicate the media type of the resource. In responses, a Content-Type header tells the client what the content type of the returned content actually is. In requests, (such as POST or PUT), the client tells the server what type of data is actually sent.' required: true schema: type: string default: application/json pContent-Length: description: Http header element that indicates the length expressed in bytes. required: true schema: type: integer pETag: description: Entity tag used for web cache validation. It provides a mechanism to cache unchanged resources. schema: type: string default: application/json pIf-Match: description: Enables optimistic updating with ETag schema: type: string default: application/json pX-Request-ID: description: 'To support communications level correlation due to some responses only having header data, a round-trip identifier (GUID) will be sent on every call from the consumer and returned by the service provider (or intermediary) regardless of the final disposition of the request/message.' required: true schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440000 pX-AuditUserId: description: 'This is the User Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the user id. It will not be use to authenticate, only audit information.' schema: type: string pX-AuditDeviceId: description: This is the device Id which the consumer would like written to the audit as performing the requested service. It will vary but could be down to the machine id. schema: type: string pX-BusinessCorrelationId: description: The correlation identification as related to business functions and activities. Generally expected to be a GUID. schema: type: string pX-WorkflowCorrelationId: description: The correlation identification as related to workflow functions and activities. Generally expected to be a GUID. schema: type: string pX-AuthenticationUserCredential-optional: description: 'Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT). <br>Example `X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml:<Generatedsaml>`' schema: type: string pX-AuthenticationProductCredential: description: 'Authentication of the Consumer Product Credentials in the form of a JSON Web Token (JWT). Same as "Authorization" jwt unless the message is sent "on-behalf-of" this consumer product. <br>Example `X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example `X-AuthenticationProductCredential: saml:<Generatedsaml>`' required: true schema: type: string pX-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation schema: type: string pX-Messages: description: Indicating messages/faults/errors returned schema: type: boolean default: false pX-Version: description: Indicating version for the management status service schema: type: string default: false pX-FaultOverride: description: Determines if all faults should be override schema: type: string default: false requestBodies: StorageDocumentsUpdateRequest: content: application/json: schema: allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 StorageDocumentsCrossindexdocumentsCreateRequest: content: application/json: schema: allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 required: - cabinetName - typeName - indexes StorageArchivetransactionsCreateRequest: content: application/json: schema: allOf: - allOf: - allOf: - allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 - type: object description: Information for a document filing job. additionalProperties: false properties: OpenVocabularyName: type: string description: |- The optional name of a Synergy Open Vocabulary mapping. If provided, the mapping will be used to map user defined cab, type, and index names to Synergy defined names. maxLength: 80 minLength: 0 nullable: true example: Custom Vocab - type: object description: The document classification and associated index values. additionalProperties: false properties: UseForSmartIndexing: type: array description: |- If the index names in this array are configured in Synergy as Smart Index lookup keys, Synergy will attempt to populate other indexes based on these values. e.g. An account number index value may be used to look up the value of a customer name index. The name(s) in this array, if any, must also be present in the indexes array. maxItems: 100 nullable: true example: - ACCOUNT NUMBER items: type: string maxLength: 80 - type: object description: The document classification and associated index values. additionalProperties: false properties: Files: type: array description: |- Information about the set of files to be uploaded as part of the transaction. If this property is provided, an array of file IDs will be returned in the response. These file IDs can be used in subsequent upload operations for this transaction. Only use this property if the sizes of the files are known ahead of time. maxItems: 100 nullable: true items: allOf: - type: object description: Basic information about a file to be uploaded. additionalProperties: false required: - FileName - FileType - FileSize properties: FileName: type: string description: |- An identifying name for the given file. This value must be unique withing the containing array. maxLength: 256 minLength: 1 FileType: type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' maxLength: 16 minLength: 1 FileSize: type: integer description: 'The size, in bytes, of the given file.' format: int64 maximum: 9223372036854780000 minimum: 1 - type: object description: Basic information about a file to be uploaded. These properties are exclusive to Archive Transactions. additionalProperties: false properties: IsAttachment: type: boolean description: |- If true, this indicates the file should be treated as an attachment, and not part of the page data. There are limited use-cases for this feature, and it should be used only when required. nullable: true AttachmentAudience: type: string description: |- This specifies the use-case for the given attachment. This must be provided for an attachment and must match a predefined value. maxLength: 32 minLength: 0 nullable: true required: - CabinetName - TypeName - Indexes StorageArchivetransactionsFilesReplaceRequest: content: application/octet-stream: schema: type: string format: binary StorageArchivetransactionsStateCreateRequest: content: application/json: schema: type: object properties: state: type: string enum: - Commit - Rollback description: |- Change the state of the archive transaction to `Commit` to create a new document in Synergy with the associated files, or `Rollback` to cancel the archive transaction and delete any uploaded files. After a successful call, the archive transaction ID will no longer be valid, regardless of the operation. required: - state StorageBatchtransactionsCreateRequest: content: application/json: schema: allOf: - type: object description: Information used when creating a Synergy document batch. additionalProperties: false properties: BatchName: type: string description: |- The optional name that the batch will have, once submitted. This property is descriptive only, and will not impact batch processing. maxLength: 80 nullable: true BatchTemplateName: type: string description: |- The name of the batch template to use when creating a batch. If not specified, the default batch template will be used. Batch templates are defined in Synergy Capture. maxLength: 80 nullable: true BatchRoutingStep: description: |- Optional action to take when the batch transaction is committed. The default, if not specified, is `Acquire`. If the disposition is other than `Acquire`, it must be compatible with the 'steps' defined in the batch template referenced by `BatchTemplateName`. nullable: true allOf: - type: string description: Impacts the action that will be taken once the archive transaction has been committed. x-enumNames: - Acquire - Clean - Index - Ocr - Review - File enum: - Acquire - Clean - Index - Ocr - Review - File StorageBatchtransactionsDocumentsCreateRequest: content: application/json: schema: allOf: - allOf: - allOf: - allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 - type: object description: Information for a document filing job. additionalProperties: false properties: OpenVocabularyName: type: string description: |- The optional name of a Synergy Open Vocabulary mapping. If provided, the mapping will be used to map user defined cab, type, and index names to Synergy defined names. maxLength: 80 minLength: 0 nullable: true example: Custom Vocab - type: object description: The document classification and associated index values. additionalProperties: false properties: UseForSmartIndexing: type: array description: |- If the index names in this array are configured in Synergy as Smart Index lookup keys, Synergy will attempt to populate other indexes based on these values. e.g. An account number index value may be used to look up the value of a customer name index. The name(s) in this array, if any, must also be present in the indexes array. maxItems: 100 nullable: true example: - ACCOUNT NUMBER items: type: string maxLength: 80 - type: object description: The document classification and associated index values. additionalProperties: false properties: Files: type: array description: |- Information about the set of files to be uploaded as part of the transaction. If this property is provided, an array of file IDs will be returned in the response. These file IDs can be used in subsequent upload operations for this transaction. Only use this property if the sizes of the files are known ahead of time. nullable: true items: type: object description: Basic information about a file to be uploaded. additionalProperties: false required: - FileName - FileType - FileSize properties: FileName: type: string description: |- An identifying name for the given file. This value must be unique withing the containing array. maxLength: 256 minLength: 1 FileType: type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' maxLength: 16 minLength: 1 FileSize: type: integer description: 'The size, in bytes, of the given file.' format: int64 maximum: 9223372036854780000 minimum: 1 required: - CabinetName - TypeName - Indexes StorageBatchtransactionsDocumentsCrossindexdocumentsCreateRequest: content: application/json: schema: allOf: - allOf: - allOf: - allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 - type: object description: Information for a document filing job. additionalProperties: false properties: OpenVocabularyName: type: string description: |- The optional name of a Synergy Open Vocabulary mapping. If provided, the mapping will be used to map user defined cab, type, and index names to Synergy defined names. maxLength: 80 minLength: 0 nullable: true example: Custom Vocab - type: object description: The document classification and associated index values. additionalProperties: false properties: UseForSmartIndexing: type: array description: |- If the index names in this array are configured in Synergy as Smart Index lookup keys, Synergy will attempt to populate other indexes based on these values. e.g. An account number index value may be used to look up the value of a customer name index. The name(s) in this array, if any, must also be present in the indexes array. maxItems: 100 nullable: true example: - ACCOUNT NUMBER items: type: string maxLength: 80 - type: object description: The document classification and associated index values. additionalProperties: false properties: Files: type: array description: |- Information about the set of files to be uploaded as part of the transaction. If this property is provided, an array of file IDs will be returned in the response. These file IDs can be used in subsequent upload operations for this transaction. Only use this property if the sizes of the files are known ahead of time. maxItems: 100 nullable: true items: allOf: - type: object description: Basic information about a file to be uploaded. additionalProperties: false required: - FileName - FileType - FileSize properties: FileName: type: string description: |- An identifying name for the given file. This value must be unique withing the containing array. maxLength: 256 minLength: 1 FileType: type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' maxLength: 16 minLength: 1 FileSize: type: integer description: 'The size, in bytes, of the given file.' format: int64 maximum: 9223372036854780000 minimum: 1 - type: object description: Basic information about a file to be uploaded. These properties are exclusive to Archive Transactions. additionalProperties: false properties: IsAttachment: type: boolean description: |- If true, this indicates the file should be treated as an attachment, and not part of the page data. There are limited use-cases for this feature, and it should be used only when required. nullable: true AttachmentAudience: type: string description: |- This specifies the use-case for the given attachment. This must be provided for an attachment and must match a predefined value. maxLength: 32 minLength: 0 nullable: true required: - CabinetName - TypeName - Indexes StorageBatchtransactionsStateCreateRequest: content: application/json: schema: type: object properties: State: type: string enum: - Commit - Rollback description: |- Change the state of the batch transaction to `Commit` to create a new batch in Synergy with the associated documents and files, or `Rollback` to cancel the batch transaction and delete any uploaded files. After a successful call, the batch transaction ID will no longer be valid, regardless of the operation. required: - State StorageBatchtransactionsDocumentsFilesReplaceRequest: content: application/octet-stream: schema: type: string format: binary StorageDocumentsStatusCreateRequest: content: application/json: schema: allOf: - type: object description: Information for setting a document's status. additionalProperties: false required: - DocumentStatusName properties: DocumentStatusName: type: string description: The status to assign to the document. maxLength: 80 minLength: 0 schemas: StorageDocumentsUpdateRequest: allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 StorageDocumentsUpdateResponse: allOf: - allOf: - required: - unqiueItemId allOf: - type: object description: Base for result objects that return a document unique item id. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: |- The unique item id for the document that was just created, modified, or queried. This is a resource id that can be used in other API calls. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 - type: object description: Base result object for a refile operation. additionalProperties: false - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageDocumentsDeleteResponse: allOf: - allOf: - type: object description: Base for result objects that return a document unique item id. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: |- The unique item id for the document that was just created, modified, or queried. This is a resource id that can be used in other API calls. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 - type: object description: Base result object for a delete document operation. additionalProperties: false - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageDocumentsCrossindexdocumentsCreateRequest: allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 required: - cabinetName - typeName - indexes StorageDocumentsCrossindexdocumentsCreateResponse: allOf: - allOf: - required: - unqiueItemId allOf: - type: object description: Base for result objects that return a document unique item id. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: |- The unique item id for the document that was just created, modified, or queried. This is a resource id that can be used in other API calls. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 - type: object description: Base result object for a refile operation. additionalProperties: false - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageDocumentsAttachmentsListResponse: allOf: - type: object description: Document attachment info for a given document attachment query. additionalProperties: false required: - Attachments properties: Document: description: Information about the document to which the attachments belong. allOf: - type: object description: Base for result objects that return a document unique item id. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: |- The unique item id for the document that was just created, modified, or queried. This is a resource id that can be used in other API calls. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 Attachments: type: array description: An array of attachment info for a given document. items: type: object description: Information about a Synergy document attachment. additionalProperties: false required: - AttachmentId - Audience - DataType - DataSize properties: AttachmentId: type: string description: The UUID of the Synergy document attachment. format: uuid minLength: 1 Audience: type: string description: The business use-case for the attachment. minLength: 1 DataType: type: string description: 'The data/file type for the attachment, e.g. `JSON`, `XML`, `TIF`, etc...' minLength: 1 DataSize: type: integer description: The length of the data/file in bytes. format: int32 Description: type: string description: |- Info about the `audience` type. *This will only be populated when the audience is known to Synergy.* nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageSynergyinstitutionsListResponse: allOf: - type: object description: Result object for a Synergy instition query. additionalProperties: false properties: SynergyInstitutionNames: type: array description: 'An array of institution names, as defined in Synergy.' example: - '01' - '02' items: type: string Paging: description: Paging information about the result set. nullable: true allOf: - type: object description: Paging information. additionalProperties: false properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageCabinetsListResponse: allOf: - type: object description: Result object for a cabinets query. additionalProperties: false properties: CabinetNames: type: array description: 'An array of cabinet names, as defined in Synergy.' example: - INVOICES - LOANS items: type: string Paging: description: Paging information about the result set. nullable: true allOf: - type: object description: Paging information. additionalProperties: false properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageCabinetsTypesListResponse: allOf: - type: object description: Result object for a document types query. additionalProperties: false properties: TypeNames: type: array description: 'An array of document type names, as defined in Synergy.' example: - AUTO APPLICATION - SHIPPING INVOICE items: type: string Paging: description: Paging information about the result set. nullable: true allOf: - type: object description: Paging information. additionalProperties: false properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageCabinetsTypesIndexesListResponse: allOf: - type: object description: Result object for an indexes query. additionalProperties: false properties: Indexes: type: array description: 'An array of index metadata, as defined in Synergy.' items: allOf: - type: object description: Basic information for a Synergy index. additionalProperties: false required: - IndexName - IndexType properties: IndexName: type: string description: |- The name of the index, as defined in Synergy. This will be used in the index assignment. maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexType: type: string description: |- The Synergy data type for the given index. Note that all index assignments should be provided as string values, regardless of the underlying type. maxLength: 20 minLength: 1 example: Numeric IsMultiValue: type: boolean description: |- If true, this index supports multiple assigned values. Otherwise, only a single value can be specified for each index assignment. example: false Length: type: integer description: The maximum value length for the index. format: int32 example: 10 - type: object description: |- Information about an index defined in Synergy including smart indexing info relevant to a given set of classifiers (institution, cabinet, type). additionalProperties: false properties: IsRequired: type: boolean description: |- This is a required index. An error will result if no value is assigned. IsSmartIndexLookup: type: boolean description: |- This index can be used as a Smart Index lookup key. If 'UseForSmartIndexLookup' is specified in the index assignment, Synergy will attempt to automatically populate other index values where 'HasSmartIndexMapping' is true. HasSmartIndexMapping: type: boolean description: |- This index is mapped in the smart index lookup table. See 'IsSmartIndexLookup' for more details. Paging: description: Paging information about the result set. nullable: true allOf: - type: object description: Paging information. additionalProperties: false properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageArchivetransactionsCreateRequest: allOf: - allOf: - allOf: - allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 - type: object description: Information for a document filing job. additionalProperties: false properties: OpenVocabularyName: type: string description: |- The optional name of a Synergy Open Vocabulary mapping. If provided, the mapping will be used to map user defined cab, type, and index names to Synergy defined names. maxLength: 80 minLength: 0 nullable: true example: Custom Vocab - type: object description: The document classification and associated index values. additionalProperties: false properties: UseForSmartIndexing: type: array description: |- If the index names in this array are configured in Synergy as Smart Index lookup keys, Synergy will attempt to populate other indexes based on these values. e.g. An account number index value may be used to look up the value of a customer name index. The name(s) in this array, if any, must also be present in the indexes array. maxItems: 100 nullable: true example: - ACCOUNT NUMBER items: type: string maxLength: 80 - type: object description: The document classification and associated index values. additionalProperties: false properties: Files: type: array description: |- Information about the set of files to be uploaded as part of the transaction. If this property is provided, an array of file IDs will be returned in the response. These file IDs can be used in subsequent upload operations for this transaction. Only use this property if the sizes of the files are known ahead of time. maxItems: 100 nullable: true items: allOf: - type: object description: Basic information about a file to be uploaded. additionalProperties: false required: - FileName - FileType - FileSize properties: FileName: type: string description: |- An identifying name for the given file. This value must be unique withing the containing array. maxLength: 256 minLength: 1 FileType: type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' maxLength: 16 minLength: 1 FileSize: type: integer description: 'The size, in bytes, of the given file.' format: int64 maximum: 9223372036854780000 minimum: 1 - type: object description: Basic information about a file to be uploaded. These properties are exclusive to Archive Transactions. additionalProperties: false properties: IsAttachment: type: boolean description: |- If true, this indicates the file should be treated as an attachment, and not part of the page data. There are limited use-cases for this feature, and it should be used only when required. nullable: true AttachmentAudience: type: string description: |- This specifies the use-case for the given attachment. This must be provided for an attachment and must match a predefined value. maxLength: 32 minLength: 0 nullable: true required: - CabinetName - TypeName - Indexes StorageArchivetransactionsCreateResponse: allOf: - type: object description: Result object returned after successfully beginning an archive transaction. additionalProperties: false required: - DocumentTransactionId properties: DocumentTransactionId: type: string description: |- The ID for the newly created transaction. Note that this is not the Synergy document ID that will be produced on a successful commit. format: uuid minLength: 1 example: d73da8b1-9dfc-ec11-a292-3cf011584417 FileResponse: type: array description: |- An array of file Ids that have been assigned to file names provided when creating the transaction. maxItems: 100 nullable: true items: type: object description: |- File Ids (associated by FileName) for each file to be uploaded as part of the transaction. additionalProperties: false required: - FileId - FileName properties: FileId: type: string description: The file's id that the caller must be provide when uploading file data. format: uuid minLength: 1 FileName: type: string description: 'The name of the file, as it was provided when beginning the transaction.' maxLength: 265 minLength: 1 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageArchivetransactionsStateCreateRequest: type: object properties: state: type: string enum: - Commit - Rollback description: |- Change the state of the archive transaction to `Commit` to create a new document in Synergy with the associated files, or `Rollback` to cancel the archive transaction and delete any uploaded files. After a successful call, the archive transaction ID will no longer be valid, regardless of the operation. required: - state StorageArchivetransactionsStateCreateResponse: type: object properties: uniqueItemId: type: string description: The unique id of the new Synergy document. example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string required: - UniqueItemId` StorageBatchtransactionsCreateRequest: allOf: - type: object description: Information used when creating a Synergy document batch. additionalProperties: false properties: BatchName: type: string description: |- The optional name that the batch will have, once submitted. This property is descriptive only, and will not impact batch processing. maxLength: 80 nullable: true BatchTemplateName: type: string description: |- The name of the batch template to use when creating a batch. If not specified, the default batch template will be used. Batch templates are defined in Synergy Capture. maxLength: 80 nullable: true BatchRoutingStep: description: |- Optional action to take when the batch transaction is committed. The default, if not specified, is `Acquire`. If the disposition is other than `Acquire`, it must be compatible with the 'steps' defined in the batch template referenced by `BatchTemplateName`. nullable: true allOf: - type: string description: Impacts the action that will be taken once the archive transaction has been committed. x-enumNames: - Acquire - Clean - Index - Ocr - Review - File enum: - Acquire - Clean - Index - Ocr - Review - File StorageBatchtransactionsCreateResponse: allOf: - type: object description: Result object returned after successfully beginning a batch transaction. additionalProperties: false required: - BatchTransactionId properties: BatchTransactionId: type: string description: The ID for the newly created batch transaction. format: uuid minLength: 1 example: d73da8b1-9dfc-ec11-a292-3cf011584417 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageBatchtransactionsDocumentsCreateRequest: allOf: - allOf: - allOf: - allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 - type: object description: Information for a document filing job. additionalProperties: false properties: OpenVocabularyName: type: string description: |- The optional name of a Synergy Open Vocabulary mapping. If provided, the mapping will be used to map user defined cab, type, and index names to Synergy defined names. maxLength: 80 minLength: 0 nullable: true example: Custom Vocab - type: object description: The document classification and associated index values. additionalProperties: false properties: UseForSmartIndexing: type: array description: |- If the index names in this array are configured in Synergy as Smart Index lookup keys, Synergy will attempt to populate other indexes based on these values. e.g. An account number index value may be used to look up the value of a customer name index. The name(s) in this array, if any, must also be present in the indexes array. maxItems: 100 nullable: true example: - ACCOUNT NUMBER items: type: string maxLength: 80 - type: object description: The document classification and associated index values. additionalProperties: false properties: Files: type: array description: |- Information about the set of files to be uploaded as part of the transaction. If this property is provided, an array of file IDs will be returned in the response. These file IDs can be used in subsequent upload operations for this transaction. Only use this property if the sizes of the files are known ahead of time. nullable: true items: type: object description: Basic information about a file to be uploaded. additionalProperties: false required: - FileName - FileType - FileSize properties: FileName: type: string description: |- An identifying name for the given file. This value must be unique withing the containing array. maxLength: 256 minLength: 1 FileType: type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' maxLength: 16 minLength: 1 FileSize: type: integer description: 'The size, in bytes, of the given file.' format: int64 maximum: 9223372036854780000 minimum: 1 required: - CabinetName - TypeName - Indexes StorageBatchtransactionsDocumentsCreateResponse: allOf: - type: object description: Result object returned after successfully beginning an archive transaction. additionalProperties: false required: - DocumentTransactionId properties: DocumentTransactionId: type: string description: |- The ID for the newly created transaction. Note that this is not the Synergy document ID that will be produced on a successful commit. format: uuid minLength: 1 example: d73da8b1-9dfc-ec11-a292-3cf011584417 FileResponse: type: array description: |- An array of file Ids that have been assigned to file names provided when creating the transaction. maxItems: 100 nullable: true items: type: object description: |- File Ids (associated by FileName) for each file to be uploaded as part of the transaction. additionalProperties: false required: - FileId - FileName properties: FileId: type: string description: The file's id that the caller must be provide when uploading file data. format: uuid minLength: 1 FileName: type: string description: 'The name of the file, as it was provided when beginning the transaction.' maxLength: 265 minLength: 1 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageBatchtransactionsDocumentsCrossindexdocumentsCreateRequest: allOf: - allOf: - allOf: - allOf: - allOf: - type: object description: Synergy Classifier properties. additionalProperties: false properties: CabinetName: type: string description: |- A cabinet name under which the document should be classified. This name must be defined in Synergy and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Application name. Example: "LOANS" maxLength: 80 minLength: 0 example: LOANS TypeName: type: string description: |- A document type name under which the document should be classified. This name must be defined in Synergy, must be mapped to the specified cabinet name, and be accessible by your account for storage purposes. Note that this property is also used by the `Report` module for the Report name. maxLength: 80 minLength: 0 example: AUTO APPLICATION SynergyInstitutionName: type: string description: |- The institution name that the document should be assigned to. This name must be defined in Synergy and be accessible by your account for storage purposes. If this property is not provided, Synergy will attempt to determine it, if possible. maxLength: 20 minLength: 0 nullable: true example: '01' - type: object description: Basic document properties for filing. additionalProperties: false properties: DocumentName: type: string description: |- The optional document name. This will default to the type name unless it has been mapped to a different default in Synergy. maxLength: 80 minLength: 0 nullable: true example: Test Document ViewAuthorities: type: array description: |- A list of numerical view authorities for the document. This must be a list of integers between 1 to 9, inclusively and can be one or many. In order to view a document, a user must be assigned one or more of these view authorities. This will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy. maxItems: 9 nullable: true example: - 1 - 3 - 5 - 7 - 9 items: type: integer format: int32 Indexes: type: array description: |- The index names and values to be associated with the document. Note that all of the indexes specified must be assigned to the document's type in Synergy. maxItems: 100 items: type: object description: An index name along with its associated value. additionalProperties: false required: - IndexName properties: IndexName: type: string description: 'The name of the index, as defined in Synergy.' maxLength: 80 minLength: 1 example: ACCOUNT NUMBER IndexValue: type: string description: |- An index value assignment for the document. If the index is defined as multi-value in Synergy, there may be multiple index mapping objects with the same index name, but each with different values. maxLength: 1024 minLength: 0 nullable: true example: 11223344 FolderName: type: string description: Folder name. maxLength: 80 - type: object description: Information for a document filing job. additionalProperties: false properties: OpenVocabularyName: type: string description: |- The optional name of a Synergy Open Vocabulary mapping. If provided, the mapping will be used to map user defined cab, type, and index names to Synergy defined names. maxLength: 80 minLength: 0 nullable: true example: Custom Vocab - type: object description: The document classification and associated index values. additionalProperties: false properties: UseForSmartIndexing: type: array description: |- If the index names in this array are configured in Synergy as Smart Index lookup keys, Synergy will attempt to populate other indexes based on these values. e.g. An account number index value may be used to look up the value of a customer name index. The name(s) in this array, if any, must also be present in the indexes array. maxItems: 100 nullable: true example: - ACCOUNT NUMBER items: type: string maxLength: 80 - type: object description: The document classification and associated index values. additionalProperties: false properties: Files: type: array description: |- Information about the set of files to be uploaded as part of the transaction. If this property is provided, an array of file IDs will be returned in the response. These file IDs can be used in subsequent upload operations for this transaction. Only use this property if the sizes of the files are known ahead of time. maxItems: 100 nullable: true items: allOf: - type: object description: Basic information about a file to be uploaded. additionalProperties: false required: - FileName - FileType - FileSize properties: FileName: type: string description: |- An identifying name for the given file. This value must be unique withing the containing array. maxLength: 256 minLength: 1 FileType: type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' maxLength: 16 minLength: 1 FileSize: type: integer description: 'The size, in bytes, of the given file.' format: int64 maximum: 9223372036854780000 minimum: 1 - type: object description: Basic information about a file to be uploaded. These properties are exclusive to Archive Transactions. additionalProperties: false properties: IsAttachment: type: boolean description: |- If true, this indicates the file should be treated as an attachment, and not part of the page data. There are limited use-cases for this feature, and it should be used only when required. nullable: true AttachmentAudience: type: string description: |- This specifies the use-case for the given attachment. This must be provided for an attachment and must match a predefined value. maxLength: 32 minLength: 0 nullable: true required: - CabinetName - TypeName - Indexes StorageBatchtransactionsDocumentsCrossindexdocumentsCreateResponse: allOf: - type: object description: Result object returned after successfully beginning an archive transaction. additionalProperties: false required: - DocumentTransactionId properties: DocumentTransactionId: type: string description: |- The ID for the newly created transaction. Note that this is not the Synergy document ID that will be produced on a successful commit. format: uuid minLength: 1 example: d73da8b1-9dfc-ec11-a292-3cf011584417 FileResponse: type: array description: |- An array of file Ids that have been assigned to file names provided when creating the transaction. maxItems: 100 nullable: true items: type: object description: |- File Ids (associated by FileName) for each file to be uploaded as part of the transaction. additionalProperties: false required: - FileId - FileName properties: FileId: type: string description: The file's id that the caller must be provide when uploading file data. format: uuid minLength: 1 FileName: type: string description: 'The name of the file, as it was provided when beginning the transaction.' maxLength: 265 minLength: 1 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageBatchtransactionsStateCreateRequest: type: object properties: State: type: string enum: - Commit - Rollback description: |- Change the state of the batch transaction to `Commit` to create a new batch in Synergy with the associated documents and files, or `Rollback` to cancel the batch transaction and delete any uploaded files. After a successful call, the batch transaction ID will no longer be valid, regardless of the operation. required: - State StorageBatchtransactionsStateCreateResponse: allOf: - type: object description: Result object returned after successfully creating a batch. additionalProperties: false required: - BatchId properties: BatchId: type: string description: The Synergy batch ID assigned to the newly created batch. format: uuid minLength: 1 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageDocumentstatusesListResponse: allOf: - type: object description: Result for GetDocumentStatues() additionalProperties: false properties: DocumentStatusNames: type: array description: Document Status names as currently defined in Synergy. items: type: string Paging: description: Paging information about the result set. nullable: true allOf: - type: object description: Paging information. additionalProperties: false properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageDocumentsStatusCreateRequest: allOf: - type: object description: Information for setting a document's status. additionalProperties: false required: - DocumentStatusName properties: DocumentStatusName: type: string description: The status to assign to the document. maxLength: 80 minLength: 0 StorageDocumentsStatusCreateResponse: allOf: - type: object description: Result of a successful document status change request. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: The document for which the status has been changed. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 PreviousDocumentStatusName: type: string description: 'The previous document status, if any. Otherwise this will be an empty string.' maxLength: 80 minLength: 0 CurrentDocumentStatusName: type: string description: 'The current document status, if any (this will be empty after clearing a document status).' maxLength: 80 minLength: 0 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageDocumentsStatusInquireResponse: allOf: - type: object description: Optional status information for a document. additionalProperties: false properties: DocumentStatusName: type: string description: |- The current status assigned to a given document. This property will only be available if the document has been assigned an explicit status. maxLength: 80 minLength: 0 Version: description: |- Most recent version information for a given document. This property will only be available when Synergy Version Management is enabled. nullable: true allOf: - type: object description: Most recent version information for a given document. additionalProperties: false properties: VersionNumber: type: integer description: The incrementing version number. format: int32 VersionComment: type: string description: Descriptive text relating to the given version. VersionManagementState: type: string description: |- The current version management state of the document. VersionDate: type: string description: The version time stamp. format: date-time UserName: type: string description: The Synergy user who saved the given version. maxLength: 255 minLength: 0 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string StorageDocumentsStatusDeleteResponse: allOf: - type: object description: Result of a successful document status change request. additionalProperties: false required: - UniqueItemId properties: UniqueItemId: type: string description: The document for which the status has been changed. maxLength: 256 minLength: 0 example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 PreviousDocumentStatusName: type: string description: 'The previous document status, if any. Otherwise this will be an empty string.' maxLength: 80 minLength: 0 CurrentDocumentStatusName: type: string description: 'The current document status, if any (this will be empty after clearing a document status).' maxLength: 80 minLength: 0 - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string ProblemDetailsResponse: allOf: - type: object properties: MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string MessageStatus: type: object description: '`MessageStatus` is required/expected for non 2xx responses.' properties: ResponseCode: description: The code related to message responses type: string Description: description: The description related to the status code in a human readable format type: string MessageSource: description: The source of the response to a message. This would represent the service provider that carry out the business service for the message type: string MessageSourceResponse: type: object additionalProperties: true Details: description: The array of details as related to a fault response code type: array items: type: object properties: Code: description: The code assigned to a providers statuses type: string Category: description: 'ENUM[Error,Fault,Warning,Overridden] The category assigned to a providers message statuses' type: string Description: description: The description related to the status code in a human readable format type: string Element: description: When an Error or Fault occurs this optional element will contain the element which is causing the condition type: string ElementValue: description: When an Error or Fault occurs this optional element will contain the value of the element which is causing the condition type: string Location: description: This is typically the program that generated the status condition type: string Logs: description: The array of logs as related to a response code type: array items: type: object properties: Store: description: The store that retains log entries type: string Key: description: The key related to a log entry specific to the log store type: string

Please ignore this field