Generate a client access token

post

https://api.cert.zerohash.com/client_auth_token

Generates a temporary JWT access token used to initialize zerohash SDK modules.

Body Params

participant_code

string

required

The participant_code for whom the SDK token is created

reference_id

string

Optional platform-defined ID to link downstream events

permissions

array of strings

required

One or more SDK experiences requested for this token. The following permissions are supported;

crypto-buy
crypto-sell
crypto-withdrawals
crypto-payouts
crypto-pay
fiat-deposits
fiat-withdrawals
fwc
onboarding
participant-profile
update-participant
crypto-account-link
fiat-account-link

permissions*

withdrawal_details

object

Details for crypto withdrawals and payouts.

deposit_details

object

Account deposit details.

payment_details

object

Details for crypto payments.

client_device_info

object

Metadata about the client environment where the SDK is initialized.

custom_fees_and_spreads

object

Custom fees and spreads for crypto buy/sell.

Headers

X-SCX-SIGNED

string

Defaults to [WEB] auto-generated on fly

Signature for your request.

X-SCX-TIMESTAMP

string

Defaults to [WEB] auto-generated on fly

UNIX timestamp.

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Client access token successfully generated.

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable