Consumers

Get KYC for a consumer

Returns the due diligence status of the logged-in consumer. Use the effective and ongoing KYC statuses to decide whether the consumer can use financial services or must complete further verification.

Read Consumer due diligence and KYC for the verification flow and status handling.

get/consumers/kyc

Request

  • Base URL: https://sandbox.weavr.io/multi
  • URL: https://sandbox.weavr.io/multi/consumers/kyc
  • Auth: HTTP bearer and API key in header api-key

Response

Success

fullDueDiligence'NOT_STARTED' | 'INITIATED' | 'PENDING_REVIEW' | 'APPROVED' | 'REJECTED' required
kycLevel'KYC_LEVEL_1' | 'KYC_LEVEL_2'

The KYC level, which determines what KYC information will be requested from the consumer:

  • KYC_LEVEL_1: The most basic level of KYC required.
  • KYC_LEVEL_2: Full due diligence level 2
ongoingFullDueDiligence'NOT_STARTED' | 'INITIATED' | 'PENDING_REVIEW' | 'APPROVED' | 'REJECTED' required
ongoingKycLevel'KYC_LEVEL_1' | 'KYC_LEVEL_2'

The KYC level, which determines what KYC information will be requested from the consumer:

  • KYC_LEVEL_1: The most basic level of KYC required.
  • KYC_LEVEL_2: Full due diligence level 2

Changes

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