Create data import record

This request creates a data import record.

   Click here to learn more about this request

LoanPro's import tool is a fast and efficient way to transfer large amounts of data. Imports can be completed manually via the LoanPro dashboard or programmatically via the API. Note the following when importing data via the API.

Importing data into LoanPro requires a series of steps. Here's a breakdown of the entire process.


This is the first step of the import process. Before sending this request, you need to create and format a .csv file for your data. View our Import Examples documentation for help with creating and formatting .csv files for the import tool.

Upon successfully creating a data import record, the response payload includes:

  • d.id – An import ID required in all subsequent calls.
  • d.url – A presigned S3 URL.

The presigned S3 URL generated by this step is required for step two of the CSV data importing process. Please note that the presigned S3 URL expires 45 minutes after it is issued.

❗️

This endpoint only supports loan data.

Line of credit data cannot be imported or created through this API endpoint. Reach out to your LoanPro representative for help with importing line of credit account data.

For more information about LoanPro's import tool, read our Importing into LoanPro article.

{
  "fileName": "payments.csv",
  "validationType": "lineRejection",
  "importProgression": "manual"
}
Path Params
string
enum
required

The type of data being imported. This determines the required CSV column schema.
> Exact Formatting Required: importType is case-sensitive and does not trim whitespace (e.g., Payments works but payments returns 409 error, and trailing spaces cause the job to hang).
> Unlisted Types Silent Failure: Passing unlisted values (e.g. LineOfCreditSetup or Buckets) may return a 200 with an upload URL, but the file will fail to process. Use only values listed in the enum.

Body Params
string
required

The name of the CSV file you are importing.
> Use the actual file name with a .csv extension.
> Omitting this returns a 409: File name is required. error.

string
Defaults to fileRejection

The way errors are handled.
> It is best practice to always send lineRejection—if omitted, it defaults to fileRejection, which rejects the entire file if a single row fails.

string
enum

Controls workflow progression.
> Despite the name, automatic does not automatically advance the import past validation.
> You must call the ingest step explicitly.

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json