Skip to main content
POST
Refresh an expired token

Authorizations

Authorization
string
header
required

Nomba authenticates API calls with OAuth2 HTTP bearer tokens. There are two methods of authentication; Client-Credentials method and PKCE (Proof Key for Code Exchange) method. In each of the methods, You will get an ACCESS_TOKEN. You need to use an "Authorization" HTTP header to provide your ACCESS_TOKEN. For example: Authorization: {ACCESS_TOKEN}.

Headers

accountId
string<uuid>
required

The parent accountId of the business.

Example:

"890022ce-bae0-45c1-9b9d-ee7872e6ca27"

Body

application/json

The request payload required to refresh the client's access_token

A structure representing a refresh token request.

grant_type
enum<string>
required

The grant type of the authentication.

Available options:
client_credentials,
refresh_token
Example:

"refresh_token"

refresh_token
string
required

A Base64 Encoded String used to refresh an expired access_token

Required string length: 30 - 60
Example:

"01h4gdx2tctxfjgacbdwrcvs5d1688473602892"

Response

Your request to refresh a token was successful.

code
string
required

Response Code

Example:

"00"

description
string
required

Response description

Example:

"Success"

data
object
required

A structure representing an authentication result.