Wallet Create
This API allows clients to create or retrieve a wallet for a user. The client supplies an email address or phone number, and receive a wallet address (and anonymized wallet ID) in response. If a wallet has already been created for the user, the wallet address and anonymized wallet ID will be returned. If a wallet already exists for the user, the wallet is looked up and the address and ID are returned.
Endpoint Details
API Name
HTTP Method
POST
URL
/v1/wallet/create
Headers
Content-Type
application/json
x-api-key
API_KEY
Query Parameters
ignoreAddress
boolean
when set to true
, prevents the return of the wallet address
string
The email of the user for claim. Note: Either email
or phone
should be present in the request.
phone
string
The phone number of the user. Note: Either email
or phone
should be present in the request.
Payload Example:
By Email:
By Mobile phone
Examples
Notes
Validation:
Ensure you have an active API key.
Either
email
orphone
should be present in the request, otherwise, a validation error will be returned.
If the wallet already exists for the provided email address or phone number, the previously created wallet ID will be returned.
If the
ignoreAddress
parameter is set totrue
, the wallet address won't be returned.If the
ignoreAddress
parameter is omitted or set tofalse
, both the wallet ID and the wallet address will be returned.
Last updated