Generate authorization checksum
Generates the checksum that signs an account-authorization link. When you send a user to GET /authorize to connect their exchange account, the link carries this checksum so Turnqey can confirm the request came from your client and has not been altered.
The checksum binds your client ID, the platform, the collection, and the optional identity. Pass the same three values on the /authorize URL. This endpoint does not verify or reconcile account data.
Endpoint
http
GET /v1/api/checksumAuthentication: Bearer token.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| platform | query | string | Yes | Source platform the user will authorize: coinbase or gemini. |
| collection | query | string (uuid) | No | Existing collection the authorized account will join. Omit it here and on /authorize to have Turnqey create a new collection. |
| identity | query | string | No | Your identity string for the account. If supplied, it must match the value on the /authorize URL. |
Example request
bash
curl -X GET 'https://api.turnqey.xyz/v1/api/checksum?platform=coinbase&collection=123e4567-e89b-12d3-a456-426614174000&identity=account-identity-1234' \
-H 'accept: application/json' \
-H 'Authorization: Bearer <token>'Example response
json
{
"statusCode": 200,
"message": "GET Request successful.",
"isError": false,
"result": {
"checksum": "3f9c1b0a7d4e2f6c8b5a9d1e0c7f4b2a6e8d3c1f",
"expiresIn": 900
}
}| Field | Type | Description |
|---|---|---|
| result.checksum | string | Value to place in the checksum query parameter of the /authorize URL. |
| result.expiresIn | number | Seconds the checksum stays valid. Generate it just before building the link. |
Errors
| Status | Meaning |
|---|---|
| 400 | platform missing or not a supported value. |
| 401 | Bearer token missing, expired, or invalid. |
See Authorizing Turnqey for the full account-connection flow and Errors and Retries for the error envelope.