Skip to main content
POST
Validate document uploads before import

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

type
enum<string>
required

Required path value identifying whether documents will later attach to recipients or donors. Accepted values are entity and donor; invalid values return 422.

Available options:
entity,
donor
program_id
integer
required

Required program ID used to scope validation and later processing for the current client.

Body

multipart/form-data
csv_filename
string
required

Required string. S3 filename of the CSV mapping file.

Example:

"imports/documents.csv"

csv_unique_field_column
number
required

Required numeric zero-based CSV column index containing the unique field value.

Required range: x >= 0
Example:

0

csv_filename_column
number
required

Required numeric zero-based CSV column index containing document filenames.

Required range: x >= 0
Example:

1

csv_permission_column
number
required

Required numeric zero-based CSV column index containing file permissions.

Required range: x >= 0
Example:

2

unique_field
string
required

Required string. Field key used to match each CSV row to a recipient or donor.

Example:

"hys_id"

create_thumbnails
boolean | null

Optional boolean. Requests thumbnail generation during import when applicable.

Example:

false

upload_session_id
string | null

Nullable string. When present, claims files from an import upload session instead of reading multipart files.

Example:

"01HV7W4XW4N8Z3J7A2Y4C9R6K2"

files
file[] | null

Multipart document uploads required when upload_session_id is not supplied.

Response

Document validation job queued.

message
string
Example:

"Document validation has been queued."

validation_job_id
integer
Example:

124