v1

latestOpenAPI 3.0.02026-07-24103118224.7 KB

Connect

Get Connect KYC status

Returns the current KYC status and a unified nextUrl/nextSteps contract for what to do next. This endpoint is the single source of truth for KYC progression.

get/api/connect/accounts/{subMerchantId}/kyc/status

Path parameters

subMerchantIdstring required

Example:usr_01JABCDEF0123456789XYZ

Sub-merchant user id created by Inflow Connect

Query parameters

kycEndorsement'sepa' | 'spei' | 'cards'

Optional Bridge endorsement hint for generated hosted links

redirectUristring

Example:https://marketplace.example.com/connect/kyc-callback

Redirect URI used for Bridge hosted KYC link generation

Response

Get Connect KYC status successful

subMerchantIdstring required

Sub-merchant user id

kycReadyboolean required

True when KYC is approved and the custodial wallet is provisioned

verificationType'KYC' | 'KYB' required

Verification type — KYC for individuals, KYB for businesses

nextUrlstring nullable required

URL to redirect the sub-merchant to for the next KYC action. Null when no action is required.

nextStepsstring[] required

Ordered list of next steps the marketplace must follow

pendingRequirementsstring[] required

List of KYC requirements still pending

fallbackKycLinkstring nullable required

Fallback KYC hosted link (independent of terms-of-service acceptance state)

walletIdstring nullable required

Managed wallet external id (null until KYC is approved and wallet is provisioned)

Example response

{
  "subMerchantId": "usr_01JABCDEF0123456789XYZ",
  "kycReady": true,
  "verificationType": "KYC",
  "nextUrl": "https://kyc.provider.com/verify?token=abc",
  "nextSteps": [
    "redirect_submerchant_to_url",
    "wait_for_kyc_approval",
    "check_connect_kyc_status"
  ],
  "pendingRequirements": [
    "kyc_document",
    "proof_of_address"
  ],
  "fallbackKycLink": "https://kyc.provider.com/verify?token=abc",
  "walletId": "wallet_ext_abc123"
}