v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Authenticate

Obtain access token

You can use this endpoint to authenticate with Nomba.

post/v1/auth/token/issue

Headers

accountIdstring uuid required

Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

grant_type'client_credentials' | 'refresh_token' required

The grant type of the authentication.

client_idstring required

The client's id as obtained from your Nomba dashboard.

client_secretstring required

The client's secret as obtained from your Nomba dashboard. It is securely generated by the Nomba system

Example request

{
  "grant_type": "client_credentials",
  "client_id": "2242b79d-f2cf-4ccc-ada1-e890bd1a9f0d",
  "client_secret": "JFJ8yq3G4+DvjivJMsji0YkZBkkKdSdjifR+TgT9RLM="
}

Response

Your authentication request was successful.

codestring required

Response Code

descriptionstring required

Response description

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "businessId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
    "access_token": "eyJhbGciOiJIUzI1NiJ9.eyJHOjhmYWM4M2FjLTc2YjAtNDM1Zi1hYTM1LThkOTU3ZGQ5MjdkZCI6Ikc6OGZhYzgzYWMtNzZiMC00MzVmLWFhMzUtOGQ5NTdkZDkyN2RkIiwiUjpURUFNU19PV05FUiI6IlI6VEVBTVNfT1dORVIiLCJFbWFpbDp2aWN0b3JzaG9hZ2FAZ21haWwuY29tIjoiRW1haWw6dmljdG9yc2hvYWdhQGdtYWlsLmNvbSIsImlhdCI6MTY4MTkxODU3OSwic3ViIjoiNWUyNmNmYjAtNTI5Zi00MTdiLWI4ZDItYWJjNDcxZjRjOWRiIiwiZXhwIjoxNjgxOTIyMTc5fQ.lQOsyhR1gajKdzE9IHQEtxhQyUrArctEDZiP9pWVTFY",
    "refresh_token": "01h4gdx2tctxfjgacbdwrcvs5d1688473602892",
    "expiresAt": "2022-07-08T14:33:00Z"
  }
}