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.

Path Parameters

id
string<uuid>
required

the ID of the Customer to GET requirements for

Response

GET Customer Requirements Succeeded

Bridge-style requirements view of a customer. All four buckets are always present (may be empty). requirements_due is a quick coarse summary — partners can use it to decide whether any action is needed before drilling into the detail buckets.

complete
RequirementItem · object[]
required

Requirements the customer has satisfied.

issues
RequirementItem · object[]
required

Terminal blockers the customer cannot self-remediate.

missing
RequirementItem · object[]
required

Requirements the customer can still satisfy (resubmittable).

pending
RequirementItem · object[]
required

Requirements the customer has submitted, awaiting review.

requirements_due
enum<string>[]
required

Sorted, deduplicated set of categories that have at least one non-complete item. Empty for fully-onboarded customers.

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