For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Batch Item

Returns one batch row by its row_key, including the full compliance review: overall rejection reasons and detailed reasons per document, per associated party and per verification step. Use it to understand exactly what to fix for a row in change_requested or rejected.

Endpoint

GET /v2/compliance/batch/{batch_id}/items/{row_key}

Link

Request

Path Parameters

Parameter
Type
Description
Required
Example

batch_id

string

Batch ID returned by Create Batch.

Yes

"01a0af8b-831f-7dbe-8eaf-459f81998958"

row_key

string

Your row_key from the manifest.

Yes

"client-001"

Headers

Key
Value
Required

Authorization

<JWT>

Yes

Accept

application/json

Yes

Response (200 OK)

Returns a BatchItemDetail: every field of BatchItem plus review and review_error.

Response Fields

Field
Type
Description
Example

row_key

string

Your row identifier from the manifest.

"client-001"

type

string

What the row onboards: individual or company.

"individual"

client_id

string

ID of the created customer. Empty for invalid rows: they never get one.

"DNkjZcj-hHJA-yhO8yAX3rBRe"

external_customer_id

string

Your customer identifier from the manifest, stable across batches.

"crm-48213"

status

string

Row status: invalid, valid, creating, submitted, finished, rejected, change_requested or failed.

"submitted"

review_status

string

Current status of the compliance review.

"pending"

error

string

Reason for invalid or failed, or the latest temporary error while the row is being retried.

""

updated_at

string (date-time)

Last change of the row.

"2026-09-28T11:05:12Z"

review

object

BatchItemReview — the compliance review of this row. See below.

—

review_error

string

Set if the review details could not be loaded.

""

review object (BatchItemReview)

Field
Type
Description

uuid

string

Review ID.

status

string

Review status.

revision

string (int64)

Review revision; increases with every resubmission.

updated_at

string (date-time)

Last review update.

reject_type

string

Type of rejection (e.g. final or retry allowed).

reject_reasons

array[string]

Overall rejection reasons.

reject_comment

string

Reviewer comment.

button_ids

array[string]

Machine-readable rejection reason codes.

details_available

boolean

Whether detailed reasons below are available.

document_reject_reasons

array[object]

Reasons per document. See below.

party_reject_reasons

array[object]

Reasons per associated party (companies).

step_reject_reasons

array[object]

Reasons per verification step.

document_reject_reasons[]

Field
Type
Description

document_uuid

string

Document ID at the provider.

party_key

string

Associated party the document belongs to; empty for the row's own document.

type

string

Document type from the manifest.

sub_type

string

Document sub-type or side.

file

string

File path from the manifest.

matched

boolean

Whether the rejected document was matched to a manifest entry.

question_section

string

For questionnaire files: section id.

question_item

string

For questionnaire files: question id.

question_index

integer

For questionnaire files: position of the file in files.

reject_type, reject_reasons, reject_comment, button_ids

—

Same meaning as in review.

party_reject_reasons[]

Field
Type
Description

party_key

string

Associated party from the manifest.

status

string

Review status of this party.

reject_type, reject_reasons, reject_comment, button_ids

—

Same meaning as in review.

step_reject_reasons[]

Field
Type
Description

party_key

string

Associated party; empty for the row's own verification.

step

string

Verification step.

reject_type, reject_reasons, reject_comment, button_ids

—

Same meaning as in review.

Example Response:


Examples

Request


Error Responses

Errors are returned as {"code", "message", "details"}, where code is a gRPC status code. Use the HTTP status for error handling.

Item Not Found (404) — the batch or the row_key does not exist, or the batch belongs to another partner:

Authorization fail (401):


Notes

  • Live review data: review details are read from compliance in real time and may be newer than the row status.

  • Mapping back to the manifest: use file, party_key and question_section / question_item / question_indexin document_reject_reasons to find the exact manifest entry to fix.

  • Fixing a row: either correct the data and resubmit via Request Batch Changes, or send the customer a link from Get Item WebSDK Link.

Last updated