Batch Inquiries

List Batches

get

List batches with aggregated status, scoped to your organization.

Returns a paginated list of batches. Use limit and offset to page through results.

Authorizations
AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Query parameters
limitinteger · max: 500OptionalDefault: 100
offsetintegerOptionalDefault: 0
Responses
chevron-right
200

Successful Response

application/json

Response for listing batches with pagination

totalintegerRequired
limitintegerRequired
offsetintegerRequired
get
/v1/batch-inquiries/

Submit Batch Inquiry

post

Submit a batch of inquiries for processing.

Accepts up to the configured lender batch max in a single request (250 by default). Each item follows the same field requirements as POST /v1/inquiries/ (see that endpoint for field details).

Recommended workflow:

  1. Submit the batch via this endpoint.

  2. Poll GET /v1/batch-inquiries/{batch_id} every 30 seconds to monitor overall progress.

  3. Once complete, retrieve individual results via GET /v1/batch-inquiries/{batch_id}/inquiries.

Authorizations
AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Body

Request model for submitting a batch of inquiries

namestringRequired
Responses
chevron-right
200

Successful Response

application/json

Response after submitting a batch of inquiries

batchIdstring · uuidRequired
batchNamestringRequired
totalintegerRequired
messagestringRequired
post
/v1/batch-inquiries/

Get Batch Status

get

Get status summary for a batch.

Returns progress_percentage and per-status counts (e.g., how many inquiries are COMPLETED, RUNNING, FAILED, etc.). Poll this endpoint every 30 seconds to monitor batch progress.

Authorizations
AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Path parameters
batch_idstringRequired
Responses
chevron-right
200

Successful Response

application/json

Status summary for a batch of inquiries

batchIdstring · uuidRequired
batchNameany ofRequired
stringOptional
or
nullOptional
operationTypeany ofOptional
string · enumOptionalPossible values:
or
nullOptional
statusany ofOptional
string · enumOptionalPossible values:
or
nullOptional
totalintegerRequired
planningintegerRequired
runningintegerRequired
completedintegerRequired
partialSuccessintegerRequired
failedintegerRequired
progressPercentagenumberRequired
createdAtstring · date-timeRequired
phaseProgressany ofOptional
or
nullOptional
sourceRecordTotalsany ofOptional
or
nullOptional
timingSummaryany ofOptional
or
nullOptional
get
/v1/batch-inquiries/{batch_id}

Get Batch Inquiries

get

Get individual inquiry results from a batch with pagination.

Use limit and offset to page through the inquiries in this batch. Each item includes the inquiry status, progress, and source record count.

Authorizations
AuthorizationstringRequired

JWT token from Cognito, or lender API key (vd__). API keys can be obtained via GET /users/me/api-key.

Path parameters
batch_idstringRequired
Query parameters
limitinteger · max: 500OptionalDefault: 100
offsetintegerOptionalDefault: 0
Responses
chevron-right
200

Successful Response

application/json

Response for listing inquiries in a batch

batchIdstring · uuidRequired
totalintegerRequired
limitintegerRequired
offsetintegerRequired
get
/v1/batch-inquiries/{batch_id}/inquiries

Last updated