Business Documents
Query parameters
skipintegerOptionalDefault:
0limitintegerOptionalDefault:
100session_idany ofOptional
string · uuidOptional
nullOptional
Responses
200
Successful Response
application/json
session_idstring · uuidRequired
document_typestring · enumRequiredPossible values:
document_numberany ofOptional
stringOptional
nullOptional
document_urlstringRequired
issue_dateany ofOptional
string · dateOptional
nullOptional
expiry_dateany ofOptional
string · dateOptional
nullOptional
ocr_dataany ofOptional
stringOptional
nullOptional
verifiedbooleanOptionalDefault:
falseverification_notesany ofOptional
stringOptional
nullOptional
idstring · uuidRequired
uploaded_atstring · date-timeRequired
422
Validation Error
application/json
get
/business-documents/Body
session_idstring · uuidRequired
document_typestring · enumRequiredPossible values:
document_numberany ofOptional
stringOptional
nullOptional
document_urlstringRequired
issue_dateany ofOptional
string · dateOptional
nullOptional
expiry_dateany ofOptional
string · dateOptional
nullOptional
ocr_dataany ofOptional
stringOptional
nullOptional
verifiedbooleanOptionalDefault:
falseverification_notesany ofOptional
stringOptional
nullOptional
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
/business-documents/Path parameters
document_idstring · uuidRequired
Responses
200
Successful Response
application/json
session_idstring · uuidRequired
document_typestring · enumRequiredPossible values:
document_numberany ofOptional
stringOptional
nullOptional
document_urlstringRequired
issue_dateany ofOptional
string · dateOptional
nullOptional
expiry_dateany ofOptional
string · dateOptional
nullOptional
ocr_dataany ofOptional
stringOptional
nullOptional
verifiedbooleanOptionalDefault:
falseverification_notesany ofOptional
stringOptional
nullOptional
idstring · uuidRequired
uploaded_atstring · date-timeRequired
422
Validation Error
application/json
get
/business-documents/{document_id}Path parameters
document_idstring · uuidRequired
Body
document_numberany ofOptional
stringOptional
nullOptional
issue_dateany ofOptional
string · dateOptional
nullOptional
expiry_dateany ofOptional
string · dateOptional
nullOptional
ocr_dataany ofOptional
stringOptional
nullOptional
verifiedany ofOptional
booleanOptional
nullOptional
verification_notesany ofOptional
stringOptional
nullOptional
Responses
200
Successful Response
application/json
session_idstring · uuidRequired
document_typestring · enumRequiredPossible values:
document_numberany ofOptional
stringOptional
nullOptional
document_urlstringRequired
issue_dateany ofOptional
string · dateOptional
nullOptional
expiry_dateany ofOptional
string · dateOptional
nullOptional
ocr_dataany ofOptional
stringOptional
nullOptional
verifiedbooleanOptionalDefault:
falseverification_notesany ofOptional
stringOptional
nullOptional
idstring · uuidRequired
uploaded_atstring · date-timeRequired
422
Validation Error
application/json
put
/business-documents/{document_id}Last updated