Documents

Enterprise Documents API

SearchServiceRequestFormResponse

object
countinteger(int64)

Number of total documents found matching the search criteria

Example:100

documentsarray[object]
Show Child Parameters
correlationIdstring

Unique ID for correlating requests

Example:123e4567-e89b-12d3-a456-426614174000

Example

ServiceRequestFormDownloadResponse

object
fileExtensionstring

File extension of the document

Example:pdf

formNamestring

Name of the document

Example:NB Application

binaryDatastring

Binary data of the document

Example:wdvb2ekllkk189w0enjansle..

correlationIdstring

Unique ID for correlating requests

Example:123e4567-e89b-12d3-a456-426614174000

Example

ErrorResponse

object
correlationIdstring

Unique ID for correlating requests

Example:123e4567-e89b-12d3-a456-426614174000

messagestring

Response message

Example:No document types found/Invalid request/Access denied for document metadata fetch

statusCodeinteger(int32)

status code

successboolean
errorCodestring

Machine-readable error code, present on timeouts and unhandled errors.

Allowed values:GATEWAY_TIMEOUTDB_TIMEOUTINTERNAL_ERROR

Example