Skip to main content
POST
Validate photo uploads before import

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

program_id
integer
required

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

Body

multipart/form-data
type
enum<string>
required

Required string. Identifies whether files should later attach to recipients or donors.

Available options:
entity,
donor
Example:

"entity"

unique_field
string
required

Required string. Field key used by validation to match file names or CSV data to records.

Example:

"hys_id"

is_profile_photo
enum<string>
required

Required boolean-like value. Indicates whether validated photos should become profile photos during processing.

Available options:
true,
false,
0,
1
Example:

"false"

upload_session_id
string | null

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

Example:

"01HV7W4XW4N8Z3J7A2Y4C9R6K1"

files
file[] | null

Multipart photo uploads required when upload_session_id is not supplied.

Response

Validation job queued.

message
string
Example:

"File validation has been queued."

validation_job_id
integer
Example:

123