KybCase

Schema #/components/schemas/KybCase of contract 1.0.0-draft.14.

id Uuidrequiredread-only
Fields of id
Uuid
customerId Uuidrequiredread-only
Fields of customerId
Uuid
status KybCaseStatusrequiredread-only
Fields of status
KybCaseStatus
provider KycProviderIdrequired
applicantId string | nullread-only
company object
Fields of company
- legalName string
- tradingName string | null
- registrationNumber string | null
- incorporationCountry CountryCode
- incorporationDate Date | null
- legalForm string | null
- website string | null (uri)
- industryCode string | null
  SIC/NACE code.
- taxId string | null
expectedActivity object
Fields of expectedActivity
- monthlyVolume Money | null
- monthlyTransactions integer | null
  min 0
- currencies array of CurrencyCode
- countries array of CountryCode
- purpose string | null
  max length 1000
- sourceOfFunds string | null
  max length 1000
steps objectrequired
Wizard completion flags.
Fields of steps
- company boolean
- addresses boolean
- ownership boolean
- activity boolean
- documents boolean
- personal boolean
  Sole traders and individuals only: the personal details are complete.
result object | null
KYC provider outcome (read-only; staff only for details).
Fields of result
- reviewAnswer string | null
  One of: "green", "red", "retry"
- screeningHits integer
  min 0
- details KybProviderResult
infoRequested string | null
submittedAt Timestamp | null
reviewedAt Timestamp | null
createdAt Timestamprequiredread-only
Fields of createdAt
Timestamp
updatedAt Timestampread-only
Fields of updatedAt
Timestamp
customerType CustomerTyperead-only
Fields of customerType
CustomerType
personal KybPersonal
mode OnboardingModeread-only
Fields of mode
OnboardingMode