Client onboarding

A client can be onboarded through the API or through Axiym's manual onboarding process. Both routes complete the same KYB review and result in an Axiym clientId once the client is active.

For PNSL, onboarding also includes financial due diligence and underwriting before the Payment Network can request financing on the client's behalf. That financial review is not required for a client that uses Trade API only.

Configure webhook delivery before starting. Client activation is asynchronous, and the client does not become available through the Clients endpoints until approval is complete.

1. Create and submit the onboarding case by API

Call POST /onboardings with the legal-entity information required by the API Reference.

The response contains the clientId. Store it with your own client identifier. The case has status ONBOARDING and is submitted for review immediately. Document intake is handled through Axiym's compliance KYB flow; it is not a PNSL API operation.

2. Or complete onboarding manually

If API onboarding is not part of your integration, Axiym can complete the same KYB process manually. Retain the Axiym-issued clientId once the client is active, then use it with the relevant Partner API paths.

3. Track review

Poll GET /onboardings/{clientId} for the current case state. The published case states are ONBOARDING, APPROVED, and REJECTED.

Signed client.* events describe the client resource lifecycle after a client record exists. They do not replace polling the onboarding case while review is in progress. Treat events as notifications and fetch the current resource when authoritative state matters.

4. Confirm activation

The client is ready for financing when GET /clients/{clientId} returns an active client. Only then should you proceed to check financing capacity.

Store these identifiers

Do not create another onboarding case merely because review is still in progress. Retrieve the existing case and continue tracking it.