Documents

Download Spec

Get all documents

get /documents

Returns a list of created KYC docs page wise.

page

integer

Default
0

size

integer

Default
50

Response

ExamplesSchema

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
}

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.

imgData

string

required

meta

object (meta)

Response

ExamplesSchema

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"
}

Get document by id

get /documents/{doc_id}

Returns a single document according to goven 'doc_id'.

doc_id

string

required

Response

ExamplesSchema

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"
}

Update document by id

post /documents/{doc_id}

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

status

required

An enumeration.

Response

ExamplesSchema

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"
}

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.

doc_id

string

required

Response

ExamplesSchema

Successful Response

null

Was this page helpful?