Skip to main content
GET
Get customer requirements

Authorizations

X-API-Key
string
header
required

API Key

Headers

X-SUB-PARTNER-ID
string

Optional sub-partner UUID, if provided, the customer will be filtered for the sub-partner

X-API-Version
string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01, 2026-08-01, 2026-10-01, 2026-10-15.

Path Parameters

id
string<uuid>
required

the ID of the Customer to GET requirements for

Response

GET Customer Requirements Succeeded

Available from API version 2026-10-01.

complete
CompleteRequirement · object[]
required
general_review_comment
string | null
required
issues
(VerificationIssue · object | ValidationIssue · object)[]
required
pending
(PendingRequirement · object | PendingQuestionnaireRequirement · object)[]
required
pendingReview
PendingReviewRequirement · object[]
required
preflight_summary
IdentificationPreflightSummary · object | null
required

Curated, partner-safe summary of the async preflight pipeline (document/selfie analysis + workflow predictor) — backfilled onto an identification once that pipeline finishes. Deliberately narrower than the full internal result: no internal level names, trace/correlation ids, or per-check evaluation names — those stay internal/backoffice-only.

requirements_due
enum<string>[]
required

Coarse summary of which areas of the customer's Sumsub KYC/KYB process still need attention. Used as a quick filter — full detail lives in the four complete/pending/missing/issues buckets.

Available options:
kyc,
kyb