Skip to main content

Bulk Upload Data

Akshat Singhal avatar
Written by Akshat Singhal
Updated over 10 months ago

Description

This API facilitates the bulk upload of loan data based on loan ID. It supports two primary operations:

  • Appending new entries or editing existing data

  • Removing existing data to overwrite with new entries

The following sections provide details about the API URL, headers for authentication, body parameters, and both success and failure responses, along with a sample payload.

API Endpoint

URL: https://collections-backend.legistify.com/api/lan/raw-bulkupload

Headers

  • apiKey: <PROVIDED_API_KEY>

  • apiSecretKey: <PROVIDED_API_SECRET_KEY>

Body Parameters

Key

Type

Remark

data

Array Of Objects

See sample payload below.

Responses

1. Success (201)

On successful data upload, the response will include:

  • status: success

  • message: Data uploaded successfully!

  • data:

    • validData: List of successfully processed loan IDs.

    • inValidData: List of errors with details, including loan ID, row number, and reasons for rejection.

For Example:

2. Error Responses

  • If apiKey and apiSecretKey are not provided:

    • status: Fail (400)

    • message: "Invalid API Key or Secret! Please contact Admin!"

  • If apiKey is incorrect:

    • status: Fail (404)

    • message: "Invalid API Key! Please contact Admin!"

  • If the intake form has not been created:

    • status: Fail (404)

    • message: "No In-Take Form Found! Please insert in-take form details first"

  • If no data is provided:

    • status: Fail (404)

    • message: "No Data Provided!"

Sample Payload

Did this answer your question?