Implementation guides
Client onboarding
Onboarding submits a client for compliance (KYB) and financial underwriting. Underwriting sets the client's credit limit.
1. Submit the client
Call POST /onboardings
with the client's legal details, currency, payment rail, and the bank account
that will receive disbursements. You can include your own client reference as
partnerClientId.
The response contains the clientId; store it with your client reference.
The case starts in ONBOARDING. Axiym collects the KYB documents through its
compliance process.
2. Wait for the decision
Poll GET /onboardings/{clientId}
while the status is ONBOARDING.
APPROVED: the client becomesACTIVEandclient.activatedis sent.REJECTED: the client cannot be funded. No event is sent.
Do not submit the client again while the review is in progress.
3. Use the client
Once GET /clients/{clientId} returns status ACTIVE, continue with
Check financing capacity.