mindox Client API
string · requiredstring · requiredstring · date-time · requiredSubmissionStatus · enum · requiredSubmissionCreateCustom/properties/customerType · enum · requiredstring · requiredinteger · int64 · requiredinteger · int64 · requiredstringstringstring · date-timestring · date-timestringstringstring · requiredstring · requiredstring · date-time · requiredSubmissionStatus · enum · requiredDocumentType · requiredstring · requiredinteger · int64 · requiredinteger · int64 · requiredstringstringstring · date-timestring · date-timestringstring · requiredstring · requiredstring · date-time · requiredSubmissionStatus · enum · requiredstring · requiredstring · requiredinteger · int64 · requiredstringstringstring · date-timestring · date-timestring · requiredSubmissionStatus · enum · requiredobject · requiredstring · requiredstring · requiredstring · requiredstring[] · application/octet-stream · requiredstringstringstringstring[]string · requiredstring · enum · requiredstringstringstring · requiredstring · requiredSubmissionCreate/properties/files/items[] · application/octet-stream · requiredstringstringstringstringstringstringstring
Schemas
SubmissionProfile
submissionIdcreatedBycreatedAtstatusEnum values:
DRAFT
PROCESSING
PENDING
IN_REVIEW
COMPLETED
REJECTED
FAILED
customerTypeEnum values:
INDIVIDUAL
ORGANIZATION
customerNametotalPagestotalDocumentsidentifierupdatedByupdatedAtcompletedAtcallbackUrlclientIdSubmissionDocument
submissionIdcreatedBycreatedAtstatusEnum values:
DRAFT
PROCESSING
PENDING
IN_REVIEW
COMPLETED
REJECTED
FAILED
documentTypedocumentNametotalPagestotalDocumentsidentifierupdatedByupdatedAtcompletedAttransformedPathSubmissionFile
submissionIdcreatedBycreatedAtstatusEnum values:
DRAFT
PROCESSING
PENDING
IN_REVIEW
COMPLETED
REJECTED
FAILED
filePathfileNametotalPagesidentifierupdatedByupdatedAtcompletedAtSubmissionResult
submissionIdstatusEnum values:
DRAFT
PROCESSING
PENDING
IN_REVIEW
COMPLETED
REJECTED
FAILED
resultsSubmissionCreate
documentTypecustomerTypecustomerNamefilesList of binary file contents
passwordsOptional JSON metadata containing password information for the provided files
Sample format: {"<file_name>": "
callbackUrlclientIdcustomPromptsSubmissionCreateCustom
customerNamecustomerTypeEnum values:
INDIVIDUAL
ORGANIZATION
object[] · required
callbackUrlclientIdSubmissionCreateClassify
customerTypecustomerNamefilesList of binary file contents
passwordsOptional JSON metadata containing password information for the provided files
Sample format: {"<file_name>": "
callbackUrlclientIdemploymentTypedobnricemployerName