Get customer compliance status

GET 
/v1/compliance/status/:customerId

Returns actionable compliance status for a customer.

Response fields:

• isCompliant: Overall compliance status
• onboardingStatus: KYC process status (PENDING, PROCESSING, APPROVED, DENIED_*, EXPIRED)
• nextAction: Primary action to take (START_KYC, COMPLETE_SDK_FLOW, UPLOAD_DOCUMENT, UPDATE_PROFILE, RERUN_KYC, WAIT, CONTACT_SUPPORT)
• checks: Array of individual compliance checks with suggestedAction for failed checks
• summary: Count of passed/failed checks and list of failed required check types

Request

Path Parameters

customerId stringrequired

Responses

200

Compliance status retrieved successfully

application/json

Schema

Schema

message string

data

object

isCompliant boolean

True if all required checks pass

onboardingStatus stringnullable

Possible values: [PENDING, PROCESSING, APPROVED, DENIED_COMPLIANCE, DENIED_IDENTITY_THEFT, EXPIRED]

Current KYC onboarding status

nextAction stringnullable

Possible values: [NONE, START_KYC, COMPLETE_SDK_FLOW, UPLOAD_DOCUMENT, UPDATE_PROFILE, RERUN_KYC, WAIT, CONTACT_SUPPORT]

Primary action to take to resolve compliance issues

checks

object[]

Individual compliance check results

Array [

type string

Possible values: [KYC_DATA_PRESENT, KYC_STARTED, SDK_VERIFICATION_COMPLETED, KYC_STATUS, REGISTRATION_ADDRESS, TAX_COUNTRY, OCCUPATION, DOC_SOURCE_OF_FUNDS, DOC_FATCA, DOC_BIOMETRIC_REPORT, DOC_PROOF_OF_ADDRESS]

Check type identifier

passed boolean

Whether the check passed

required boolean

Whether the check is required for compliance

suggestedAction string

Possible values: [NONE, START_KYC, COMPLETE_SDK_FLOW, UPLOAD_DOCUMENT, UPDATE_PROFILE, RERUN_KYC, WAIT, CONTACT_SUPPORT]

Suggested action to resolve this check (only present when passed=false)

]

summary

object

passed number

Number of checks passed

failed number

Number of checks failed

requiredFailed string[]

List of failed required check types

traceId string

Example (from schema)

{
  "message": "string",
  "data": {
    "isCompliant": true,
    "onboardingStatus": "PENDING",
    "nextAction": "NONE",
    "checks": [
      {
        "type": "KYC_DATA_PRESENT",
        "passed": true,
        "required": true,
        "suggestedAction": "NONE"
      }
    ],
    "summary": {
      "passed": 0,
      "failed": 0,
      "requiredFailed": [
        "string"
      ]
    }
  },
  "traceId": "string"
}

Loading...