api-docs-icon

Authorizing Turnqey

User visits the url on their browser. The browser loads the turnqey page to initiate the authorization process.

POST https://api.turnqey.xyz/authorize?client=[CLIENT_ID]&platform=[PLATFORM]&collection=[COLLECTION_ID]&state=[RANDOM_KEY]&identity=[IDENTITY_PARAM]&checksum=[CHECKSUM]
POST https://sandbox.turnqey.xyz/authorize?client=[CLIENT_ID]&platform=[PLATFORM]&collection=[COLLECTION_ID]&state=[RANDOM_KEY]&identity=[IDENTITY_PARAM]&checksum=[CHECKSUM]

Query parameters

Parameter NameDescriptionRequired
clientIdThe client ID provided by TurnqeyYes
platform(string) Platform name [eg: coinbase]Yes
checksum(string) Generate checksum for this request from here. Make sure you are sending the same parameters.Yes
collection(uuid) Collection Id that can be used from previous authorizations so that the new authorization is also grouped under the same collection. Use this param for grouping accounts under an existing collection. Any account authorization request without a collection id will generate a new collection id.No
state(string) An unguessable random string to protect against cross-site request forgery attacks. This value will be returned during redirect.No
identity(string) Use this to pass an identity ID as parameter. This value will be returned during redirect If you intend to use this parameter to fetch accounts.Yes