Documents
Download SpecAuthentication
ApiKey
Responses
Response: application/json
items
array[object (RootUserDocumentResponse)]
required
page
integer
required
size
int
required
total
integer
required
Response: application/json
detail
array[object (ValidationError)]
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.
Authentication
ApiKey
Responses
Response: application/json
created
string
date-time
required
file
string
required
filetype
string
required
id
string
required
root_user_id
string
status
required
An enumeration.
updated
string
date-time
required
Response: application/json
detail
array[object (ValidationError)]
Request Examples
Authentication
ApiKey
Responses
Response: application/json
created
string
date-time
required
file
string
required
filetype
string
required
id
string
required
root_user_id
string
status
required
An enumeration.
updated
string
date-time
required
Response: application/json
detail
array[object (ValidationError)]
Update document by id
Updates status (options are accepted, declined, pending, under_review) only of 'doc_id' document.
Authentication
ApiKey
Responses
Response: application/json
created
string
date-time
required
file
string
required
filetype
string
required
id
string
required
root_user_id
string
status
required
An enumeration.
updated
string
date-time
required
Response: application/json
detail
array[object (ValidationError)]
Request Examples
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.
Authentication
ApiKey
Responses
Response: application/json
Response: application/json
detail
array[object (ValidationError)]
Was this page helpful?