Get the onboarding status of a client

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

  HTTP Code	Description
  200	OK	OK
  400	Bad Request	Error Code Description InvalidModelState One or more properties of the request are invalid!
  401	Unauthorized	Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
  404	Not Found	Error Code Description NotFound SignupNotFound The given signup could not be found
  429	Too Many Requests	The request was rejected due to rate limit being exceeded.
  503	Service Unavailable	Service Unavailable.

  Close

• 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"
  }