---
title: "Bulk verification"
method: POST
path: "/kyc/batch"
tags: ["batch"]
---

# Bulk verification

`POST /kyc/batch`

## Request

- Base URL: `https://api.qorpiq.com`
- URL: `https://api.qorpiq.com/kyc/batch`
- Auth: API key in header `x-api-key`

Run one check over a list of up to 25 items, with per-item results. Each item is billed as one check. The whole batch must fit in your balance up front, otherwise the call returns 402. Only items that complete a lookup (status ok) are charged; invalid and errored items cost nothing.

## Request body

- BatchRequest
  - `realtime` boolean: Read the record live from MCA instead of our saved copy. Default false: a saved copy that covers this check answers first, and MCA is read live only when we hold no sufficient record. Live reads are available to accounts enabled for them; if a live read cannot run, the saved copy answers and the response says so.
  - `check` 'pan' | 'director' | 'director-affiliations' | 'signatory' | 'charges' | 'filing-health' | 'auditor' | 'network' | 'adjudication', required: Which check to run over every item.
  - `items` object[], required: Up to 25 items, each shaped like the chosen check's request body.

## Response `200`

Success.

- BatchResponse
  - `transaction_id` string, uuid: Unique id for this request, echoed in the X-Transaction-Id header.
  - `check` string
  - `total` integer
  - `succeeded` integer
  - `failed` integer
  - `results` object[]
    - `index` integer
    - `status` 'ok' | 'invalid' | 'error'
  - `timestamp` integer: Response time (epoch ms).

## Other responses

- `400`: Invalid request body or parameters.
- `401`: Missing or invalid x-api-key.
- `402`: Balance too low for this call. Add money to your QorpIQ balance to continue (reason credit_balance_exhausted is kept for compatibility).
- `503`: MCA data source temporarily unavailable.

---

[API](https://skmtc.dev/qorpiq/apis/qorpiq-kyc-kyb-api.md) · [All operations](https://skmtc.dev/qorpiq/apis/qorpiq-kyc-kyb-api/llms.txt) · [OpenAPI document](https://skmtc.dev/qorpiq/apis/qorpiq-kyc-kyb-api/revisions/5a9c792b6c06?raw)
