Obtain OAuth Application Access Token

Overview

Exchange an authorization code for an access token that the OAuth Application can use to perform actions on behalf of the profile.

Obtain OAuth Application Access Token

Endpoint: POST /oauth-application/obtain-access-token

Authentication: Required (Basic authentication using authorization code)

Header:

Authorization: Basic {oauth_authorization_code}

Request Parameters

Parameter	Type	Required	Description
`authorization_code`	string	Yes	The authorization code obtained from the previous step

Response Fields

Field	Description
`clientId`	The OAuth Application's client ID
`token`	The access token for authenticated requests
`refreshToken`	Token used to obtain a new access token when the current one expires
`type`	Token type (typically "bearer")
`scope`	Permissions granted to this token
`expiresAt`	ISO 8601 timestamp when the access token expires
`refreshTokenExpiresAt`	ISO 8601 timestamp when the refresh token expires

Use Case

This endpoint completes the OAuth flow by exchanging the short-lived authorization code for a longer-lived access token. The access token allows the OAuth Application to act on behalf of the profile within the defined scope. The refresh token enables obtaining new access tokens without requiring user re-authorization.

Store both the token and refreshToken securely
The authorization code can only be used once
Use the refresh token to obtain new access tokens before expiration

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "clientId": "example_client_id",
    "token": "example_access_token",
    "refreshToken": "example_refresh_token",
    "type": "bearer",
    "scope": "all",
    "expiresAt": "2025-02-10T10:03:06+00:00",
    "refreshTokenExpiresAt": "2025-02-10T10:03:06+00:00"
}

🟠401401

🟠403403

🟠404404

🟠422422

Obtain OAuth app access token

Obtain OAuth Application Access Token#

Overview#