Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    ClientKey ClientKey Route The client key
  • Response Parameters

    View Response Codes
    Name Type Description
    ClientId String Client ID
    ClientKey String Client key
    Message String Onboarding Status message
    OnboardingState OnboardingStateType Onboarding State of client
    OnboardingSubState OnboardingSubStateType Onboarding Sub State of client
    PendingReasons OnboardingStatePendingReason [] Pending reasons of why the client hasn't been onboarded yet
  • Request Example

    Request URL
    GET /cm/v1/signups/status/d2-PzdC5wIPy1284wD-rRA==
  • Response Example

    Response body
      "ClientId": "7856478",
      "ClientKey": "d2-PzdC5wIPy1284wD-rRA==",
      "Message": "Onboarding request complete. Account and client keys have been created",
      "OnboardingState": "ClientOnboarded"