Sign in
latestOpenAPI 3.0.02026-08-133383136.3 KB

fc4f4dd68f9b

Onboarding

Initiate Data Processing

post/v1/onboarding/initiate-data-processing

Headers

accept-languagestring

Language of the response, supported languages: en-us, in

Request body

customerReferenceNostring required

Customer Reference Number of company/business assigned by the platform to uniquely identify the customer. It's a unique number with a combination of alphabets, numeric and some special characters like dash, hash, ampersand and forward slash.

  • /(^[a-zA-Z0-9#/-]+)$/
dataCycle'monitoring' | 'origination' required

Data Cycles.

We support these two data cycles,

  1. monitoring - Monitoring

  2. origination - Origination

datasetType'single' | 'batch' required

Dataset Types.

We support these two dataset types,

  1. single - Single Operation

  2. batch - Batch Operation

fileNamesstring[] required

File Names

s3Pathsstring[] required

Data Location S3 Paths

noOfFilesUploadednumber required

No. of files uploaded on the data location

  • Min=2 & Max=100000.
additionalFieldsobject required

Additional Fields for Data Processing

Example request

{
  "customerReferenceNo": "c3eb1619-ff24-4773-97d8-b05264621e60",
  "dataCycle": "monitoring",
  "datasetType": "single",
  "fileNames": [
    "tenant_456.xlsx"
  ],
  "s3Paths": [
    "https://"
  ],
  "noOfFilesUploaded": 24
}

Response

Data processing Initiated.

statusCodenumber required

The HTTP status code of the error

messagestring required

Human-readable message containing all available details about the operation

successboolean required

A boolean indicating whether this was a success response or an error response