batch

Bulk verification

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.

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

Request body

realtimeboolean

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.

itemsobject[] required

Up to 25 items, each shaped like the chosen check's request body.

Response

Success.

transaction_idstring uuid

Unique id for this request, echoed in the X-Transaction-Id header.

checkstring
totalinteger
succeededinteger
failedinteger
timestampinteger

Response time (epoch ms).

Changes

No recorded changes to this operation across all 1 revision of this API.