Documents

Download Spec

Get all documents

get /documents

Returns a list of created KYC docs page wise.

API Key ApiKey

page

integer

Default
0

size

integer

Default
50

Response

Examples Schema

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
}

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

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

integer

required

page

integer

required

size

int

required

No schema

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.

API Key ApiKey

imgData

string

required

meta

object (meta)

Request

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

Response

Examples Schema

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

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

No schema

detail

array[object (ValidationError)]

ValidationError

object (ValidationError)

loc

array[Any Of]

required

Any Of

string

int

msg

string

required

type

string

required

Get document by id

get /documents/{doc_id}

Returns a single document according to goven 'doc_id'.

API Key ApiKey

doc_id

string

required

Response

Examples Schema

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

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

No schema

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.

API Key ApiKey

doc_id

string

required

status

required

An enumeration.

Request

{
  "status": null
}

Response

Examples Schema

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

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

No schema

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

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.

API Key ApiKey

doc_id

string

required

Response

Examples Schema

Successful Response

null

Not found

Empty response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

No schema

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?