REST API›Organization›Organization Management

GET

Get enterprise onboarding

Get onboarding and KYC details for a child enterprise, including KYC verification and identity product status.

Path Params

  • enterpriseId string required
    The ID of the child enterprise within the organization

Query Params

  • organizationId string required
    The ID of the organization that owns the enterprise

Responses

200
Onboarding and KYC details for the enterprise, including KYC verification and identity product status.

Response Body

object

  • verification object required
    verification object
    • type string enum required
      kyckyb
    • jurisdiction string required
    • complianceModel string enum nullable required
      EURegulatedEUNonRegulated
  • externalRefs object required
    externalRefs object
    • identityId string nullable required
    • verificationId string nullable required
  • kycState string enum required
    unverifiedapprovedrejectedpendingqrscannedinreviewflaggedflagged_retry_allowed
  • verificationStatus object nullable required
    verificationStatus object
    • value string required
    • display string required
  • failureReasons array of strings required
  • entityInfo object required
    entityInfo object
    • enterpriseId string required
    • displayName string required
    • accountType string
    • businessModel string
    • legalName string
    • incorporationCountry string
    • entityStructure string
    • primaryBusinessType string
  • outstandingRequirements array of objects required
    outstandingRequirements object
    • id string required
    • kind string enum required
      datadocumentagreementsignatureassociatedPersonexternalVerificationbusinessInformation
    • name string required
    • displayName string required
    • status string required
    • statusDisplay string required
  • requestedProducts array of objects required
    requestedProducts object
    • id string required
    • name string required
    • displayName string required
    • status string required
    • statusDisplay string required
  • associatedPeople array of objects required
    associatedPeople object
    • identityId string required
    • userId string required
    • role string required
    • roleDisplay string required
    • name string required
    • email string required
    • status string required
    • statusDisplay string required
    • outstandingRequirements array of objects required
      outstandingRequirements object
      • id string required
      • kind string enum required
        datadocumentagreementsignatureassociatedPersonexternalVerificationbusinessInformation
      • name string required
      • displayName string required
      • status string required
      • statusDisplay string required