`/dataAccess/createQueuedDocumentContainer/`¶

The /dataAccess/createQueuedDocumentContainer/ endpoint creates a new document container in a queued state.

From this state, another session can select the container add additional metadata and upload document data.

Request

POST {{server}}/VPE/dataAccess/createQueuedDocumentContainer/
Content-Type: application/json
Tid-Api-Key: xxx-xxx-xx
{
    "DeviceId": "device-id",
    "SessionId": "...",
    "BranchId": "...",
    "ApplicationFlexibleFieldValues": [
        {
            "FlexibleFieldVersionId": "36fda3bf-b6c3-46d7-94f2-8b7b6ae8cd54",
            "FieldValueString": "Software Development and IT Department"
        }
    ],
    "ContainerEventCallbackUrl": "https://www.my-company.co.uk/web-hooks/container-event-callback/",
    "ClientApplicationReference": "MyReference"
}

CreateQueuedDocumentContainerRequest.BranchId¶

= BranchId

Unique identifier of the branch to assign this application to. Any user that is allowed to view scans for the specified branch can select and complete the application.

CreateQueuedDocumentContainerRequest.ClientApplicationReference¶

= ClientApplicationReference

An optional string that can be passed through, that allows for calling clients to add identifying information. This may be useful for the adding of context mapping, or linking your object ID’s to ours. This value will be included in request payload sent to your webhook.

CreateQueuedDocumentContainerRequest.ApplicationFlexibleFieldValues¶

= ApplicationFlexibleFieldValues

List of application-level custom fields that are attached to the application. Default: Empty list.

{
    "ApplicationFlexibleFieldValues": [
        {
            "FlexibleFieldVersionId": "...",
            "FieldValueString": "Software Development and IT Department"
        }
    ]
}

Property	Description
`ApplicationFlexibleFieldValue.FlexibleFieldVersionId`	Flexible field identifier.
`ApplicationFlexibleFieldValue.FieldValueString`	Flexible field value for string values.
`ApplicationFlexibleFieldValue.FieldValueInt`	Flexible field value for integer values.
`ApplicationFlexibleFieldValue.FieldValueDate`	Flexible field values for date values.
`ApplicationFlexibleFieldValue.FieldValueDecimal`	Flexible field values for decimal values.

See also

ApplicationFlexibleFieldValue for more information about application flexible field values.

CreateQueuedDocumentContainerRequest.ContainerEventCallbackUrl¶

= ContainerEventCallbackUrl

An optional property which can be used to link document container to specified callback url.

Note

This will override static address against your account.

CreateQueuedDocumentContainerRequest.ContainerEventCallbackHeaders¶

= ContainerEventCallbackHeaders

An optional property containing a list of headers and values used with callbacks.

{
     "ContainerEventCallbackHeaders": [
         {
             "Header": "Authorization",
             "Value": "..."
         }
     ]
}

Property	Description
`ContainerEventCallbackHeaders.Header`	Header property used with callbacks, following properties allowed: (Authorization).
`ContainerEventCallbackHeaders.Value`	Value of Header property.

Response

{
    "Success": true,
    "Message": "Operation executed successfully.",

    "ContainerId": "..."
}

CreateQueuedDocumentContainerResponse.ContainerId¶

= ContainerId

Unique identifier of the document container that was created on the TrustID cloud.

CreateQueuedDocumentContainerResponse.ClientApplicationReference¶

= ClientApplicationReference

An optional string that can be passed through, that allows for calling clients to add identifying information. This may be useful for the adding of context mapping, or linking your object ID’s to ours. This value will be included in request payload sent to your webhook.

/dataAccess/createQueuedDocumentContainer/¶

`/dataAccess/createQueuedDocumentContainer/`¶