Submission

Download schema

POST

https://api.mindox.ai

/v1/api/submission/create

X-API-Key (header)

Request Body

SubmissionCreate

documentType

string · required

customerType

string · required

customerName

string · required

files

string[] · 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

customPrompts

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/v1/api/submission/create

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

Example Request Body

{
  "documentType": "documentType",
  "customerType": "customerType",
  "customerName": "customerName",
  "files": [
    "string"
  ],
  "passwords": "passwords",
  "callbackUrl": "callbackUrl",
  "clientId": "clientId",
  "customPrompts": [
    "string"
  ]
}

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

/v1/api/submission/create/looms

X-API-Key (header)

Request Body

documentType

string · required

customerType

string · required

customerName

string · required

files

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

List of binary file contents

countryCode

string

passwords

string

Optional JSON metadata containing password information for the provided files

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

clientId

string

customPrompts

string[]

Responses

Success

POST/v1/api/submission/create/looms

curl https://api.mindox.ai/v1/api/submission/create/looms \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form 'documentType=documentType' \
  --form 'customerType=customerType' \
  --form 'customerName=customerName' \
  --form 'countryCode=countryCode' \
  --form 'files=string' \
  --form 'passwords=passwords' \
  --form 'clientId=clientId' \
  --form 'customPrompts=string'

Example Request Body

{
  "documentType": "documentType",
  "customerType": "customerType",
  "customerName": "customerName",
  "countryCode": "countryCode",
  "files": [
    "string"
  ],
  "passwords": "passwords",
  "clientId": "clientId",
  "customPrompts": [
    "string"
  ]
}

text

Example Responses

{}

json

application/json

POST

https://api.mindox.ai

/v1/api/submission/create/custom

X-API-Key (header)

Request Body

SubmissionCreateCustom

customerName

string · required

customerType

string · enum · required

Enum values:

INDIVIDUAL

ORGANIZATION

object[] · required

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/v1/api/submission/create/custom

curl https://api.mindox.ai/v1/api/submission/create/custom \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "customerName": "customerName",
  "customerType": "INDIVIDUAL",
  "files": [
    {
      "documentType": "documentType",
      "content": "content",
      "fileName": "fileName",
      "password": "password"
    }
  ],
  "callbackUrl": "callbackUrl",
  "clientId": "clientId"
}'

Example Request Body

{
  "customerName": "customerName",
  "customerType": "INDIVIDUAL",
  "files": [
    {
      "documentType": "documentType",
      "content": "content",
      "fileName": "fileName",
      "password": "password"
    }
  ],
  "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

POST

https://api.mindox.ai

/v1/api/submission/create/classify

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/v1/api/submission/create/classify

curl https://api.mindox.ai/v1/api/submission/create/classify \
  --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

PATCH

https://api.mindox.ai

/v1/api/submission/{submissionId}/document

X-API-Key (header)

path Parameters

submissionId

string · required

Request Body

EntityUpdate

documentType

DocumentType

identifier

string

object

Responses

Success

EntityUpdate

documentType

DocumentType

identifier

string

object

PATCH

https://api.mindox.ai

/v1/api/submission/{submissionId}/profile

X-API-Key (header)

path Parameters

submissionId

string · required

Request Body

ProfileEdit

clientId

string

customerName

string

callbackUrl

string

Responses

Success

ProfileEdit

clientId

string

customerName

string

callbackUrl

string

POST

https://api.mindox.ai

/v1/api/submission/{submissionId}/file/approve

X-API-Key (header)

path Parameters

submissionId

string · required

query Parameters

identifier

string · required

documentType

DocumentType · required

Responses

Success

No data returned

POST

https://api.mindox.ai

/v1/api/submission/{submissionId}/file/reject

X-API-Key (header)

path Parameters

submissionId

string · required

query Parameters

identifier

string · required

documentType

DocumentType · required

Responses

Success

No data returned

GET

https://api.mindox.ai

/v1/api/submission/analysis

X-API-Key (header)

query Parameters

submissionId

string · required

documentType

DocumentType · required

months

integer

startDate

string

endDate

string

orgId

string

Responses

Success

SubmissionReportDataV2

firstDate

string

lastDate

string

object[]

GET/v1/api/submission/analysis

curl 'https://api.mindox.ai/v1/api/submission/analysis?submissionId=<string>&documentType=<string>' \
  --header 'X-API-Key: <api-key>'

Example Responses

{
  "firstDate": "firstDate",
  "lastDate": "lastDate",
  "accounts": [
    {
      "accountBank": "accountBank",
      "accountCurrency": "accountCurrency",
      "accountName": "accountName",
      "accountNumber": "accountNumber",
      "accountStartDate": "accountStartDate",
      "accountEndDate": "accountEndDate",
      "accountStartBalance": 0,
      "accountEndBalance": 0,
      "accountTotalDays": 0,
      "accountTotalTransactions": 0,
      "totals": {
        "totalCredit": 0,
        "totalDebit": 0,
        "dailyAvg": {
          "credit": 0,
          "debit": 0,
          "creditDebitRatio": 0
        },
        "monthlyAvg": {
          "credit": 0,
          "debit": 0,
          "creditDebitRatio": 0
        },
        "isBalanceCorrect": true
      },
      "transactionCodes": {
        "totalCount": 0,
        "totalCredit": 0,
        "totalDebit": 0,
        "codes": [
          {
            "code": "code",
            "credit": 0,
            "debit": 0,
            "count": 0,
            "percentage": 0
          }
        ]
      },
      "transactions": {
        "daily": [
          {
            "date": "date",
            "credit": 0,
            "debit": 0,
            "balance": 0,
            "avgCredit": 0,
            "avgDebit": 0,
            "avgBalance": 0,
            "creditDebitRatio": 0,
            "minBalanceDate": "minBalanceDate",
            "minBalance": 0,
            "maxBalanceDate": "maxBalanceDate",
            "maxBalance": 0,
            "isBalanceCorrect": true
          }
        ],
        "monthly": [
          {
            "date": "date",
            "credit": 0,
            "debit": 0,
            "balance": 0,
            "avgCredit": 0,
            "avgDebit": 0,
            "avgBalance": 0,
            "creditDebitRatio": 0,
            "minBalanceDate": "minBalanceDate",
            "minBalance": 0,
            "maxBalanceDate": "maxBalanceDate",
            "maxBalance": 0,
            "isBalanceCorrect": true
          }
        ]
      }
    }
  ]
}

json

application/json

GET

https://api.mindox.ai

/v1/api/submission/confidence

X-API-Key (header)

query Parameters

submissionId

string · required

documentType

DocumentType · required

Responses

Success

string

GET

https://api.mindox.ai

/v1/api/submission/profile

X-API-Key (header)

query Parameters

submissionId

string · required

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

GET

https://api.mindox.ai

/v1/api/submission/documents

X-API-Key (header)

query Parameters

submissionId

string · required

documentType

DocumentType

Responses

Success

SubmissionDocument[]

SubmissionDocument

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

documentType

DocumentType · required

documentName

string · required

totalPages

integer · int64 · required

totalDocuments

integer · int64 · required

identifier

string

updatedBy

string

updatedAt

string · date-time

completedAt

string · date-time

EntityUpdate/properties/entityUpdates

transformedPath

string

GET

https://api.mindox.ai

/v1/api/submission/files

X-API-Key (header)

query Parameters

submissionId

string · required

documentType

DocumentType

Responses

Success

SubmissionFile[]

SubmissionFile

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

filePath

string · required

fileName

string · required

totalPages

integer · int64 · required

identifier

string

updatedBy

string

updatedAt

string · date-time

completedAt

string · date-time

GET

https://api.mindox.ai

/v1/api/submission/results

X-API-Key (header)

query Parameters

submissionId

string · required

documentType

DocumentType · required

simplified

boolean

Default: true

Responses

Success

SubmissionResult

submissionId

string · required

status

SubmissionStatus · enum · required

Enum values:

DRAFT

PROCESSING

PENDING

IN_REVIEW

COMPLETED

REJECTED

FAILED

results

object · required

GET

https://api.mindox.ai

/v1/api/submission/list/all

X-API-Key (header)

Responses

Success

SubmissionProfile[]

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

GET

https://api.mindox.ai

/v1/api/submission/{submissionId}/validation-data

X-API-Key (header)

path Parameters

submissionId

string · required

Responses

Success

Validation