Start client onboarding
Creates a KYB onboarding case for a client you represent. The client remains your customer; Axiym reviews the case before Trade API resources can be used for that client.
This is the API onboarding route. You can instead complete the same onboarding process manually with Axiym. Trade-only onboarding does not include PNSL financial underwriting. A partnerClientId may identify only one onboarding case in your partnership; a new request using an existing value returns 409 Conflict.
Authorization
Default In: header
Header Parameters
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.
uuidA unique key that makes a funds-moving request safe to retry. Reusing the key returns the original result instead of creating a duplicate. A UUID is recommended.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Legal-entity information needed to start KYB onboarding for a represented client.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json