Getting started with AUTH
Integrate an AUTH-enabled SDK, track end-user transfer outcomes with webhooks, and test deposits and withdrawals in Cert.
Getting started with AUTH
Integrate an AUTH-enabled software development kit (SDK) so end users can initiate digital-asset transfers, then use webhooks to track outcomes and test the flow in Cert (the test environment).
Prerequisites
- Get platform access - Request access to a Cert platform and generate API credentials using Get platform access.
- Onboard an end user - Onboard an end user and retain their
participant_codeusing the onboarding guide. - Configure AUTH - Agree on your product, connections, assets, networks, and controls with zerohash using Configure AUTH.
- Set up webhooks - Give zerohash your webhook callback URL and review the webhook overview.
Integrate AUTH
- Select an SDK - Choose the guide for your enabled product:
- Deposits - Use the Account Funding SDK or Crypto Deposits SDK guide.
- Withdrawals - Use the Fund Withdrawals SDK with AUTH or Crypto Withdrawals SDK guide.
- Mobile - Follow the native iOS and Android SDK guides to access all AUTH features for your selected product.
- Generate an end-user access token - Call Generate a client access token with the onboarded end user’s
participant_codeand the permissions required by your selected SDK guide. Sign the request as described in API authentication. - Launch the SDK - Initialize your selected SDK with the access token and settings in its integration guide. Let the end user connect a supported account and submit a transfer.
- Handle transaction updates - Receive the AUTH and product webhooks enabled for your platform. Use their statuses to show pending, completed, failed, and recovery outcomes in your application.
- Test in Cert - Run the enabled product, provider, asset, and network combinations before production rollout. Test available failure and recovery paths as well as successful transfers.
A successful token request starts an end-user flow; it does not complete a transfer. Determine the outcome from transaction updates, not from SDK closure alone.
Track transaction status
Receive both AUTH and deposit or withdrawal events when they are enabled for your platform. AUTH events can include connection information that product events do not. Correlate the events for each transfer and use the selected product’s event schema to determine when funds are available or a withdrawal is settled.
| Status or condition | What to show the end user | Where to find details |
|---|---|---|
| Pending, two-factor authentication (2FA) pending, or submitted | Show the transfer as in progress; submission does not mean settlement. | Deposit status updates and webhook overview |
| Confirmed or completed deposit | Check the product event before showing funds as available; on-chain confirmation alone does not establish that the end-user balance is credited. | Deposit status updates or Account Funding transaction updates |
| Posted or settled withdrawal | Distinguish on-chain broadcast from settlement using the statuses for your withdrawal product. | Withdrawal status updates and Fund Withdrawals SDK with AUTH |
| Account match pending, timeout, or failed | If name matching applies, show the hold or recovery outcome for the configured matching flow. | Account Funding transaction updates and Name match |
| Failed, quarantined, or unexpected | Do not show funds as available; show the applicable recovery path when one is available. | Deposit status updates and Non-AUTH-initiated transaction block |
These are conditions to handle, not a complete list of webhook values. Status names and terminal states vary by product; implement the event schemas and state transitions in your selected SDK’s integration guide.
Test in Cert
- Confirm configuration - Ask zerohash to enable your intended AUTH product, end-user connections, controls, and webhook callback URL on your Cert platform.
- Check test assets - Use Cert environment assets to identify test assets, then confirm which assets and networks are enabled for your AUTH flow.
- Submit a transfer - Generate a token for an onboarded Cert end user, launch the selected SDK, and follow the flow through submission.
- Verify outcomes - Check that your application receives the relevant webhooks and shows submission, completion, and failure correctly. If matching or recovery is enabled, check the paths available in Cert.
Cert simulates transactions, but the available guides do not establish that every provider and exception path can be reproduced there. Agree on a test plan with zerohash for cases you cannot run in Cert.
Optional: Request setup help
Contact zerohash about AUTH setup to request access, product configuration, or help with your test plan.
Updated 3 days ago