SubmissionV2

Download schema

POST

https://api.mindox.ai

/v2/api/submission/create

X-API-Key (header)

Request Body

SubmissionCreateClassify

customerType

string · required

customerName

string · required

files

SubmissionCreate/properties/files/items[] · application/octet-stream · required

List of binary file contents

passwords

string

Optional JSON metadata containing password information for the provided files

Sample format: {"<file_name>": ""}

callbackUrl

string

clientId

string

employmentType

string

dob

string

nric

string

employerName

string

Responses

Success

SubmissionProfile

submissionId

string · required

createdBy

string · required

createdAt

string · date-time · required

status

SubmissionStatus · enum · required

Enum values:

DRAFT

PROCESSING

PENDING

IN_REVIEW

COMPLETED

REJECTED

FAILED

customerType

SubmissionCreateCustom/properties/customerType · enum · required

Enum values:

INDIVIDUAL

ORGANIZATION

customerName

string · required

totalPages

integer · int64 · required

totalDocuments

integer · int64 · required

identifier

string

updatedBy

string

updatedAt

string · date-time

completedAt

string · date-time

callbackUrl

string

clientId

string

POST/v2/api/submission/create

curl https://api.mindox.ai/v2/api/submission/create \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'customerType=customerType' \
  --form 'customerName=customerName' \
  --form 'files=string' \
  --form 'passwords=passwords' \
  --form 'callbackUrl=callbackUrl' \
  --form 'clientId=clientId' \
  --form 'employmentType=employmentType' \
  --form 'dob=dob' \
  --form 'nric=nric' \
  --form 'employerName=employerName'

Example Request Body

{
  "customerType": "customerType",
  "customerName": "customerName",
  "files": [
    "string"
  ],
  "passwords": "passwords",
  "callbackUrl": "callbackUrl",
  "clientId": "clientId",
  "employmentType": "employmentType",
  "dob": "dob",
  "nric": "nric",
  "employerName": "employerName"
}

text

Example Responses

{
  "identifier": "identifier",
  "submissionId": "submissionId",
  "createdBy": "createdBy",
  "updatedBy": "updatedBy",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "status": "DRAFT",
  "completedAt": "2024-08-25T15:00:00Z",
  "customerType": "INDIVIDUAL",
  "customerName": "customerName",
  "callbackUrl": "callbackUrl",
  "clientId": "clientId",
  "totalPages": 0,
  "totalDocuments": 0
}

json

application/json

POST

https://api.mindox.ai

/v2/api/submission/create/url

X-API-Key (header)

Request Body

documentType

string · required

customerType

string · required

customerName

string · required

object[] · required

List of binary file contents

callbackUrl

string

clientId

string

Responses

Success

SubmissionProfile

submissionId

string · required

createdBy

string · required

createdAt

string · date-time · required

status

SubmissionStatus · enum · required

Enum values:

DRAFT

PROCESSING

PENDING

IN_REVIEW

COMPLETED

REJECTED

FAILED

customerType

SubmissionCreateCustom/properties/customerType · enum · required

Enum values:

INDIVIDUAL

ORGANIZATION

customerName

string · required

totalPages

integer · int64 · required

totalDocuments

integer · int64 · required

identifier

string

updatedBy

string

updatedAt

string · date-time

completedAt

string · date-time

callbackUrl

string

clientId

string

POST/v2/api/submission/create/url

curl https://api.mindox.ai/v2/api/submission/create/url \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "documentType": "documentType",
  "customerType": "customerType",
  "customerName": "customerName",
  "files": [
    {
      "fileUrl": "fileUrl",
      "keyUrl": "keyUrl",
      "filePassword": "filePassword"
    }
  ],
  "callbackUrl": "callbackUrl",
  "clientId": "clientId"
}'

Example Request Body

{
  "documentType": "documentType",
  "customerType": "customerType",
  "customerName": "customerName",
  "files": [
    {
      "fileUrl": "fileUrl",
      "keyUrl": "keyUrl",
      "filePassword": "filePassword"
    }
  ],
  "callbackUrl": "callbackUrl",
  "clientId": "clientId"
}

json

Example Responses

{
  "identifier": "identifier",
  "submissionId": "submissionId",
  "createdBy": "createdBy",
  "updatedBy": "updatedBy",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "status": "DRAFT",
  "completedAt": "2024-08-25T15:00:00Z",
  "customerType": "INDIVIDUAL",
  "customerName": "customerName",
  "callbackUrl": "callbackUrl",
  "clientId": "clientId",
  "totalPages": 0,
  "totalDocuments": 0
}

json

application/json

GET

https://api.mindox.ai

/v2/api/submission/results

X-API-Key (header)

query Parameters

submissionId

string · required

documentType

string

Responses

Success

Validation

mindox Client API

SubmissionV2

Download schema

POST

https://api.mindox.ai

/v2/api/submission/create

X-API-Key (header)

Request Body

SubmissionCreateClassify

customerType

string · required

customerName

string · required

files

SubmissionCreate/properties/files/items[] · application/octet-stream · required

List of binary file contents

passwords

string

Optional JSON metadata containing password information for the provided files

Sample format: {"<file_name>": ""}

callbackUrl

string

clientId

string

employmentType

string

dob

string

nric

string

employerName

string

Responses

Success

SubmissionProfile

submissionId

string · required

createdBy

string · required

createdAt

string · date-time · required

status

SubmissionStatus · enum · required

Enum values:

DRAFT

PROCESSING

PENDING

IN_REVIEW

COMPLETED

REJECTED

FAILED

customerType

SubmissionCreateCustom/properties/customerType · enum · required

Enum values:

INDIVIDUAL

ORGANIZATION

customerName

string · required

totalPages

integer · int64 · required

totalDocuments

integer · int64 · required

identifier

string

updatedBy

string

updatedAt

string · date-time

completedAt

string · date-time

callbackUrl

string

clientId

string

POST/v2/api/submission/create

curl https://api.mindox.ai/v2/api/submission/create \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'customerType=customerType' \
  --form 'customerName=customerName' \
  --form 'files=string' \
  --form 'passwords=passwords' \
  --form 'callbackUrl=callbackUrl' \
  --form 'clientId=clientId' \
  --form 'employmentType=employmentType' \
  --form 'dob=dob' \
  --form 'nric=nric' \
  --form 'employerName=employerName'

Example Request Body

{
  "customerType": "customerType",
  "customerName": "customerName",
  "files": [
    "string"
  ],
  "passwords": "passwords",
  "callbackUrl": "callbackUrl",
  "clientId": "clientId",
  "employmentType": "employmentType",
  "dob": "dob",
  "nric": "nric",
  "employerName": "employerName"
}

text

Example Responses

{
  "identifier": "identifier",
  "submissionId": "submissionId",
  "createdBy": "createdBy",
  "updatedBy": "updatedBy",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "status": "DRAFT",
  "completedAt": "2024-08-25T15:00:00Z",
  "customerType": "INDIVIDUAL",
  "customerName": "customerName",
  "callbackUrl": "callbackUrl",
  "clientId": "clientId",
  "totalPages": 0,
  "totalDocuments": 0
}

json

application/json

POST

https://api.mindox.ai

/v2/api/submission/create/url

X-API-Key (header)

Request Body

documentType

string · required

customerType

string · required

customerName

string · required

object[] · required

List of binary file contents

callbackUrl

string

clientId

string

Responses

Success

SubmissionProfile

submissionId

string · required

createdBy

string · required

createdAt

string · date-time · required

status

SubmissionStatus · enum · required

Enum values:

DRAFT

PROCESSING

PENDING

IN_REVIEW

COMPLETED

REJECTED

FAILED

customerType

SubmissionCreateCustom/properties/customerType · enum · required

Enum values:

INDIVIDUAL

ORGANIZATION

customerName

string · required

totalPages

integer · int64 · required

totalDocuments

integer · int64 · required

identifier

string

updatedBy

string

updatedAt

string · date-time

completedAt

string · date-time

callbackUrl

string

clientId

string

POST/v2/api/submission/create/url

curl https://api.mindox.ai/v2/api/submission/create/url \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "documentType": "documentType",
  "customerType": "customerType",
  "customerName": "customerName",
  "files": [
    {
      "fileUrl": "fileUrl",
      "keyUrl": "keyUrl",
      "filePassword": "filePassword"
    }
  ],
  "callbackUrl": "callbackUrl",
  "clientId": "clientId"
}'

Example Request Body

{
  "documentType": "documentType",
  "customerType": "customerType",
  "customerName": "customerName",
  "files": [
    {
      "fileUrl": "fileUrl",
      "keyUrl": "keyUrl",
      "filePassword": "filePassword"
    }
  ],
  "callbackUrl": "callbackUrl",
  "clientId": "clientId"
}

json

Example Responses

{
  "identifier": "identifier",
  "submissionId": "submissionId",
  "createdBy": "createdBy",
  "updatedBy": "updatedBy",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z",
  "status": "DRAFT",
  "completedAt": "2024-08-25T15:00:00Z",
  "customerType": "INDIVIDUAL",
  "customerName": "customerName",
  "callbackUrl": "callbackUrl",
  "clientId": "clientId",
  "totalPages": 0,
  "totalDocuments": 0
}

json

application/json

GET

https://api.mindox.ai

/v2/api/submission/results

X-API-Key (header)

query Parameters

submissionId

string · required

documentType

string

Responses

Success

Validation