Get business customer compliance status

GET 
/v1/compliance/business/status/:customerId

Returns actionable business compliance (KYB) status for a business customer.

Response fields:

• isCompliant: Overall compliance status
• onboardingStatus: KYB process status (PENDING, PROCESSING, APPROVED, DENIED_*, EXPIRED)
• nextAction: Primary action to take (UPDATE_BUSINESS_DATA, ADD_PERSON_RELATIONS, COMPLETE_UBO_KYC, START_KYB, UPLOAD_BUSINESS_DOCUMENT, WAIT, CONTACT_SUPPORT, NONE)
• checks: Array of individual compliance checks with suggestedAction for failed checks
• summary: Count of passed/failed checks and number of required failed checks

Request

Path Parameters

customerId stringrequired

Responses

200

Business 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 KYB onboarding status

nextAction stringnullable

Possible values: [NONE, UPDATE_BUSINESS_DATA, ADD_PERSON_RELATIONS, COMPLETE_UBO_KYC, START_KYB, COMPLETE_SDK_FLOW, UPLOAD_BUSINESS_DOCUMENT, WAIT, CONTACT_SUPPORT]

Primary action to take to resolve compliance issues

checks

object[]

Individual compliance check results

Array [

type string

Check type identifier

passed boolean

Whether the check passed

required boolean

Whether the check is required for compliance

suggestedAction string

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": "string",
        "passed": true,
        "required": true,
        "suggestedAction": "string"
      }
    ],
    "summary": {
      "passed": 0,
      "failed": 0,
      "requiredFailed": [
        "string"
      ]
    }
  },
  "traceId": "string"
}

Loading...