Initiate Data Processing

post

https://sandbox-api.credilinq.ai/v1/onboarding/initiate-data-processing

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Purpose

This API enables the commencement of customer data processing obtained from partner platforms. In light of the diverse data schemas found across these platforms, CrediLinq's Data Science team will work jointly to establish precise API invocation guidelines with each platform in advance. For information on the appropriate file structures and API payloads necessary to successfully invoke this API, please reach out to our Data Science team.

Please Note: once this API is triggered for a given customer, it must not be called again for the next 20 seconds—subsequent requests within this window will be throttled. This restriction is enforced on a per-platform and per-customer basis.

Body Params

customerReferenceNo

string

required

length ≤ 100

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

string

enum

required

Data Cycles.

We support these two data cycles,

monitoring - Monitoring
origination - Origination

Allowed:

datasetType

string

enum

required

Dataset Types.

We support these two dataset types,

single - Single Operation
batch - Batch Operation

Allowed:

fileNames

array of strings

required

File Names

fileNames*

s3Paths

array of strings

required

Data Location S3 Paths

s3Paths*

noOfFilesUploaded

number

required

No. of files uploaded on the data location

Min=2 & Max=100000.

additionalFields

object

required

Additional Fields for Data Processing

Headers

accept-language

string

Defaults to en-us

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

Responses

Purpose

200Data processing Initiated.

400Invalid Request

401Invalid credentials

403Forbidden resource

404Requested Data Not Found

500Internal Server Error, Some problem is there, please try after sometime