HEhevn-inc
auth

Exchange a refresh token for a session, optionally acting for an account

Changed on

Exchange a device-bound refresh token for a new short-lived access token. userId may select an account the authenticated actor is currently authorized to access.

post/auth/refresh

Request

Headers

user-agentstring nullable

Request body

userIdstring nullable

Account to act for; omit it to continue acting as the authenticated account.

Example request

{
  "userId": "cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
}

Response

Successful Response

accessTokenstring required

Short-lived bearer token used to authorize API requests.

expiresIninteger required

Number of seconds until the access token expires.

userIdstring required

Account selected for the issued session.

Example response

{
  "userId": "cl_9f2c1ab84d7e4f1fa3c65b0e7d9a2c41"
}

Changes

  • 299a3aa6f521Revision changes
    • warning

      added the new verification_not_applicable enum value to the / response property for the response status

    • info

      removed the phone_required enum value from the / response property for the response status

    • info

      removed the rail_requirements_unmet enum value from the / response property for the response status

  • a02795de2d2bRevision changes
    • warning

      deleted the header request parameter x-api-key

    • warning

      added the new client_already_linked enum value to the / response property for the response status

    • warning

      added the new kyb_documents_processing enum value to the / response property for the response status

    • warning

      added the new link_code_expired enum value to the / response property for the response status

    • warning

      added the new link_code_invalid enum value to the / response property for the response status

    • warning

      added the new payout_not_awaiting_signature enum value to the / response property for the response status

    • warning

      added the new redirect_uri_not_allowed enum value to the / response property for the response status

    • warning

      added the new sandbox_amount_limit_exceeded enum value to the / response property for the response status

    • warning

      added the new sandbox_faucet_balance_too_high enum value to the / response property for the response status

    • info

      removed the client_policy_not_enabled enum value from the / response property for the response status

    • info

      removed the client_request_conflict enum value from the / response property for the response status

    • info

      removed the email_in_use enum value from the / response property for the response status

    • info

      removed the integrator_inactive enum value from the / response property for the response status

    • info

      removed the name_in_use enum value from the / response property for the response status