Refresh Token Based Access Token - Revision history

Ashley DeBon: /* Successful Response (200) */

2026-07-21T14:57:24Z

‎Successful Response (200)

Ashley DeBon: /* Get Access Token */

2026-07-21T14:56:54Z

‎Get Access Token

Ashley DeBon: Created page with "== Get Access Token == === Base URL === https://apimobile.callproof.com === Endpoint === /api/access-token === Purpose === Issues a new access token (and refresh token) usi..."

2026-07-21T14:56:40Z

Created page with "== Get Access Token == === Base URL === https://apimobile.callproof.com === Endpoint === /api/access-token === Purpose === Issues a new access token (and refresh token) usi..."

New page

== Get Access Token ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/access-token

=== Purpose ===
Issues a new access token (and refresh token) using a valid refresh token. This endpoint is used when the current access token has expired and the client needs to renew authentication without logging in again.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || No || Not required for this endpoint
|}

=== Security ===
* '''No Bearer token required''' – Authenticated via a valid <code>refresh_token</code> in the request body.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| refresh_token || string || Yes || Valid refresh token used to request a new access token
|-
| access_token || string || No || Current/expired access token (optional; used for logging/context when provided)
|}

=== Successful Response (200) ===
Returns a new OAuth token pair from the token service.

{| class="wikitable"
! Field !! Type !! Description
|-
| token_type || string || Token type (typically <code>Bearer</code>)
|-
| expires_in || integer || Access token lifetime in seconds
|-
| access_token || string || Newly issued access token
|-
| refresh_token || string || Newly issued refresh token
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation or refresh failed – response body uses <code>clientStatusCode</code> 401 with an error message
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Missing <code>refresh_token</code>.
* '''Invalid refresh token (HTTP 200, clientStatusCode 401)''' – Refresh failed (for example, "Given Refresh Token is Invalid" with related user/token context when available).

← Older revision		Revision as of 14:56, 21 July 2026
Line 1:		Line 1:
−	== Get Access Token ==	+	== [[Mobile_API]] »Get Access Token ==

	=== Base URL ===		=== Base URL ===

@@ Line 39: / Line 39: @@
 | access_token || string || No || Current/expired access token (optional; used for logging/context when provided)
 |}
 === Successful Response (200) ===