Get onboarding status
Returns the current status of one client onboarding case. When onboarding is approved, use the returned clientId in Trade API client paths.
Authorization
Default AuthorizationBearer <token>
In: header
Path Parameters
clientId*string
Client identifier (UUID) assigned when an onboarding case is created. It identifies the onboarding case and, once active, the client's Trade API resources. The client must belong to your partnership; anyone else's id returns 404.
Format
uuidHeader Parameters
X-Request-Id?string
Optional identifier for tracing a request end to end. A UUID is recommended. Axiym returns it in the X-Request-Id response header and records it in logs. If omitted, Axiym generates one. Include it when contacting support.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json