Browse documentation
Batches

Create Batch

post/v1/check_batches

Create Batch

Authentication

Send your tenant secret key as a Bearer token. Keep secret keys on your server; never ship them in browser or mobile code.

Parameters

Idempotency-Key
header · optional

No additional parameter description.

Request body

JSON · required

datasets
AmlDataset[] | null

No additional field description.

mode
CheckMode

No additional field description.

records
BatchRecordIn[]required

No additional field description.

use_case
CheckUseCase

No additional field description.

Example request

cURL
curl --request POST \
  --url 'https://api.fideralabs.com/v1/check_batches' \
  --header 'Authorization: Bearer $FIDERA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "datasets": [
    "string"
  ],
  "mode": "async",
  "records": [
    {
      "applicant_id": {},
      "external_id": {},
      "subjects": [
        {}
      ]
    }
  ],
  "use_case": "lookback"
}'

Responses

202Successful Response
completed_at
string | nullrequired

No additional field description.

completed_count
integerrequired

No additional field description.

created_at
stringrequired

No additional field description.

datasets
string[]required

No additional field description.

error
string | nullrequired

No additional field description.

error_count
integerrequired

No additional field description.

id
stringrequired

No additional field description.

status
BatchStatusrequired

No additional field description.

subject_count
integerrequired

No additional field description.

updated_at
stringrequired

No additional field description.

use_case
CheckUseCaserequired

No additional field description.

application/json
{
  "completed_at": "2026-07-29T12:00:00Z",
  "completed_count": 0,
  "created_at": "2026-07-29T12:00:00Z",
  "datasets": [
    "string"
  ],
  "error": "string",
  "error_count": 0,
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "string",
  "subject_count": 0,
  "updated_at": "2026-07-29T12:00:00Z",
  "use_case": "string"
}
422Validation Error
detail
ValidationError[]

No additional field description.

Operation ID

create_batch_v1_check_batches_post