Documents

get/documents

Get all documents

Returns a list of created KYC docs page wise.

pageint

Default: 0

sizeint

Default: 50

Responses

Response examples

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
}

post/documents

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.

imgDatastring

required

metaobject (Meta)

Responses

Request examples

{
  "imgData": "string",
  "meta": {}
}

Response examples

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

Get document by id

Returns a single document according to goven 'doc_id'.

doc_idstring

required

Responses

Response examples

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

post/documents/{doc_id}

Update document by id

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

status

required

An enumeration.

Responses

Request examples

{
  "status": null
}

Response examples

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

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_idstring

required

Responses

Response examples

Successful Response

null