Documents
Download Specpage
integer
- Default
- 0
size
integer
- Default
- 50
ApiKey
Response
Successful Response
{
"items": [
{
"id": "string",
"created": "2023-06-07T17:32:28Z",
"updated": "2023-06-07T17:32:28Z",
"root_user_id": "string",
"status": null,
"filetype": "string",
"file": "string"
}
],
"total": null,
"page": null,
"size": 123
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Not found
Empty response
Validation Error
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
string
required
items
array[object (RootUserDocumentResponse)]
required
RootUserDocumentResponse
object (RootUserDocumentResponse)
id
string
required
created
string
date-time
required
updated
string
date-time
required
root_user_id
string
status
required
An enumeration.
filetype
string
required
file
string
required
total
integer
required
page
integer
required
size
int
required
Create a New document
⚠ Only accessible to Partners.
Creates a new kyc document.
Only imgData (base64 encoded) is required, but client can also add meta information optinally.
imgData
string
required
meta
object (meta)
ApiKey
Request
{
"imgData": "string",
"meta": {}
}Response
Successful Response
{
"id": "string",
"created": "2023-06-07T17:32:28Z",
"updated": "2023-06-07T17:32:28Z",
"root_user_id": "string",
"status": null,
"filetype": "string",
"file": "string"
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Not found
Empty response
Validation Error
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
string
required
id
string
required
created
string
date-time
required
updated
string
date-time
required
root_user_id
string
status
required
An enumeration.
filetype
string
required
file
string
required
doc_id
string
required
ApiKey
Response
Successful Response
{
"id": "string",
"created": "2023-06-07T17:32:28Z",
"updated": "2023-06-07T17:32:28Z",
"root_user_id": "string",
"status": null,
"filetype": "string",
"file": "string"
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Not found
Empty response
Validation Error
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
string
required
id
string
required
created
string
date-time
required
updated
string
date-time
required
root_user_id
string
status
required
An enumeration.
filetype
string
required
file
string
required
Update document by id
Updates status (options are accepted, declined, pending, under_review) only of 'doc_id' document.
status
required
An enumeration.
ApiKey
doc_id
string
required
Request
{
"status": null
}Response
Successful Response
{
"id": "string",
"created": "2023-06-07T17:32:28Z",
"updated": "2023-06-07T17:32:28Z",
"root_user_id": "string",
"status": null,
"filetype": "string",
"file": "string"
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Not found
Empty response
Validation Error
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
string
required
id
string
required
created
string
date-time
required
updated
string
date-time
required
root_user_id
string
status
required
An enumeration.
filetype
string
required
file
string
required
Download document file
Retrieves the pre-signed url from AWS S3 service to download 'document' securely, The return url will have expiry time 3600 seconds.
ℹ Accessible to Partners and Providers companies.
doc_id
string
required
ApiKey
Response
Successful Response
nullEmpty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Not found
Empty response
Validation Error
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
string
required
Was this page helpful?