Swagger UI

CPNI eKYC
 0.1 
OAS3

CPNI eKYC Documentation

bundle

Bundle API. Prefix endpoints with /bundle/

Ensure the user's email is both valid and in the database of approved emails to access the rest of the application.

Parameters

NameDescription
type *
string
(query)

The type of the seperated bundles to retrieve (e.g chemicals)

accessToken *
(query)

The access token required to authenticate the user to the bundle endpoint

limit *
number
(query)

Maximum amount of bundles to get whilst retrieving bundles within specified page

page *
number
(query)

Page of current location of pagination

totalBytes *
boolean
(query)

Whether or not to include the total MB size of all the seperated bundles combined for the specified type

Responses

CodeDescriptionLinks
200
Media type
Controls Accept header.
{
  "bundles": [
    {
      "index": 0,
      "signedUrl": "string",
      "sizeInBytes": 0,
      "type": "string"
    }
  ],
  "pageInfo": {
    "total": 0,
    "hasNextPage": true,
    "totalSizeBytes": 0
  }
}
No links

user

User API. Prefix endpoints with /user/