Documents
Download Specpage
int
- Default
- 0
size
int
- Default
- 50
ApiKey
Returns a list of created KYC docs page wise.
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": 123,
"page": 123,
"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
int
required
page
int
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
⚠ Only accessible to Partners.
Creates a new kyc document.
Only imgData (base64 encoded) is required, but client can also add meta information optinally.
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"
}
]
}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
detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
string
required
doc_id
string
required
ApiKey
Returns a single document according to goven 'doc_id'.
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"
}
]
}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
detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
string
required
Update document by id
Updates status (options are accepted, declined, pending, under_review) only of 'doc_id' document.
status
required
An enumeration.
doc_id
string
required
ApiKey
Updates status (options are accepted, declined, pending, under_review) only of 'doc_id' document.
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"
}
]
}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
detail
array[object (ValidationError)]
ValidationError
object (ValidationError)
loc
array[Any Of]
required
Any Of
string
int
msg
string
required
type
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
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.
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
- Content Type
- application/json
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?