Environment:

Documents

Download Spec

Get all documents

get /documents

Returns a list of created KYC docs page wise.

Authentication

API Key ApiKey

page

integer

Default
0

size

integer

Default
50

Responses

Response: application/json

items

array[object (RootUserDocumentResponse)]

required

RootUserDocumentResponse

object (RootUserDocumentResponse)

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

page

integer

required

size

int

required

total

integer

required

Response: application/json

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Create a New document

post /documents

⚠ Only accessible to Partners.

Creates a new kyc document. Only imgData (base64 encoded) is required, but client can also add meta information optinally.

Authentication

API Key ApiKey

application/json

imgData

string

required

meta

object (meta)

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)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Get document by id

get /documents/{doc_id}

Returns a single document according to goven 'doc_id'.

Authentication

API Key ApiKey

doc_id

string

required

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)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Update document by id

post /documents/{doc_id}

Updates status (options are accepted, declined, pending, under_review) only of 'doc_id' document.

Authentication

API Key ApiKey

doc_id

string

required

application/json

status

required

An enumeration.

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)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Request Examples

Download document file

get /documents/{doc_id}/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

API Key ApiKey

doc_id

string

required

Responses

Response: application/json

Response: application/json

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?