POST
/
v1
/
auth
/
token
/
refresh

Authorizations

Authorization
string
headerrequired

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
required

The parent accountId of the business.

Body

application/json
grant_type
enum<string>
required

The grant type of the authentication.

Available options:
client_credentials,
refresh_token
refresh_token
string
required

A Base64 Encoded String used to refresh an expired access_token

Response

200 - application/json
code
string
required

Response Code

description
string
required

Response description

data
object
required

A structure representing an authentication result.

Obtain access tokenRevoke an access_token